ovirt_group - Модуль для управления группами в 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. Он получит идентификаторы дисков, снимков и т. д. виртуальных машин. Пользователь может настроить получение других атрибутов вложенных сущностей, указав `nested_attributes`.
name	да			Имя группы, которую нужно управлять.
namespace	нет			Пространство имён провайдера авторизации, где расположена группа.
nested_attributes (добавлен в 2.3)	нет			Указывает список атрибутов, которые нужно получить из API. Этот параметр применяется только когда `fetch_nested` равен true.
poll_interval	нет	3		Число секунд, которое модуль ожидает, прежде чем отправить другой запрос о статусе сущности.
state	нет	present	present absent	Группа должна быть present/absent.
timeout	нет	180		Количество секунд, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние.
wait	нет			True, если модуль должен ждать, пока сущность не перейдет в нужное состояние.

Примеры

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

# Add group group1 from authorization provider example.com-authz
ovirt_group:
    name: group1
    domain: example.com-authz

# Add group group1 from authorization provider example.com-authz
# In case of multi-domain Active Directory setup, you should pass
# also namespace, so it adds correct group:
ovirt_group:
    name: group1
    namespace: dc=ad2,dc=example,dc=com
    domain: example.com-authz

# Remove group group1 with authorization provider example.com-authz
ovirt_group:
    state: absent
    name: group1
    domain: example.com-authz

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

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

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

Примечания

Примечание

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

Статус

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

Для получения помощи в разработке модулей, если у вас есть желание, прочтите Информацию сообщества и участие, Тестирование 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_group_module.html