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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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

Параметры

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

- 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 string	Результат операции Возвращается: при успешном выполнении Пример: `"Successfully created correlation"`

Авторы

ONODERA Masaru(@masa-orca)

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

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