ovirt_permissions - Модуль для управления разрешениями пользователей/групп в 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 обязательно | Поставщик авторизации пользователя/группы. псевдонимы: домен | |
| fetch_nested (добавлено в 2.3) | Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить запрос других атрибутов вложенных сущностей, указав nested_attributes. | |
| group_name | Имя группы для управления. Обратите внимание, что если группа не существует в системе, этот модуль завершит работу с ошибкой. Вы должны убедиться, что группа существует, используя модуль ovirt_groups. | |
| namespace | Пространство имён поставщика авторизации, где находится пользователь/группа. | |
| nested_attributes (добавлено в 2.3) | Указывает список атрибутов, которые следует получить из API. Этот параметр применяется только если fetch_nested равен true. | |
| object_id | Идентификатор объекта, где разрешения должны быть управляемы. | |
| object_name | Имя объекта, где разрешения должны быть управляемы. | |
| object_type |
| Объект, где разрешения должны быть управляемы. |
| poll_interval | Значение по умолчанию: 3 | Количество секунд, которое модуль ожидает до отправки нового запроса о статусе сущности. |
| role | Значение по умолчанию: UserRole | Имя роли, которая должна быть назначена пользователю/группе для конкретного объекта. |
| state |
| Разрешение должно присутствовать/отсутствовать. |
| timeout | Значение по умолчанию: 180 | Время в секундах, которое модуль должен ждать, пока экземпляр не перейдёт в требуемое состояние. |
| user_name | Имя пользователя для управления. В большинстве LDAP это uid пользователя, но в Active Directory необходимо указать UPN пользователя. Обратите внимание, что если пользователь не существует в системе, этот модуль завершит работу с ошибкой. Вы должны убедиться, что пользователь существует, используя модуль ovirt_users. | |
| 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:
- name: Add user user1 from authorization provider example.com-authz
ovirt_permissions:
user_name: user1
authz_name: example.com-authz
object_type: vm
object_name: myvm
role: UserVmManager
- name: Remove permission from user
ovirt_permissions:
state: absent
user_name: user1
authz_name: example.com-authz
object_type: cluster
object_name: mycluster
role: ClusterAdmin
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| id str | При успехе, если разрешение найдено. | Идентификатор разрешения, которое управляется Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| permission dict | При успехе, если разрешение найдено. | Словарь всех атрибутов разрешения. Атрибуты разрешения можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/permission. |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Автор
- 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_permissions_module.html
