fortinet.fortimanager.fmgr_pkg_firewall_dospolicy_anomaly module – Anomaly name.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.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_pkg_firewall_dospolicy_anomaly.

New in fortinet.fortimanager 2.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

DoS-policy

string

Deprecated, please use “DoS_policy”

DoS_policy

string

The parameter (DoS-policy) in requested url.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

pkg

string / required

The parameter (pkg) in requested url.

pkg_firewall_dospolicy_anomaly

dictionary

The top level parameters set.

action

string

Action taken when the threshold is reached.

Choices:

  • "pass"

  • "block"

  • "proxy"

log

string

Enable/disable logging for this anomaly.

Choices:

  • "disable"

  • "enable"

name

string / required

Anomaly name.

quarantine

string

Quarantine method.

Choices:

  • "none"

  • "attacker"

  • "both"

  • "interface"

quarantine-expiry

string

Deprecated, please rename it to quarantine_expiry. Duration of quarantine, from 1 minute to 364 days, 23 hours, and 59 min…

quarantine-log

string

Deprecated, please rename it to quarantine_log. Enable/disable quarantine logging.

Choices:

  • "disable"

  • "enable"

status

string

Enable/disable the active status of this anomaly sensor.

Choices:

  • "disable"

  • "enable"

synproxy-tcp-mss

string

Deprecated, please rename it to synproxy_tcp_mss. Determine TCP maximum segment size

Choices:

  • "0"

  • "256"

  • "512"

  • "1024"

  • "1300"

  • "1360"

  • "1460"

  • "1500"

synproxy-tcp-sack

string

Deprecated, please rename it to synproxy_tcp_sack. Enable/disable TCP selective acknowledage

Choices:

  • "disable"

  • "enable"

synproxy-tcp-timestamp

string

Deprecated, please rename it to synproxy_tcp_timestamp. Enable/disable TCP timestamp option for packets replied by syn pro…

Choices:

  • "disable"

  • "enable"

synproxy-tcp-window

string

Deprecated, please rename it to synproxy_tcp_window. Determine TCP Window size for packets replied by syn proxy module.

Choices:

  • "4096"

  • "8192"

  • "16384"

  • "32768"

synproxy-tcp-windowscale

string

Deprecated, please rename it to synproxy_tcp_windowscale. Determine TCP window scale option value for packets replied by s…

Choices:

  • "0"

  • "1"

  • "2"

  • "3"

  • "4"

  • "5"

  • "6"

  • "7"

  • "8"

  • "9"

  • "10"

  • "11"

  • "12"

  • "13"

  • "14"

synproxy-tos

string

Deprecated, please rename it to synproxy_tos. Determine TCP differentiated services code point value

Choices:

  • "0"

  • "10"

  • "12"

  • "14"

  • "18"

  • "20"

  • "22"

  • "26"

  • "28"

  • "30"

  • "34"

  • "36"

  • "38"

  • "40"

  • "46"

  • "255"

synproxy-ttl

string

Deprecated, please rename it to synproxy_ttl. Determine Time to live

Choices:

  • "32"

  • "64"

  • "128"

  • "255"

synproxy_tcp_mss

string

Determine TCP maximum segment size

Choices:

  • "0"

  • "256"

  • "512"

  • "1024"

  • "1300"

  • "1360"

  • "1460"

  • "1500"

synproxy_tcp_sack

string

Enable/disable TCP selective acknowledage

Choices:

  • "disable"

  • "enable"

synproxy_tcp_timestamp

string

Enable/disable TCP timestamp option for packets replied by syn proxy module.

Choices:

  • "disable"

  • "enable"

synproxy_tcp_window

string

Determine TCP Window size for packets replied by syn proxy module.

Choices:

  • "4096"

  • "8192"

  • "16384"

  • "32768"

synproxy_tcp_windowscale

string

Determine TCP window scale option value for packets replied by syn proxy module.

Choices:

  • "0"

  • "1"

  • "2"

  • "3"

  • "4"

  • "5"

  • "6"

  • "7"

  • "8"

  • "9"

  • "10"

  • "11"

  • "12"

  • "13"

  • "14"

synproxy_tos

string

Determine TCP differentiated services code point value

Choices:

  • "0"

  • "10"

  • "12"

  • "14"

  • "18"

  • "20"

  • "22"

  • "26"

  • "28"

  • "30"

  • "34"

  • "36"

  • "38"

  • "40"

  • "46"

  • "255"

synproxy_ttl

string

Determine Time to live

Choices:

  • "32"

  • "64"

  • "128"

  • "255"

threshold

integer

Number of detected instances per minute which triggers action

threshold(default)

integer

Deprecated, please rename it to threshold_default). Threshold

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"

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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Anomaly name.
      fortinet.fortimanager.fmgr_pkg_firewall_dospolicy_anomaly:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        DoS-policy: 1 # policyid
        state: present
        pkg_firewall_dospolicy_anomaly:
          action: pass # <value in [pass, block, proxy]>
          log: enable
          name: ansible-test-anomaly
          quarantine: none # <value in [none, attacker, both, ...]>
          status: disable

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the anomaly names of IPv4 DoS policy
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_dospolicy_anomaly"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            DoS-policy: "1" # policyid
            anomaly: "your_value"

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)