ovirt_users — Модуль для управления пользователями в oVirt/RHV
Новый в версии 2.3.
- Обзор
- Требования (для хоста, на котором выполняется модуль)
- Параметры
- Примеры
- Значения возврата
- Примечания
Обзор
- Модуль для управления пользователями в oVirt/RHV.
Требования (для хоста, на котором выполняется модуль)
- python >= 2.7
- ovirt-engine-sdk-python >= 4.0.0
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| 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. Он получит идентификаторы дисков, снимков и т. д. для виртуальных машин. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. | ||
| name | да | Имя пользователя для управления. В большинстве LDAP это uid пользователя, но в Active Directory необходимо указать UPN пользователя. | ||
| nested_attributes (добавлен в 2.3)
| нет | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда fetch_nested равен true. | ||
| poll_interval | нет | 3 | Количество секунд, в течение которого модуль ожидает, прежде чем отправить еще один запрос опроса о состоянии сущности. | |
| state | нет | present |
| Пользователь должен быть present/absent. |
| timeout | нет | 180 | Количество секунд, в течение которого модуль должен ждать, пока экземпляр не перейдет в требуемое состояние. | |
| wait | нет |
True, если модуль должен ждать, пока сущность перейдет в желаемое состояние. |
Примеры
# 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 | ID управляемого пользователя | При успехе, если пользователь найден. | str | 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| user | Словарь всех атрибутов пользователя. Атрибуты пользователя можно найти на вашей установке oVirt/RHV по следующему URL-адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/user. | При успехе, если пользователь найден. | dict |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0
Статус
Этот модуль помечен как preview, что означает, что гарантии обратной совместимости интерфейса нет.
Для получения помощи в разработке модулей, если у вас есть такое желание, пожалуйста, ознакомьтесь с Информацией сообщества и участием в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ovirt_users_module.html
