ovirt_permission – Модуль для управления разрешениями пользователей/групп в oVirt/RHV
Новое в версии 2.3.
Обзор
- Модуль для управления разрешениями пользователей/групп в oVirt/RHV.
Псевдонимы: ovirt_permissions
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- 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 - / обязательно | Поставщик авторизации для пользователя/группы. Псевдонимы: домен | |
| fetch_nested boolean добавлено в 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 | Количество секунд, которое модуль ждёт до отправки другого запроса на проверку статуса сущности. |
| quota_name - добавлено в 2.7 | Имя квоты для назначения разрешений. Работает только с object_type data_center. | |
| role - | По умолчанию: "UserRole" | Имя роли, которая будет назначена пользователю/группе на определённый объект. |
| state - |
| Разрешение должно быть присутствовать/отсутствовать. |
| timeout - | По умолчанию: 180 | Время в секундах, которое модуль должен ждать, пока экземпляр не перейдёт в нужное состояние. |
| user_name - | Имя пользователя для управления. В большинстве LDAP это uid пользователя, но в Active Directory необходимо указать UPN пользователя. Обратите внимание, что если пользователя нет в системе, этот модуль завершится ошибкой. Убедитесь, что пользователь существует, используя модуль ovirt_users. | |
| wait boolean |
|
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:
- 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id строка | При успехе, если разрешение найдено. | Идентификатор разрешения, которое управляется Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| permission словарь | При успехе, если разрешение найдено. | Словарь всех атрибутов разрешения. Атрибуты разрешения можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/permission. |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/ovirt_permission_module.html
