fortinet.fortimanager.fmgr_pkg_firewall_dospolicy module – Configure IPv4 DoS policies.
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
.
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 |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The parameter (pkg) in requested url. |
|
The top level parameters set. |
|
Anomaly. |
|
Action taken when the threshold is reached. Choices:
|
|
Enable/disable logging for this anomaly. Choices:
|
|
Anomaly name. |
|
Quarantine method. Choices:
|
|
Deprecated, please rename it to quarantine_expiry. Duration of quarantine, from 1 minute to 364 days, 23 hours, an… |
|
Deprecated, please rename it to quarantine_log. Enable/disable quarantine logging. Choices:
|
|
Enable/disable the active status of this anomaly sensor. Choices:
|
|
Deprecated, please rename it to synproxy_tcp_mss. Determine TCP maximum segment size Choices:
|
|
Deprecated, please rename it to synproxy_tcp_sack. Enable/disable TCP selective acknowledage Choices:
|
|
Deprecated, please rename it to synproxy_tcp_timestamp. Enable/disable TCP timestamp option for packets replied by… Choices:
|
|
Deprecated, please rename it to synproxy_tcp_window. Determine TCP Window size for packets replied by syn proxy mo… Choices:
|
|
Deprecated, please rename it to synproxy_tcp_windowscale. Determine TCP window scale option value for packets repl… Choices:
|
|
Deprecated, please rename it to synproxy_tos. Determine TCP differentiated services code point value Choices:
|
|
Deprecated, please rename it to synproxy_ttl. Determine Time to live Choices:
|
|
Determine TCP maximum segment size Choices:
|
|
Enable/disable TCP selective acknowledage Choices:
|
|
Enable/disable TCP timestamp option for packets replied by syn proxy module. Choices:
|
|
Determine TCP Window size for packets replied by syn proxy module. Choices:
|
|
Determine TCP window scale option value for packets replied by syn proxy module. Choices:
|
|
Determine TCP differentiated services code point value Choices:
|
|
Determine Time to live Choices:
|
|
Number of detected instances per minute which triggers action |
|
Deprecated, please rename it to threshold_default). Threshold |
|
Comment. |
|
(list or str) Destination address name from available addresses. |
|
Incoming interface name from available interfaces. |
|
Policy name. |
|
Policy ID. |
|
(list or str) Service object from available options. |
|
(list or str) Source address name from available addresses. |
|
Enable/disable this policy. Choices:
|
|
Universally Unique Identifier |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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: Configure IPv4 DoS policies.
fortinet.fortimanager.fmgr_pkg_firewall_dospolicy:
bypass_validation: false
adom: ansible
pkg: ansible # package name
state: present
pkg_firewall_dospolicy:
comments: "ansible-comment1"
interface: "sslvpn_tun_intf"
policyid: 1
status: enable
- 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 IPv4 DoS policies
fortinet.fortimanager.fmgr_fact:
facts:
selector: "pkg_firewall_dospolicy"
params:
adom: "ansible"
pkg: "ansible" # package name
DoS-policy: "your_value"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |