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

Примечание

Этот плагин входит в коллекцию community.zabbix (версия 1.2.0).

Для его установки используйте: ansible-galaxy collection install community.zabbix.

Чтобы использовать его в плейбуке, укажите: community.zabbix.zabbix_discovery_rule.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Создание правила обнаружения.
Удаление существующего правила обнаружения.
Обновление существующего правила обнаружения новыми параметрами.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

zabbix-api >= 0.5.4

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
dchecks список / элементы=словарь			Список словарей объектов проверки обнаружения. Для получения дополнительной информации ознакомьтесь с документацией по объектам проверки обнаружения по адресу https://www.zabbix.com/documentation/current/manual/api/reference/dcheck/object псевдонимы: dcheck
	host_source строка	Варианты: DNS ← IP обнаружение	Источник имени хоста. Возможные значения: DNS (по умолчанию) IP обнаружение - значение обнаружения этой проверки Параметр доступен начиная с Zabbix 4.4
	key строка		Значение этого свойства отличается в зависимости от типа проверки: - ключ для запроса проверок агента Zabbix - SNMP-OID для проверок SNMPv1, SNMPv2 и SNMPv3
	name_source строка	Варианты: Нет ← DNS IP обнаружение	Источник видимого имени. Возможные значения: нет - (по умолчанию) не указано DNS IP обнаружение - значение обнаружения этой проверки Параметр доступен начиная с Zabbix 4.4
	ports строка		Один или несколько диапазонов портов для проверки, разделенных запятыми. Используется для всех проверок, кроме ICMP.
	snmp_community строка		SNMP-сообщество. Требуется для проверок агента SNMPv1 и SNMPv2.
	snmpv3_authpassphrase строка		Пароль аутентификации, используемый для проверок агента SNMPv3 с уровнем безопасности authNoPriv или authPriv.
	snmpv3_authprotocol строка	Варианты: MD5 SHA	Протокол аутентификации, используемый для проверок агента SNMPv3 с уровнем безопасности authNoPriv или authPriv. Возможные значения: MD5 SHA
	snmpv3_contextname строка		Имя контекста SNMPv3. Используется только для проверок SNMPv3.
	snmpv3_privpassphrase строка		Пароль конфиденциальности, используемый для проверок агента SNMPv3 с уровнем безопасности authPriv.
	snmpv3_privprotocol строка	Варианты: DES AES	Протокол конфиденциальности, используемый для проверок агента SNMPv3 с уровнем безопасности authPriv. Возможные значения: DES AES
	snmpv3_securitylevel строка	Варианты: noAuthNoPriv authNoPriv authPriv	Уровень безопасности, используемый для проверок агента SNMPv3. Возможные значения: noAuthNoPriv authNoPriv authPriv
	snmpv3_securityname строка		Имя безопасности, используемое для проверок агента SNMPv3.
	type строка	Варианты: SSH LDAP SMTP FTP HTTP POP NNTP IMAP TCP Zabbix SNMPv1 SNMPv2 ICMP SNMPv3 HTTPS Telnet	Тип проверки.
	uniq булево	Варианты: нет ← да	Используется ли эта проверка в качестве критерия уникальности устройства. Только одна уникальная проверка может быть настроена для правила обнаружения. Используется для проверок агента Zabbix, SNMPv1, SNMPv2 и SNMPv3 агента. Возможные значения: нет - (по умолчанию) не использовать эту проверку в качестве критерия уникальности да - использовать эту проверку в качестве критерия уникальности
delay строка		По умолчанию: "1ч"	Интервал выполнения правила обнаружения. Принимает секунды, единицу измерения времени с суффиксом и пользовательский макрос.
http_login_password строка			Пароль Basic Auth
http_login_user строка			Логин Basic Auth
iprange список / элементы=строка			Один или несколько диапазонов IP-адресов для проверки, разделенных запятыми.
login_password строка / обязательно			Пароль пользователя Zabbix.
login_user строка / обязательно			Имя пользователя Zabbix.
name строка / обязательно			Имя правила обнаружения.
proxy строка			Имя прокси, используемого для обнаружения.
server_url строка / обязательно			URL сервера Zabbix, с протоколом (http или https). `url` является псевдонимом `server_url`. псевдонимы: url
state строка		Варианты: наличие ← отсутствие	Создание или удаление правил обнаружения.
status строка		Варианты: активирован ← отключен	Включено ли правило обнаружения. Возможные значения: активирован (по умолчанию) отключен
timeout целое число		По умолчанию: 10	Таймаут запроса API (в секундах).
validate_certs булево		Варианты: нет да ←	Если значение равно False, сертификаты SSL не будут проверяться. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов.

Примечания

Примечание

Поддерживается только Zabbix >= 4.0.
Если вы используете login_password=zabbix, слово «zabbix» заменяется на «****» во всех выводах модуля, потому что login_password использует no_log. Дополнительную информацию см. в этом разделе FAQ.

Примеры

# Base create discovery rule example
- name: Create discovery rule with ICMP and zabbix agent checks
  community.zabbix.zabbix_discovery_rule:
    server_url: "http://zabbix.example.com/zabbix/"
    login_user: admin
    login_password: secret
    name: ACME
    state: present
    iprange: 192.168.1.1-255
    dchecks:
        - type: ICMP
        - type: Zabbix
          key: "system.hostname"
          ports: 10050
          uniq: yes
          host_source: "discovery"

# Base update (add new dcheck) discovery rule example
- name: Create discovery rule with ICMP and zabbix agent checks
  community.zabbix.zabbix_discovery_rule:
    server_url: "http://zabbix.example.com/zabbix/"
    login_user: admin
    login_password: secret
    name: ACME
    state: present
    iprange: 192.168.1.1-255
    dchecks:
        - type: SNMPv3
          snmp_community: CUSTOMER@snmp3-readonly
          ports: "161"
          key: iso.3.6.1.2.1.1.1.0
          snmpv3_contextname: "ContextName"
          snmpv3_securityname: "SecurityName"
          snmpv3_securitylevel: "authPriv"
          snmpv3_authprotocol: "SHA"
          snmpv3_authpassphrase: "SeCrEt"
          snmpv3_privprotocol: "AES"
          snmpv3_privpassphrase: "TopSecret"
          uniq: no
          host_source: "DNS"
          name_source: "None"

# Base delete discovery rule example
- name: Delete discovery rule
  community.zabbix.zabbix_discovery_rule:
    server_url: "http://zabbix.example.com/zabbix/"
    login_user: admin
    login_password: secret
    name: ACME
    state: absent

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
drule строка	при успехе	Имя правила обнаружения. Пример: ACME
druleid строка	при успехе	Идентификатор правила обнаружения. Пример: 42
msg строка	всегда	Результат операции Пример: Правило обнаружения создано: ACME, ID: 42
state строка	при успехе	Состояние правила обнаружения в конце выполнения. Пример: наличие

Авторы

Tobias Birkefeld (@tcraxs)

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