ovirt_permission – Модуль для управления правами пользователей/групп в oVirt/RHV
Новый в версии 2.3.
Описание
- Модуль для управления правами пользователей/групп в 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 строка | Строка, содержащая API-URL сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задаётся переменной окружения OVIRT_URL. Требуется либо url, либо hostname. | ||
| username строка / обязательно | Имя пользователя, например, admin@internal. Значение по умолчанию задаётся переменной окружения OVIRT_USERNAME. | ||
| 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 | Количество секунд, которое модуль ожидает, прежде чем отправить новый запрос о состоянии сущности. | |
| 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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.8/modules/ovirt_permission_module.html
