fmgr_firewall_mmsprofile_flood – Flood configuration.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
6.2.1 |
6.2.3 |
6.2.5 |
|
| firewall_mmsprofile_flood | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- adom - The parameter in requested url type: str required: true
- mms-profile - The parameter in requested url type: str required: true
- firewall_mmsprofile_flood - no description type: dict
- action1 - No description for the parameter type: array choices: [log, archive, intercept, block, archive-first, alert-notif] more...
- action2 - No description for the parameter type: array choices: [log, archive, intercept, block, archive-first, alert-notif] more...
- action3 - No description for the parameter type: array choices: [log, archive, intercept, block, archive-first, alert-notif] more...
- block-time1 - Duration for which action takes effect (0 - 35791 min). type: int more...
- block-time2 - Duration for which action takes effect (0 - 35791 min). type: int more...
- block-time3 - Duration action takes effect (0 - 35791 min). type: int more...
- limit1 - Maximum number of messages allowed. type: int more...
- limit2 - Maximum number of messages allowed. type: int more...
- limit3 - Maximum number of messages allowed. type: int more...
- protocol - Protocol. type: str more...
- status1 - Enable/disable status1 detection. type: str choices: [disable, enable] more...
- status2 - Enable/disable status2 detection. type: str choices: [disable, enable] more...
- status3 - Enable/disable status3 detection. type: str choices: [disable, enable] more...
- window1 - Window to count messages over (1 - 2880 min). type: int more...
- window2 - Window to count messages over (1 - 2880 min). type: int more...
- window3 - Window to count messages over (1 - 2880 min). type: int more...
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: no description
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict