fortios_firewall_DoS_policy6 – Configure IPv6 DoS policies in Fortinet’s FortiOS and FortiGate — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# fortios_firewall_DoS_policy6 – Configure IPv6 DoS policies in Fortinet’s FortiOS and FortiGate

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- This module is able to configure a FortiGate or FortiOS by allowing the user to configure firewall feature and DoS_policy6 category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

## Requirements

The below requirements are needed on the host that executes this module.

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
firewall_DoS_policy6 - | Default: null | Configure IPv6 DoS policies.
| anomaly - |  | Anomaly name.
|  | action - | Choices: pass block | Action taken when the threshold is reached.
|  | log - | Choices: enable disable | Enable/disable anomaly logging.
|  | name - / required |  | Anomaly name.
|  | quarantine - | Choices: none attacker | Quarantine method.
|  | quarantine-expiry - |  | Duration of quarantine. (Format
|  | quarantine-log - | Choices: disable enable | Enable/disable quarantine logging.
|  | status - | Choices: disable enable | Enable/disable this anomaly.
|  | threshold - |  | Anomaly threshold. Number of detected instances per minute that triggers the anomaly action.
|  | threshold(default) - |  | Number of detected instances per minute which triggers action (1 - 2147483647, default = 1000). Note that each anomaly has a different threshold value assigned to it.
| comments - |  | Comment.
| dstaddr - |  | Destination address name from available addresses.
|  | name - / required |  | Address name. Source firewall.address6.name firewall.addrgrp6.name.
| interface - |  | Incoming interface name from available interfaces. Source system.zone.name system.interface.name.
| policyid - / required |  | Policy ID.
| service - |  | Service object from available options.
|  | name - / required |  | Service name. Source firewall.service.custom.name firewall.service.group.name.
| srcaddr - |  | Source address name from available addresses.
|  | name - / required |  | Service name. Source firewall.address6.name firewall.addrgrp6.name.
| state - | Choices: present absent | Indicates whether to create or remove the object
| status - | Choices: enable disable | Enable/disable this policy.
host - / required |  | FortiOS or FortiGate ip address.
https boolean | Choices: no ← yes | Indicates if the requests towards FortiGate must use HTTPS protocol
password - | Default: "" | FortiOS or FortiGate password.
username - / required |  | FortiOS or FortiGate username.
vdom - | Default: "root" | 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.

## Notes

Note

- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook

## Examples

    - hosts: localhost
      vars:
       host: "192.168.122.40"
       username: "admin"
       password: ""
       vdom: "root"
      tasks:
      - name: Configure IPv6 DoS policies.
        fortios_firewall_DoS_policy6:
          host:  "{{ host }}"
          username: "{{ username }}"
          password: "{{ password }}"
          vdom:  "{{ vdom }}"
          firewall_DoS_policy6:
            state: "present"
            anomaly:
             -
                action: "pass"
                log: "enable"
                name: "default_name_6"
                quarantine: "none"
                quarantine-expiry: "<your_own_value>"
                quarantine-log: "disable"
                status: "disable"
                threshold: "11"
                threshold(default): "12"
            comments: "<your_own_value>"
            dstaddr:
             -
                name: "default_name_15 (source firewall.address6.name firewall.addrgrp6.name)"
            interface: "<your_own_value> (source system.zone.name system.interface.name)"
            policyid: "17"
            service:
             -
                name: "default_name_19 (source firewall.service.custom.name firewall.service.group.name)"
            srcaddr:
             -
                name: "default_name_21 (source firewall.address6.name firewall.addrgrp6.name)"
            status: "enable"

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
build string | always | Build number of the fortigate image Sample: 1547
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id
name string | always | Name of the table used to fulfill the request Sample: urlfilter
path string | always | Path of the table used to fulfill the request Sample: webfilter
revision string | always | Internal revision number Sample: 17.0.2.10658
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352
status string | always | Indication of the operation's result Sample: success
vdom string | always | Virtual domain used Sample: root
version string | always | Version of the FortiGate Sample: v5.6.3

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation you can edit this document to improve it.