openstack.cloud.os_keystone_domain_info – Получение информации об одном или нескольких домен OpenStack

Примечание

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

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

Для использования в playbook, укажите: openstack.cloud.os_keystone_domain_info.

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

Обзор

Получение информации об одном или нескольких домен OpenStack
Этот модуль назывался openstack.cloud.identity_domain_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль openstack.cloud.identity_domain_info больше не возвращает ansible_facts!

Требования

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

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.
filters словарь		Словарь метаданных для дальнейшей фильтрации. Элементы этого словаря могут быть дополнительными словарями.
interface строка	Варианты: admin internal public ←	Тип URL-адреса конечной точки для извлечения из каталога сервиса. псевдонимы: endpoint_type
name строка		Имя или идентификатор домена
region_name строка		Имя региона.
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, затем из стандартных переменных среды, а затем из явных параметров в playbooks. Более подробную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/

Примеры

# Gather information about previously created domain
- openstack.cloud.identity_domain_info:
    cloud: awesomecloud
  register: result
- debug:
    msg: "{{ result.openstack_domains }}"

# Gather information about a previously created domain by name
- openstack.cloud.identity_domain_info:
    cloud: awesomecloud
    name: demodomain
  register: result
- debug:
    msg: "{{ result.openstack_domains }}"

# Gather information about a previously created domain with filter
- openstack.cloud.identity_domain_info:
    cloud: awesomecloud
    name: demodomain
    filters:
      enabled: false
  register: result
- debug:
    msg: "{{ result.openstack_domains }}"

Возвращаемые значения

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

Ключ		Возвращаемое значение	Описание
openstack_domains сложный		всегда, но может быть null	содержит всю информацию OpenStack о доменах
	description строка	успех	Описание домена.
	enabled логическое значение	успех	Флаг, указывающий, включён ли домен.
	id строка	успех	Уникальный UUID.
	name строка	успех	Имя, присвоенное домену.

Авторы

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_info_module.html