os_keystone_domain - Управление доменами идентификации OpenStack
Новая версия 2.1.
Обзор
- Создание, обновление или удаление доменов идентификации OpenStack. Если домен с указанным именем уже существует, он будет обновлён с новым описанием и атрибутами включения.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени должно ждать сокетное соединение перед истечением времени ожидания для API-вызовов. Если этот параметр опущен, он не будет передан библиотеке requests. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые для работы плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type | Имя плагина авторизации для использования. Если облако использует что-то другое, кроме парольной аутентификации, здесь должно быть указано имя плагина, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | Игнорируется. Присутствует для обратной совместимости | |
| cacert | Путь к файлу CA Cert-пакета, который может использоваться при проверке SSL API-запросов. | |
| cert | Путь к клиенту сертификата для использования в рамках SSL-транзакции. | |
| cloud | Имя облака или конфигурация облака для работы. Если cloud — строка, она ссылается на конфигурацию облака с именем, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен параметр auth или присутствуют переменные окружения OpenStack OS_* . Если cloud — словарь, он содержит полную конфигурацию облака, как в секции clouds.yaml. | |
| description | По умолчанию: None | Описание домена |
| enabled | По умолчанию: да | Включён ли домен |
| interface (добавлен в 2.3) |
| Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| key | Путь к клиентскому ключу для использования в рамках SSL-транзакции. | |
| name обязательно | Имя, которое должно быть присвоено экземпляру | |
| region_name | Имя региона. | |
| state |
| Должен ли ресурс быть присутствующим или отсутствующим. |
| timeout | По умолчанию: 180 | Сколько времени Ansible должно ждать запрашиваемого ресурса. |
| verify |
| Следует ли проверять SSL API-запросы. До версии 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, затем из стандартных переменных окружения, и, наконец, из явных параметров в play. Более подробная информация доступна по адресу 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' | Словарь, описывающий домен. | |
| enabled булево | Описание домена. Пример: True | ||
| description строка | Описание домена. Пример: Демо-домен | ||
| name строка | Имя домена. Пример: demo | ||
| id строка | ID домена. Пример: 474acfe5-be34-494c-b339-50f06aa143e4 | ||
| id строка | При успехе, когда state равен 'present' | ID домена. Пример: 474acfe5-be34-494c-b339-50f06aa143e4 | |
Статус
Этот модуль помечен как preview, что означает, что гарантия обратной совместимости интерфейса не предоставляется.
Автор
- Монти
- Ханиф Али
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_keystone_domain_module.html
