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

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.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 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	Путь к пакету сертификатов CA, который можно использовать для проверки запросов 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.
domain_id string	Идентификатор домена, которому принадлежит роль.
interface псевдонимы: endpoint_type string	Тип URL конечной точки, которую нужно получить из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name string	Имя или идентификатор роли.
region_name string	Название региона.
sdk_log_level string	Уровень журналирования OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если значение не указано, журнал не ведётся.
timeout integer	Время ожидания ресурса, запрошенного Ansible. По умолчанию: `180`
validate_certs псевдонимы: verify boolean	Определяет, нужно ли проверять запросы API SSL. До Ansible 2.3 значение по умолчанию — `true`. Варианты: `false` `true`
wait boolean	Должен ли Ansible ожидать завершения операции с запрошенным ресурсом. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Вместо явного указания значений можно использовать стандартные переменные окружения OpenStack, например OS_USERNAME.
Данные аутентификации обрабатываются openstacksdk. Это означает, что значения могут быть взяты из файла конфигурации YAML /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения и, наконец, из явно указанных параметров в плейбуках. Дополнительную информацию см. на странице 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 list / elements=dictionary	Список словарей с описанием соответствующих ролей идентификации. Возвращается: всегда
description string	Описание роли, предназначенное для пользователей. Возвращается: при успешном выполнении
domain_id string	Идентификатор домена, которому принадлежит роль. Возвращается: при успешном выполнении
id string	Уникальный идентификатор роли Возвращается: при успешном выполнении
links dictionary	Ссылки на ресурсы службы Возвращается: при успешном выполнении
name string	Уникальное имя роли в пределах домена-владельца. Возвращается: при успешном выполнении

Авторы

Группа специальных интересов OpenStack Ansible

Ссылки на коллекцию

© 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/identity_role_info_module.html