ovirt_permission – Модуль для управления правами пользователей/групп в 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 строка | Строка, содержащая URL API сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию устанавливается переменной среды OVIRT_URL. Требуется либо url, либо hostname. | ||
| username строка / обязательный | Имя пользователя, например admin@internal. Значение по умолчанию устанавливается переменной среды OVIRT_USERNAME. | ||
| authz_name - / обязательный | Провайдер авторизации для пользователя/группы. псевдонимы: домен | ||
| fetch_nested логическое значение |
| Если истина, модуль загрузит дополнительные данные из API. Он загрузит идентификаторы дисков, снимков и т.д. виртуальных машин. Пользователь может настроить загрузку других атрибутов вложенных сущностей, указав nested_attributes. | |
| group_name - | Имя группы для управления. Обратите внимание, что если группа не существует в системе, этот модуль завершится ошибкой. Вы должны убедиться, что группа существует, используя модуль ovirt_groups. | ||
| namespace - | Имя пространства имён провайдера авторизации, где находится пользователь/группа. | ||
| nested_attributes список | Указывает список атрибутов, которые должны быть загружены из API. Этот параметр применим только тогда, когда fetch_nested равно истина. | ||
| object_id - | Идентификатор объекта, права которого необходимо управлять. | ||
| object_name - | Имя объекта, права которого необходимо управлять. | ||
| object_type - |
| Объект, права которого необходимо управлять. | |
| poll_interval целое число | Значение по умолчанию: 3 | Количество секунд, которые модуль ждет до отправки следующего запроса о статусе сущности. | |
| quota_name - добавлено в 2.7 | Имя квоты для назначения прав. Работает только с object_type центром_данных. | ||
| role - | Значение по умолчанию: "UserRole" | Имя роли, которая должна быть назначена пользователю/группе на конкретном объекте. | |
| state - |
| Должны ли права существовать/отсутствовать. | |
| timeout целое число | Значение по умолчанию: 180 | Количество секунд, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние. | |
| user_name - | Имя пользователя для управления. В большинстве LDAP это uid пользователя, но в Active Directory вы должны указать UPN пользователя. Обратите внимание, что если пользователь не существует в системе, этот модуль завершится ошибкой. Вы должны убедиться, что пользователь существует, используя модуль ovirt_users. | ||
| 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:
- name: Add user user1 from authorization provider example.com-authz
ovirt_permission:
user_name: user1
authz_name: example.com-authz
object_type: vm
object_name: myvm
role: UserVmManager
- name: Remove permission from user
ovirt_permission:
state: absent
user_name: user1
authz_name: example.com-authz
object_type: cluster
object_name: mycluster
role: ClusterAdmin
- name: Assign QuotaConsumer role to user
ovirt_permissions:
state: present
user_name: user1
authz_name: example.com-authz
object_type: data_center
object_name: mydatacenter
quota_name: myquota
role: QuotaConsumer
- name: Assign QuotaConsumer role to group
ovirt_permissions:
state: present
group_name: group1
authz_name: example.com-authz
object_type: data_center
object_name: mydatacenter
quota_name: myquota
role: QuotaConsumer
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id строка | При успехе, если разрешение найдено. | Идентификатор разрешения, которое управляется Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| permission словарь | При успехе, если разрешение найдено. | Словарь всех атрибутов разрешения. Атрибуты разрешения можно найти на вашем экземпляре oVirt/RHV по следующему URL-адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/permission. |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом 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_permission_module.html
