ovirt_affinity_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-запросу. | ||
| cluster | нет | Имя кластера группы родства. | ||
| description | нет | Описание группы родства. | ||
| fetch_nested (добавлено в 2.3)
| нет | Если True, модуль извлечёт дополнительные данные из API. Он извлечёт идентификаторы дисков, снимков и т.д. виртуальных машин. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes. | ||
| host_enforcing | нет | Если True, виртуальная машина не сможет запуститься на хосте, если не соответствует host_rule.This parameter is support since oVirt/RHV 4.1 version. | ||
| host_rule | нет |
| Если positive, все виртуальные машины в этой группе должны выполняться на этом хосте. Если negative, никакие виртуальные машины в этой группе не должны выполняться на этом хосте. This parameter is support since oVirt/RHV 4.1 version. | |
| hosts | нет | Список имён хостов, которым должна быть назначена эта группа родства. This parameter is support since oVirt/RHV 4.1 version. | ||
| name | да | Имя группы родства, которую нужно управлять. | ||
| nested_attributes (добавлено в 2.3)
| нет | Указывает список атрибутов, которые должны быть извлечены из API. Этот параметр применяется только когда fetch_nested равен true. | ||
| poll_interval | нет | 3 | Количество секунд, которое модуль ожидает, прежде чем отправлять другой запрос на проверку статуса сущности. | |
| state | нет | present |
| Должна ли группа родства быть present или absent. |
| timeout | нет | 180 | Количество секунд, в течение которых модуль должен ждать, пока экземпляр не перейдёт в желаемое состояние. | |
| vm_enforcing | нет | Если true, виртуальная машина не сможет запуститься, если не соответствует vm_rule. | ||
| vm_rule | нет |
| Если positive, все виртуальные машины в этой группе должны выполняться на хосте, определённом в host_rule.Если negative, никакие виртуальные машины в этой группе не должны выполняться на хосте, определённом в host_rule.Если disabled, эта группа родства не вступает в силу. | |
| vms | нет | Список имён виртуальных машин, которым должна быть назначена эта группа родства. | ||
| wait | нет |
True, если модуль должен подождать, пока сущность не перейдёт в нужное состояние. |
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Create(if not exists) and assign affinity group to VMs vm1 and vm2 and host host1
- ovirt_affinity_group:
name: mygroup
cluster: mycluster
vm_enforcing: true
vm_rule: positive
host_enforcing: true
host_rule: positive
vms:
- vm1
- vm2
hosts:
- host1
# Detach VMs from affinity group and disable VM rule:
- ovirt_affinity_group:
name: mygroup
cluster: mycluster
vm_enforcing: false
vm_rule: disabled
host_enforcing: true
host_rule: positive
vms: []
hosts:
- host1
- host2
# Remove affinity group
- ovirt_affinity_group:
state: absent
cluster: mycluster
name: mygroup
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие являются полями, уникальными для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| affinity_group | Словарь всех атрибутов группы родства. Атрибуты группы родства можно найти на вашем экземпляре oVirt/RHV по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/affinity_group. | При успехе, если группа родства найдена. | str | |
| id | Идентификатор группы родства, которая управляется | При успехе, если группа родства найдена. | str | 7de90f31-222c-436c-a1ca-7e655bd5b60c |
Примечания
Примечание
- Для использования этого модуля необходимо установить Python SDK oVirt. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: 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_affinity_group_module.html