Docs4dev
Docs
ansible / 2.11 / collections / fortinet / fortimanager / fmgr_firewall_mmsprofile_flood_module.html

fortinet.fortimanager.fmgr_firewall_mmsprofile_flood – Flood configuration.

Note

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

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_mmsprofile_flood.

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
firewall_mmsprofile_flood
dictionary
the top level parameters set
action1
list / elements=string
    Choices:
  • log
  • archive
  • intercept
  • block
  • archive-first
  • alert-notif
no description
action2
list / elements=string
    Choices:
  • log
  • archive
  • intercept
  • block
  • archive-first
  • alert-notif
no description
action3
list / elements=string
    Choices:
  • log
  • archive
  • intercept
  • block
  • archive-first
  • alert-notif
no description
block-time1
integer
Duration for which action takes effect (0 - 35791 min).
block-time2
integer
Duration for which action takes effect (0 - 35791 min).
block-time3
integer
Duration action takes effect (0 - 35791 min).
limit1
integer
Maximum number of messages allowed.
limit2
integer
Maximum number of messages allowed.
limit3
integer
Maximum number of messages allowed.
protocol
string
Protocol.
status1
string
    Choices:
  • disable
  • enable
Enable/disable status1 detection.
status2
string
    Choices:
  • disable
  • enable
Enable/disable status2 detection.
status3
string
    Choices:
  • disable
  • enable
Enable/disable status3 detection.
window1
integer
Window to count messages over (1 - 2880 min).
window2
integer
Window to count messages over (1 - 2880 min).
window3
integer
Window to count messages over (1 - 2880 min).
mms-profile
string / required
the parameter (mms-profile) in requested url
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
    Choices:
  • present
  • absent
the directive to create, update or delete an object
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
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Flood configuration.
     fmgr_firewall_mmsprofile_flood:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        mms-profile: <your own value>
        firewall_mmsprofile_flood:
           action1:
             - log
             - archive
             - intercept
             - block
             - archive-first
             - alert-notif
           action2:
             - log
             - archive
             - intercept
             - block
             - archive-first
             - alert-notif
           action3:
             - log
             - archive
             - intercept
             - block
             - archive-first
             - alert-notif
           block-time1: <value of integer>
           block-time2: <value of integer>
           block-time3: <value of integer>
           limit1: <value of integer>
           limit2: <value of integer>
           limit3: <value of integer>
           protocol: <value of string>
           status1: <value in [disable, enable]>
           status2: <value in [disable, enable]>
           status3: <value in [disable, enable]>
           window1: <value of integer>
           window2: <value of integer>
           window3: <value of integer>

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_firewall_mmsprofile_flood_module.html