ovirt_role – Модуль управления ролями в oVirt/RHV

Новый в версии 2.8.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Модуль для управления ролями в oVirt/RHV.

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

python >= 2.7
ovirt-engine-sdk-python >= 4.3.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
administrative boolean		Варианты: no yes	Определяет роль как только для административных действий или нет.
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 boolean	Варианты: no yes	Флаг boolean, указывающий, следует ли проверять серверный TLS-сертификат и имя хоста.
	kerberos boolean	Варианты: no yes	Флаг boolean, указывающий, следует ли использовать аутентификацию 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`.
description -			Описание роли.
fetch_nested boolean добавлено в 2.3		Варианты: no yes	Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков, снимков и т.д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав `nested_attributes`.
id -			Идентификатор роли для управления.
name -			Имя роли для управления.
nested_attributes список добавлено в 2.3			Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда `fetch_nested` равен true.
permits -			Список разрешений, которые будет иметь роль. Разрешение 'login' — по умолчанию, и все роли его будут иметь. Список может содержать имя разрешения.
poll_interval целое число		По умолчанию: 3	Количество секунд, в течение которых модуль ожидает, прежде чем отправить другой запрос опроса о состоянии сущности.
state -		Варианты: present ← absent	Должна ли роль быть present/absent.
timeout целое число		По умолчанию: 180	Время в секундах, которое модуль должен ждать, пока экземпляр не перейдет в желаемое состояние.
wait boolean		Варианты: no yes ←	`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:

# Create administrative role with two permits
- ovirt_role:
    name: role
    administrative: true
    permits:
      - manipulate_permissions
      - create_instance

# Remove role
- ovirt_role:
    name: role
    state: absent

# Remove all permit
- ovirt_role:
    name: role
    administrative: ture
    permits:
      - login

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
ovirt_role список	При успехе.	Список словарей, описывающих роли. Атрибуты роли отображаются в ключах словаря, все атрибуты ролей можно найти по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/role.

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Martin Necas (@mnecas)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 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_role_module.html