fortinet.fortimanager.fmgr_waf_profile module – Web application firewall configuration.

Note

This module is part of the fortinet.fortimanager collection (version 2.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_waf_profile.

New in fortinet.fortimanager 1.0.0

Synopsis

• This module is able to configure a FortiManager device.

• Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter	Comments
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: false ← (default) true
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: "update" "set" "add"
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
state string / required	The directive to create, update or delete an object. Choices: "present" "absent"
waf_profile dictionary	The top level parameters set.
address-list dictionary	Deprecated, please rename it to address_list.
blocked-address any	(list or str) Deprecated, please rename it to blocked_address. Blocked address.
blocked-log string	Deprecated, please rename it to blocked_log. Enable/disable logging on blocked addresses. Choices: "disable" "enable"
severity string	Severity. Choices: "low" "medium" "high"
status string	Status. Choices: "disable" "enable"
trusted-address any	(list or str) Deprecated, please rename it to trusted_address. Trusted address.
comment string	Comment.
constraint dictionary	No description.
content-length dictionary	Deprecated, please rename it to content_length.
action string	Action. Choices: "allow" "block"
length integer	Length of HTTP content in bytes
log string	Enable/disable logging. Choices: "disable" "enable"
severity string	Severity. Choices: "low" "medium" "high"
status string	Enable/disable the constraint. Choices: "disable" "enable"
exception list / elements=dictionary	Exception.
address string	Host address.
content-length string	Deprecated, please rename it to content_length. HTTP content length in request. Choices: "disable" "enable"
header-length string	Deprecated, please rename it to header_length. HTTP header length in request. Choices: "disable" "enable"
hostname string	Enable/disable hostname check. Choices: "disable" "enable"
id integer	Exception ID.
line-length string	Deprecated, please rename it to line_length. HTTP line length in request. Choices: "disable" "enable"
malformed string	Enable/disable malformed HTTP request check. Choices: "disable" "enable"
max-cookie string	Deprecated, please rename it to max_cookie. Maximum number of cookies in HTTP request. Choices: "disable" "enable"
max-header-line string	Deprecated, please rename it to max_header_line. Maximum number of HTTP header line. Choices: "disable" "enable"
max-range-segment string	Deprecated, please rename it to max_range_segment. Maximum number of range segments in HTTP range line. Choices: "disable" "enable"
max-url-param string	Deprecated, please rename it to max_url_param. Maximum number of parameters in URL. Choices: "disable" "enable"
method string	Enable/disable HTTP method check. Choices: "disable" "enable"
param-length string	Deprecated, please rename it to param_length. Maximum length of parameter in URL, HTTP POST request or HTT… Choices: "disable" "enable"
pattern string	URL pattern.
regex string	Enable/disable regular expression based pattern match. Choices: "disable" "enable"
url-param-length string	Deprecated, please rename it to url_param_length. Maximum length of parameter in URL. Choices: "disable" "enable"
version string	Enable/disable HTTP version check. Choices: "disable" "enable"
header-length dictionary	Deprecated, please rename it to header_length.
action string	Action. Choices: "allow" "block"
length integer	Length of HTTP header in bytes
log string	Enable/disable logging. Choices: "disable" "enable"
severity string	Severity. Choices: "low" "medium" "high"
status string	Enable/disable the constraint. Choices: "disable" "enable"
hostname dictionary	No description.
action string	Action. Choices: "allow" "block"
log string	Enable/disable logging. Choices: "disable" "enable"
severity string	Severity. Choices: "low" "medium" "high"
status string	Enable/disable the constraint. Choices: "disable" "enable"
line-length dictionary	Deprecated, please rename it to line_length.
action string	Action. Choices: "allow" "block"
length integer	Length of HTTP line in bytes
log string	Enable/disable logging. Choices: "disable" "enable"
severity string	Severity. Choices: "low" "medium" "high"
status string	Enable/disable the constraint. Choices: "disable" "enable"
malformed dictionary	No description.
action string	Action. Choices: "allow" "block"
log string	Enable/disable logging. Choices: "disable" "enable"
severity string	Severity. Choices: "low" "medium" "high"
status string	Enable/disable the constraint. Choices: "disable" "enable"
max-cookie dictionary	Deprecated, please rename it to max_cookie.
action string	Action. Choices: "allow" "block"
log string	Enable/disable logging. Choices: "disable" "enable"
max-cookie integer	Deprecated, please rename it to max_cookie. Maximum number of cookies in HTTP request
severity string	Severity. Choices: "low" "medium" "high"
status string	Enable/disable the constraint. Choices: "disable" "enable"
max-header-line dictionary	Deprecated, please rename it to max_header_line.
action string	Action. Choices: "allow" "block"
log string	Enable/disable logging. Choices: "disable" "enable"
max-header-line integer	Deprecated, please rename it to max_header_line. Maximum number HTTP header lines
severity string	Severity. Choices: "low" "medium" "high"
status string	Enable/disable the constraint. Choices: "disable" "enable"
max-range-segment dictionary	Deprecated, please rename it to max_range_segment.
action string	Action. Choices: "allow" "block"
log string	Enable/disable logging. Choices: "disable" "enable"
max-range-segment integer	Deprecated, please rename it to max_range_segment. Maximum number of range segments in HTTP range line
severity string	Severity. Choices: "low" "medium" "high"
status string	Enable/disable the constraint. Choices: "disable" "enable"
max-url-param dictionary	Deprecated, please rename it to max_url_param.
action string	Action. Choices: "allow" "block"
log string	Enable/disable logging. Choices: "disable" "enable"
max-url-param integer	Deprecated, please rename it to max_url_param. Maximum number of parameters in URL
severity string	Severity. Choices: "low" "medium" "high"
status string	Enable/disable the constraint. Choices: "disable" "enable"
method dictionary	No description.
action string	Action. Choices: "allow" "block"
log string	Enable/disable logging. Choices: "disable" "enable"
severity string	Severity. Choices: "low" "medium" "high"
status string	Enable/disable the constraint. Choices: "disable" "enable"
param-length dictionary	Deprecated, please rename it to param_length.
action string	Action. Choices: "allow" "block"
length integer	Maximum length of parameter in URL, HTTP POST request or HTTP body in bytes
log string	Enable/disable logging. Choices: "disable" "enable"
severity string	Severity. Choices: "low" "medium" "high"
status string	Enable/disable the constraint. Choices: "disable" "enable"
url-param-length dictionary	Deprecated, please rename it to url_param_length.
action string	Action. Choices: "allow" "block"
length integer	Maximum length of URL parameter in bytes
log string	Enable/disable logging. Choices: "disable" "enable"
severity string	Severity. Choices: "low" "medium" "high"
status string	Enable/disable the constraint. Choices: "disable" "enable"
version dictionary	No description.
action string	Action. Choices: "allow" "block"
log string	Enable/disable logging. Choices: "disable" "enable"
severity string	Severity. Choices: "low" "medium" "high"
status string	Enable/disable the constraint. Choices: "disable" "enable"
extended-log string	Deprecated, please rename it to extended_log. Enable/disable extended logging. Choices: "disable" "enable"
external string	Disable/Enable external HTTP Inspection. Choices: "disable" "enable"
method dictionary	No description.
default-allowed-methods list / elements=string	Deprecated, please rename it to default_allowed_methods. Methods. Choices: "delete" "get" "head" "options" "post" "put" "trace" "others" "connect"
log string	Enable/disable logging. Choices: "disable" "enable"
method-policy list / elements=dictionary	Deprecated, please rename it to method_policy. Method-Policy.
address string	Host address.
allowed-methods list / elements=string	Deprecated, please rename it to allowed_methods. Allowed Methods. Choices: "delete" "get" "head" "options" "post" "put" "trace" "others" "connect"
id integer	HTTP method policy ID.
pattern string	URL pattern.
regex string	Enable/disable regular expression based pattern match. Choices: "disable" "enable"
severity string	Severity. Choices: "low" "medium" "high"
status string	Status. Choices: "disable" "enable"
name string / required	WAF Profile name.
signature dictionary	No description.
credit-card-detection-threshold integer	Deprecated, please rename it to credit_card_detection_threshold. The minimum number of Credit cards to detect viol…
custom-signature list / elements=dictionary	Deprecated, please rename it to custom_signature. Custom-Signature.
action string	Action. Choices: "allow" "block" "erase"
case-sensitivity string	Deprecated, please rename it to case_sensitivity. Case sensitivity in pattern. Choices: "disable" "enable"
direction string	Traffic direction. Choices: "request" "response"
log string	Enable/disable logging. Choices: "disable" "enable"
name string	Signature name.
pattern string	Match pattern.
severity string	Severity. Choices: "low" "medium" "high"
status string	Status. Choices: "disable" "enable"
target list / elements=string	Match HTTP target. Choices: "arg" "arg-name" "req-body" "req-cookie" "req-cookie-name" "req-filename" "req-header" "req-header-name" "req-raw-uri" "req-uri" "resp-body" "resp-hdr" "resp-status"
disabled-signature any	(list or str) Deprecated, please rename it to disabled_signature. Disabled signatures
disabled-sub-class any	(list or str) Deprecated, please rename it to disabled_sub_class. Disabled signature subclasses.
main-class dictionary	Deprecated, please rename it to main_class.
action string	Action. Choices: "allow" "block" "erase"
id integer	Main signature class ID.
log string	Enable/disable logging. Choices: "disable" "enable"
severity string	Severity. Choices: "low" "medium" "high"
status string	Status. Choices: "disable" "enable"
url-access list / elements=dictionary	Deprecated, please rename it to url_access. Url-Access.
access-pattern list / elements=dictionary	Deprecated, please rename it to access_pattern. Access-Pattern.
id integer	URL access pattern ID.
negate string	Enable/disable match negation. Choices: "disable" "enable"
pattern string	URL pattern.
regex string	Enable/disable regular expression based pattern match. Choices: "disable" "enable"
srcaddr string	Source address.
action string	Action. Choices: "bypass" "permit" "block"
address string	Host address.
id integer	URL access ID.
log string	Enable/disable logging. Choices: "disable" "enable"
severity string	Severity. Choices: "low" "medium" "high"
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: 300

Notes

Note

• Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

• Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

• To create or update an object, use state present directive.

• To delete an object, use state absent directive.

• Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Web application firewall configuration.
      fortinet.fortimanager.fmgr_waf_profile:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        waf_profile:
          comment: <string>
          extended_log: <value in [disable, enable]>
          external: <value in [disable, enable]>
          name: <string>
          url_access:
            -
              access_pattern:
                -
                  id: <integer>
                  negate: <value in [disable, enable]>
                  pattern: <string>
                  regex: <value in [disable, enable]>
                  srcaddr: <string>
              action: <value in [bypass, permit, block]>
              address: <string>
              id: <integer>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
          address_list:
            blocked_address: <list or string>
            blocked_log: <value in [disable, enable]>
            severity: <value in [low, medium, high]>
            status: <value in [disable, enable]>
            trusted_address: <list or string>
          constraint:
            content_length:
              action: <value in [allow, block]>
              length: <integer>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
            exception:
              -
                address: <string>
                content_length: <value in [disable, enable]>
                header_length: <value in [disable, enable]>
                hostname: <value in [disable, enable]>
                id: <integer>
                line_length: <value in [disable, enable]>
                malformed: <value in [disable, enable]>
                max_cookie: <value in [disable, enable]>
                max_header_line: <value in [disable, enable]>
                max_range_segment: <value in [disable, enable]>
                max_url_param: <value in [disable, enable]>
                method: <value in [disable, enable]>
                param_length: <value in [disable, enable]>
                pattern: <string>
                regex: <value in [disable, enable]>
                url_param_length: <value in [disable, enable]>
                version: <value in [disable, enable]>
            header_length:
              action: <value in [allow, block]>
              length: <integer>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
            hostname:
              action: <value in [allow, block]>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
            line_length:
              action: <value in [allow, block]>
              length: <integer>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
            malformed:
              action: <value in [allow, block]>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
            max_cookie:
              action: <value in [allow, block]>
              log: <value in [disable, enable]>
              max_cookie: <integer>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
            max_header_line:
              action: <value in [allow, block]>
              log: <value in [disable, enable]>
              max_header_line: <integer>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
            max_range_segment:
              action: <value in [allow, block]>
              log: <value in [disable, enable]>
              max_range_segment: <integer>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
            max_url_param:
              action: <value in [allow, block]>
              log: <value in [disable, enable]>
              max_url_param: <integer>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
            method:
              action: <value in [allow, block]>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
            param_length:
              action: <value in [allow, block]>
              length: <integer>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
            url_param_length:
              action: <value in [allow, block]>
              length: <integer>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
            version:
              action: <value in [allow, block]>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
          method:
            default_allowed_methods:
              - delete
              - get
              - head
              - options
              - post
              - put
              - trace
              - others
              - connect
            log: <value in [disable, enable]>
            method_policy:
              -
                address: <string>
                allowed_methods:
                  - delete
                  - get
                  - head
                  - options
                  - post
                  - put
                  - trace
                  - others
                  - connect
                id: <integer>
                pattern: <string>
                regex: <value in [disable, enable]>
            severity: <value in [low, medium, high]>
            status: <value in [disable, enable]>
          signature:
            credit_card_detection_threshold: <integer>
            custom_signature:
              -
                action: <value in [allow, block, erase]>
                case_sensitivity: <value in [disable, enable]>
                direction: <value in [request, response]>
                log: <value in [disable, enable]>
                name: <string>
                pattern: <string>
                severity: <value in [low, medium, high]>
                status: <value in [disable, enable]>
                target:
                  - arg
                  - arg-name
                  - req-body
                  - req-cookie
                  - req-cookie-name
                  - req-filename
                  - req-header
                  - req-header-name
                  - req-raw-uri
                  - req-uri
                  - resp-body
                  - resp-hdr
                  - resp-status
            disabled_signature: <list or string>
            disabled_sub_class: <list or string>
            main_class:
              action: <value in [allow, block, erase]>
              id: <integer>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: "/sys/login/user"
response_code integer	The status of api request. Returned: always Sample: 0
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: "OK."
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: 0
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)