Модуль openstack.cloud.keystone_federation_protocol_info – получение протоколов федерации Keystone

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).

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

Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.keystone_federation_protocol_info.

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

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

Получение протоколов федерации Keystone.

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout integer	Время ожидания сокетного уровня перед истечением времени ожидания вызовов API. Если параметр не указан, библиотеке requests ничего не передаётся.
auth dictionary	Словарь с данными аутентификации, необходимыми выбранной стратегии плагина аутентификации облака. Для стандартного плагина password здесь должны быть указаны auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все параметры, необходимые соответствующему плагину аутентификации. Параметр не требуется, если указано именованное облако или заданы переменные окружения OpenStack OS_*.
auth_type string	Имя используемого плагина аутентификации. Если в облаке используется не парольная аутентификация, укажите здесь имя плагина и соответствующим образом измените содержимое параметра auth.
ca_cert псевдонимы: cacert string	Путь к пакету сертификатов центра сертификации, который можно использовать для проверки запросов к API по SSL.
client_cert псевдонимы: cert string	Путь к сертификату клиента, используемому при SSL-соединении.
client_key псевдонимы: key string	Путь к ключу клиента, используемому при SSL-соединении.
cloud any	Именованное облако или конфигурация облака, с которыми нужно работать. Если cloud — строка, она указывает на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Задаёт значения по умолчанию для auth и auth_type. Параметр не требуется, если указан auth или заданы переменные окружения OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml.
idp псевдонимы: idp_id, idp_name string / обязательный	ID или имя поставщика удостоверений, с которым связан этот протокол.
interface псевдонимы: endpoint_type string	Тип URL конечной точки, извлекаемой из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name псевдонимы: id string	ID или имя протокола федерации.
region_name string	Имя региона.
sdk_log_level string	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если значение не задано, журнал не записывается.
timeout integer	Время ожидания запрошенного ресурса в Ansible. По умолчанию: `180`
validate_certs псевдонимы: verify boolean	Следует ли проверять запросы к API по SSL. До Ansible 2.3 значением по умолчанию было `true`. Варианты: `false` `true`
wait boolean	Должен ли Ansible ожидать завершения операции с запрошенным ресурсом. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Имя совпадает с ID протокола федерации.
Имя совпадает с ID поставщика удостоверений.
Вместо явного указания значений можно использовать стандартные переменные окружения OpenStack, например OS_USERNAME.
Данные аутентификации обрабатываются openstacksdk. Это означает, что значения могут поступать из файла конфигурации YAML /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения и, наконец, из явно заданных параметров плейбука. Дополнительные сведения см. на странице https://docs.openstack.org/openstacksdk/

Примеры

- name: Fetch all federation protocols attached to an identity provider
  openstack.cloud.keystone_federation_protocol_info:
    cloud: example_cloud
    idp: example_idp

- name: Fetch federation protocol by name
  openstack.cloud.keystone_federation_protocol_info:
    cloud: example_cloud
    idp: example_idp
    name: example_protocol

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

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

Ключ	Описание
protocols list / элементы=dictionary	Список словарей протоколов федерации. Возвращается: всегда
id string	ID протокола федерации. Возвращается: при успехе
mapping_id string	Определение протокола федерации. Возвращается: при успехе
name string	Имя протокола. Совпадает с `id`. Возвращается: при успехе

Авторы

Специальная группа OpenStack Ansible

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

© 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/openstack/cloud/keystone_federation_protocol_info_module.html