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

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

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

Описание

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

Требования

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

openstacksdk
python >= 2.7

Параметры

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

Примечания

Примечание

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

Примеры

# 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

Статус

Интерфейс этого модуля не гарантирует обратной совместимости. [превью]
Этот модуль поддерживается сообществом 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.7/modules/os_group_module.html