Модуль community.zabbix.zabbix_discovery_rule — Создание/удаление/обновление правил обнаружения Zabbix
Примечание
Этот модуль входит в коллекцию community.zabbix (версия 2.5.1).
Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.zabbix. Для использования этого модуля требуются дополнительные зависимости, см. Требования для подробностей.
Чтобы использовать его в книге задач, укажите: community.zabbix.zabbix_discovery_rule.
Описание
- Создание правила обнаружения.
- Удаление существующего правила обнаружения.
- Обновление существующего правила обнаружения новыми параметрами.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 3.9
Параметры
Параметр | Комментарии |
|---|---|
dchecks aliases: dcheck list / elements=dictionary | Список словарей объектов проверки обнаружения. Для получения дополнительной информации ознакомьтесь с документацией по объектам проверки обнаружения по адресу https://www.zabbix.com/documentation/current/manual/api/reference/dcheck/object |
|
host_source string |
Источник имени хоста. Возможные значения: DNS (по умолчанию) IP discovery - значение обнаружения этой проверки Опция доступна начиная с Zabbix 4.4 Варианты:
|
|
key string |
Значение этого свойства зависит от типа проверки:
|
|
name_source string |
Источник видимого имени. Возможные значения: none - (по умолчанию) не указано DNS IP discovery - значение обнаружения этой проверки Опция доступна начиная с Zabbix 4.4 Варианты:
|
|
ports string |
Один или несколько диапазонов портов для проверки, разделенных запятыми. Используется для всех проверок, кроме ICMP. |
|
snmp_community string |
SNMP сообщество. Требуется для проверок агентов SNMPv1 и SNMPv2. |
|
snmpv3_authpassphrase string |
Пароль аутентификации, используемый для проверок агента SNMPv3 с уровнем безопасности, установленным в authNoPriv или authPriv. |
|
snmpv3_authprotocol string |
Протокол аутентификации, используемый для проверок агента SNMPv3 с уровнем безопасности, установленным в authNoPriv или authPriv. Возможные значения: MD5 SHA Варианты:
|
|
snmpv3_contextname string |
Имя контекста SNMPv3. Используется только проверками SNMPv3. |
|
snmpv3_privpassphrase string |
Секретная фраза конфиденциальности, используемая для проверок агента SNMPv3 с уровнем безопасности, установленным в authPriv. |
|
snmpv3_privprotocol string |
Протокол конфиденциальности, используемый для проверок агента SNMPv3 с уровнем безопасности, установленным в authPriv. Возможные значения: DES AES Варианты:
|
|
snmpv3_securitylevel string |
Уровень безопасности, используемый для проверок агента SNMPv3. Возможные значения: noAuthNoPriv authNoPriv authPriv Варианты:
|
|
snmpv3_securityname string |
Имя безопасности, используемое для проверок агента SNMPv3. |
|
type string |
Тип проверки. Варианты:
|
|
uniq boolean |
Использовать ли эту проверку в качестве критерия уникальности устройства. Для правила обнаружения может быть настроена только одна уникальная проверка. Используется для проверок агентов Zabbix, SNMPv1, SNMPv2 и SNMPv3. Возможные значения: no - (по умолчанию) не использовать эту проверку в качестве критерия уникальности yes - использовать эту проверку в качестве критерия уникальности Выбираемые значения:
|
delay string | Интервал выполнения правила обнаружения. Принимает секунды, единицы измерения со значением суффикса и пользовательские макросы. По умолчанию: |
http_login_password string | Пароль Basic Auth |
http_login_user string | Логин Basic Auth |
iprange list / elements=string | Один или несколько диапазонов IP-адресов для проверки, разделенных запятыми. |
name string / обязательный | Имя правила обнаружения. |
proxy string | Имя прокси, используемого для обнаружения. |
state string | Создать или удалить правила обнаружения. Выбираемые значения:
|
status string | Включено ли правило обнаружения. Возможные значения: enabled (по умолчанию) disabled Выбираемые значения:
|
Примеры
# 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
# Base create discovery rule example
- name: Create discovery rule with ICMP and zabbix agent checks
# 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_discovery_rule:
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
# 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_discovery_rule:
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
# 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_discovery_rule:
name: ACME
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
drule string | Имя правила обнаружения. Возвращается: при успехе Пример: |
druleid string | Идентификатор правила обнаружения. Возвращается: при успехе Пример: |
msg string | Результат операции Возвращается: всегда Пример: |
state string | Состояние правила обнаружения в конце выполнения. Возвращается: при успехе Пример: |
Ссылки на коллекцию
© 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_discovery_rule_module.html