os_group - Управление группами OpenStack Identity
Новая в версии 2.1.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Управление группами OpenStack Identity. Группы могут быть созданы, удалены или обновлены. Только значение описания может быть обновлено.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- python >= 2.7
- shade
Параметры
| параметр | обязательно | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| api_timeout | нет | None | Сколько времени должен ждать уровень сокетов перед истечением времени ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов. | |
| auth | нет | Словарь, содержащий информацию об авторизации, как это требуется стратегией плагина авторизации облака. Для стандартного плагина password, это будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать любые параметры, требуемые плагином авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | ||
| auth_type | нет | password | Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | нет | Игнорируется. Присутствует для обратной совместимости | ||
| cacert | нет | None | Путь к пакету сертификатов CA, который может быть использован для проверки запросов API SSL. | |
| cert | нет | None | Путь к клиенту сертификата для использования в рамках транзакции SSL. | |
| cloud | нет | Именованное облако для работы. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или если присутствуют переменные окружения OpenStack OS_*. | ||
| description | нет | None | Описание группы | |
| domain_id (добавлено в 2.3)
| нет | None | Идентификатор домена для создания группы в облаке, если облако поддерживает домены. | |
| endpoint_type | нет | public |
| Тип URL-адреса конечной точки для извлечения из каталога служб. |
| key | нет | None | Путь к ключу клиента для использования в рамках транзакции SSL. | |
| name | да | Имя группы | ||
| region_name | нет | Имя региона. | ||
| state | нет | present |
| Должна ли ресурс присутствовать или отсутствовать. |
| timeout | нет | 180 | Сколько времени Ansible должен ждать запрошенного ресурса. | |
| validate_certs | нет | Нужно ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. псевдонимы: verify | ||
| wait | нет | yes |
| Должен ли Ansible ждать, пока запрошенный ресурс завершит работу. |
Примеры
# 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 | Словарь, описывающий группу. | При успехе, когда I(state) равен 'present'. | сложный | ||||||||||||||||||||||||||
| содержит: |
| ||||||||||||||||||||||||||||
Примечания
Примечание
- Стандартные переменные окружения 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
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, ознакомьтесь с Информацией о сообществе и участии, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_group_module.html
