openstack.cloud.identity_domain – Управление доменными именами OpenStack Identity

Примечание

Этот плагин входит в состав коллекции openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

Для использования в книге задач укажите: openstack.cloud.identity_domain.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Создание, обновление или удаление доменов OpenStack Identity. Если домен с указанным именем уже существует, он будет обновлён с новым описанием и включёнными атрибутами.

Требования

Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени (в секундах) слой сокета должен ждать перед таймаутом для вызовов API. Если этот параметр опущен, он не будет передан в библиотеку requests.
auth словарь		Словарь, содержащий информацию об аутентификации, необходимую стратегии подключаемого модуля аутентификации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или 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 строка	Варианты: admin internal public ←	Тип URL конечной точки для извлечения из каталога услуг. псевдонимы: endpoint_type
name строка / обязательно		Имя, которое должно быть предоставлено экземпляру
region_name строка		Имя региона.
state строка	Варианты: present ← absent	Должен ли ресурс быть присутствующим или отсутствующим.
timeout целое число	По умолчанию: 180	Сколько времени Ansible должен ждать запрошенного ресурса.
validate_certs булево	Варианты: нет ← да	Необходимо ли проверять запросы SSL API. До Ansible 2.3 это по умолчанию было `yes`. псевдонимы: verify
wait булево	Варианты: нет да ←	Должен ли 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
- openstack.cloud.identity_domain:
     cloud: mycloud
     state: present
     name: demo
     description: Demo Domain

# Delete a domain
- openstack.cloud.identity_domain:
     cloud: mycloud
     state: absent
     name: demo

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для этого модуля:

Ключ		Возвращаемое значение	Описание
domain сложный		При успехе, когда state равен 'present'	Словарь, описывающий домен.
	description строка	успех	Описание домена. Пример: Демонстрационный домен
	enabled булево	успех	Описание домена. Пример: True
	id строка	успех	Идентификатор домена. Пример: 474acfe5-be34-494c-b339-50f06aa143e4
	name строка	успех	Имя домена. Пример: demo
id строка		При успехе, когда state равен 'present'	Идентификатор домена. Пример: 474acfe5-be34-494c-b339-50f06aa143e4

Авторы

OpenStack Ansible SIG

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/identity_domain_module.html