community.general.icinga2_host – Управление хостом в Icinga2
Примечание
Этот плагин является частью коллекции community.general (версия 2.0.1).
Для его установки используйте: 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 не получать кэшированную копию.Псевдоним thirsty устарел и будет удалён в версии 2.13.псевдонимы: thirsty |
| force_basic_auth логическое |
| httplib2, библиотека, используемая модулем uri, отправляет информацию об аутентификации только тогда, когда веб-сервис отвечает на начальный запрос кодом состояния 401. Поскольку некоторые службы базовой аутентификации не отправляют должным образом код 401, вход в систему будет провален. Этот параметр принудительно отправляет заголовок базовой аутентификации при первом запросе. |
| http_agent строка | По умолчанию: "ansible-httpget" | Заголовок для идентификации, обычно отображается в журналах веб-сервера. |
| ip строка / обязательно | IP-адрес хоста. | |
| name строка / обязательно | Имя, используемое для создания/удаления хоста. Это не обязательно должно быть полное доменное имя (FQDN), но оно должно быть уникальным. | |
| state строка |
| Применение состояния функции. |
| 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 логическое добавлен в 2.11 ansible.builtin |
| Использование GSSAPI для выполнения аутентификации, обычно это для аутентификации Kerberos или Kerberos через Negotiate. Требуется установка Python библиотеки gssapi. Учётные данные для GSSAPI могут быть указаны с помощью url_username/url_password или с помощью переменной среды GSSAPI KRB5CCNAME, которая задаёт кастомный кэш Kerberos.Аутентификация NTLM not поддерживается даже если механизм GSSAPI для NTLM был установлен. |
| use_proxy логическое |
| Если no, прокси не будет использоваться, даже если она определена в переменной среды на целевых хостах. |
| validate_certs логическое |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на лично контролируемых сайтах, использующих самозаверяющие сертификаты. |
| variables словарь | Словарь переменных. | |
| zone строка | Зона, из которой должен осуществляться контроль за хостом. |
Примеры
- 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/icinga2_host_module.html
