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 |
---|---|
Name of host to add discovery rule to. Required when template_name is not used. Mutually exclusive with template_name. |
|
Basic Auth password |
|
Basic Auth login |
|
Name of discovery rule to create or delete. |
|
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 |
|
Status of the LLD rule. Overrides “status” in API docs Choices:
|
|
Update interval of the LLD rule. Alias for “delay” in API docs |
|
LLD rule key. Alias for “key_” in API docs |
|
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 |
|
Action type used in case of preprocessing step failure. Choices:
|
|
The preprocessing option type. Choices:
|
|
Status of the LLD rule. Choices:
|
|
Type of the LLD rule. Required if state is “present”. Choices:
|
|
Create or delete discovery rule. Choices:
|
|
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