os_group – Управление группами OpenStack Identity
Описание
- Управление группами OpenStack Identity. Группы могут быть созданы, удалены или обновлены. Только значение description может быть обновлено.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- 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 - | Идентификатор домена для создания группы, если облако поддерживает домены. | |
| interface строка |
| Тип URL-адреса конечной точки для извлечения из каталога сервисов. Псевдонимы: endpoint_type |
| name - / обязательно | Имя группы | |
| region_name строка | Имя региона. | |
| state - |
| Ресурс должен быть present или absent. |
| timeout целое число | Значение по умолчанию: 180 | Сколько времени Ansible должно ждать запрашиваемого ресурса. |
| validate_certs логическое значение |
| Нужно ли проверять SSL-API-запросы. В Ansible версии 2.3 значение по умолчанию было yes. Псевдонимы: verify |
| wait логическое значение |
| 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.9/modules/os_group_module.html
