openstack.cloud.os_group – Управление группами идентификации OpenStack

Примечание

Этот плагин является частью коллекции openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

Чтобы использовать его в книге задач, укажите: openstack.cloud.os_group.

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

Обзор

Управление группами идентификации OpenStack. Группы могут быть созданы, удалены или обновлены. Можно обновить только значение описания.

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должна ждать socket-слой перед истечением времени ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку requests.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если их поддерживает облако. Для других плагинов этот параметр должен содержать параметры, необходимые для плагина авторизации. Этот параметр не нужен, если предоставлен именованный облачный ресурс или присутствуют переменные окружения OpenStack OS_*.
auth_type строка		Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone строка		Игнорируется. Присутствует для обратной совместимости.
ca_cert строка		Путь к пакету сертификатов CA, который может использоваться при проверке запросов SSL API. алиасы: cacert
client_cert строка		Путь к клиенту сертификат для использования в рамках SSL транзакции. алиасы: cert
client_key строка		Путь к ключу клиента для использования в рамках SSL транзакции. алиасы: key
cloud сырой		Именованное облако или конфигурация облака для работы с ним. Если cloud является строкой, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен параметр auth или если присутствуют переменные окружения OpenStack OS_. Если cloud* является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
description строка		Описание группы
domain_id строка		Идентификатор домена для создания группы в нём, если облако поддерживает домены.
interface строка	Варианты: admin internal public ←	Тип URL конечной точки для получения из каталога служб. алиасы: endpoint_type
name строка / обязательный		Имя группы
region_name строка		Имя региона.
state строка	Варианты: present ← absent	Должен ли ресурс присутствовать или отсутствовать.
timeout целое число	По умолчанию: 180	Сколько времени ansible должно ждать запрошенного ресурса.
validate_certs булево	Варианты: no ← yes	Требуется ли проверка запросов API SSL. До Ansible 2.3 это по умолчанию было `yes`. алиасы: verify
wait булево	Варианты: no yes ←	Должен ли ansible ждать завершения запрошенного ресурса.

Примечания

Примечание

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

Примеры

# Create a group named "demo"
- openstack.cloud.identity_group:
    cloud: mycloud
    state: present
    name: demo
    description: "Demo Group"
    domain_id: demoid

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

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

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

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

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

Авторы

OpenStack Ansible SIG

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