Spec-Zone.ru › Ansible

Модуль openstack.cloud.identity_domain_info — получение доменов идентификации (Keystone) из облака OpenStack

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.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

integer

Время ожидания перед истечением времени ожидания вызова API на уровне сокета. Если параметр не указан, в библиотеку requests ничего не передаётся.

auth

dictionary

Словарь с данными аутентификации, необходимыми выбранной стратегии плагина аутентификации облака. Для стандартного плагина password он содержит auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все параметры, необходимые соответствующему плагину аутентификации. Этот параметр не требуется, если указано именованное облако или заданы переменные окружения OpenStack OS_*.

auth_type

string

Имя используемого плагина аутентификации. Если облако использует не аутентификацию по паролю, укажите здесь имя плагина и соответствующим образом настройте параметр auth.

ca_cert

псевдонимы: cacert

string

Путь к пакету сертификатов CA, который можно использовать для проверки запросов SSL API.

client_cert

псевдонимы: cert

string

Путь к клиентскому сертификату, используемому при SSL-соединении.

client_key

псевдонимы: key

string

Путь к клиентскому ключу, используемому при SSL-соединении.

cloud

any

Именованное облако или конфигурация облака, с которыми будет выполняться работа. Если cloud — строка, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Задаёт значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или заданы переменные окружения OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу в файле clouds.yaml.

filters

dictionary

Словарь метаданных для фильтрации.

Элементы этого словаря могут быть дополнительными словарями.

interface

псевдонимы: endpoint_type

string

Тип URL конечной точки, используемой для получения данных из каталога служб.

Варианты:

  • "admin"
  • "internal"
  • "public" ← (по умолчанию)

name

string

Имя или идентификатор домена

region_name

string

Имя региона.

sdk_log_level

string

Уровень ведения журнала OpenStackSDK

Варианты:

  • "INFO" ← (по умолчанию)
  • "DEBUG"

sdk_log_path

string

Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не ведётся.

timeout

integer

Как долго Ansible должен ожидать запрошенный ресурс.

По умолчанию: 180

validate_certs

псевдонимы: verify

boolean

Следует ли проверять запросы SSL API.

До Ansible 2.3 значением по умолчанию было true.

Варианты:

  • false
  • true

wait

boolean

Должен ли 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

list / elements=dictionary

Список словарей с описанием доменов OpenStack

Возвращается: всегда

description

string

Описание домена.

Возвращается: при успешном выполнении

id

string

Уникальный UUID.

Возвращается: при успешном выполнении

is_enabled

boolean

Признак того, что домен включён.

Возвращается: при успешном выполнении

links

list / elements=string

Ссылки, связанные с ресурсом домена

Возвращается: при успешном выполнении

name

string

Имя, присвоенное домену.

Возвращается: при успешном выполнении

Авторы

  • Специальная группа Ansible по OpenStack

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API