Модуль openstack.cloud.auth — получение токена аутентификации из облака OpenStack
Примечание
Этот модуль входит в состав коллекции openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.auth.
Краткое описание
- Получение токена аутентификации из облака OpenStack
Требования
Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout integer | Сколько времени сокетный уровень должен ожидать ответа перед истечением времени ожидания вызова API. Если параметр не задан, библиотеке requests ничего не передаётся. |
auth dictionary | Словарь с данными аутентификации, необходимыми используемой облаком стратегией плагина аутентификации. Для стандартного плагина password здесь указываются auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов в этом параметре необходимо указать все параметры, требуемые соответствующим плагином аутентификации. Этот параметр не требуется, если указано имя облака или заданы переменные окружения OpenStack OS_*. |
auth_type string | Имя используемого плагина аутентификации. Если облако использует не парольную аутентификацию, здесь следует указать имя плагина и соответствующим образом изменить содержимое параметра auth. |
ca_cert псевдонимы: cacert string | Путь к пакету сертификатов ЦС, который можно использовать для проверки запросов к API по SSL. |
client_cert псевдонимы: cert string | Путь к сертификату клиента, используемому при SSL-подключении. |
client_key псевдонимы: key string | Путь к ключу клиента, используемому при SSL-подключении. |
cloud any | Именованное облако или конфигурация облака, с которыми выполняются операции. Если cloud — строка, она указывает на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или заданы переменные окружения OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml. |
interface псевдонимы: endpoint_type string | Тип URL конечной точки, получаемый из каталога служб. Допустимые значения:
|
region_name string | Название региона. |
sdk_log_level string | Уровень журналирования OpenStackSDK Допустимые значения:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не ведётся. |
timeout integer | Сколько времени Ansible должен ожидать запрошенный ресурс. По умолчанию: |
validate_certs псевдонимы: verify boolean | Следует ли проверять запросы к API по SSL. До Ansible 2.3 значение по умолчанию было Допустимые значения:
|
wait boolean | Должен ли 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 cloud and return auth token
openstack.cloud.auth:
cloud: rax-dfw
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
auth_token string | Токен аутентификации API OpenStack Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/openstack/cloud/auth_module.html
