os_group — Управление группами OpenStack Identity
Новая в версии 2.1.
Обзор
- Управление группами OpenStack Identity. Группы могут быть созданы, удалены или обновлены. Можно обновить только значение description.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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 | По умолчанию: None | Описание группы |
| domain_id (добавлено в 2.3) | По умолчанию: None | ID домена для создания группы в облаке, если облако поддерживает домены. |
| interface (добавлено в 2.3) |
| Тип URL конечной точки для получения из каталога сервисов. псевдонимы: endpoint_type |
| key | Путь к клиенту ключ для использования в процессе SSL. | |
| name обязательно | Имя группы | |
| region_name | Имя региона. | |
| state |
| Должен ли ресурс присутствовать или отсутствовать. |
| timeout | По умолчанию: 180 | Сколько времени Ansible должно ждать запрашиваемого ресурса. |
| verify |
| Нужно ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait |
| Должен ли 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'. | Словарь, описывающий группу. | |
| id строка | Уникальный идентификатор группы Пример: ee6156ff04c645f481a6738311aea0b0 | ||
| domain_id строка | Домен группы Пример: default | ||
| name строка | Имя группы Пример: demo | ||
| description строка | Описание группы Пример: Демо-группа | ||
Статус
Этот модуль помечен как экспериментальный, что означает, что интерфейс не гарантируется как обратной совместимости.
Автор
- 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.5/modules/os_group_module.html
