os_keystone_domain - Управление областями 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 | Описание домена | |
| enabled bool |
| Домен включен |
| 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, затем из стандартных переменных среды, и, наконец, из явных параметров в задачах. Дополнительную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config
Примеры
# 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' | Словарь, описывающий домен. | |
| id строка | Идентификатор домена. Пример: 474acfe5-be34-494c-b339-50f06aa143e4 | ||
| name строка | Имя домена. Пример: demo | ||
| description строка | Описание домена. Пример: Демонстрационный домен | ||
| enabled булево | Описание домена. Пример: True | ||
| id строка | При успехе, когда state — 'present' | Идентификатор домена. Пример: 474acfe5-be34-494c-b339-50f06aa143e4 | |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантированно будет совместим с предыдущими версиями.
Техническое обслуживание
Этот модуль помечен как community, что означает, что его поддерживает сообщество Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, поддерживаемых сообществом 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.6/modules/os_keystone_domain_module.html
