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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.identity_group_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	Путь к пакету сертификатов центра сертификации, используемому для проверки запросов к 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 string	Имя или идентификатор домена, содержащего группу.
filters dictionary	Словарь метаданных для дополнительной фильтрации. Элементы этого словаря могут быть дополнительными словарями.
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: Gather previously created groups
  openstack.cloud.identity_group_info:
    cloud: awesomecloud

- name: Gather previously created groups by name
  openstack.cloud.identity_group_info:
    cloud: awesomecloud
    name: demogroup

- name: Gather previously created groups in a specific domain
  openstack.cloud.identity_group_info:
    cloud: awesomecloud
    domain: admindomain

- name: Gather and filter previously created groups
  openstack.cloud.identity_group_info:
    cloud: awesomecloud
    name: demogroup
    domain: admindomain
    filters:
      is_enabled: False

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

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

Ключ	Описание
groups list / элементы=dictionary	Словарь с описанием всех соответствующих групп идентификации. Возвращается: всегда
description string	Описание группы. Возвращается: при успешном выполнении
domain_id boolean	Идентификатор домена, содержащего группу (только для облаков Keystone v3) Возвращается: при успешном выполнении
id string	Уникальный UUID. Возвращается: при успешном выполнении
name string	Имя, присвоенное группе. Возвращается: при успешном выполнении

Авторы

OpenStack Ansible SIG

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

© 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_group_info_module.html