openstack.cloud.federation_idp – управление поставщиком федерации идентификаторов
Примечание
Этот плагин является частью коллекции openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в плейбуке укажите: openstack.cloud.federation_idp.
Обзор
- Управление поставщиком федерации идентификаторов.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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, который может использоваться для проверки запросов API SSL. алиасы: cacert | |
| client_cert строка | Путь к клиенту сертификат для использования в рамках транзакции SSL. алиасы: cert | |
| client_key строка | Путь к ключу клиента для использования в рамках транзакции SSL. алиасы: key | |
| cloud сырой | Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| description строка | Описание поставщика идентификаторов. | |
| domain_id строка | Идентификатор домена, связанного с поставщиком идентификаторов. Федеративные пользователи, которые проходят аутентификацию с помощью поставщика идентификаторов, будут созданы в указанном домене. Необходимо при создании нового поставщика идентификаторов. | |
| enabled логическое значение |
| Включен ли поставщик идентификаторов. Будет по умолчанию true при создании нового поставщика идентификаторов.алиасы: is_enabled |
| interface строка |
| Тип URL-адреса конечной точки для извлечения из каталога служб. алиасы: endpoint_type |
| name строка / требуется | Имя поставщика идентификаторов. алиасы: id | |
| region_name строка | Имя региона. | |
| remote_ids список / элементы=строка | Список уникальных удаленных идентификаторов поставщика идентификаторов. Будет по умолчанию пустым списком при создании нового поставщика идентификаторов. | |
| state строка |
| Должен ли поставщик идентификаторов быть present или absent. |
| 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: Create an identity provider
openstack.cloud.federation_idp:
cloud: example_cloud
name: example_provider
domain_id: 0123456789abcdef0123456789abcdef
description: 'My example IDP'
remote_ids:
- 'https://auth.example.com/auth/realms/ExampleRealm'
- name: Delete an identity provider
openstack.cloud.federation_idp:
cloud: example_cloud
name: example_provider
state: absent
Авторы
- 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/federation_idp_module.html
