Модуль community.zabbix.zabbix_discoveryrule – Создание/удаление правил обнаружения Zabbix

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 строка	Пароль Basic Auth
http_login_user строка	Логин Basic Auth
name строка / обязательно	Имя правила обнаружения для создания или удаления.
params словарь	Параметры для создания/обновления правила обнаружения. Требуется, если состояние равно “present”. Параметры, как определено в https://www.zabbix.com/documentation/current/en/manual/api/reference/discoveryrule/object Дополнительно поддерживаемые параметры указаны ниже
enabled логическое значение	Статус правила LLD. Переопределяет “status” в документации API Варианты: `false` `true`
interval строка	Интервал обновления правила LLD. Псевдоним для “delay” в документации API
key строка	Ключ правила LLD. Псевдоним для “key_” в документации API
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. Требуется, если состояние равно “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

# 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

Авторы

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