openstack.cloud.os_keystone_federation_protocol_info – получение информации о протоколах федерации
Примечание
Этот плагин является частью коллекции openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в книге задач укажите: openstack.cloud.os_keystone_federation_protocol_info.
Описание
- Получение информации о протоколах федерации.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk >= 0.12.0
- openstacksdk >= 0.44
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должна ждать сокетная прослойка, прежде чем произойдёт таймаут при вызовах API. Если этот параметр опущен, он не будет передан в библиотеку requests. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он содержит auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать параметры, необходимые этому подключаемому модулю. Этот параметр не требуется, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type строка | Имя подключаемого модуля авторизации для использования. Если облако использует что-то кроме аутентификации по паролю, здесь должно быть указано имя подключаемого модуля, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone строка | Игнорируется. Присутствует для обратной совместимости | |
| ca_cert строка | Путь к файлу сертификата CA, который можно использовать для проверки запросов SSL API. псевдонимы: cacert | |
| client_cert строка | Путь к клиенту сертификату для использования в рамках транзакции SSL. псевдонимы: cert | |
| client_key строка | Путь к ключу клиента для использования в рамках транзакции SSL. псевдонимы: key | |
| cloud необработанные данные | Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| idp_id строка / обязательный | Имя поставщика идентификации, с которым связан этот протокол. псевдонимы: idp_name | |
| interface строка |
| Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| name строка | Имя протокола. псевдонимы: id | |
| region_name строка | Имя региона. | |
| timeout целое число | Значение по умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| validate_certs булево |
| Нужно ли проверять запросы API SSL. До Ansible 2.3 это имело значение по умолчанию yes.псевдонимы: verify |
| wait булево |
| Должен ли Ansible ждать завершения запрошенного ресурса. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, а затем из явных параметров в задачах. Более подробную информацию можно найти на странице https://docs.openstack.org/openstacksdk/
Примеры
- name: Describe a protocol
openstack.cloud.keystone_federation_protocol_info:
cloud: example_cloud
name: example_protocol
idp_id: example_idp
mapping_name: example_mapping
- name: Describe all protocols attached to an IDP
openstack.cloud.keystone_federation_protocol_info:
cloud: example_cloud
idp_id: example_idp
Авторы
- OpenStack Ansible SIG
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/os_keystone_federation_protocol_info_module.html
