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

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

Описание

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

Псевдонимы: os_keystone_domain_facts

Требования

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

openstacksdk >= 0.12.0
python >= 2.7
sdk

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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, который может использоваться для проверки запросов 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
- os_keystone_domain_info:
    cloud: awesomecloud
  register: result
- debug:
    msg: "{{ result.openstack_domains }}"

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

# Gather information about a previously created domain with filter
- os_keystone_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 строка	успешно	Имя, присвоенное домену.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [предварительная версия]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Ricardo Carrillo Cruz (@rcarrillocruz)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/os_keystone_domain_info_module.html