fmgr_system_log_ratelimit – Logging rate limit.¶
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
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
- system_log_ratelimit - no description type: dict
- device - Device. type: array
more...
- device - Device(s) filter according to filter-type setting, wildcard expression supported. type: str more...
- filter-type - Device filter type. type: str choices: [devid] default: devid more...
- id - Device filter ID. type: int default: 0 more...
- ratelimit - Maximum device log rate limit. type: int default: 0 more...
- device-ratelimit-default - Default maximum device log rate limit. type: int default: 0 more...
- mode - Logging rate limit mode. type: str choices: [disable, manual] default: disable more...
- system-ratelimit - Maximum system log rate limit. type: int default: 0 more...
- ratelimits - No description for the parameter type: array
more...
- filter - Device or ADOM filter according to filter-type setting, wildcard expression supported. type: str more...
- filter-type - Device filter type. type: str choices: [devid, adom] default: devid more...
- id - Filter ID. type: int default: 0 more...
- ratelimit - Maximum log rate limit. type: int default: 0 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_system_log_ratelimit:
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, ...]
system_log_ratelimit:
device:
-
device: <value of string>
filter-type: <value in [devid]>
id: <value of integer>
ratelimit: <value of integer>
device-ratelimit-default: <value of integer>
mode: <value in [disable, manual]>
system-ratelimit: <value of integer>
ratelimits:
-
filter: <value of string>
filter-type: <value in [devid, adom]>
id: <value of integer>
ratelimit: <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