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

Примечание

Этот плагин является частью коллекции community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general

Для использования в книге задач укажите: community.general.ovirt_user_facts

УСТАРЕВШЕ
Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕВШЕ

Удалено в: версии 3.0.0
Почему: При миграции на коллекцию мы решили использовать только модули _info.
Альтернатива: Используйте ovirt.ovirt.ovirt_user_info вместо этого.

Описание

Получение информации об одном или нескольких пользователях 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 вместо стандартной аутентификации по протоколу Basic. `headers` - Словарь HTTP-заголовков, которые необходимо добавить к каждому API-запросу.
fetch_nested булево	Варианты: нет ← да	Если да, модуль будет получать дополнительные данные из API. Он будет получать только идентификаторы вложенных сущностей. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить получение других атрибутов вложенных сущностей, указав `nested_attributes`.
nested_attributes список / элементы=строка		Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда `fetch_nested` равен true.
pattern строка		Критерий поиска, который принимается бэкендом поиска oVirt/RHV. Например, для поиска пользователя X используйте следующий шаблон: name=X

Примечания

Примечание

Этот модуль возвращает переменную ovirt_users, которая содержит список пользователей. Вам нужно зарегистрировать результат с помощью ключевого слова register, чтобы использовать его.
Для использования этого модуля необходимо установить Python SDK для oVirt. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: ansible.builtin.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:

- name: Gather information about all users which first names start with john
  ovirt_user_info:
    pattern: name=john*
  register: result

- name: Print gathered information
  ansible.builtin.debug:
    msg: "{{ result.ovirt_users }}"

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

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

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

Статус

Этот модуль будет удалён в версии 3.0.0. [устаревший]
Дополнительная информация см. в разделе УСТАРЕВШЕ.

Авторы

Ondra Machacek (@machacekondra)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/ovirt_user_facts_module.html