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

Примечание

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

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

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

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

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

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должна ждать транспортный уровень сокета перед истечением времени ожидания для вызовов API. Если этот параметр опущен, в библиотеку запросов ничего не будет передано.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для подключаемого модуля по умолчанию password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если их поддерживает облако. Для других подключаемых модулей этот параметр должен содержать необходимые параметры подключаемого модуля авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type строка		Имя подключаемого модуля авторизации для использования. Если облако использует что-то кроме аутентификации по паролю, имя подключаемого модуля должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone строка		Игнорируется. Присутствует для обратной совместимости.
ca_cert строка		Путь к пакету сертификатов CA, который может использоваться при проверке запросов API SSL. Псевдонимы: 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 строка	Варианты: админ внутренний общедоступный ←	Тип URL конечной точки для извлечения из каталога сервиса. Псевдонимы: endpoint_type
name строка / требуется		Имя, которое должно быть присвоено экземпляру
region_name строка		Имя региона.
state строка	Варианты: present ← absent	Должен ли ресурс присутствовать или отсутствовать.
timeout целое число	По умолчанию: 180	Сколько времени Ansible должен ждать запрашиваемого ресурса.
validate_certs логическое значение	Варианты: нет ← да	Нужно ли проверять запросы API SSL. В 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 complex		При успехе, когда state — 'present'	Словарь, описывающий домен.
	description string	успех	Описание домена. Пример: Демонстрационный домен
	enabled boolean	успех	Описание домена. Пример: True
	id string	успех	Идентификатор домена. Пример: 474acfe5-be34-494c-b339-50f06aa143e4
	name string	успех	Имя домена. Пример: demo
id string		При успехе, когда 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/os_keystone_domain_module.html