модуль telekom_mms.icinga_director.icinga_user_info — Запрос пользователей в Icinga2

Примечание

Этот модуль входит в коллекцию telekom_mms.icinga_director (версия 2.5.1).

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

Для установки используйте: ansible-galaxy collection install telekom_mms.icinga_director.

Чтобы использовать её в плейбуке, укажите: telekom_mms.icinga_director.icinga_user_info.

Добавлено в telekom_mms.icinga_director 1.13.0

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

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

Получение списка объектов пользователей из Icinga2 через API Director.

Параметры

Параметр	Комментарии
api_timeout integer	Тайм-аут по умолчанию в секундах для ожидания завершения транзакции. По умолчанию: `10`
client_cert path	Файл цепочки сертификатов в формате PEM для аутентификации SSL-клиента. Этот файл также может содержать ключ. Если ключ включён в файл, параметр `client_key` не требуется.
client_key path	Файл в формате PEM, содержащий закрытый ключ для аутентификации SSL-клиента. Если `client_cert` содержит и сертификат, и ключ, этот параметр не требуется.
force boolean	Если `yes`, не получать кэшированную копию. Варианты: `false` ← (по умолчанию) `true`
force_basic_auth boolean	Передавать учётные данные, указанные с помощью `url_username` и `url_password`, в заголовке HTTP. Варианты: `false` ← (по умолчанию) `true`
http_agent string	Значение заголовка, используемое для идентификации; обычно отображается в журналах веб-сервера. По умолчанию: `"ansible-httpget"`
query string	Текст для фильтрации результатов поиска. Сопоставление текста выполняется со значением object_name. В результат будут включены только объекты, содержащие этот текст. Требуется Icinga Director версии 1.8.0 или новее. В более ранних версиях этот параметр игнорируется и возвращаются все объекты. По умолчанию: `""`
resolved boolean	Разрешить все унаследованные свойства объектов и исключить шаблоны из вывода. Варианты: `false` ← (по умолчанию) `true`
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	Если `no`, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Если `no`, SSL-сертификаты проверяться не будут. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Этот модуль поддерживает режим проверки.

Примеры

- name: Query a user in icinga
  telekom_mms.icinga_director.icinga_user_info:
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    query: "rb"

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

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

Ключ	Описание
objects list / элементы=string	Список возвращённых объектов Director. Список содержит все объекты, соответствующие фильтру запроса. Если фильтру не соответствует ни один объект, список будет пустым. Возвращается: всегда

Авторы

Martin Schurz (@schurzi)

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

© 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/telekom_mms/icinga_director/icinga_user_info_module.html