community.zabbix.zabbix_discoveryrule module – Create/delete Zabbix discovery rules

Note

This module is part of the community.zabbix collection (version 2.5.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.zabbix. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.zabbix.zabbix_discoveryrule.

Synopsis

  • Create discoveryrules if they do not exist.
  • Delete existing discoveryrules if they exist.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

Parameters

Parameter

Comments

host_name

string

Name of host to add discovery rule to.

Required when template_name is not used.

Mutually exclusive with template_name.

http_login_password

string

Basic Auth password

http_login_user

string

Basic Auth login

name

string / required

Name of discovery rule to create or delete.

params

dictionary

Parameters to create/update discovery rule with.

Required if state is “present”.

Parameters as defined at https://www.zabbix.com/documentation/current/en/manual/api/reference/discoveryrule/object

Additionally supported parameters are below

enabled

boolean

Status of the LLD rule.

Overrides “status” in API docs

Choices:

  • false
  • true

interval

string

Update interval of the LLD rule.

Alias for “delay” in API docs

key

string

LLD rule key.

Alias for “key_” in API docs

preprocessing

list / elements=dictionary

discovery rules preprocessing options.

Parameters as defined at https://www.zabbix.com/documentation/current/en/manual/api/reference/discoveryrule/object#lld-rule-preprocessing

Additionally supported parameters are below

error_handler

string

Action type used in case of preprocessing step failure.

Choices:

  • "zabbix_server"
  • "discard"
  • "set_custom_value"
  • "set_custom_error_message"

type

string / required

The preprocessing option type.

Choices:

  • "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

string

Status of the LLD rule.

Choices:

  • "enabled"
  • "disabled"

type

string

Type of the LLD rule.

Required if state is “present”.

Choices:

  • "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

string

Create or delete discovery rule.

Choices:

  • "present" ← (default)
  • "absent"

template_name

string

Name of template to add discovery rule to.

Required when host_name is not used.

Mutually exclusive with host_name.

Examples

# 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

# Add tags to the 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:
        type: zabbix_agent
        key: 'vfs.fs.discovery'
        interval: 1h
        enabled: True
        tags:
          - tag: class
            value: application
    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

Authors

  • Andrew Lathrop (@aplathrop)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/zabbix/zabbix_discoveryrule_module.html