ovirt_user_facts – Получение фактов об одном или нескольких пользователях oVirt/RHV
Новая версия 2.3.
Обзор
- Получение фактов об одном или нескольких пользователях oVirt/RHV.
Псевдонимы: ovirt_users_facts
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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 boolean добавлен в 2.3 |
| Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков, снимков VM и т. д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. |
| nested_attributes - добавлен в 2.3 | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда fetch_nested равен true. | |
| pattern - | Поисковый термин, который принимается back-end поиска oVirt/RHV. Например, для поиска пользователя X используйте следующий шаблон: name=X |
Примечания
Примечание
- Этот модуль создает новый факт верхнего уровня
ovirt_users, который содержит список пользователей. - Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.2.4
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Gather facts about all users which first names start with C(john):
- ovirt_user_facts:
pattern: name=john*
- debug:
var: ovirt_users
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_users список | При успехе. | Список словарей, описывающих пользователей. Атрибуты пользователя сопоставлены с ключами словаря, все атрибуты пользователей можно найти по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/user. |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/ovirt_user_facts_module.html
