fortinet.fortimanager.fmgr_pkg_firewall_dospolicy – Configure IPv4 DoS policies.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

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 version 2.10: of fortinet.fortimanager

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

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

pkg

string / required

the parameter (pkg) in requested url

pkg_firewall_dospolicy

dictionary

the top level parameters set

anomaly

list / elements=string

Anomaly.

action

string

Action taken when the threshold is reached.

Choices:

  • pass

  • block

  • proxy

log

string

Enable/disable logging for this anomaly.

Choices:

  • disable

  • enable

name

string

Anomaly name.

quarantine

string

Quarantine method.

Choices:

  • none

  • attacker

  • both

  • interface

quarantine-expiry

string

Duration of quarantine, from 1 minute to 364 days, 23 hours, and 59 minutes from now. (format: ###d##h##m, default = 5…

quarantine-log

string

Enable/disable quarantine logging.

Choices:

  • disable

  • enable

status

string

Enable/disable the active status of this anomaly sensor.

Choices:

  • disable

  • enable

threshold

integer

Number of detected instances per minute which triggers action (1 - 2147483647, default = 1000). Note that each anomaly…

threshold(default)

integer

Threshold(Default).

comments

string

Comment.

dstaddr

string

Destination address name from available addresses.

interface

string

Incoming interface name from available interfaces.

name

string

Policy name.

policyid

integer

Policy ID.

service

string

Service object from available options.

srcaddr

string

Source address name from available addresses.

status

string

Enable/disable this policy.

Choices:

  • disable

  • enable

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

Notes

Note

  • 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: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the IPv4 DoS policies
     fmgr_fact:
       facts:
           selector: 'pkg_firewall_dospolicy'
           params:
               adom: 'ansible'
               pkg: 'ansible' # package name
               DoS-policy: ''
- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure IPv4 DoS policies.
     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

Return Values

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

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)