Spec-Zone.ru › Ansible 2.4

ovirt_permissions - Модуль для управления разрешениями пользователей/групп в oVirt/RHV

Новое в версии 2.3.

  • Описание
  • Требования (для хоста, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус

Описание

  • Модуль для управления разрешениями пользователей/групп в oVirt/RHV

Требования (для хоста, на котором выполняется модуль)

  • python >= 2.7
  • ovirt-engine-sdk-python >= 4.0.0

Параметры

параметр обязательно по умолчанию варианты комментарии
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
да
Провайдер авторизации для пользователя/группы. В предыдущих версиях oVirt/RHV известен как домен.
псевдонимы: домен
fetch_nested
(добавлено в 2.3)
нет
Если True, модуль получит дополнительные данные из API.
Он получит ID дисков, снимков и т. д. ВМ. Пользователь может настроить загрузку других атрибутов вложенных сущностей, указав nested_attributes.
group_name
нет
Имя группы для управления.
Обратите внимание, что если группа не существует в системе, этот модуль завершится ошибкой. Вы должны убедиться, что группа существует, используя модуль ovirt_groups.
namespace
нет
Пространство имен провайдера авторизации, где находится пользователь/группа.
nested_attributes
(добавлено в 2.3)
нет
Указывает список атрибутов, которые должны быть получены из API.
Этот параметр применяется только при fetch_nested равен true.
object_id
нет
ID объекта, где необходимо управлять разрешениями.
object_name
нет
Имя объекта, где необходимо управлять разрешениями.
object_type
нет vm
  • data_center
  • cluster
  • host
  • storage_domain
  • network
  • disk
  • vm
  • vm_pool
  • template
  • cpu_profile
  • disk_profile
  • vnic_profile
  • system
Объект, где нужно управлять разрешениями.
poll_interval
нет 3
Количество секунд, которые модуль ожидает до отправки нового запроса на проверку состояния сущности.
role
нет UserRole
Имя роли, которая должна быть назначена пользователю/группе на определенный объект.
state
нет present
  • present
  • absent
Разрешение должно быть присутствующим/отсутствующим.
timeout
нет 180
Время в секундах, которое модуль должен ожидать, пока экземпляр не перейдет в нужное состояние.
user_name
нет
Имя пользователя для управления. В большинстве LDAP это uid пользователя, но в Active Directory вы должны указать UPN пользователя.
Обратите внимание, что если пользователь не существует в системе, этот модуль завершится ошибкой. Вы должны убедиться, что пользователь существует, используя модуль ovirt_users.
wait
нет
True, если модуль должен ожидать, пока сущность не перейдет в нужное состояние.

Примеры

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# 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

# 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
ID разрешения, которое управляется
При успехе, если разрешение найдено. str 7de90f31-222c-436c-a1ca-7e655bd5b60c
permission
Словарь всех атрибутов разрешения. Атрибуты разрешений можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/permission.
При успехе, если разрешение найдено. dict

Примечания

Примечание

  • Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0

Статус

Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.

Для получения помощи в разработке модулей, если вам это нужно, прочтите Информацию о сообществе и о внесении вклада, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ovirt_permissions_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API