Модуль community.zabbix.zabbix_api_info – Получение информации об API Zabbix

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.zabbix.zabbix_api_info.

Новая в community.zabbix 2.1.0

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

Обзор

Этот модуль позволяет получить информацию об API Zabbix.

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
http_login_password строка	Пароль аутентификации Basic
http_login_user строка	Логин аутентификации Basic

Примеры

# 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: Retrieve API information
  # 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_api_info:
  register: zbx_api_info

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

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

Ключ	Описание
api словарь	Сводка информации об API Zabbix Возвращается: success
version строка	Версия API Возвращается: success Пример: `"6.0.18"`

Авторы

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_api_info_module.html