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

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: openstack.cloud.identity_group_info.

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

Описание

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

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout integer	Сколько времени слой сокетов должен ждать, прежде чем истечет время ожидания для вызовов API. Если это пропущено, ничего не будет передано в библиотеку запросов.
auth dictionary	Словарь, содержащий информацию об аутентификации, необходимую стратегии подключаемого модуля аутентификации облака. Для плагина password по умолчанию это будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все параметры, необходимые этому плагину аутентификации. Этот параметр не требуется, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type string	Имя используемого плагина аутентификации. Если облако использует что-то другое, кроме парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть обновлено соответствующим образом.
ca_cert aliases: cacert string	Путь к пакету сертификатов CA, который может использоваться в качестве части проверки запросов SSL API.
client_cert aliases: cert string	Путь к клиентскому сертификату, который нужно использовать в качестве части транзакции SSL.
client_key aliases: key string	Путь к клиентскому ключу, который нужно использовать в качестве части транзакции SSL.
cloud any	Именованное облако или конфигурация облака, с которым нужно работать. Если cloud — строка, она ссылается на именованную конфигурацию облака, определенную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или если присутствуют переменные окружения OpenStack OS_. Если cloud* — это словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
domain string	Имя или ID домена, содержащего группу.
filters dictionary	Словарь метаданных для дополнительной фильтрации. Элементы этого словаря могут быть дополнительными словарями.
interface aliases: endpoint_type string	Тип URL-адреса конечной точки для извлечения из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name string	Имя или ID группы.
region_name string	Имя региона.
sdk_log_level string	Уровень логирования OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается
timeout integer	Сколько времени ansible должен ждать запрашиваемого ресурса. По умолчанию: `180`
validate_certs aliases: verify boolean	Следует ли проверять запросы SSL API. До 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 список / элементы=словарь	Словарь, описывающий все соответствующие группы идентификации. Возвращается: всегда
description строка	Описание группы. Возвращается: успешно
domain_id логическое	Идентификатор домена, содержащий группу (только облака keystone v3). Возвращается: успешно
id строка	Уникальный UUID. Возвращается: успешно
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_group_info_module.html