os_group – Управление группами OpenStack Identity

Новая в версии 2.1.

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

Обзор

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

Требования

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

openstacksdk
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени (в секундах) должен ожидать уровень сокета перед истечением времени ожидания для вызовов API. Если это значение опущено, оно не будет передано в библиотеку requests.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина по умолчанию password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_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 - добавлено в 2.3		Идентификатор домена для создания группы в облаке, если облако поддерживает домены.
interface строка добавлено в 2.3	Варианты: 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"
- os_group:
    cloud: mycloud
    state: present
    name: demo
    description: "Demo Group"
    domain_id: demoid

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

# Delete group named "demo"
- os_group:
    cloud: mycloud
    state: absent
    name: demo

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

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

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

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Monty Taylor (@emonty), David Shrewsbury (@Shrews)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.

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