os_auth – Получение маркера аутентификации

Новое в версии 2.0.

Синопсис
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Синопсис

Получение маркера аутентификации из облака OpenStack

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

openstacksdk
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должна ждать сокетная часть перед завершением действия по тайм-ауту для API-вызовов. Если этот параметр опущен, ничего не будет передано в библиотеку requests.
auth словарь		Словарь, содержащий информацию об аутентификации, как требуется стратегией плагина аутентификации облака. Для плагина password по умолчанию он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать любые параметры, необходимые для данного плагина аутентификации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка		Имя плагина аутентификации, который нужно использовать. Если облако использует что-то кроме парольной аутентификации, здесь должно быть указано имя плагина, и содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone -		Игнорируется. Присутствует для обратной совместимости
ca_cert строка		Путь к набору сертификатов CA, который можно использовать для проверки SSL-API-запросов. Псевдонимы: cacert
client_cert строка		Путь к клиенту сертификату для использования в рамках SSL-транзакции. Псевдонимы: cert
client_key строка		Путь к ключу клиента для использования в рамках SSL-транзакции. Псевдонимы: key
cloud raw		Наименованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на конфигурацию имени облака, как определено в файле OpenStack clouds.yaml. Обеспечивает значения по умолчанию для auth и auth_type. Этот параметр не нужен, если задан auth или присутствуют переменные окружения OpenStack OS_. Если cloud* является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
interface строка добавлено в 2.3	Варианты: admin internal public ←	Тип URL конечной точки для извлечения из каталога служб. Псевдонимы: endpoint_type
region_name строка		Имя региона.
timeout целое число	По умолчанию: 180	Сколько времени Ansible должно ждать запрошенного ресурса.
validate_certs логическое значение	Варианты: нет ← да	Необходимо ли проверять SSL-API-запросы. До 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: Authenticate to the cloud and retrieve the service catalog
  os_auth:
    cloud: rax-dfw

- name: Show service catalog
  debug:
    var: service_catalog

Возвращаемые значения

Общие возвращаемые значения описаны в здесь, следующие — уникальные для данного модуля:

Ключ	Возвращается	Описание
auth_token строка	успех	Маркер аутентификации API Openstack
service_catalog словарь	успех	Словарь доступных API-конечных точек

Статус

Гарантии обратной совместимости интерфейса этого модуля нет. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.8/modules/os_auth_module.html