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

Примечание

Этот плагин входит в коллекцию community.general (версия 1.3.2).

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

Примечания

Примечание

Этот модуль возвращает переменную ovirt_users, которая содержит список пользователей. Вам нужно зарегистрировать результат с помощью ключевого слова register, чтобы использовать его.
Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/ovirt_user_facts_module.html