os_group — Управление группами OpenStack Identity
Впервые в версии 2.1.
Обзор
- Управление группами OpenStack Identity. Группы могут быть созданы, удалены или обновлены. Обновляться можно только значением параметра описание.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться данный модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени (в секундах) сокетный слой должен ждать перед истечением времени ожидания для API-вызовов. Если этот параметр опущен, он не будет передан в библиотеку requests. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако её поддерживает. Для других подключаемых модулей этот параметр должен содержать необходимые параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type | Имя используемого подключаемого модуля авторизации. Если облако использует аутентификацию, отличную от парольной, здесь следует указать имя подключаемого модуля, а содержимое параметра auth следует соответствующим образом обновить. | |
| availability_zone | Игнорируется. Присутствует для обратной совместимости | |
| cacert | Путь к пакету сертификатов CA, который может использоваться для проверки SSL-API-запросов. | |
| cert | Путь к клиенту сертификат, который используется в рамках SSL-транзакции. | |
| cloud | Наименованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на конфигурацию именованного облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| description | Описание группы | |
| domain_id (добавлен в 2.3) | Идентификатор домена, в котором должна быть создана группа, если облако поддерживает домены. | |
| interface (добавлен в 2.3) |
| Тип URL конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| key | Путь к ключу клиента, который используется в рамках SSL-транзакции. | |
| name обязательно | Название группы | |
| region_name | Название региона. | |
| state |
| Должен ли ресурс присутствовать или отсутствовать. |
| timeout | По умолчанию: 180 | Сколько времени Ansible должен ждать запрошенного ресурса. |
| verify bool |
| Должны ли проверяться SSL API-запросы. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait bool |
| Должен ли Ansible ждать завершения запрошенного ресурса. |
Примечания
Примечание
- Могут использоваться стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения и, наконец, из явных параметров в playbooks. Более подробную информацию можно найти по адресу 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'. | Словарь, описывающий группу. | |
| id строка | Уникальный идентификатор группы Пример: ee6156ff04c645f481a6738311aea0b0 | ||
| name строка | Название группы Пример: demo | ||
| description строка | Описание группы Пример: Демонстрационная группа | ||
| domain_id строка | Домен для группы Пример: default | ||
Статус
Данный модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Подробнее см. Техническое обслуживание модулей и поддержка.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/os_group_module.html
