community.zabbix.zabbix_host_events_update 模块 – 更新事件状态。

注意

此模块是 community.zabbix 集合 (版本 3.2.0) 的一部分。

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

要安装它，请使用： ansible-galaxy collection install community.zabbix。您需要满足其他要求才能使用此模块，请参阅 需求 以了解详细信息。

要在剧本中使用它，请指定： community.zabbix.zabbix_host_events_update。

概要

  • 更新事件状态。

需求

执行此模块的主机需要以下需求。

  • python >= 2.6

参数

参数

注释

http_login_password

字符串

基本身份验证密码

http_login_user

字符串

基本身份验证用户名

params

字典 / 必需

用于更新事件的参数。

参数定义在 https://www.zabbix.com/documentation/current/en/manual/api/reference/event/acknowledge

此外，还支持以下参数

action

字符串

用于更新事件的操作

覆盖 API 文档中的“action”

当不使用 *actions* 时必需。

与 *actions* 互斥。

选项

  • "close_problem"

  • "close"

  • "acknowledge_event"

  • "acknowledge"

  • "ack"

  • "add_message"

  • "message"

  • "msg"

  • "change_severity"

  • "severity"

  • "unacknowledge_event"

  • "unacknowledge"

  • "unack"

  • "suppress_event"

  • "suppress"

  • "unsuppress_event"

  • "unsuppress"

  • "change_event_rank_to_cause"

  • "convert_to_cause"

  • "change_event_rank_to_symptom"

  • "convert_to_symptom"

actions

列表 / 元素=字符串

用于更新事件的操作

覆盖 API 文档中的“action”

当不使用 *action* 时必需。

与 *action* 互斥。

选项

  • "close_problem"

  • "close"

  • "acknowledge_event"

  • "acknowledge"

  • "ack"

  • "add_message"

  • "message"

  • "msg"

  • "change_severity"

  • "severity"

  • "unacknowledge_event"

  • "unacknowledge"

  • "unack"

  • "suppress_event"

  • "suppress"

  • "unsuppress_event"

  • "unsuppress"

  • "change_event_rank_to_cause"

  • "convert_to_cause"

  • "change_event_rank_to_symptom"

  • "convert_to_symptom"

msg

字符串

消息文本。

API 文档中“message”的别名

severity

字符串

事件的新严重性。

覆盖 API 文档中的“severity”

选项

  • "not_classified"

  • "information"

  • "warning"

  • "average"

  • "high"

  • "disaster"

示例

# If you want to use Username and Password to be authenticated by Zabbix Server
- name: Set credentials to access Zabbix Server API
  ansible.builtin.set_fact:
    ansible_user: Admin
    ansible_httpapi_pass: zabbix

# If you want to use API token to be authenticated by Zabbix Server
# https://www.zabbix.com/documentation/current/en/manual/web_interface/frontend_sections/administration/general#api-tokens
- name: Set API token
  ansible.builtin.set_fact:
    ansible_zabbix_auth_key: 8ec0d52432c15c91fcafe9888500cf9a607f44091ab554dbee860f6b44fac895

# Acknowledge single event
- name: ack event
  community.zabbix.zabbix_host_events_update:
    params:
      eventids: 12345
      actions: ack

- name: ack and close event with a message
  community.zabbix.zabbix_host_events_update:
    params:
      eventids: [12345, 67890]
      actions: ['ack', 'msg', 'close']
      msg: 'closed by user'

作者

  • Andrew Lathrop (@aplathrop)