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

Примечание

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

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

Для использования в книге задач укажите: openstack.cloud.os_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, который может быть использован для проверки запросов API SSL. псевдонимы: cacert
client_cert строка		Путь к клиенту сертификат для использования в рамках транзакции SSL. псевдонимы: cert
client_key строка		Путь к ключу клиента для использования в рамках транзакции SSL. псевдонимы: key
cloud необработанный		Именованное облако или конфигурация облака для работы с ним. Если cloud — строка, она ссылается на конфигурацию именованного облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если задан auth или присутствуют переменные среды OpenStack OS_* . Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
domain строка		Имя или идентификатор домена, содержащего пользователя, если облако поддерживает домены
filters словарь		Словарь метаданных для дальнейшего фильтрации. Элементы этого словаря могут быть дополнительными словарями.
interface строка	Варианты: admin internal public ←	Тип URL-адреса конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type
name строка		Имя или идентификатор пользователя
region_name строка		Имя региона.
timeout целое число	По умолчанию: 180	Сколько времени Ansible должен ждать запрошенного ресурса.
validate_certs логическое	Варианты: нет ← да	Нужно ли проверять запросы API SSL. До 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 сложное		всегда, но может быть нулевым	содержит всю информацию OpenStack о пользователях
	default_project_id строка	успешно	Идентификатор проекта по умолчанию пользователя
	domain_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/os_user_info_module.html