os_keystone_domain – Управление областями OpenStack Identity
Описание
- Создание, обновление или удаление областей OpenStack Identity. Если область с указанным именем уже существует, она будет обновлена с новым описанием и атрибутами включения.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени слой сокетов должен ждать перед истечением времени ожидания для вызовов API. Если это значение опущено, в библиотеку запросов ничего не будет передано. | |
| 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 - | Описание домена | |
| enabled логический тип |
| Включён ли домен |
| interface строка |
| Тип URL-адреса конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| name - / обязательно | Имя, которое должно быть присвоено экземпляру | |
| region_name строка | Имя региона. | |
| state - |
| Ресурс должен быть present или absent. |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должен ждать запрашиваемого ресурса. |
| validate_certs логический тип |
| Необходимо ли проверять запросы API SSL. До Ansible 2.3 это имело значение yes. псевдонимы: verify |
| wait логический тип |
| Должен ли Ansible ждать, пока запрашиваемый ресурс не будет завершен. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и, наконец, из явных параметров в playbooks. Более подробную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
# Create a domain
- os_keystone_domain:
cloud: mycloud
state: present
name: demo
description: Demo Domain
# Delete a domain
- os_keystone_domain:
cloud: mycloud
state: absent
name: demo
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| domain сложное | При успехе, когда state — 'present' | Словарь, описывающий домен. | |
| description строка | Описание домена. Пример: Демо Домен | ||
| enabled логический тип | Описание домена. Пример: True | ||
| id строка | Идентификатор домена. Пример: 474acfe5-be34-494c-b339-50f06aa143e4 | ||
| name строка | Имя домена. Пример: demo | ||
| id строка | При успехе, когда state — 'present' | Идентификатор домена. Пример: 474acfe5-be34-494c-b339-50f06aa143e4 | |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Monty Taylor (@emonty)
- Haneef Ali (@haneefs)
Подсказка
Если вы заметите какие-либо проблемы в данной документации, вы можете изменить этот документ, чтобы улучшить его.
© 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_keystone_domain_module.html
