Модуль community.zabbix.zabbix_discoveryrule — создание и удаление правил низкоуровневого обнаружения (LLD) Zabbix

Примечание

Этот модуль входит в коллекцию community.zabbix (версия 4.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.zabbix. Для использования этого модуля могут потребоваться дополнительные компоненты. Подробнее см. в разделе Требования.

Чтобы использовать модуль в сценарии, укажите: community.zabbix.zabbix_discoveryrule.

Краткое описание
Требования
Параметры
Примеры

Краткое описание

Создание правил обнаружения, если они не существуют.
Удаление существующих правил обнаружения.

Требования

На узле, где выполняется этот модуль, должны быть установлены следующие компоненты.

python >= 2.6

Параметры

Параметр	Комментарии
host_name string	Имя узла, для которого нужно добавить правило обнаружения. Обязательно, если не используется template_name. Взаимоисключающий параметр с template_name.
http_login_password string	Пароль для базовой аутентификации
http_login_user string	Имя пользователя для базовой аутентификации
name string / обязательный	Имя правила обнаружения для создания или удаления.
params dictionary	Параметры для создания или обновления правила обнаружения. Обязательно, если для state задано значение «present». Параметры, определённые по адресу https://www.zabbix.com/documentation/current/en/manual/api/reference/discoveryrule/object Дополнительно поддерживаются следующие параметры
enabled boolean	Состояние правила LLD. Переопределяет «status» в документации API Варианты: `false` `true`
interval string	Интервал обновления правила LLD. Альтернативное имя для «delay» в документации API
key string	Ключ правила LLD. Альтернативное имя для «key_» в документации API
new_name string	Новое имя правила LLD.
preprocessing list / элементы типа dictionary	Параметры предварительной обработки правил обнаружения. Параметры, определённые по адресу https://www.zabbix.com/documentation/current/en/manual/api/reference/discoveryrule/object#lld-rule-preprocessing Дополнительно поддерживаются следующие параметры
error_handler string	Тип действия в случае сбоя шага предварительной обработки. Варианты: `"zabbix_server"` `"discard"` `"set_custom_value"` `"set_custom_error_message"`
type string / обязательный	Тип параметра предварительной обработки. Варианты: `"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	Состояние правила LLD. Варианты: `"enabled"` `"disabled"`
type string	Тип правила 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 string	Создать или удалить правило обнаружения. Варианты: `"present"` ← (по умолчанию) `"absent"`
template_name string	Имя шаблона, для которого нужно добавить правило обнаружения. Обязательно, если не используется 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

- name: Rename Zabbix LLD 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:
      new_name: new_mounted_filesystem_discovery
    state: present

Авторы

Andrew Lathrop (@aplathrop)

Ссылки на коллекцию

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