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 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 (добавлено в 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.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_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 по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/user. |
Статус
Этот модуль помечен как предварительный, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом 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.6/modules/ovirt_users_module.html
