fortinet.fortimanager.fmgr_waf_profile_signature – WAF signatures.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

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

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

New in version 2.10: of fortinet.fortimanager

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			Choices/Defaults	Comments
adom string / required				the parameter (adom) in requested url
bypass_validation boolean			Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
profile string / required				the parameter (profile) in requested url
rc_failed list / elements=string				the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string				the rc codes list with which the conditions to succeed will be overriden
state string / required			Choices: present absent	the directive to create, update or delete an object
waf_profile_signature dictionary				the top level parameters set
	credit-card-detection-threshold integer			The minimum number of Credit cards to detect violation.
	custom-signature list / elements=string			no description
		action string	Choices: allow block erase	Action.
		case-sensitivity string	Choices: disable enable	Case sensitivity in pattern.
		direction string	Choices: request response	Traffic direction.
		log string	Choices: disable enable	Enable/disable logging.
		name string		Signature name.
		pattern string		Match pattern.
		severity string	Choices: low medium high	Severity.
		status string	Choices: disable enable	Status.
		target list / elements=string	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	no description
	disabled-signature string			Disabled signatures
	disabled-sub-class string			Disabled signature subclasses.
	main-class dictionary			no description
		action string	Choices: allow block erase	Action.
		id integer		Main signature class ID.
		log string	Choices: disable enable	Enable/disable logging.
		severity string	Choices: low medium high	Severity.
		status string	Choices: disable enable	Status.
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			Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

• 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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: WAF signatures.
     fmgr_waf_profile_signature:
        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>
        profile: <your own value>
        waf_profile_signature:
           credit-card-detection-threshold: <value of 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: <value of string>
                 pattern: <value of 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: <value of string>
           disabled-sub-class: <value of string>
           main-class:
              action: <value in [allow, block, erase]>
              id: <value of 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	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)