ovirt_user – Модуль для управления пользователями в oVirt/RHV
Описание
- Модуль для управления пользователями в oVirt/RHV.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth словарь / обязательно | Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: | ||
| ca_file строка | Файл PEM, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с использованием этих сертификатов CA. Если параметр ca_file не задан, используется системное хранилище сертификатов CA.Значение по умолчанию задано переменной среды OVIRT_CAFILE. | ||
| headers словарь | Словарь HTTP-заголовков, которые будут добавлены к каждому API-запросу. | ||
| hostname строка | Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию задано переменной среды OVIRT_HOSTNAME. Требуется либо url, либо hostname. | ||
| insecure логическое |
| Логический флаг, указывающий, следует ли проверять сертификат TLS сервера и имя хоста. | |
| kerberos логическое |
| Логический флаг, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации. | |
| password строка / обязательно | Пароль пользователя. Значение по умолчанию задано переменной среды OVIRT_PASSWORD. | ||
| token строка | Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию задано переменной среды OVIRT_TOKEN. | ||
| url строка | Строка, содержащая API-URL сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задано переменной среды OVIRT_URL. Требуется либо url, либо hostname. | ||
| username строка / обязательно | Имя пользователя, например admin@internal. Значение по умолчанию задано переменной среды OVIRT_USERNAME. | ||
| authz_name - / обязательно | Провайдер авторизации пользователя. В предыдущих версиях oVirt/RHV известен как домен. псевдонимы: домен | ||
| fetch_nested логическое |
| Если истина, модуль извлечёт дополнительные данные из API. Он извлечёт идентификаторы дисков, снимков VM и т. д. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes. | |
| name - / обязательно | Имя пользователя для управления. В большинстве LDAP это uid пользователя, но в Active Directory необходимо указать UPN пользователя. | ||
| namespace - | Пространство имён, в котором находится пользователь. При использовании провайдера авторизации, хранящего пользователей на сервере LDAP, этот атрибут равен контексту именования сервера LDAP. | ||
| nested_attributes список | Указывает список атрибутов, которые должны быть извлечены из API. Этот параметр применяется только при fetch_nested равняется истина. | ||
| poll_interval целое число | По умолчанию: 3 | Количество секунд, которые модуль ожидает перед отправкой нового запроса о состоянии сущности. | |
| state - |
| Пользователь должен быть present/absent. | |
| timeout целое число | По умолчанию: 180 | Количество секунд, которые модуль должен ждать, пока экземпляр не перейдёт в нужное состояние. | |
| wait логическое |
| yes если модуль должен ждать, пока сущность не перейдёт в нужное состояние. | |
Примечания
Примечание
- Для использования этого модуля необходимо установить 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:
# 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. [community]
Авторы
- 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.9/modules/ovirt_user_module.html
