fortinet.fortimanager.fmgr_system_alertevent 模块 – 警报事件。

注意

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

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

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

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

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 代码列表。
state 字符串 / 必需	创建、更新或删除对象的指令。 选项 "present" "absent"
system_alertevent 字典	设置的顶级参数。
alert_destination 别名：alert-destination 列表 / 元素=字典	警报目标。
from 字符串	在警报电子邮件中使用的发件人电子邮件地址。
smtp_name 别名：smtp-name 字符串	SMTP 服务器名称。
snmp_name 别名：snmp-name 字符串	SNMP 陷阱名称。
syslog_name 别名：syslog-name 字符串	Syslog 服务器名称。
to 字符串	在警报电子邮件中使用的收件人电子邮件地址。
type 字符串	目标类型。 mail - 发送电子邮件警报。 snmp - 发送 SNMP 陷阱。 syslog - 发送 syslog 消息。 选项 "mail" "snmp" "syslog"
enable_generic_text 别名：enable-generic-text 列表 / 元素=字符串	启用/禁用通用文本匹配。 enable - 启用设置。 disable - 禁用设置。 选项 "enable" "disable"
enable_severity_filter 别名：enable-severity-filter 列表 / 元素=字符串	启用/禁用警报严重性筛选。 enable - 启用设置。 disable - 禁用设置。 选项 "enable" "disable"
event_time_period 别名：event-time-period 字符串	时间段 1 - 1 小时。 3 - 3 小时。 6 - 6 小时。 12 - 12 小时。 24 - 1 天。 72 - 3 天。 168 - 1 周。 选项 "0.5" "1" "3" "6" "12" "24" "72" "168"
generic_text 别名：generic-text 字符串	日志中必须包含的文本才能触发警报。
name 字符串 / 必需	警报名称。
num_events 别名：num-events 字符串	时间段内所需的最小事件数。 1 - 1 个事件。 5 - 5 个事件。 10 - 10 个事件。 50 - 50 个事件。 100 - 100 个事件。 选项 "1" "5" "10" "50" "100"
severity_filter 别名：severity-filter 字符串	触发警报所需的日志严重性。 high - 高级别警报。 medium-high - 中高级别警报。 medium - 中级别警报。 medium-low - 中低级别警报。 low - 低级别警报。 选项 "high" "medium-high" "medium" "medium-low" "low"
severity_level_comp 别名：severity-level-comp 列表 / 元素=字符串	日志严重性阈值比较标准。 选项 ">=" "=" "<="
severity_level_logs 别名：severity-level-logs 列表 / 元素=字符串	日志严重性阈值级别。 no-check - 不检查此日志类型的严重性级别。 information - 信息级别。 notify - 通知级别。 warning - 警告级别。 error - 错误级别。 critical - 严重级别。 alert - 警报级别。 emergency - 紧急级别。 选项 "no-check" "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 有助于完成此工作。

• 要创建或更新对象，请使用 state present 指令。

• 要删除对象，请使用 state absent 指令。

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

示例

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Alert events.
      fortinet.fortimanager.fmgr_system_alertevent:
        bypass_validation: false
        state: present
        system_alertevent:
          enable-generic-text:
            - enable
            - disable
          enable-severity-filter:
            - enable
            - disable
          event-time-period: 1 # <value in [0.5, 1, 3, ...]>
          name: ansible-test-sysalert
          num-events: 1 # <value in [1, 5, 10, ...]>
          severity-filter: high # <value in [high, medium-high, medium, ...]>
          # severity-level-comp:
          #  - <=
          severity-level-logs:
            - no-check
            - information
            - notify
            - warning
            - error
            - critical
            - alert
            - emergency

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the alert events
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_alertevent"
          params:
            alert-event: "your_value"

返回值

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

键	描述
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)

资源链接

• 问题追踪器
• 主页
• 代码库 (源代码)