ansible.builtin.fortios_firewall_DoS_policy (v2.8.20) — module

Configure IPv4 DoS policies in Fortinet's FortiOS and FortiGate.

| "added in version" 2.8 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure IPv4 DoS policies.
    fortios_firewall_DoS_policy:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      firewall_DoS_policy:
        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.address.name firewall.addrgrp.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.address.name firewall.addrgrp.name)"
        status: "enable"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

vdom:
    default: root
    description:
    - 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.

https:
    default: false
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

firewall_DoS_policy:
    default: null
    description:
    - Configure IPv4 DoS policies.
    suboptions:
      anomaly:
        description:
        - Anomaly name.
        suboptions:
          action:
            choices:
            - pass
            - block
            description:
            - Action taken when the threshold is reached.
          log:
            choices:
            - enable
            - disable
            description:
            - Enable/disable anomaly logging.
          name:
            description:
            - Anomaly name.
            required: true
          quarantine:
            choices:
            - none
            - attacker
            description:
            - Quarantine method.
          quarantine-expiry:
            description:
            - Duration of quarantine. (Format
          quarantine-log:
            choices:
            - disable
            - enable
            description:
            - Enable/disable quarantine logging.
          status:
            choices:
            - disable
            - enable
            description:
            - Enable/disable this anomaly.
          threshold:
            description:
            - Anomaly threshold. Number of detected instances per minute that triggers
              the anomaly action.
          threshold(default):
            description:
            - 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:
        description:
        - Comment.
      dstaddr:
        description:
        - Destination address name from available addresses.
        suboptions:
          name:
            description:
            - Address name. Source firewall.address.name firewall.addrgrp.name.
            required: true
      interface:
        description:
        - Incoming interface name from available interfaces. Source system.zone.name system.interface.name.
      policyid:
        description:
        - Policy ID.
        required: true
      service:
        description:
        - Service object from available options.
        suboptions:
          name:
            description:
            - Service name. Source firewall.service.custom.name firewall.service.group.name.
            required: true
      srcaddr:
        description:
        - Source address name from available addresses.
        suboptions:
          name:
            description:
            - Service name. Source firewall.address.name firewall.addrgrp.name.
            required: true
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable this policy.

Outputs

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