- source
fmgr_pkg_firewall_dospolicy_anomaly.py
- orphan
2.0.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name
,var name
,var.name
- New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.0.0 -> latest
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- adom - The parameter in requested url type: str required: true
- pkg - The parameter in requested url type: str required: true
- DoS-policy - The parameter in requested url type: str required: true
- pkg_firewall_dospolicy_anomaly - Anomaly name. type: dict
- action Action taken when the threshold is reached. type: str choices: [pass, block, proxy]
more...
Supported Version Ranges:
v6.0.0 -> latest
- log Enable/disable logging for this anomaly. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- name Anomaly name. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- quarantine Quarantine method. type: str choices: [none, attacker, both, interface]
more...
Supported Version Ranges:
v6.0.0 -> latest
- quarantine_expiry (Alias name: quarantine-expiry) Duration of quarantine, from 1 minute to 364 days, 23 hours, and 59 minutes from now. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- quarantine_log (Alias name: quarantine-log) Enable/disable quarantine logging. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- status Enable/disable the active status of this anomaly sensor. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- threshold Number of detected instances per minute which triggers action (1 - 2147483647, default = 1000). type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- threshold_default) (Alias name: threshold(default)) type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- synproxy_tos Determine tcp differentiated services code point value (type of service). type: str choices: [0, 10, 12, 14, 18, 20, 22, 26, 28, 30, 34, 36, 38, 40, 46, 255]
more...
Supported Version Ranges:
v6.2.5 -> v7.2.0
- synproxy_ttl Determine time to live (ttl) value for packets replied by syn proxy module. type: str choices: [32, 64, 128, 255]
more...
Supported Version Ranges:
v6.2.5 -> v7.2.0
- synproxy_tcp_sack Enable/disable tcp selective acknowledage (sack) for packets replied by syn proxy module. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.5 -> v7.2.0
- synproxy_tcp_window Determine tcp window size for packets replied by syn proxy module. type: str choices: [4096, 8192, 16384, 32768]
more...
Supported Version Ranges:
v6.2.5 -> v7.2.0
- synproxy_tcp_timestamp Enable/disable tcp timestamp option for packets replied by syn proxy module. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.5 -> v7.2.0
- synproxy_tcp_mss Determine tcp maximum segment size (mss) value for packets replied by syn proxy module. type: str choices: [0, 256, 512, 1024, 1300, 1360, 1460, 1500]
more...
Supported Version Ranges:
v6.2.5 -> v7.2.0
- synproxy_tcp_windowscale Determine tcp window scale option value for packets replied by syn proxy module. type: str choices: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14]
more...
Supported Version Ranges:
v6.2.5 -> v7.2.0
- synproxy_tos (Alias name: synproxy-tos) Determine tcp differentiated services code point value (type of service). type: str choices: [0, 10, 12, 14, 18, 20, 22, 26, 28, 30, 34, 36, 38, 40, 46, 255]
more...
Supported Version Ranges:
v6.2.6 -> v6.2.12
,v6.4.2 -> v7.2.0
- synproxy_tcp_window (Alias name: synproxy-tcp-window) Determine tcp window size for packets replied by syn proxy module. type: str choices: [4096, 8192, 16384, 32768]
more...
Supported Version Ranges:
v6.2.6 -> v6.2.12
,v6.4.2 -> v7.2.0
- synproxy_tcp_windowscale (Alias name: synproxy-tcp-windowscale) Determine tcp window scale option value for packets replied by syn proxy module. type: str choices: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14]
more...
Supported Version Ranges:
v6.2.6 -> v6.2.12
,v6.4.2 -> v7.2.0
- synproxy_tcp_timestamp (Alias name: synproxy-tcp-timestamp) Enable/disable tcp timestamp option for packets replied by syn proxy module. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.6 -> v6.2.12
,v6.4.2 -> v7.2.0
- synproxy_ttl (Alias name: synproxy-ttl) Determine time to live (ttl) value for packets replied by syn proxy module. type: str choices: [32, 64, 128, 255]
more...
Supported Version Ranges:
v6.2.6 -> v6.2.12
,v6.4.2 -> v7.2.0
- synproxy_tcp_mss (Alias name: synproxy-tcp-mss) Determine tcp maximum segment size (mss) value for packets replied by syn proxy module. type: str choices: [0, 256, 512, 1024, 1300, 1360, 1460, 1500]
more...
Supported Version Ranges:
v6.2.6 -> v6.2.12
,v6.4.2 -> v7.2.0
- synproxy_tcp_sack (Alias name: synproxy-tcp-sack) Enable/disable tcp selective acknowledage (sack) for packets replied by syn proxy module. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.6 -> v6.2.12
,v6.4.2 -> v7.2.0
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
- 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"
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)