community.zabbix.zabbix_discoveryrule 模块 – 创建/删除 Zabbix 低级别发现 (LLD) 规则

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.zabbix。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 Playbook 中使用它，请指定：community.zabbix.zabbix_discoveryrule。

概要

  • 如果发现规则不存在，则创建它们。

  • 如果发现规则存在，则删除它们。

要求

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

  • python >= 2.6

参数

参数

注释

host_name

字符串

要将发现规则添加到的主机名称。

当未使用 *template_name* 时为必需。

与 *template_name* 互斥。

http_login_password

字符串

基本身份验证密码

http_login_user

字符串

基本身份验证登录名

name

字符串 / 必需

要创建或删除的发现规则的名称。

params

字典

用于创建/更新发现规则的参数。

如果 state 为 “present”，则为必需。

参数的定义请参见 https://www.zabbix.com/documentation/current/en/manual/api/reference/discoveryrule/object

其他支持的参数如下

enabled

布尔值

LLD 规则的状态。

覆盖 API 文档中的 “status”

选项

  • false

  • true

interval

字符串

LLD 规则的更新间隔。

API 文档中 “delay” 的别名

key

字符串

LLD 规则键。

API 文档中 “key_” 的别名

preprocessing

列表 / 元素=字典

发现规则预处理选项。

参数的定义请参见 https://www.zabbix.com/documentation/current/en/manual/api/reference/discoveryrule/object#lld-rule-preprocessing

其他支持的参数如下

error_handler

字符串

在预处理步骤失败时使用的操作类型。

选项

  • "zabbix_server"

  • "discard"

  • "set_custom_value"

  • "set_custom_error_message"

type

字符串 / 必需

预处理选项类型。

选项

  • "xml_xpath"

  • "jsonpath"

  • "does_not_match_regular_expression"

  • "not_match_regex"

  • "check_for_error_in_json"

  • "check_for_json_error"

  • "check_for_error_in_xml"

  • "check_for_xml_error"

  • "discard_unchanged_with_heartbeat"

  • "javascript"

  • "prometheus_to_json"

  • "csv_to_json"

  • "replace"

  • "xml_to_json"

  • "snmp_walk_value"

  • "snmp_walk_to_json"

status

字符串

LLD 规则的状态。

选项

  • "enabled"

  • "disabled"

type

字符串

LLD 规则的类型。

如果 state 为 “present”，则为必需。

选项

  • "zabbix_agent"

  • "zabbix_trapper"

  • "simple_check"

  • "zabbix_internal"

  • "zabbix_agent_active"

  • "web_item"

  • "external_check"

  • "database_monitor"

  • "ipmi_agent"

  • "ssh_agent"

  • "telnet_agent"

  • "calculated"

  • "jmx_agent"

  • "snmp_trap"

  • "dependent_item"

  • "http_agent"

  • "snmp_agent"

  • "script"

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 LLD rule on example_host
- name: create rule
  # 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_discoveryrule:
    name: mounted_filesystem_discovery
    host_name: example_host
    params:
        type: zabbix_agent
        key: 'vfs.fs.discovery'
        interval: 1h
        enabled: True
    state: present

# Create LLD rule on example_template
- name: create rule
  # 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_discoveryrule:
    name: mounted_filesystem_discovery
    template_name: example_template
    params:
        type: zabbix_agent
        key: 'vfs.fs.discovery'
        interval: 1h
        enabled: True
    state: present

# Change interval for existing Zabbix LLD rule
- name: update rule
  # 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_discoveryrule:
    name: mounted_filesystem_discovery
    template_name: example_template
    params:
        interval: 2h
    state: present

# Delete LLD rule
- name: delete rule
  # 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_discoveryrule:
    name: mounted_filesystem_discovery
    template_name: example_template
    state: absent

作者

  • Andrew Lathrop (@aplathrop)