Модуль community.zabbix.zabbix_triggerprototype — Создание/удаление шаблонов триггеров Zabbix

Примечание

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

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

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

Для использования в плейбуке укажите: community.zabbix.zabbix_triggerprototype.

Обзор
Требования
Параметры
Примеры

Обзор

Создать шаблоны триггеров, если они не существуют.
Удалить существующие шаблоны триггеров, если они существуют.

Требования

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

python >= 2.6

Параметры

Параметр	Комментарии
dependencies список / элементы=словарь	список шаблонов триггеров, от которых зависит данный шаблон триггера
host_name строка	Имя хоста, содержащего зависимый триггер. Требуется, когда не используется template_name. Взаимоисключающее с template_name.
name строка / обязательно	Имя зависимого триггера.
template_name строка	Имя шаблона, содержащего зависимый триггер. Требуется, когда не используется host_name. Взаимоисключающее с host_name.
desc алиасы: описание строка	Дополнительное описание шаблона триггера. Переопределяет “комментарии” в документации API.
host_name строка	Имя хоста, к которому добавляется шаблон триггера. Требуется, когда не используется template_name. Взаимоисключающее с template_name.
http_login_password строка	Пароль Basic Auth
http_login_user строка	Логин Basic Auth
name строка / обязательно	Имя шаблона триггера для создания или удаления. Переопределяет “описание” в документации API. Не может быть изменено. Если имя шаблона триггера необходимо изменить, его нужно удалить и создать заново
params словарь	Параметры для создания/обновления шаблона триггера. Требуется, если состояние равно “present”. Параметры, как определено в https://www.zabbix.com/documentation/current/en/manual/api/reference/triggerprototype/object Ниже приведены дополнительные поддерживаемые параметры.
correlation_mode строка	Завершение события OK. Переопределяет “correlation_mode” в документации API. Варианты: `"all"` `"tag"`
enabled логическое	Статус шаблона триггера. Переопределяет “состояние” в документации API. Варианты: `false` `true`
generate_multiple_events логическое	Можно ли шаблону триггера генерировать несколько событий о проблемах? Псевдоним для “типа” в документации API. Варианты: `false` `true`
manual_close логическое	Разрешить ручное закрытие. Переопределяет “manual_close” в документации API. Варианты: `false` `true`
recovery_mode строка	Режим генерации событий OK. Переопределяет “recovery_mode” в документации API. Варианты: `"expression"` `"recovery_expression"` `"none"`
severity алиасы: приоритет строка	Уровень серьезности шаблона триггера. Псевдоним для “приоритета” в документации API. Варианты: `"not_classified"` `"information"` `"warning"` `"average"` `"high"` `"disaster"`
status строка	Статус шаблона триггера. Варианты: `"enabled"` `"disabled"`
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 trigger prototype on example_host using example_rule
- name: create trigger prototype
  # 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_triggerprototype:
    name: '{% raw %}Free disk space is less than 20% on volume {#FSNAME}{% endraw %}'
    host_name: example_host
    params:
      severity: high
      expression: "{% raw %}last(/example_host/vfs.fs.size[{#FSNAME}, pused])>80{% endraw %}"
      recovery_mode: none
      manual_close: True
      enabled: True
    state: present

# Create trigger prototype on example_template using example_rule
- name: create trigger prototype
  # 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_triggerprototype:
    name: '{% raw %}Free disk space is less than 20% on volume {#FSNAME}{% endraw %}'
    template_name: example_template
    params:
      severity: high
      expression: "{% raw %}last(/example_host/vfs.fs.size[{#FSNAME}, pused])>80{% endraw %}"
      recovery_mode: none
      manual_close: True
      enabled: True
    state: present

# Add tags to the existing Zabbix trigger prototype
- name: update trigger prototype
  # 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_triggerprototype:
    name: '{% raw %}Free disk space is less than 20% on volume {#FSNAME}{% endraw %}'
    template_name: example_template
    params:
      severity: high
      expression: "{% raw %}last(/example_host/vfs.fs.size[{#FSNAME}, pused])>80{% endraw %}"
      recovery_mode: none
      manual_close: True
      enabled: True
      tags:
          - tag: class
            value: application
    state: present

# Delete Zabbix trigger prototype
- name: delete trigger prototype
  # 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_triggerprototype:
    name: '{% raw %}Free disk space is less than 20% on volume {#FSNAME}{% endraw %}'
    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_triggerprototype_module.html