Модуль community.zabbix.zabbix_correlation – Создание/обновление/удаление корреляции Zabbix

Примечание

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

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

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

Для использования в книге задач укажите: community.zabbix.zabbix_correlation.

Новое в community.zabbix 2.4.0

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

Описание

Этот модуль позволяет создавать, обновлять и удалять корреляцию Zabbix.

Требования

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

python >= 3.9

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
description строка	Описание этой корреляции
filter словарь	Фильтр.
conditions список / элементы=словарь / обязательно	Условие.
formulaid строка	Произвольный уникальный идентификатор, используемый для ссылки на условие из пользовательского выражения. Значение этого параметра должно содержать только заглавные буквы. Этот параметр обязателен, если значение evaltype фильтра равно `custom_expression`.
hostgroup строка	Имя группы хостов Этот параметр обязателен, если значение type условия равно `new_event_host_group`.
newtag строка	Новый тег события. Этот параметр обязателен, если значение type условия равно `event_tag_pair`.
oldtag строка	Старый тег события. Этот параметр обязателен, если значение type условия равно `event_tag_pair`.
operator строка	Оператор условия. Этот параметр обязателен, если значение type условия равно `new_event_host_group`, `old_event_tag_value` или `new_event_tag_value`. Вы можете выбрать только `equal` или `not_equal`, если значение type условия равно `new_event_host_group`. Варианты: `"equal"` `"not_equal"` `"like"` `"not_like"`
tag строка	Тег события (старый или новый). Этот параметр обязателен, если значение type условия равно `old_event_tag`, `new_event_tag`, `old_event_tag_value` или `new_event_tag_value`.
type строка / обязательно	Тип условия. Варианты: `"old_event_tag"` `"new_event_tag"` `"new_event_host_group"` `"event_tag_pair"` `"old_event_tag_value"` `"new_event_tag_value"`
value строка	Значение тега события (старого или нового). Этот параметр обязателен, если значение type условия равно `old_event_tag_value` или `new_event_tag_value`.
evaltype строка / обязательно	Метод оценки фильтра. Варианты: `"and_or"` `"and"` `"or"` `"custom_expression"`
formula строка	Пользовательское выражение для фильтра. Этот параметр обязателен, если значение evaltype равно `custom_expression`.
http_login_password строка	Пароль базовой авторизации
http_login_user строка	Логин базовой авторизации
name строка / обязательно	Название этой корреляции
operations список / элементы=словарь	Операции.
type строка / обязательно	Тип операции. Варианты: `"close_old_events"` `"close_new_event"`
state строка	Состояние корреляции. Варианты: `"present"` ← (по умолчанию) `"absent"`
status строка	Статус корреляции. Варианты: `"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

- name: Create correlation of 'New event tag correlation'
  # 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_correlation:
    name: New event tag correlation
    filter:
      evaltype: and_or
      conditions:
        - type: new_event_tag
          tag: ok
    operations:
      - type: close_old_events

Значения возврата

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

Ключ	Описание
msg строка	Результат операции Возвращено: success Пример: `"Successfully created correlation"`

Авторы

ONODERA Masaru(@masa-orca)

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

© 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_correlation_module.html