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

Примечание

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

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

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

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

Обзор

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

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должен ожидать уровень сокета перед истечением времени ожидания для вызовов 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	Нужно ли проверять запросы SSL API. До версии 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 строка	успех	Описание группы Пример: Демо-группа
	domain_id строка	успех	Домен для группы Пример: default
	id строка	успех	Уникальный идентификатор группы Пример: ee6156ff04c645f481a6738311aea0b0
	name строка	успех	Имя группы Пример: 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/identity_group_module.html