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

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: openstack.cloud.identity_group.

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

Краткое описание

Создание, обновление или удаление группы идентификации 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.
description string	Описание группы.
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. Если значение пустое, журнал не ведётся.
state string	Должен ли ресурс присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
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: Create a group named "demo"
  openstack.cloud.identity_group:
    cloud: mycloud
    state: present
    name: demo
    description: "Demo Group"
    domain_id: demoid

- name: Update the description on existing demo group
  openstack.cloud.identity_group:
    cloud: mycloud
    state: present
    name: demo
    description: "Something else"
    domain_id: demoid

- name: Delete group named demo
  openstack.cloud.identity_group:
    cloud: mycloud
    state: absent
    name: demo

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

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

Ключ	Описание
group dictionary	Словарь с описанием группы идентификации. Возвращается: При успешном выполнении, если state имеет значение `present`.
description string	Описание группы Возвращается: при успешном выполнении Пример: `"Demo Group"`
domain_id string	Домен группы Возвращается: при успешном выполнении Пример: `"default"`
id string	Уникальный идентификатор группы Возвращается: при успешном выполнении Пример: `"ee6156ff04c645f481a6738311aea0b0"`
name string	Имя группы Возвращается: при успешном выполнении Пример: `"demo"`

Авторы

Специальная группа 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_group_module.html