community.general.icinga2_host модуль – Управление хостом в Icinga2

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 строка	Команда, используемая для проверки активности хоста. По умолчанию: `"hostalive"`
client_cert путь	Файл цепочки сертификатов в формате PEM, используемый для аутентификации клиента SSL. Этот файл также может содержать ключ, и если ключ включён, `client_key` не требуется.
client_key путь	Файл в формате PEM, содержащий ваш закрытый ключ для аутентификации клиента SSL. Если `client_cert` содержит как сертификат, так и ключ, этот параметр не требуется.
display_name строка	Имя, используемое для отображения хоста. Если не указано, по умолчанию используется значение параметра `name`
force булево	Если `yes`, не использовать кэшированную копию. Варианты: `false` ← (по умолчанию) `true`
force_basic_auth булево	Библиотека httplib2, используемая модулем uri, отправляет информацию об аутентификации только тогда, когда веб-сервис отвечает на начальный запрос статусом 401. Поскольку некоторые сервисы базовой аутентификации не отправляют должным образом 401, логины будут завершаться ошибкой. Этот параметр принудительно отправляет заголовок Basic аутентификации при начальном запросе. Варианты: `false` ← (по умолчанию) `true`
http_agent строка	Заголовок, используемый для идентификации, обычно отображается в логах веб-сервера. По умолчанию: `"ansible-httpget"`
ip строка	IP-адрес хоста. Этот параметр больше не требуется с версии community.general 8.0.0.
name псевдонимы: host строка / обязательно	Имя, используемое для создания/удаления хоста. Оно не обязательно должно быть FQDN, но должно быть уникальным.
state строка	Состояние применяемой функции. Варианты: `"present"` ← (по умолчанию) `"absent"`
template строка	Шаблон, используемый для определения хоста. Шаблон не может быть изменён после создания объекта.
url строка	URL HTTP, HTTPS или FTP в формате (http\|https\|ftp)://[user[:pass]]@host.domain[:port]/path
url_password строка	Пароль для использования в HTTP базовой аутентификации. Если параметр `url_username` не указан, параметр `url_password` не будет использован.
url_username строка	Имя пользователя для использования в HTTP базовой аутентификации. Этот параметр может использоваться без `url_password` для сайтов, допускающих пустые пароли.
use_gssapi булево добавлен в 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 булево	Если `false`, прокси не будет использован, даже если он определён в переменной среды на целевых хостах. Варианты: `false` `true` ← (по умолчанию)
validate_certs булево	Если `false`, сертификаты SSL не будут валидироваться. Это следует использовать только на контролируемых сайтах, использующих самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)
variables словарь	Словарь переменных.
zone строка	Зона, из которой должен опрашиваться этот хост.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в `check_mode` и возвращать прогноз изменения статуса без модификации целевого объекта.
diff_mode	Поддержка: отсутствует	Вернет подробную информацию о том, что изменилось (или, возможно, нуждается в изменении в `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 словарь	Структура данных, используемая для создания, изменения или удаления хоста Возвращается: всегда
name строка	Имя, используемое для создания, изменения или удаления хоста Возвращается: всегда

Авторы

Jurgen Brand (@t794104)

Ссылки на сборки

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