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

Примечание

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

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

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

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

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

Описание

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

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout integer	Как долго слой сокета должен ожидать перед истечением времени ожидания для вызовов API. Если это пропущено, ничего не будет передано в библиотеку запросов.
auth dictionary	Словарь, содержащий информацию об аутентификации, необходимую стратегии плагина аутентификации облака. Для плагина password по умолчанию это будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен будет содержать любые параметры, требуемые этим плагином аутентификации. Этот параметр не требуется, если предоставлено имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type string	Имя плагина аутентификации для использования. Если облако использует что-то другое, кроме парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть обновлено соответствующим образом.
ca_cert aliases: cacert string	Путь к пакету сертификатов CA, который может использоваться в качестве части проверки запросов SSL API.
client_cert aliases: cert string	Путь к клиентскому сертификату, используемому как часть транзакции SSL.
client_key aliases: key string	Путь к клиентскому ключу, используемому как часть транзакции SSL.
cloud any	Именованное облако или конфигурация облака, с которым нужно работать. Если cloud — это строка, она ссылается на именованную конфигурацию облака, определенную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если предоставлен auth или если присутствуют переменные среды OpenStack OS_. Если cloud* — это словарь, он содержит полную конфигурацию облака, как это было бы в разделе clouds.yaml.
domain string	Имя или ID домена, содержащего пользователя.
filters dictionary	Словарь метаданных для использования для дополнительной фильтрации. Элементы этого словаря могут быть дополнительными словарями.
interface aliases: endpoint_type string	Тип URL конечной точки для получения из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name string	Имя или ID пользователя.
region_name string	Имя региона.
sdk_log_level string	Уровень логирования OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается
timeout integer	Как долго ansible должен ожидать запрашиваемый ресурс. По умолчанию: `180`
validate_certs aliases: 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 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 список / элементы=словарь	Словарь, описывающий всех соответствующих пользователей идентификации. Возвращается: всегда
default_project_id строка	Идентификатор проекта по умолчанию пользователя Возвращается: успех
description строка	Описание этого пользователя Возвращается: успех
domain_id строка	Идентификатор домена, содержащего пользователя Возвращается: успех
email строка	Электронная почта пользователя Возвращается: успех
id строка	Уникальный UUID. Возвращается: успех
is_enabled булево	Флаг, указывающий, включен ли пользователь Возвращается: успех
links словарь	Ссылки на ресурс пользователя Возвращается: успех
name строка	Имя пользователя. Возвращается: успех
password строка	Стандартный вид учетных данных, используемых при аутентификации. Возвращается: успех
password_expires_at строка	Дата и время истечения срока действия пароля. Временная зона — UTC. Значение Null означает, что пароль никогда не истекает. Возвращается: успех
username строка	Имя пользователя с API v2 идентификации (OpenStack Pike или более ранние версии), в противном случае Null. Возвращается: успех

Авторы

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