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 boolean |
| Домен включён |
| interface - добавлено в 2.3 |
| Тип URL конечной точки, который нужно получить из каталога сервисов. псевдонимы: endpoint_type |
| key - | Путь к клиентскому ключу, который нужно использовать в рамках транзакции SSL. | |
| name - / обязательно | Имя, которое должно быть присвоено экземпляру | |
| region_name - | Имя региона. | |
| state - |
| Ресурс должен быть present или absent. |
| timeout - | По умолчанию: 180 | Сколько времени Ansible должен ждать требуемого ресурса. |
| verify boolean |
| Нужно ли проверять запросы SSL API. До версии 2.3 это значение по умолчанию было True. псевдонимы: validate_certs |
| wait boolean |
| 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' | Словарь, описывающий домен. | |
| description строка | Описание домена. Пример: Демонстрационный домен | ||
| enabled boolean | Описание домена. Пример: True | ||
| id строка | ID домена. Пример: 474acfe5-be34-494c-b339-50f06aa143e4 | ||
| name строка | Имя домена. Пример: demo | ||
| id строка | При успехе, когда state равен 'present' | ID домена. Пример: 474acfe5-be34-494c-b339-50f06aa143e4 | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Монти
- Ханeef Али
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/os_keystone_domain_module.html
