openstack.cloud.os_keystone_federation_protocol – управление протоколом федерации
Примечание
Этот плагин входит в состав коллекции openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud
Для использования в плейбуке укажите: openstack.cloud.os_keystone_federation_protocol
Описание
- Управление протоколом федерации.
Требования
Ниже перечислены требования, необходимые на хосте, на котором будет выполняться этот модуль.
- 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. | |
| idp_id строка / обязательный | Имя поставщика идентификации, с которым связан этот протокол. псевдонимы: idp_name | |
| interface строка |
| Тип URL-адреса конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| mapping_id строка | Имя отображения, используемое для этого протокола. Обязательно при создании нового протокола. псевдонимы: mapping_name | |
| name строка / обязательный | Название протокола. псевдонимы: id | |
| region_name строка | Имя региона. | |
| 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 a protocol
openstack.cloud.keystone_federation_protocol:
cloud: example_cloud
name: example_protocol
idp_id: example_idp
mapping_id: example_mapping
- name: Delete a protocol
openstack.cloud.keystone_federation_protocol:
cloud: example_cloud
name: example_protocol
idp_id: example_idp
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/os_keystone_federation_protocol_module.html
