Модуль community.general.icinga2_host — управление узлом в Icinga2

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: community.general.icinga2_host.

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

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

Добавление узла в Icinga2 или его удаление через API.
См. https://www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/.

Параметры

Параметр	Комментарии
check_command string	Команда, используемая для проверки доступности узла. По умолчанию: `"hostalive"`
client_cert path	Файл цепочки сертификатов в формате PEM, используемый для аутентификации SSL-клиента. Этот файл также может содержать ключ; если ключ включён в файл, параметр `client_key` не требуется.
client_key path	Файл в формате PEM, содержащий закрытый ключ для аутентификации SSL-клиента. Если `client_cert` содержит и сертификат, и ключ, этот параметр не требуется.
display_name string	Имя, используемое для отображения узла. Если не указано, по умолчанию используется значение параметра `name`.
force boolean	Если `yes`, не использовать кэшированную копию. Варианты: `false` ← (по умолчанию) `true`
force_basic_auth boolean	`httplib2` библиотека, используемая кодом HTTP-запросов Ansible, отправляет данные аутентификации только в том случае, если веб-служба отвечает на первоначальный запрос кодом состояния 401. Некоторые службы с базовой аутентификацией некорректно отправляют ответ 401, из-за чего вход может завершиться ошибкой. Этот параметр принудительно включает отправку заголовка базовой аутентификации при первоначальном запросе. Варианты: `false` ← (по умолчанию) `true`
http_agent string	Заголовок, используемый для идентификации; обычно отображается в журналах веб-сервера. По умолчанию: `"ansible-httpget"`
ip string	IP-адрес узла. Начиная с community.general 8.0.0 этот параметр больше не является обязательным.
name псевдонимы: host string / обязательный	Имя, используемое для создания или удаления узла. Оно не обязательно должно быть полным доменным именем (FQDN), но должно быть уникальным.
state string	Задать состояние функции. Варианты: `"present"` ← (по умолчанию) `"absent"`
template string	Шаблон, используемый для определения узла. Шаблон нельзя изменить после создания объекта.
url string	URL HTTP, HTTPS или FTP в формате `(http\|https\|ftp)://[user[:pass]]@host.domain[:port]/path`.
url_password string	Пароль для базовой аутентификации HTTP. Если параметр `url_username` не указан, параметр `url_password` не используется.
url_username string	Имя пользователя для базовой аутентификации HTTP. Этот параметр можно использовать без `url_password` для сайтов, допускающих пустые пароли.
use_gssapi boolean добавлен в ansible-core 2.11	Использовать GSSAPI для аутентификации; обычно это Kerberos или Kerberos через аутентификацию Negotiate. Требуется установленная библиотека Python gssapi. Учётные данные для GSSAPI можно указать с помощью `url_username`/`url_password` или переменной среды GSSAPI `KRB5CCNAME`, задающей пользовательский кэш учётных данных Kerberos. Аутентификация NTLM не поддерживается, даже если установлен механизм GSSAPI для NTLM. Варианты: `false` ← (по умолчанию) `true`
use_proxy boolean	Если `false`, прокси не используется, даже если он задан в переменной среды на целевых узлах. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Если `false`, сертификаты SSL не проверяются. Это следует использовать только на сайтах под личным контролем с самоподписанными сертификатами. Варианты: `false` `true` ← (по умолчанию)
variables dictionary	Словарь переменных.
zone string	Зона, из которой следует опрашивать этот узел.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: full	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой узел.
diff_mode	Поддержка: none	В режиме сравнения возвращает сведения об изменениях (или возможных изменениях в `check_mode`).

Примеры

- name: Add host to icinga
  community.general.icinga2_host:
    url: "https://icinga2.example.com"
    url_username: "ansible"
    url_password: "a_secret"
    state: present
    name: "{{ ansible_fqdn }}"
    ip: "{{ ansible_default_ipv4.address }}"
    variables:
      foo: "bar"
  delegate_to: 127.0.0.1

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

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

Ключ	Описание
data dictionary	Структура данных, используемая для создания, изменения или удаления узла. Возвращается: всегда
name string	Имя, используемое для создания, изменения или удаления узла. Возвращается: всегда

Авторы

Jurgen Brand (@t794104)

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

© 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/general/icinga2_host_module.html