ovirt_users_facts - Получение фактов об одном или нескольких пользователях oVirt/RHV
Новое в версии 2.3.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Получение фактов об одном или нескольких пользователях oVirt/RHV.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- ovirt-engine-sdk-python >= 4.0.0
Параметры
| параметр | обязательно | по умолчанию | значения | комментарии |
|---|---|---|---|---|
| auth | да | Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: username[обязательно] - Имя пользователя, например admin@internal. Значение по умолчанию задается переменной окружения OVIRT_USERNAME.password[обязательно] - Пароль пользователя. Значение по умолчанию задается переменной окружения OVIRT_PASSWORD.url[обязательно] - Строка, содержащая базовый URL сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задается переменной окружения OVIRT_URL.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 |
Примеры
# 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. | При успешном выполнении. | список |
Примечания
Примечание
- Этот модуль создает новый факт верхнего уровня
ovirt_users, содержащий список пользователей. - Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0
Статус
Этот модуль помечен как бета-версия, что означает, что его интерфейс не гарантируется как обратной совместимый.
Для получения помощи в разработке модулей, если вы так склонны, пожалуйста, прочтите Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ovirt_users_facts_module.html