faz_cli_system_log_ratelimit – Logging rate limit.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiAnalyzer 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

FortiAnalyzer Version Compatibility


7.0.0 7.2.0
cli_system_log_ratelimit yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: 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 FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
  • 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
  • cli_system_log_ratelimit - Logging rate limit. type: dict
    • device - No description for the parameter 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

  • 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

- collections:
  - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer-inventory
  tasks:
  - faz_cli_system_log_ratelimit:
      cli_system_log_ratelimit:
        device:
        - device: port4
          filter-type: devid
          id: 1
          ratelimit: 5
        device-ratelimit-default: 0
        mode: disable
        system-ratelimit: 0
    name: Logging rate limit.
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.