fortinet.fortimanager.fmgr_system_log_ratelimit 模块 – 日志速率限制。

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。

要在剧本中使用它，请指定： fortinet.fortimanager.fmgr_system_log_ratelimit。

fortinet.fortimanager 2.1.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包含所有需要在使用前根据数据源调整的参数和值。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而无需验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务的日志记录。

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 FortiCloud API 访问令牌对 Ansible 客户端进行身份验证。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

system_log_ratelimit

字典

设置的顶级参数。

device

列表 / 元素=字典

设备。

device

字符串

设备

filter_type

别名：filter-type

字符串

设备过滤器类型。

devid - 设备 ID。

选项

  • "devid"

id

整数

设备过滤器 ID。

ratelimit

整数

最大设备日志速率限制。

device_ratelimit_default

别名：device-ratelimit-default

整数

默认最大设备日志速率限制。

mode

字符串

日志速率限制模式。

disable - 日志速率限制功能已禁用。

manual - 系统速率限制和设备速率限制均可配置，如果未配置则无限制。

选项

  • "disable"

  • "manual"

ratelimits

列表 / 元素=字典

速率限制。

filter

字符串

根据 filter-type 设置的设备或 ADOM 过滤器，支持通配符表达式。

filter_type

别名：filter-type

字符串

设备过滤器类型。

devid - 设备 ID。

adom - ADOM 名称。

选项

  • "devid"

  • "adom"

id

整数

过滤器 ID。

ratelimit

整数

最大日志速率限制。

system_ratelimit

别名：system-ratelimit

整数

最大系统日志速率限制。

workspace_locking_adom

字符串

在工作区模式下运行 FortiManager 的 ADOM 锁定，该值可以是全局的和其他值，包括 root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁的最大时间（秒）。

默认值： 300

备注

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶级参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成这项工作。

  • 通常情况下，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件。

示例

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Logging rate limit.
      fortinet.fortimanager.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: <string>
              filter_type: <value in [devid]>
              id: <integer>
              ratelimit: <integer>
          device_ratelimit_default: <integer>
          mode: <value in [disable, manual]>
          system_ratelimit: <integer>
          ratelimits:
            -
              filter: <string>
              filter_type: <value in [devid, adom]>
              id: <integer>
              ratelimit: <integer>

返回值

常用的返回值已在 此处 记录，以下是此模块特有的字段

键

描述

meta

字典

请求的结果。

返回：始终

request_url

字符串

请求的完整 URL。

返回：始终

示例： "/sys/login/user"

response_code

整数

API 请求的状态。

返回：始终

示例： 0

response_data

列表 / 元素=字符串

API 响应。

返回：始终

response_message

字符串

API 响应的描述性消息。

返回：始终

示例： "OK."

system_information

字典

目标系统的信息。

返回：始终

rc

整数

请求的状态。

返回：始终

示例： 0

version_check_warning

列表 / 元素=字符串

如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。

返回：复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑凌 (@chillancezen)

  • 沈方 (@fshen01)

  • 卢洪斌 (@fgtdev-hblu)