fortios_firewall_dos_policy6 – Configure IPv6 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_policy6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
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_policy6 - Configure IPv6 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...
- 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...
- synproxy_tcp_sack - enable/disable TCP selective acknowledage (SACK) for packets replied by syn proxy module. type: str choices: enable, disable more...
- synproxy_tcp_timestamp - enable/disable TCP timestamp option for packets replied by syn proxy module. type: str choices: enable, disable more...
- synproxy_tcp_window - Determine TCP Window size for packets replied by syn proxy module. type: str choices: 4096, 8192, 16384, 32768 more...
- 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...
- 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...
- synproxy_ttl - Determine Time to live (TTL) value for packets replied by syn proxy module. type: str choices: 32, 64, 128, 255 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.address6.name firewall.addrgrp6.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. see Notes. 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.address6.name firewall.addrgrp6.name. type: str required: true more...
- status - Enable/disable this policy. type: str choices: enable, disable more...
Notes
Note
We highly recommend using your own value as the policyid instead of 0, while ‘0’ is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure IPv6 DoS policies.
fortinet.fortios.fortios_firewall_dos_policy6:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_dos_policy6:
anomaly:
-
action: "pass"
log: "enable"
name: "default_name_6"
quarantine: "none"
quarantine_expiry: "<your_own_value>"
quarantine_log: "disable"
status: "disable"
synproxy_tcp_mss: "0"
synproxy_tcp_sack: "enable"
synproxy_tcp_timestamp: "enable"
synproxy_tcp_window: "4096"
synproxy_tcp_windowscale: "0"
synproxy_tos: "0"
synproxy_ttl: "32"
threshold: "0"
threshold_default: "0"
comments: "<your_own_value>"
dstaddr:
-
name: "default_name_22 (source firewall.address6.name firewall.addrgrp6.name)"
interface: "<your_own_value> (source system.zone.name system.interface.name)"
name: "default_name_24"
policyid: "<you_own_value>"
service:
-
name: "default_name_27 (source firewall.service.custom.name firewall.service.group.name)"
srcaddr:
-
name: "default_name_29 (source firewall.address6.name firewall.addrgrp6.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
Status
This module is not guaranteed to have a backwards compatible interface.