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

Примечание

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

Примечания

Примечание

Имя равно идентификатору протокола федерации.
Имя равно идентификатору поставщика удостоверений.
Стандартные переменные окружения OpenStack, такие как OS_USERNAME могут быть использованы вместо явного указания значений.
Информация об авторизации управляется openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, а затем из явных параметров в play. Более подробная информация доступна на 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 список / элементы=словарь	Список словарей протоколов федерации. Возвращается: всегда
id строка	Идентификатор протокола федерации. Возвращается: успешно
mapping_id строка	Определение протокола федерации. Возвращается: успешно
name строка	Имя протокола. Равно `id`. Возвращается: успешно

Авторы

OpenStack Ansible SIG

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

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