fortinet.fortimanager.fmgr_system_alertconsole 模块 – 告警控制台。

注意

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

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

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

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

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_alertconsole

字典

设置的顶级参数。

period

字符串

告警控制台保留告警的时间段。

1 - 1 天。

2 - 2 天。

3 - 3 天。

4 - 4 天。

5 - 5 天。

6 - 6 天。

7 - 7 天。

选项

  • "1"

  • "2"

  • "3"

  • "4"

  • "5"

  • "6"

  • "7"

severity_level

别名：severity-level

列表 / 元素=字符串

告警控制台保留此严重级别及以上严重级别的告警。

debug - 调试级别。

information - 信息级别。

notify - 通知级别。

warning - 警告级别。

error - 错误级别。

critical - 严重级别。

alert - 警报级别。

emergency - 紧急级别。

选项

  • "debug"

  • "information"

  • "notify"

  • "warning"

  • "error"

  • "critical"

  • "alert"

  • "emergency"

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: Alert console.
      fortinet.fortimanager.fmgr_system_alertconsole:
        # 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_alertconsole:
          period: <value in [1, 2, 3, ...]>
          severity_level:
            - "debug"
            - "information"
            - "notify"
            - "warning"
            - "error"
            - "critical"
            - "alert"
            - "emergency"

返回值

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

键

描述

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)