ovirt_user_facts – Получение фактов об одном или нескольких пользователях oVirt/RHV
Новое в версии 2.3.
Описание
- Получение фактов об одном или нескольких пользователях oVirt/RHV.
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- 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 логическое добавлен в 2.3 |
| Если да, модуль извлечёт дополнительные данные из API. Он извлечёт идентификаторы дисков, снимков VM и т.д. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав 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.3.0
Примеры
# 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. [сообщество]
Авторы
- 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.8/modules/ovirt_user_facts_module.html
