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

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

Описание

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

Псевдонимы: os_user_facts

Требования

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

openstacksdk
openstacksdk >= 0.12.0
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должна ждать служба сокетов перед тем, как сбросить таймаут для API-запросов. Если этот параметр опущен, он не будет передан библиотеке requests.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_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 raw		Именованное облако или конфигурация облака для работы. Если 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 булево	Варианты: no ← yes	Нужно ли проверять SSL API-запросы. До Ansible 2.3 это значение по умолчанию было `yes`. псевдонимы: verify
wait булево	Варианты: no yes ←	Должен ли 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
- os_user_info:
    cloud: awesomecloud
  register: result
- debug:
    msg: "{{ result.openstack_users }}"

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

# Gather information about a previously created user in a specific domain
- os_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
- os_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 строка	успешно	Имя пользователя

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Ricardo Carrillo Cruz (@rcarrillocruz)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/os_user_info_module.html