os_auth – Получение маркера аутентификации
Новая версия с 2.0.
Обзор
- Получение маркера аутентификации из облака OpenStack
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout - | Сколько времени должна ждать сокетная прослойка перед истечением времени ожидания для вызовов API. Если этот параметр опущен, в библиотеку requests ничего не будет передано. | |
| 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 boolean |
| Нужно ли проверять SSL-запросы к API. До версии 2.3 это значение по умолчанию было True. псевдонимы: validate_certs |
| wait boolean |
| Должен ли Ansible ждать, пока запрашиваемый ресурс не будет завершен. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения 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
Примеры
- name: Authenticate to the cloud and retrieve the service catalog
os_auth:
cloud: rax-dfw
- name: Show service catalog
debug:
var: service_catalog
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.7/modules/os_auth_module.html
