ovirt_user – Модуль управления пользователями в oVirt/RHV

Новое в версии 2.3.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Модуль для управления пользователями в oVirt/RHV.

Псевдонимы: ovirt_users

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

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-запросу.
authz_name - / обязательно		Провайдер авторизации пользователя. В предыдущих версиях oVirt/RHV известен как домен. Псевдонимы: домен
fetch_nested boolean добавлено в 2.3	Варианты: no yes	Если True, модуль загрузит дополнительные данные из API. Будут загружены ID дисков, снимков и т.д. пользователя. Пользователь может настроить загрузку других атрибутов вложенных сущностей, указав `nested_attributes`.
name - / обязательно		Имя пользователя для управления. В большинстве LDAP это uid пользователя, но в Active Directory необходимо указать UPN пользователя.
namespace -		Пространство имен, в котором находится пользователь. При использовании провайдера авторизации, хранящего пользователей на сервере LDAP, этот атрибут равен контексту именования сервера LDAP.
nested_attributes - добавлено в 2.3		Указывает список атрибутов, которые необходимо загрузить из API. Этот параметр применяется только если `fetch_nested` равен true.
poll_interval -	По умолчанию: 3	Количество секунд, которое модуль ожидает перед отправкой нового запроса на проверку статуса сущности.
state -	Варианты: present ← absent	Пользователь должен быть present/absent.
timeout -	По умолчанию: 180	Время в секундах, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние.
wait boolean	Варианты: no yes ←	True, если модуль должен ждать, пока сущность перейдет в нужное состояние.

Примечания

Примечание

Для использования этого модуля необходимо установить 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:

# Add user user1 from authorization provider example.com-authz
- ovirt_user:
    name: user1
    domain: example.com-authz

# Add user user1 from authorization provider example.com-authz
# In case of Active Directory specify UPN:
- ovirt_user:
    name: user1@ad2.example.com
    domain: example.com-authz

# Remove user user1 with authorization provider example.com-authz
- ovirt_user:
    state: absent
    name: user1
    authz_name: example.com-authz

Значения возврата

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

Ключ	Возвращаемое значение	Описание
id строка	При успешном поиске пользователя.	Идентификатор управляемого пользователя. Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c
user словарь	При успешном поиске пользователя.	Словарь всех атрибутов пользователя. Атрибуты пользователя можно найти на вашем экземпляре oVirt/RHV по следующему 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.7/modules/ovirt_user_module.html