openstack.cloud.keystone_federation_protocol_info – получение информации о протоколах федерации
Примечание
Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в книге задач, укажите: openstack.cloud.keystone_federation_protocol_info.
Обзор
- Получить информацию о протоколах федерации.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk >= 0.12.0
- openstacksdk >= 0.44
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должно ждать слой сокетов перед истечением времени ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов. | |
| 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 булево |
| Нужно ли проверять запросы SSL API. До 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/keystone_federation_protocol_info_module.html
