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 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 (добавлено в 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.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_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. |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом 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.6/modules/ovirt_permissions_module.html
