Spec-Zone.ru › Ansible

Модуль community.zabbix.zabbix_host_info – Сбор информации о хосте Zabbix

Примечание

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

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

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

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

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

Описание

  • Этот модуль позволяет искать записи хостов Zabbix.
  • Этот модуль назывался zabbix_host_facts до Ansible 2.9. Использование не изменилось.

Требования

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

  • python >= 3.9

Параметры

Параметр

Комментарии

exact_match

boolean

Найти точное совпадение

Варианты:

  • false ← (по умолчанию)
  • true

host_inventory

list / elements=string

Список ключей инвентаризации хостов для отображения в результате.

Вся инвентаризация хостов извлекается, если ключи не указаны.

По умолчанию: []

host_ip

list / elements=string

IP-адрес интерфейса хоста в Zabbix.

Требуется, когда host_name не используется.

По умолчанию: []

host_name

string

Имя хоста в Zabbix.

host_name является уникальным идентификатором и не может быть обновлен с помощью этого модуля.

Требуется, когда host_ip не используется.

Если ни host_name, ни host_ip не указаны, возвращаются все хосты, настроенные в Zabbix.

По умолчанию: ""

http_login_password

string

Пароль для аутентификации Basic.

http_login_user

string

Логин для аутентификации Basic.

remove_duplicate

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: Get host info
  # 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_host_info:
    host_name: ExampleHost
    host_ip: 127.0.0.1
    exact_match: no
    remove_duplicate: yes

- name: Reduce host inventory information to provided keys
  # 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_host_info:
    host_name: ExampleHost
    host_inventory:
      - os
      - tag
    host_ip: 127.0.0.1
    exact_match: no
    remove_duplicate: yes

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

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

Ключ

Описание

hosts

dictionary

Список хостов Zabbix. См. https://www.zabbix.com/documentation/4.0/manual/api/reference/host/get для списка значений хоста.

Возвращается: успех

Пример: [{"...": null, "available": "1", "description": "", "disable_until": "0", "error": "", "flags": "0", "groups": ["1"], "host": "Host A"}]

Авторы

  • Michael Miko (@RedWhiteMiko)

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API