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

Новое в версии 2.1.

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

Описание

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

Требования

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

openstacksdk
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 -		Имя или идентификатор домена, содержащего пользователя, если облако поддерживает домены
filters -		Словарь метаданных для дальнейшего фильтрации. Элементы этого словаря могут быть дополнительными словарями.
interface строка добавлено в 2.3	Варианты: admin internal public ←	Тип URL конечной точки для получения данных из каталога сервисов. псевдонимы: endpoint_type
name - / обязательно		Имя или идентификатор пользователя
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 facts about previously created users
- os_user_facts:
    cloud: awesomecloud
- debug:
    var: openstack_users

# Gather facts about a previously created user by name
- os_user_facts:
    cloud: awesomecloud
    name: demouser
- debug:
    var: openstack_users

# Gather facts about a previously created user in a specific domain
- os_user_facts:
    cloud: awesomecloud
    name: demouser
    domain: admindomain
- debug:
    var: openstack_users

# Gather facts about a previously created user in a specific domain with filter
- os_user_facts:
    cloud: awesomecloud
    name: demouser
    domain: admindomain
    filters:
      enabled: False
- debug:
    var: openstack_users

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

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

Ключ		Возвращаемое значение	Описание
openstack_users сложное		всегда, но может быть null	содержит все данные OpenStack о пользователях
	default_project_id строка	успех	Идентификатор проекта по умолчанию пользователя
	domain_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.8/modules/os_user_facts_module.html