fortinet.fortimanager.fmgr_system_log_ioc 模块 – IoC 设置。

注意

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

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

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

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

fortinet.fortimanager 2.0.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_ioc

字典

设置的顶级参数。

notification

字符串

禁用/启用 IoC 通知。

disable - 禁用 IoC 功能。

enable - 启用 IoC 功能。

选择

  • "disable"

  • "enable"

notification_throttle

别名: notification-throttle

整数

用于限制 IoC 通知速率的分钟值。

rescan_max_runner

别名: rescan-max-runner

整数

IoC 重新扫描的最大并发运行器计数。

rescan_run_at

别名: rescan-run-at

整数

何时运行 IoC 重新扫描。

rescan_status

别名: rescan-status

字符串

禁用/启用 IoC 重新扫描。

disable - 禁用 IoC 功能。

enable - 启用 IoC 功能。

选择

  • "disable"

  • "enable"

status

字符串

禁用/启用 IoC 功能。

disable - 禁用 IoC 功能。

enable - 启用 IoC 功能。

选择

  • "disable"

  • "enable"

workspace_locking_adom

字符串

在工作区模式下运行时要锁定的 FortiManager 的 adom，该值可以是 global 和其他包括 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: IoC settings.
      fortinet.fortimanager.fmgr_system_log_ioc:
        # 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_ioc:
          notification: <value in [disable, enable]>
          notification_throttle: <integer>
          rescan_max_runner: <integer>
          rescan_run_at: <integer>
          rescan_status: <value in [disable, enable]>
          status: <value in [disable, enable]>

返回值

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

键

描述

元数据

字典

请求的结果。

返回: 总是

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 版本支持，则发出警告。

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)