ovirt_users - Модуль для управления пользователями в oVirt/RHV
Новое в версии 2.3.
Обзор
- Модуль для управления пользователями в oVirt/RHV.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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-запросу. | |
| authz_name обязательно | Провайдер авторизации пользователя. В предыдущих версиях oVirt/RHV известен как домен. псевдонимы: домен | |
| fetch_nested (добавлено в 2.3) | Если True, модуль извлечёт дополнительные данные из API. Будет извлекаться информация об идентификаторах дисков, снимков VM и т. д. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes. | |
| name обязательно | Имя пользователя для управления. В большинстве LDAP это uid пользователя, но в Active Directory необходимо указать UPN пользователя. | |
| nested_attributes (добавлено в 2.3) | Указывает список атрибутов, которые должны быть извлечены из API. Этот параметр применяется только когда fetch_nested равен true. | |
| poll_interval | Значение по умолчанию: 3 | Количество секунд, в течение которых модуль ожидает, прежде чем отправить другой запрос для опроса состояния сущности. |
| state |
| Должен ли пользователь присутствовать/отсутствовать. |
| timeout | Значение по умолчанию: 180 | Время в секундах, в течение которого модуль должен ждать, пока экземпляр не перейдёт в нужное состояние. |
| wait |
True, если модуль должен ожидать, пока сущность не перейдёт в нужное состояние. |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0
Примеры
# 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_users:
name: user1
domain: example.com-authz
# Add user user1 from authorization provider example.com-authz
# In case of Active Directory specify UPN:
- ovirt_users:
name: user1@ad2.example.com
domain: example.com-authz
# Remove user user1 with authorization provider example.com-authz
- ovirt_users:
state: absent
name: user1
authz_name: example.com-authz
Возвращаемые значения
Общие значения возврата документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id str | При успехе, если пользователь найден. | Идентификатор управляемого пользователя Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| user dict | При успехе, если пользователь найден. | Словарь всех атрибутов пользователя. Атрибуты пользователя можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/user. |
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется обратной совместимости.
Автор
- 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.5/modules/ovirt_users_module.html
