Spec-Zone.ru › Ansible

Модуль openstack.cloud.identity_user_info — получение пользователей OpenStack Identity (Keystone)

Примечание

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

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

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

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

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

Краткое описание

  • Получение пользователей OpenStack Identity (Keystone).

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • 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, который можно использовать для проверки запросов API через SSL.

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.

domain

string

Имя или идентификатор домена, содержащего пользователя.

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

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

До 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 previously created users
  openstack.cloud.identity_user_info:
    cloud: awesomecloud

- name: Gather previously created user by name
  openstack.cloud.identity_user_info:
    cloud: awesomecloud
    name: demouser

- name: Gather previously created user in a specific domain
  openstack.cloud.identity_user_info:
    cloud: awesomecloud
    name: demouser
    domain: admindomain

- name: Gather previously created user with filters
  openstack.cloud.identity_user_info:
    cloud: awesomecloud
    name: demouser
    domain: admindomain
    filters:
      is_enabled: False

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

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

Ключ

Описание

users

list / элементы=dictionary

Словарь с описанием всех подходящих пользователей Identity.

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

default_project_id

string

Идентификатор проекта пользователя по умолчанию

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

description

string

Описание этого пользователя

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

domain_id

string

Идентификатор домена, содержащего пользователя

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

email

string

Адрес электронной почты пользователя

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

id

string

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

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

is_enabled

boolean

Флаг, указывающий, включён ли пользователь

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

links

dictionary

Ссылки на ресурс пользователя

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

name

string

Имя пользователя.

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

password

string

Стандартный тип учётных данных, используемый при аутентификации.

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

password_expires_at

string

Дата и время истечения срока действия пароля. Часовой пояс — UTC. Значение Null означает, что срок действия пароля не истекает.

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

username

string

Имя пользователя для Identity API v2 (OpenStack Pike или более ранней версии); в противном случае — Null.

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

Авторы

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

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

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

© 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_user_info_module.html

Spec-Zone.ru

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