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