os_auth - Получение токена авторизации
Новая версия 2.0.
Обзор
- Получение токена авторизации из облака OpenStack
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени должна ждать транспортный уровень сокета перед завершением ожидания вызова API. Если это значение опущено, оно не будет передано в библиотеку запросов. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, требуемые этим плагином. Этот параметр не требуется, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type | Имя плагина авторизации для использования. Если облако использует что-то кроме аутентификации по паролю, здесь должно быть указано имя плагина, и содержимое параметра auth должно быть обновлено соответственно. | |
| availability_zone | Игнорируется. Присутствует для обратной совместимости | |
| cacert | Путь к пакету сертификатов CA, который можно использовать для проверки запросов SSL API. | |
| cert | Путь к клиенту сертификата для использования в рамках SSL-транзакции. | |
| cloud | Имя облака или конфигурация облака для работы. Если cloud является строкой, он ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или присутствуют переменные окружения OpenStack OS_* . Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| interface (добавлено в 2.3) |
| Тип URL конечной точки для извлечения из каталога сервиса. псевдонимы: endpoint_type |
| key | Путь к ключу клиента для использования в рамках SSL-транзакции. | |
| region_name | Имя региона. | |
| timeout | Значение по умолчанию: 180 | Сколько времени ansible должно ждать запрашиваемый ресурс. |
| verify |
| Необходимо ли проверять запросы SSL API. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait |
| Должен ли ansible ждать завершения запрошенного ресурса. |
Примечания
Примечание
- Стандартные переменные окружения OpenStack, такие как
OS_USERNAMEмогут быть использованы вместо явного указания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, и, наконец, явных параметров в play. Дополнительную информацию можно найти на http://docs.openstack.org/developer/os-client-config
Примеры
- name: Authenticate to the cloud and retrieve the service catalog
os_auth:
cloud: rax-dfw
- name: Show service catalog
debug:
var: service_catalog
Статус
Этот модуль помечен как превью, что означает, что гарантии обратной совместимости интерфейса нет.
Автор
- Monty Taylor (@emonty)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ для его улучшения.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/os_auth_module.html
