openstack.cloud.identity_user_info – Получение информации об одном или нескольких пользователях OpenStack

Примечание

Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

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

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

Обзор

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

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

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

Примечания

Примечание

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

Примеры

# Gather information about previously created users
- openstack.cloud.identity_user_info:
    cloud: awesomecloud
  register: result
- debug:
    msg: "{{ result.openstack_users }}"

# Gather information about a previously created user by name
- openstack.cloud.identity_user_info:
    cloud: awesomecloud
    name: demouser
  register: result
- debug:
    msg: "{{ result.openstack_users }}"

# Gather information about a previously created user in a specific domain
- openstack.cloud.identity_user_info:
    cloud: awesomecloud
    name: demouser
    domain: admindomain
  register: result
- debug:
    msg: "{{ result.openstack_users }}"

# Gather information about a previously created user in a specific domain with filter
- openstack.cloud.identity_user_info:
    cloud: awesomecloud
    name: demouser
    domain: admindomain
    filters:
      enabled: False
  register: result
- debug:
    msg: "{{ result.openstack_users }}"

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

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

Ключ		Возвращаемое значение	Описание
openstack_users сложный		всегда, но может быть null	содержит всю информацию OpenStack о пользователях
	default_project_id строка	успех	ID проекта по умолчанию пользователя
	domain_id строка	успех	ID домена, содержащего пользователя
	email строка	успех	Электронная почта пользователя
	enabled логическое значение	успех	Флаг, указывающий, включен ли пользователь
	id строка	успех	Уникальный UUID.
	name строка	успех	Имя пользователя.
	username строка	успех	Имя пользователя

Авторы

OpenStack Ansible SIG

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