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