fortios_firewall_dos_policy – Configure IPv4 DoS policies in Fortinet’s FortiOS and FortiGate.¶
New in version 2.0.0.
Synopsis¶
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and dos_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
v7.2.4 |
v7.4.0 |
|
fortios_firewall_dos_policy | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- firewall_dos_policy - Configure IPv4 DoS policies. type: dict more...
- anomaly - Anomaly name. type: list member_path: anomaly:name more...
- action - Action taken when the threshold is reached. type: str choices: pass, block, proxy more...
- log - Enable/disable anomaly logging. type: str choices: enable, disable more...
- name - Anomaly name. type: str required: true more...
- quarantine - Quarantine method. type: str choices: none, attacker more...
- quarantine_expiry - Duration of quarantine. (Format type: str more...
- quarantine_log - Enable/disable quarantine logging. type: str choices: disable, enable more...
- status - Enable/disable this anomaly. type: str choices: disable, enable more...
- threshold - Anomaly threshold. Number of detected instances (packets per second or concurrent session number) that triggers the anomaly action. type: int more...
- threshold_default - Number of detected instances per minute which triggers action (1 - 2147483647). Note that each anomaly has a different threshold value assigned to it. type: int more...
- comments - Comment. type: str more...
- dstaddr - Destination address name from available addresses. type: list member_path: dstaddr:name more...
- name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...
- interface - Incoming interface name from available interfaces. Source system.zone.name system.interface.name. type: str more...
- name - Policy name. type: str more...
- policyid - Policy ID. type: int required: true more...
- service - Service object from available options. type: list member_path: service:name more...
- name - Service name. Source firewall.service.custom.name firewall.service.group.name. type: str required: true more...
- srcaddr - Source address name from available addresses. type: list member_path: srcaddr:name more...
- name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true more...
- status - Enable/disable this policy. type: str choices: enable, disable more...
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 DoS policies.
fortios_firewall_dos_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_dos_policy:
anomaly:
-
action: "pass"
log: "enable"
name: "default_name_6"
quarantine: "none"
quarantine_expiry: "<your_own_value>"
quarantine_log: "disable"
status: "disable"
threshold: "0"
threshold_default: "0"
comments: "<your_own_value>"
dstaddr:
-
name: "default_name_15 (source firewall.address.name firewall.addrgrp.name)"
interface: "<your_own_value> (source system.zone.name system.interface.name)"
name: "default_name_17"
policyid: "0"
service:
-
name: "default_name_20 (source firewall.service.custom.name firewall.service.group.name)"
srcaddr:
-
name: "default_name_22 (source firewall.address.name firewall.addrgrp.name)"
status: "enable"
Return Values¶
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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3