ovirt_users_facts - Получение фактов об одном или нескольких пользователях oVirt/RHV
Новая версия с 2.3.
Обзор
- Получение фактов об одном или нескольких пользователях oVirt/RHV.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться данный модуль.
- 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 (добавлено в 2.3) | Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. | |
| nested_attributes (добавлено в 2.3) | Указывает список атрибутов, которые следует получить из API. Этот параметр применяется только когда fetch_nested равен true. | |
| pattern | Поисковый термин, который принимается 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_users_facts:
pattern: name=john*
- debug:
var: ovirt_users
Возвращаемые значения
Общие значения возврата документированы здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_users список | При успехе. | Список словарей, описывающих пользователей. Атрибуты пользователя отображаются в ключах словаря, все атрибуты пользователей можно найти по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/user. |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Более подробную информацию можно найти в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, которые также поддерживаются сообществом 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.6/modules/ovirt_users_facts_module.html
