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 и любую информацию о доменах (например, 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 строка добавлен в версии 2.3 |
| Тип URL конечной точки для извлечения из каталога сервисов. Псевдонимы: endpoint_type |
| name - / обязательно | Имя, которое должно быть присвоено экземпляру | |
| region_name строка | Имя региона. | |
| state - |
| Должен ли ресурс присутствовать или отсутствовать. |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| validate_certs булево значение |
| Нужно ли проверять SSL запросы API. До Ansible 2.3 по умолчанию было yes. Псевдонимы: verify |
| Ожидание boolean |
| Должен ли Ansible ожидать завершения запрошенного ресурса. |
Примечания
Примечание
- Могут быть использованы стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и, наконец, из явных параметров в задачах. Более подробную информацию можно найти на сайте 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
Значения возврата
Общие значения возврата описаны здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| домен сложный | При успехе, когда состояние равно 'present' | Словарь, описывающий домен. | |
| описание строка | Описание домена. Пример: Демонстрационный домен | ||
| активирован boolean | Описание домена. Пример: True | ||
| идентификатор строка | Идентификатор домена. Пример: 474acfe5-be34-494c-b339-50f06aa143e4 | ||
| имя строка | Имя домена. Пример: demo | ||
| идентификатор строка | При успехе, когда состояние равно 'present' | Идентификатор домена. Пример: 474acfe5-be34-494c-b339-50f06aa143e4 | |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Данный модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.8/modules/os_keystone_domain_module.html
