community.zabbix.zabbix_triggerprototype 模块 – 创建/删除 Zabbix 触发器原型

注意

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

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

要安装它,请使用: ansible-galaxy collection install community.zabbix。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求

要在 playbook 中使用它,请指定: community.zabbix.zabbix_triggerprototype

概要

  • 如果触发器原型不存在,则创建它们。

  • 如果触发器原型存在,则删除它们。

要求

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

  • python >= 2.6

参数

参数

注释

dependencies

列表 / 元素=字典

此触发器原型依赖的触发器原型的列表

host_name

字符串

包含依赖触发器的宿主机名称。

template_name未被使用时为必填项。

template_name互斥。

name

字符串 / 必填

依赖触发器的名称。

template_name

字符串

包含依赖触发器的模板名称。

host_name未被使用时为必填项。

host_name互斥。

desc

别名:description

字符串

触发器原型的附加描述。

覆盖 API 文档中的“comments”。

host_name

字符串

要添加触发器原型的宿主机名称。

template_name未被使用时为必填项。

template_name互斥。

http_login_password

字符串

基本身份验证密码

http_login_user

字符串

基本身份验证用户名

name

字符串 / 必填

要创建或删除的触发器原型的名称。

覆盖 API 文档中的“description”。

不能更改。如果需要更改触发器原型的名称,则需要将其删除并重新创建。

params

字典

用于创建/更新触发器原型的参数。

如果 state 为“present”,则为必填项。

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

另外支持的参数如下。

correlation_mode

字符串

OK 事件关闭。

覆盖 API 文档中的“correlation_mode”。

选项

  • "all"

  • "tag"

enabled

布尔值

触发器原型的状态。

覆盖 API 文档中的“status”。

选项

  • false

  • true

generate_multiple_events

布尔值

触发器原型是否可以生成多个问题事件。

API 文档中“type”的别名。

选项

  • false

  • true

manual_close

布尔值

允许手动关闭。

覆盖 API 文档中的“manual_close”。

选项

  • false

  • true

recovery_mode

字符串

OK 事件生成模式。

覆盖 API 文档中的“recovery_mode”。

选项

  • "expression"

  • "recovery_expression"

  • "none"

severity

别名:priority

字符串

触发器原型的严重性。

API 文档中“priority”的别名。

选项

  • "not_classified"

  • "information"

  • "warning"

  • "average"

  • "high"

  • "disaster"

status

字符串

触发器原型的状态。

选项

  • "enabled"

  • "disabled"

state

字符串

创建或删除触发器原型。

选项

  • "present" ← (默认)

  • "absent"

template_name

字符串

要添加触发器原型的模板名称。

host_name未被使用时为必填项。

host_name互斥。

示例

# 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

# Create trigger prototype on example_host using example_rule
- name: create trigger prototype
  # set task level variables as we change ansible_connection plugin here
  vars:
    ansible_network_os: community.zabbix.zabbix
    ansible_connection: httpapi
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_zabbix_url_path: 'zabbixeu'  # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_triggerprototype:
    name: '{% raw %}Free disk space is less than 20% on volume {#FSNAME}{% endraw %}'
    host_name: example_host
    params:
      severity: high
      expression: "{% raw %}last(/example_host/vfs.fs.size[{#FSNAME}, pused])>80{% endraw %}"
      recovery_mode: none
      manual_close: True
      enabled: True
    state: present

# Create trigger prototype on example_template using example_rule
- name: create trigger prototype
  # set task level variables as we change ansible_connection plugin here
  vars:
    ansible_network_os: community.zabbix.zabbix
    ansible_connection: httpapi
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_zabbix_url_path: 'zabbixeu'  # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_triggerprototype:
    name: '{% raw %}Free disk space is less than 20% on volume {#FSNAME}{% endraw %}'
    template_name: example_template
    params:
      severity: high
      expression: "{% raw %}last(/example_host/vfs.fs.size[{#FSNAME}, pused])>80{% endraw %}"
      recovery_mode: none
      manual_close: True
      enabled: True
    state: present

# Add tags to the existing Zabbix trigger prototype
- name: update trigger prototype
  # set task level variables as we change ansible_connection plugin here
  vars:
    ansible_network_os: community.zabbix.zabbix
    ansible_connection: httpapi
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_zabbix_url_path: 'zabbixeu'  # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_triggerprototype:
    name: '{% raw %}Free disk space is less than 20% on volume {#FSNAME}{% endraw %}'
    template_name: example_template
    params:
      severity: high
      expression: "{% raw %}last(/example_host/vfs.fs.size[{#FSNAME}, pused])>80{% endraw %}"
      recovery_mode: none
      manual_close: True
      enabled: True
      tags:
          - tag: class
            value: application
    state: present

# Delete Zabbix trigger prototype
- name: delete trigger prototype
  # set task level variables as we change ansible_connection plugin here
  vars:
    ansible_network_os: community.zabbix.zabbix
    ansible_connection: httpapi
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_zabbix_url_path: 'zabbixeu'  # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_triggerprototype:
    name: '{% raw %}Free disk space is less than 20% on volume {#FSNAME}{% endraw %}'
    template_name: example_template
    state: absent

作者

  • Andrew Lathrop (@aplathrop)