Модуль community.zabbix.zabbix_connector — создание, удаление и обновление коннекторов Zabbix

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: community.zabbix.zabbix_connector.

Добавлено в community.zabbix 3.3.0

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

Краткое описание

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

Требования

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

python >= 3.9

Параметры

Параметр	Описание
attempt_interval integer	Параметр добавлен в Zabbix 7.0 Интервал между попытками в секундах (значение от 0 до 10).
auth_type string	Метод HTTP-аутентификации, используемый коннектором. Возможные значения: `"none"` `"basic"` `"ntlm"` `"kerberos"` `"digest"` `"bearer"`
data_type string	Тип передаваемых данных. Возможные значения: `"item_values"` `"events"`
description string	Описание коннектора.
enabled boolean	Включен ли коннектор. (соответствует свойству status объекта коннектора в API Zabbix) Возможные значения: `false` `true`
http_login_password string	Пароль для базовой аутентификации
http_login_user string	Имя пользователя для базовой аутентификации
http_proxy string	HTTP(S)-прокси, используемый коннектором.
item_value_types list / elements=string	Параметр добавлен в Zabbix 7.0 Список типов значений для передачи. Каждый элемент должен быть одним из следующих: `all`, `all+bin`, `numeric_float`, `character`, `log`, `numeric_unsigned`, `text` или `binary`. `all` соответствует всем типам, кроме двоичных (по умолчанию). `all+bin` соответствует всем типам, включая двоичные.
max_attempts integer	Максимальное количество попыток.
max_records integer	Максимальное количество записей, отправляемых в одном сообщении.
max_senders integer	Количество процессов отправки, используемых коннектором.
name string / обязательный	Имя коннектора.
password string	Пароль для аутентификации коннектора у получателя. Поддерживается, только если `auth_type` — одно из значений `basic`, `ntlm`, `kerberos` или `digest`.
ssl_cert_file string	Путь к файлу открытого ключа SSL для аутентификации клиента.
ssl_key_file string	Путь к файлу закрытого ключа SSL для аутентификации клиента.
ssl_key_password string	Пароль файла закрытого ключа SSL.
state string	Состояние коннектора. При значении `present` модуль создаст коннектор, если он не существует, или обновит его, если связанные с ним данные отличаются. При значении `absent` модуль удалит коннектор, если он существует. Возможные значения: `"present"` ← (по умолчанию) `"absent"`
tags list / elements=dictionary	Список тегов для фильтрации передаваемых данных.
operator string	Условный оператор, используемый для фильтрации. Возможные значения: `"equals"` `"does not equal"` `"contains"` `"does not contain"` `"exists"` `"does not exist"`
tag string / обязательный	Имя тега.
value string	Сравниваемое значение тега.
tags_eval_type string	Метод оценки фильтра тегов. Возможные значения: `"and/or"` `"or"`
timeout integer	Тайм-аут отправки сообщения в секундах (значение от 1 до 60).
token string	Токен Bearer для аутентификации коннектора у получателя. Обязателен, если `auth_type=bearer`.
url string	URL получателя, используемый коннектором.
username string	Имя пользователя для аутентификации коннектора у получателя. Поддерживается, только если `auth_type` — одно из значений `basic`, `ntlm`, `kerberos` или `digest`.
verify_host boolean	Должен ли коннектор проверять имя хоста получателя по полям CN или SAN сертификата. Возможные значения: `false` `true`
verify_peer boolean	Должен ли коннектор проверять сертификат получателя. Возможные значения: `false` `true`

Примеры

# 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 or update a connector
  # 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_proxy:
    name: My app connector
    description: Connector to send item values to My app
    state: present
    enabled: true
    data_type: item_values
    url: https://my-app.example.com/api/zabbix-stream
    auth_type: bearer
    token: "{{ my_app_bearer_token }}"
    value_types:
      - numeric_float
      - character
      - numeric_unsigned
      - text
    tags_eval_type: and/or
    tags:
      - tag: to-my-app
        operator: exists
      - tag: privacy
        operator: does not equal
        value: hidden

- name: Delete a connector
  # 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_proxy:
    name: My app connector
    state: absent

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

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

Ключ	Описание
msg string	Текстовый результат операции. Возвращается: всегда Пример: `"Successfully updated connector 'My app connector' (id: 2)"`
result dictionary	Результат вызова API Zabbix в формате JSON Возвращается: при успешном выполнении Пример: `{"connectorids": ["2"]}`

Авторы

Loric Vandentempel (@loricvdt)

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

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