openstack.cloud.identity_role_info модуль – Получение ролей идентификации OpenStack (Keystone)

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные зависимости, см. Требования для подробностей.

Для использования в книге задач укажите: openstack.cloud.identity_role_info.

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

Описание

Получение ролей идентификации OpenStack (Keystone).

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout целое число	Сколько времени слой сокета должен ждать, прежде чем произойдёт таймаут для вызовов API. Если этот параметр опущен, он не будет передан библиотеке requests.
auth словарь	Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для стандартного плагина password, он должен содержать auth_url, username, password, project_name, а также любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина авторизации. Этот параметр не нужен, если предоставлен именованное облако или присутствуют переменные окружения OpenStack OS_*.
auth_type строка	Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено.
ca_cert псевдонимы: cacert строка	Путь к пакету сертификатов CA, который может использоваться при проверке запросов API SSL.
client_cert псевдонимы: cert строка	Путь к клиенту сертификату для использования в рамках транзакции SSL.
client_key псевдонимы: key строка	Путь к ключу клиента для использования в рамках транзакции SSL.
cloud любой	Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен параметр auth или присутствуют переменные окружения OpenStack OS_. Если cloud* является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
domain_id строка	Идентификатор домена, владеющего ролью.
interface псевдонимы: endpoint_type строка	Тип URL конечной точки для извлечения из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name строка	Имя или ID роли.
region_name строка	Имя региона.
sdk_log_level строка	Уровень логирования OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к файлу логов OpenStackSDK. Если пусто, лог не записывается
timeout целое число	Сколько времени Ansible должен ждать запрашиваемого ресурса. По умолчанию: `180`
validate_certs псевдонимы: verify логическое	Нужно ли проверять запросы API SSL. До Ansible 2.3, это по умолчанию `true`. Варианты: `false` `true`
wait логическое	Должен ли Ansible ждать завершения запрошенного ресурса. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Стандартные переменные окружения OpenStack, такие как OS_USERNAME могут использоваться вместо явных значений.
Информация об авторизации управляется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и, наконец, из явных параметров в playbooks. Более подробную информацию можно найти на https://docs.openstack.org/openstacksdk/

Примеры

- name: Retrieve info about all roles
  openstack.cloud.identity_role_info:
    cloud: mycloud

- name: Retrieve info about all roles in specific domain
  openstack.cloud.identity_role_info:
    cloud: mycloud
    domain_id: some_domain_id

- name: Retrieve info about role 'admin'
  openstack.cloud.identity_role_info:
    cloud: mycloud
    name: admin

Значения возврата

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

Ключ	Описание
roles список / элементы=словарь	Список словарей, описывающих соответствующие роли идентификации. Возвращается: всегда
description строка	Описание роли для пользователя. Возвращается: успех
domain_id строка	Ссылка на идентификатор домена, которому принадлежит роль. Возвращается: успех
id строка	Уникальный идентификатор роли Возвращается: успех
links словарь	Ссылки на ресурсы службы Возвращается: успех
name строка	Уникальное имя роли в пределах домена владельца. Возвращается: успех

Авторы

OpenStack Ansible SIG

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/identity_role_info_module.html