Модуль openstack.cloud.identity_domain_info – Получение доменной информации идентификации (Keystone) из облака OpenStack

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Чтобы использовать его в плейбуке, укажите: openstack.cloud.identity_domain_info.

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

Обзор

Получение доменной информации идентификации (Keystone) из облака OpenStack

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout целое число	Сколько времени в секундах должен ждать слой сокета, прежде чем истечёт время ожидания для вызовов API. Если это значение опущено, в библиотеку запросов ничего не передаётся.
auth словарь	Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые этому плагину авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка	Имя плагина авторизации для использования. Если облако использует что-то кроме парольной авторизации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
ca_cert псевдонимы: cacert строка	Путь к пакету сертификата CA, который может использоваться для проверки запросов API SSL.
client_cert псевдонимы: cert строка	Путь к клиенту сертификату для использования в рамках транзакции SSL.
client_key псевдонимы: key строка	Путь к ключу клиента для использования в рамках транзакции SSL.
cloud любой	Наименованное облако или конфигурация облака для работы с ним. Если cloud — строка, она ссылается на конфигурацию имени облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если задан auth или присутствуют переменные окружения OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
filters словарь	Словарь метаданных для использования в фильтрации. Элементы этого словаря могут быть дополнительными словарями.
interface псевдонимы: endpoint_type строка	Тип URL конечной точки, который необходимо получить из каталога сервисов. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name строка	Имя или ID домена
region_name строка	Имя региона.
sdk_log_level строка	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается
timeout целое число	Сколько времени Ansible должен ждать запрошенного ресурса. По умолчанию: `180`
validate_certs псевдонимы: verify булево	Должны ли проверяться запросы API SSL. До Ansible 2.3 это значение по умолчанию было `true`. Варианты: `false` `true`
wait булево	Должен ли Ansible ждать, пока запрошенный ресурс будет завершён. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Стандартные переменные окружения OpenStack, такие как OS_USERNAME могут быть использованы вместо явного указания значений.
Информация об авторизации управляется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, и, наконец, из явных параметров в задачах. Более подробную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/

Примеры

- name: Gather information about previously created domain
  openstack.cloud.identity_domain_info:
    cloud: awesomecloud

- name: Gather information about a previously created domain by name
  openstack.cloud.identity_domain_info:
    cloud: awesomecloud
    name: demodomain

- name: Gather information about a previously created domain with filter
  openstack.cloud.identity_domain_info:
    cloud: awesomecloud
    name: demodomain
    filters:
      is_enabled: false

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

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

Ключ	Описание
domains список / элементы=словарь	Список словарей, описывающих домены OpenStack Возвращается: всегда
description строка	Описание домена. Возвращается: успешно
id строка	Уникальный UUID. Возвращается: успешно
is_enabled логическое	Флаг, указывающий, включен ли домен. Возвращается: успешно
links список / элементы=строка	Ссылки, относящиеся к ресурсу домена Возвращается: успешно
name строка	Наименование домена. Возвращается: успешно

Авторы

OpenStack Ansible SIG

Ссылки на коллекцию

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