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

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

Обзор

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

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

Требования

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

python >= 2.7
ovirt-engine-sdk-python >= 4.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth словарь / обязательный		Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: `username`[обязательный] - Имя пользователя, например admin@internal. Значение по умолчанию устанавливается переменной среды OVIRT_USERNAME. `password`[обязательный] - Пароль пользователя. Значение по умолчанию устанавливается переменной среды OVIRT_PASSWORD. `url`- Строка, содержащая URL API сервера, обычно в формате `https://server.example.com/ovirt-engine/api`. Значение по умолчанию устанавливается переменной среды OVIRT_URL. Требуется либо `url` либо `hostname`. `hostname` - Строка, содержащая имя хоста сервера, обычно в формате `server.example.com`. Значение по умолчанию устанавливается переменной среды OVIRT_HOSTNAME. Требуется либо `url` либо `hostname`. `token` - Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию устанавливается переменной среды OVIRT_TOKEN. `insecure` - Флаг булевого типа, указывающий, нужно ли проверять сертификат TLS сервера и имя хоста. `ca_file` - Файл PEM, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с помощью этих сертификатов CA. Если параметр ``ca_file`` не задан, используется системный хранилище сертификатов CA. Значение по умолчанию устанавливается переменной среды OVIRT_CAFILE. `kerberos` - Флаг булевого типа, указывающий, нужно ли использовать аутентификацию Kerberos вместо стандартной аутентификации. `headers` - Словарь HTTP-заголовков, которые должны быть добавлены к каждому API-запросу.
fetch_nested логическое	Варианты: нет да	Если да, модуль получит дополнительные данные из API. Он получит только идентификаторы вложенной сущности. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить получение других атрибутов вложенных сущностей, указав `nested_attributes`.
nested_attributes список		Указывает список атрибутов, которые необходимо получить из API. Этот параметр применяется только когда `fetch_nested` равен true.
pattern -		Критерий поиска, принятый поисковым механизмом oVirt/RHV. Например, для поиска пользователя X используйте следующий шаблон: name=X

Примечания

Примечание

Этот модуль возвращает переменную ovirt_users, которая содержит список пользователей. Вам нужно зарегистрировать результат с помощью ключевого слова register, чтобы использовать его.
Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.3.0

Примеры

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Gather information about all users which first names start with C(john):
- ovirt_user_info:
    pattern: name=john*
  register: result
- debug:
    msg: "{{ result.ovirt_users }}"

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

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

Ключ	Возвращаемое значение	Описание
ovirt_users список	При успехе.	Список словарей, описывающих пользователей. Атрибуты пользователя сопоставлены с ключами словаря, все атрибуты пользователей можно найти по следующему URL-адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/user.

Статус

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

Авторы

Ondra Machacek (@machacekondra)

Подсказка

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

© 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/ovirt_user_info_module.html