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

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

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое сопровождение
- Автор

Обзор

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

Требования

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

openstacksdk
python >= 2.7

Параметры

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

Примечания

Примечание

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

Примеры

# 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 о пользователях
	id строка	успех	Уникальный UUID.
	name строка	успех	Имя пользователя.
	enabled bool	успех	Флаг, указывающий, включен ли пользователь.
	domain_id строка	успех	ID домена, содержащего пользователя.
	default_project_id строка	успех	ID проекта по умолчанию для пользователя.
	email строка	успех	Электронная почта пользователя.
	username строка	успех	Имя пользователя.

Статус

Этот модуль помечен как превью, что означает, что гарантии обратной совместимости нет.

Техническое сопровождение

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое сопровождение модулей для получения дополнительной информации.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

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.6/modules/os_user_facts_module.html