Модуль ovirt.ovirt.ovirt_vm — модуль для управления виртуальными машинами в oVirt/RHV

affinity_group_mappings

list / elements=dictionary

Сопоставитель, сопоставляющий имя группы affinity из OVF виртуальной машины с целевой группой affinity, в которую следует зарегистрировать эту виртуальную машину; применяется при регистрации state.

По умолчанию: []

affinity_label_mappings

list / elements=dictionary

Сопоставитель, сопоставляющий имя метки affinity из OVF виртуальной машины с целевой меткой, к которой следует привязать эту виртуальную машину; применяется при регистрации state.

По умолчанию: []

allow_partial_import

boolean

Логическое значение, указывающее, разрешена ли частичная регистрация виртуальной машины при регистрации state.

Варианты:

• false
• true

auth

dictionary / обязательный

Словарь со значениями, необходимыми для создания HTTP/HTTPS-подключения к oVirt:

ca_file

string

Файл PEM с доверенными сертификатами центра сертификации (CA).

Сертификат, предоставленный сервером, будет проверен с использованием этих сертификатов CA.

Если параметр ca_file не задан, используется системное хранилище сертификатов CA.

Значение по умолчанию задается переменной среды OVIRT_CAFILE.

compress

boolean

Флаг, указывающий, используется ли сжатие при подключении.

Варианты:

• false
• true ← (по умолчанию)

headers

dictionary

Словарь HTTP-заголовков, добавляемых к каждому вызову API.

hostname

string

Строка с именем хоста сервера, обычно в формате `server.example.com`.

Значение по умолчанию задается переменной среды OVIRT_HOSTNAME.

Необходимо указать либо url, либо hostname.

insecure

boolean

Логический флаг, указывающий, следует ли проверять сертификат TLS и имя хоста сервера.

Варианты:

• false ← (по умолчанию)
• true

kerberos

boolean

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

Варианты:

• false
• true

password

string

Пароль пользователя.

Значение по умолчанию задается переменной среды OVIRT_PASSWORD.

timeout

integer

Количество секунд ожидания ответа.

По умолчанию: 0

token

string

Токен, используемый вместо входа с именем пользователя и паролем.

Значение по умолчанию задается переменной среды OVIRT_TOKEN.

url

string

Строка с URL API сервера, обычно в формате `https://server.example.com/ovirt-engine/api`.

Значение по умолчанию задается переменной среды OVIRT_URL.

Необходимо указать либо url, либо hostname.

username

string

Имя пользователя, например admin@internal.

Значение по умолчанию задается переменной среды OVIRT_USERNAME.

ballooning_enabled

boolean

Если значение равно true, используется динамическое распределение памяти.

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

Варианты:

• false
• true

bios_type

string

Задайте тип BIOS, необходимый для некоторых операционных систем и безопасной загрузки.

Если значение не указано, используется значение кластера по умолчанию.

ПРИМЕЧАНИЕ. Поддерживается начиная с oVirt 4.3.

Варианты:

• "i440fx_sea_bios"
• "q35_ovmf"
• "q35_sea_bios"
• "q35_secure_boot"

boot_devices

list / elements=string

Список устройств, с которых следует выполнять загрузку. Например, [ cdrom, hd ].

Значение по умолчанию задается движком oVirt/RHV.

Варианты:

• "cdrom"
• "hd"
• "network"

boot_menu

boolean

True включает меню выбора устройства загрузки, False отключает его. По умолчанию значение выбирается движком oVirt/RHV.

Варианты:

• false
• true

cd_iso

string

Файл ISO из домена хранилища ISO, который следует подключить к виртуальной машине.

Если есть несколько дисков ISO с одинаковым именем, укажите нужный диск по его ID или используйте storage_domain для фильтрации дисков.

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

Если параметр используется с state в состоянии running или present и виртуальная машина запущена, компакт-диск будет подключен к ней.

Если параметр используется с state в состоянии running или present и виртуальная машина выключена, компакт-диск будет подключен к ней постоянно.

clone

boolean

Если значение равно yes, диски созданной виртуальной машины будут клонированы и станут независимыми от шаблона.

Этот параметр используется только, когда state имеет состояние running или present, а виртуальная машина ранее не существовала.

Варианты:

• false ← (по умолчанию)
• true

clone_permissions

boolean

Если значение равно yes, разрешения шаблона (только прямые, без унаследованных) будут скопированы в созданную виртуальную машину.

Этот параметр используется только, когда state имеет состояние running или present, а виртуальная машина ранее не существовала.

Варианты:

• false ← (по умолчанию)
• true

cloud_init

dictionary

Словарь со значениями для инициализации виртуальной машины под управлением Unix с помощью cloud-init.

authorized_ssh_keys

string

Используйте эти ключи SSH для входа в виртуальную машину.

custom_script

string

Сценарий cloud-init, который будет выполнен при развертывании виртуальной машины.

Он добавляется в конец сценария cloud-init, созданного с помощью других параметров.

Дополнительные сведения см. в документации cloud-init User-Data.

dns_search

string

Домены поиска DNS, которые следует настроить на виртуальной машине.

dns_servers

string

Серверы DNS, которые следует настроить на виртуальной машине; не более двух, разделенных пробелами.

host_name

string

Имя хоста, которое будет задано виртуальной машине при развертывании.

nic_boot_protocol

string

Задайте протокол загрузки сетевого интерфейса виртуальной машины.

Варианты:

• "none"
• "dhcp"
• "static"

nic_boot_protocol_v6

string

Задайте протокол загрузки сетевого интерфейса виртуальной машины.

Варианты:

• "none"
• "dhcp"
• "static"

nic_gateway

string

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

nic_gateway_v6

string

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

Для адресов IPv6 значение является целым числом в диапазоне 0–128, представляющим префикс подсети.

nic_ip_address

string

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

nic_ip_address_v6

string

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

nic_name

string

Задайте имя сетевого интерфейса виртуальной машины.

nic_netmask

string

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

nic_netmask_v6

string

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

regenerate_ssh_keys

boolean

Если значение равно True, ключи SSH будут заново сгенерированы на виртуальной машине.

Варианты:

• false
• true

root_password

string

Пароль, задаваемый для пользователя, указанного параметром user_name.

timezone

string

Часовой пояс, который будет задан виртуальной машине при развертывании.

user_name

string

Имя пользователя, для которого будет задан пароль виртуальной машины при развертывании.

cloud_init_nics

list / elements=dictionary

Список словарей, описывающих сетевые интерфейсы, которые будут настроены cloud-init.

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

Если достаточно одного сетевого интерфейса, следует использовать параметры cloud_init nic_*. Параметры cloud_init nic_* объединяются с параметрами cloud_init_nics.

По умолчанию: []

nic_boot_protocol

string

Задайте протокол загрузки сетевого интерфейса виртуальной машины. Возможные значения: none, dhcp или static.

nic_boot_protocol_v6

string

Задайте протокол загрузки сетевого интерфейса виртуальной машины. Возможные значения: none, dhcp или static.

nic_gateway

string

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

nic_gateway_v6

string

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

Для адресов IPv6 значение является целым числом в диапазоне 0–128, представляющим префикс подсети.

nic_ip_address

string

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

nic_ip_address_v6

string

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

nic_name

string

Задайте имя сетевого интерфейса виртуальной машины.

nic_netmask

string

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

nic_netmask_v6

string

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

cloud_init_persist

псевдонимы: sysprep_persist

boolean

Если значение равно yes, параметры cloud_init или sysprep будут сохранены для виртуальной машины, и она не будет запущена в режиме однократного запуска.

Варианты:

• false ← (по умолчанию)
• true

cluster

string

Имя кластера, в котором следует создать виртуальную машину.

Обязательный параметр при создании виртуальной машины.

cluster_mappings

list / elements=dictionary

Сопоставитель, сопоставляющий имя кластера из OVF виртуальной машины с целевым кластером, в который следует зарегистрировать эту виртуальную машину; применяется при регистрации state. Сопоставление кластеров задается следующим словарем:

По умолчанию: []

dest_name

string

Имя целевого кластера.

source_name

string

Имя исходного кластера.

comment

string

Комментарий к виртуальной машине.

cpu_cores

integer

Количество ядер виртуального процессора виртуальной машины.

Значение по умолчанию задается механизмом oVirt/RHV.

cpu_mode

string

Режим ЦП виртуальной машины. Возможны следующие значения: host_passthrough, host_model или custom.

Для типа ЦП host_passthrough необходимо установить placement_policy в значение pinned.

Если значение не указано, значение по умолчанию задается механизмом oVirt/RHV.

cpu_pinning

list / elements=dictionary

Топология привязки ЦП для сопоставления виртуальных ЦП машины с ЦП узла.

Топология привязки ЦП представляет собой список словарей, которые могут содержать следующие значения:

cpu

string

Номер ЦП узла.

vcpu

string

Номер виртуального ЦП машины.

cpu_shares

integer

Задает долю ЦП для этой виртуальной машины.

Значение по умолчанию задается механизмом oVirt/RHV.

cpu_sockets

integer

Количество сокетов виртуального процессора виртуальной машины.

Значение по умолчанию задается механизмом oVirt/RHV.

cpu_threads

integer

Количество потоков на ядро виртуальной машины.

Значение по умолчанию задается механизмом oVirt/RHV.

custom_compatibility_version

string

Позволяет задать для виртуальной машины собственную версию совместимости. Если установлено значение «custom_compatibility_version», оно переопределяет версию совместимости кластера для этой виртуальной машины.

custom_emulated_machine

string

Задает значение атрибута custom_emulated_machine.

custom_properties

list / elements=dictionary

Свойства, передаваемые в VDSM для настройки различных хуков.

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

name

string

Имя пользовательского свойства. Например: hugepages, vhost, sap_agent и т. д.

regexp

string

Регулярное выражение для пользовательского свойства.

value

string

Значение пользовательского свойства.

delete_protected

boolean

Если указано yes, для виртуальной машины будет включена защита от удаления.

Если указано no, для виртуальной машины не будет включена защита от удаления.

Если значение не указано, значение по умолчанию задается механизмом oVirt/RHV.

Варианты:

• false
• true

description

string

Описание виртуальной машины.

disk_format

string

Задает формат диска.

Если используется формат cow, диск будет создан как разреженный: пространство будет выделяться для тома по мере необходимости. Этот режим также называется тонким выделением ресурсов.

Если используется формат raw, пространство для диска будет выделено сразу. Этот режим также называется предварительным выделением.

Обратите внимание, что этот параметр не является идемпотентным, поскольку в настоящее время изменить формат диска через API невозможно.

Этот параметр учитывается только при наличии template и storage domain.

Варианты:

• "cow" ← (по умолчанию)
• "raw"

disks

list / elements=dictionary

Список дисков, которые необходимо подключить к виртуальной машине. Диск описывается следующим словарем.

По умолчанию: []

activate

boolean

True, если диск должен быть активирован; по умолчанию диск активен.

ПРИМЕЧАНИЕ. Этот параметр используется только когда state имеет значение running или present и позволяет только подключать диски. Для более детального управления дисками виртуальной машины используйте модуль ovirt.ovirt.ovirt_disk.

Варианты:

• false
• true

bootable

boolean

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

Варианты:

• false
• true

id

string

Идентификатор диска. Требуется либо name, либо id.

interface

string

Интерфейс диска.

Варианты:

• "virtio" ← (по умолчанию)
• "ide"

name

string

Имя диска. Требуется либо name, либо id.

domain_mappings

list / elements=dictionary

Сопоставление имен доменов aaa между OVF виртуальной машины и целевым доменом aaa, в котором необходимо зарегистрировать эту виртуальную машину; применимо, если зарегистрирован state. Сопоставление доменов aaa описывается следующим словарем:

По умолчанию: []

dest_name

string

Имя целевого домена aaa.

source_name

string

Имя исходного домена aaa.

exclusive

boolean

Если state имеет значение exported, этот параметр указывает, следует ли перезаписать существующую виртуальную машину с таким же именем.

Варианты:

• false
• true

export_domain

string

Если state имеет значение exported, этот параметр указывает имя домена хранилища экспорта.

export_ova

dictionary

Словарь значений, используемых для экспорта виртуальной машины в формате OVA.

directory

string

Имя каталога, в который необходимо экспортировать OVA.

filename

string

Имя экспортированного файла OVA.

host

string

Имя целевого узла, на который необходимо экспортировать OVA.

fetch_nested

boolean

Если указано True, модуль получит дополнительные данные из API.

Будут получены идентификаторы дисков, снимков и других объектов виртуальной машины. Пользователь может указать, какие другие атрибуты вложенных сущностей получать, задав nested_attributes.

Варианты:

• false ← (по умолчанию)
• true

force

boolean

Подробное описание параметра force см. в разделе Синопсис; его поведение может различаться в зависимости от ситуации.

Варианты:

• false ← (по умолчанию)
• true

force_migrate

boolean

Если указано true, виртуальная машина будет перенесена при значении placement_policy=user-migratable, но не при значении placement_policy=pinned.

Варианты:

• false
• true

graphical_console

dictionary

Назначает виртуальной машине графическую консоль.

copy_paste_enabled

boolean

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

Этот параметр доступен только для консолей типа SPICE.

Варианты:

• false
• true

disconnect_action

string

Возвращает действие, которое будет выполнено при отключении графической консоли (только SPICE). Возможны следующие варианты:

none Действие не выполняется.

lock_screen Блокирует текущий активный сеанс пользователя.

logout Завершает текущий активный сеанс пользователя.

reboot Выполняет штатную перезагрузку виртуальной машины.

shutdown Выполняет штатное выключение виртуальной машины.

file_transfer_enabled

boolean

Указывает, может ли пользователь перетаскивать файлы с внешнего узла в графическую консоль.

Этот параметр доступен только для консолей типа SPICE.

Варианты:

• false
• true

headless_mode

boolean

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

Варианты:

• false
• true

keyboard_layout

string

Раскладка клавиатуры для этой графической консоли.

Этот параметр доступен только для консолей типа VNC.

Если клавиатура не включена, ее данные не будут отображаться.

monitors

integer

Количество мониторов, открываемых для этой графической консоли.

Этот параметр доступен только для протокола SPICE.

Возможные значения: 1, 2 или 4.

protocol

list / elements=string

Графический протокол: список, содержащий spice, vnc или оба значения.

high_availability

boolean

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

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

Если значение не указано, значение по умолчанию задается механизмом oVirt/RHV.

Варианты:

• false
• true

high_availability_priority

integer

Задает приоритет виртуальной машины в очередях запуска и миграции. Виртуальные машины с более высоким приоритетом запускаются и переносятся раньше машин с более низким приоритетом. Значение — целое число от 0 до 100. Чем выше значение, тем выше приоритет.

Если значение не указано, значение по умолчанию задается механизмом oVirt/RHV.

host

string

Задает узел, на котором должна работать виртуальная машина. По умолчанию узел выбирается планировщиком механизма.

Этот параметр используется только когда state имеет значение running или present.

host_devices

list / elements=dictionary

Single Root I/O Virtualization — технология, позволяющая одному устройству предоставлять несколько конечных точек, которые можно передавать виртуальным машинам.

host_devices — это список словарей, содержащих имя и состояние устройства.

id

string

Идентификатор виртуальной машины, которой необходимо управлять.

initrd_path

string

Путь к начальному RAM-диску, используемому с ядром, указанным параметром kernel_path.

Образ RAM-диска должен храниться либо в домене ISO, либо в хранилище узла.

instance_type

string

Имя конфигурации оборудования виртуальной машины.

По умолчанию тип экземпляра не используется.

io_threads

integer

Количество потоков ввода-вывода, используемых виртуальной машиной. Значение 0 отключает многопоточную обработку ввода-вывода.

kernel_params

string

Параметры командной строки ядра (в виде строки), используемые с ядром, указанным параметром kernel_path.

kernel_params_persist

boolean

Если указано true, параметры kernel_params, initrd_path и kernel_path сохраняются в конфигурации виртуальной машины; если указано False, они используются только при однократном запуске.

Варианты:

• false ← (по умолчанию)
• true

kernel_path

string

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

Образ ядра должен храниться либо в домене ISO, либо в хранилище узла.

kvm

dictionary

Словарь значений, используемых для подключения к KVM и импорта виртуальной машины в oVirt.

drivers_iso

string

Имя ISO-образа с драйверами, которые можно использовать в процессе преобразования virt-v2v.

name

string

Имя виртуальной машины KVM.

password

string

Пароль для аутентификации в KVM.

sparse

boolean

Задает политику выделения дискового пространства для создаваемой виртуальной машины: true — разреженное выделение, false — предварительное выделение.

Варианты:

• false
• true ← (по умолчанию)

storage_domain

string

Задает целевой домен хранилища для преобразованных дисков. Это обязательный параметр.

url

string

URL, передаваемый инструменту virt-v2v для преобразования.

Например, qemu:///system. Это обязательный параметр.

username

string

Имя пользователя для аутентификации в KVM.

lease

string

Имя домена хранилища, в котором находится аренда этой виртуальной машины. Передайте пустую строку, чтобы удалить аренду.

ПРИМЕЧАНИЕ — поддерживается начиная с oVirt 4.1.

lun_mappings

list / elements=dictionary

Средство сопоставления LUN в OVF виртуальной машины с целевым LUN, который должна содержать эта виртуальная машина; применяется, когда зарегистрирован state. Параметр lun_mappings описывается следующим словарем:

По умолчанию: []

logical_unit_address

string

Адрес хоста блочного хранилища.

logical_unit_id

string

Номер логического устройства, идентифицирующий логическое устройство.

logical_unit_password)

string

Пароль для подключения к хосту блочного хранилища.

logical_unit_port

string

Порт, используемый для подключения к диску LUN.

logical_unit_portal

string

Портал, используемый для подключения к диску LUN.

logical_unit_target

string

Спецификация iSCSI, расположенная на сервере iSCSI.

logical_unit_username

string

Имя пользователя для подключения к хосту блочного хранилища.

storage_type

string

Тип хранилища, в котором находится LUN (iscsi или fcp).

memory

string

Объем памяти виртуальной машины. Для приставок используется стандарт IEC 60027-2 (например, 1GiB, 1024MiB).

Значение по умолчанию задается движком.

memory_guaranteed

string

Объем гарантированной минимальной памяти виртуальной машины. Для приставок используется стандарт IEC 60027-2 (например, 1GiB, 1024MiB).

Значение параметра memory_guaranteed не может быть меньше значения параметра memory.

Значение по умолчанию задается движком.

memory_max

string

Верхняя граница объема памяти виртуальной машины, до которой можно выполнять горячее подключение памяти. Для приставок используется стандарт IEC 60027-2 (например, 1GiB, 1024MiB).

Значение по умолчанию задается движком.

migrate

boolean

Если задано true, виртуальная машина будет перенесена на любой доступный хост.

Варианты:

• false
• true

multi_queues_enabled

boolean

добавлено в ovirt.ovirt 1.7.0

Если задано `true`, для каждого виртуального сетевого интерфейса будет настроено оптимальное количество очередей в зависимости от доступного числа виртуальных процессоров.

Варианты:

• false
• true

name

string

Имя виртуальной машины, которой нужно управлять.

Если виртуальная машина не существует, требуется name. В противном случае можно использовать id или name.

nested_attributes

list / elements=string

Задает список атрибутов, которые следует получить из API.

Этот параметр применяется только, если fetch_nested имеет значение true.

По умолчанию: []

next_run

boolean

Если задано true, обновление не будет применено к виртуальной машине немедленно и вступит в силу только после ее перезапуска.

ПРИМЕЧАНИЕ — если для виртуальной машины задано несколько изменений конфигурации, применяемых при следующем запуске, первое изменение может быть отменено, если не передать этот параметр.

Варианты:

• false
• true

nics

list / elements=dictionary

Список сетевых интерфейсов, которые следует подключить к виртуальной машине. Параметры сетевого интерфейса задаются следующим словарем.

По умолчанию: []

interface

string

Тип сетевого интерфейса.

Варианты:

• "virtio" ← (по умолчанию)
• "e1000"
• "rtl8139"

mac_address

string

Пользовательский MAC-адрес сетевого интерфейса; по умолчанию он назначается из пула MAC-адресов.

ПРИМЕЧАНИЕ — этот параметр используется только, когда state имеет значение running или present, и позволяет только создавать сетевые интерфейсы. Для более детального управления сетевыми интерфейсами виртуальной машины используйте вместо этого модуль ovirt.ovirt.ovirt_nic.

name

string

Имя сетевого интерфейса.

profile_name

string

Имя профиля, к которому следует подключить сетевой интерфейс.

numa_nodes

list / elements=dictionary

Список узлов vNUMA для этой виртуальной машины с привязкой к назначенным физическим узлам NUMA хоста.

Каждый узел vNUMA описывается следующим словарем:

По умолчанию: []

cores

list / elements=integer / обязательный

Список индексов ядер ЦП виртуальной машины, включаемых в этот узел NUMA.

index

string / обязательный

Индекс этого узла NUMA.

memory

string / обязательный

Объем памяти узла NUMA в МиБ.

numa_node_pins

list / elements=integer

Список индексов физических узлов NUMA, к которым следует привязать этот виртуальный узел NUMA.

numa_tune_mode

string

Задает способ применения выделения памяти для узлов NUMA этой виртуальной машины (применяется, если для виртуальной машины заданы узлы NUMA).

Возможные значения: interleave, preferred или strict.

Если значение не указано, значение по умолчанию задается движком oVirt/RHV.

Варианты:

• "interleave"
• "preferred"
• "strict"

operating_system

string

Операционная система виртуальной машины, например «rhel_8x64».

Значение по умолчанию задается движком oVirt/RHV.

Для получения текущего списка используйте модуль ovirt.ovirt.ovirt_vm_os_info.

placement_policy

string

Конфигурация политики размещения виртуальной машины.

Если значение не указано, значение по умолчанию задается движком oVirt/RHV.

Политика размещения может принимать одно из следующих значений:

migratable

string

Разрешить ручную и автоматическую миграцию.

pinned

string

Запретить миграцию.

user_migratable

string

Разрешить только ручную миграцию.

placement_policy_hosts

list / elements=string

Список имен хостов.

poll_interval

integer

Количество секунд ожидания модулем перед отправкой следующего запроса для проверки состояния объекта.

По умолчанию: 3

quota_id

string

Идентификатор квоты виртуальной машины, используемой для диска. По умолчанию квоту выбирает движок oVirt/RHV.

reassign_bad_macs

boolean

Логическое значение, указывающее, следует ли переназначать некорректные MAC-адреса, когда зарегистрирован state.

Варианты:

• false
• true

rng_device

string

Генератор случайных чисел (RNG). Можно выбрать одно из следующих устройств: urandom, random или hwrng.

Чтобы выбрать hwrng, сначала необходимо включить его в кластере.

Для версии кластера >= 4.1 используется /dev/urandom, а для версии кластера <= 4.0 — /dev/random.

role_mappings

list / elements=dictionary

Средство сопоставления имен ролей из OVF виртуальной машины с целевыми ролями, в которые следует зарегистрировать эту виртуальную машину; применяется, когда зарегистрирован state. Сопоставление ролей описывается следующим словарем:

По умолчанию: []

dest_name

string

Имя целевой роли.

source_name

string

Имя исходной роли.

serial_console

boolean

True — включить последовательную консоль VirtIO, False — отключить ее. По умолчанию значение выбирает движок oVirt/RHV.

Варианты:

• false
• true

serial_policy

string

Задает политику серийного номера виртуальной машины.

Поддерживаются следующие параметры.

vm — задает UUID виртуальной машины в качестве ее серийного номера.

host — задает UUID хоста в качестве серийного номера виртуальной машины.

custom — позволяет указать пользовательский серийный номер в serial_policy_value.

Варианты:

• "vm"
• "host"
• "custom"

serial_policy_value

string

Позволяет указать пользовательский серийный номер.

Этот параметр используется только, когда значение serial_policy — custom.

smartcard_enabled

boolean

Если задано true, используется аутентификация со смарт-картой.

Варианты:

• false
• true

snapshot_name

string

Снимок, на основе которого клонируется виртуальная машина.

Должен существовать снимок с указанным описанием.

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

snapshot_vm

string

Исходная виртуальная машина, на основе которой клонируется виртуальная машина.

Для виртуальной машины должен существовать снимок, указанный параметром snapshot.

Если указан snapshot_name, требуется snapshot_vm.

soundcard_enabled

boolean

Если задано true, к виртуальной машине добавляется звуковая карта.

Варианты:

• false
• true

sso

boolean

True — включить единый вход с помощью гостевого агента, False — отключить его. По умолчанию значение выбирает движок oVirt/RHV.

Варианты:

• false
• true

state

string

Должна ли виртуальная машина быть запущена/остановлена/присутствовать/отсутствовать/приостановлена/обновлена при следующем запуске/зарегистрирована/экспортирована/перезагружена. Если state имеет значение registered, а имя незарегистрированной ВМ совпадает с именем уже зарегистрированной в движке ВМ в том же ЦОД, регистрация незарегистрированного шаблона завершится ошибкой.

Состояние present создаст или обновит ВМ, не меняя её состояние, если она уже существует.

Состояние running создаст или обновит ВМ и запустит её.

Состояние next_run обновляет ВМ и перезагружает её, если для ВМ настроена конфигурация следующего запуска.

Подробное описание состояний см. в разделе notes.

Состояние exported экспортирует ВМ в домен экспорта или в формате OVA.

Состояние registered поддерживается начиная с версии 2.4.

Состояние reboot поддерживается начиная с версии 2.10; виртуальная машина перезагружается, только если она находится в состоянии up.

reset отправляет запрос на сброс виртуальной машины.

Варианты:

• "absent"
• "next_run"
• "present" ← (по умолчанию)
• "registered"
• "running"
• "stopped"
• "suspended"
• "exported"
• "reboot"
• "reset"

stateless

boolean

Если указано yes, виртуальная машина будет переведена в режим без сохранения состояния.

Если указано no, для виртуальной машины будет отключён режим без сохранения состояния.

Если значение не передано, используется значение по умолчанию, заданное движком oVirt/RHV.

Варианты:

• false
• true

storage_domain

string

Имя домена хранения, в котором должны быть созданы все диски шаблона.

Этот параметр учитывается только при наличии template.

ВАЖНО: этот параметр не является идемпотентным. Если ВМ существует и указан другой домен хранения, диск не будет перемещён.

storage_error_resume_behaviour

string

добавлено в ovirt.ovirt 3.2.0

Если хранилище, на котором находятся диски этой виртуальной машины, перестаёт отвечать, виртуальная машина приостанавливается.

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

Варианты:

• "auto_resume"
• "kill"
• "leave_paused"

sysprep

dictionary

Словарь со значениями для инициализации виртуальной машины Windows с помощью sysprep.

active_directory_ou

string

Подразделение Active Directory, используемое для входа пользователя.

custom_script

string

Пользовательское описание Sysprep в виде полного файла ответов для автоматической установки.

domain

string

Домен, который будет задан виртуальной машине Windows.

host_name

string

Имя узла, которое будет задано виртуальной машине при развёртывании.

input_locale

string

Язык ввода виртуальной машины Windows.

org_name

string

Название организации, которое будет задано виртуальной машине Windows.

root_password

string

Пароль, который будет задан для имени пользователя виртуальной машины Windows.

system_locale

string

Язык системы виртуальной машины Windows.

timezone

string

Часовой пояс, который будет задан виртуальной машине Windows.

ui_language

string

Язык интерфейса виртуальной машины Windows.

user_name

string

Имя пользователя, для которого будет задан пароль виртуальной машины Windows.

windows_license_key

string

Лицензионный ключ, который будет задан виртуальной машине Windows.

template

string

Имя шаблона, который следует использовать для создания виртуальной машины.

Обязателен при создании ВМ.

Если шаблон не указан и ВМ не существует, она будет создана на основе шаблона Blank.

template_version

integer

Номер версии шаблона, используемого для ВМ.

По умолчанию используется последняя доступная версия шаблона.

ticket

boolean

Если указано true, дополнительно возвращает remote_vv_file в словаре vm, содержащий совместимое содержимое для приложения remote-viewer. Работает, только если state имеет значение running.

Варианты:

• false
• true

timeout

integer

Время в секундах, в течение которого модуль должен ожидать перехода экземпляра в требуемое состояние.

По умолчанию: 180

timezone

string

Задаёт смещение часового пояса аппаратных часов гостевой системы.

Например, Etc/GMT

tpm_enabled

boolean

добавлено в ovirt.ovirt 3.2.0

Если указано `true`, в виртуальную машину добавляется устройство TPM.

Варианты:

• false
• true

type

string

Тип виртуальной машины.

Значение по умолчанию задаётся движком oVirt/RHV.

high_performance поддерживается начиная с Ansible 2.5 и oVirt/RHV 4.2.

Варианты:

• "desktop"
• "server"
• "high_performance"

usb_support

boolean

True включает поддержку USB, False отключает её. По умолчанию значение выбирается движком oVirt/RHV.

Варианты:

• false
• true

use_latest_template_version

boolean

Указывает, следует ли использовать последнюю версию шаблона при запуске ВМ без сохранения состояния.

Если для этого параметра задано значение yes, создаётся ВМ без сохранения состояния.

Варианты:

• false
• true

virtio_scsi_enabled

boolean

добавлено в ovirt.ovirt 1.7.0

Включает поддержку Virtio SCSI.

Варианты:

• false
• true

virtio_scsi_multi_queues

integer

добавлено в ovirt.ovirt 1.7.0

Количество очередей для контроллера Virtio-SCSI; возможные значения: -1 — очереди будут настроены автоматически. 0 — многопоточность Virtio SCSI будет отключена. >0 — количество очередей Virtio SCSI, используемых виртуальной машиной.

vmware

dictionary

Словарь значений, используемых для подключения к VMware и импорта виртуальной машины в oVirt.

drivers_iso

string

Имя ISO-образа с драйверами, которые можно использовать в процессе преобразования virt-v2v.

password

string

Пароль для аутентификации в VMware.

sparse

boolean

Указывает политику выделения дискового пространства для создаваемой виртуальной машины. true — динамическое выделение, false — предварительное выделение.

Варианты:

• false
• true ← (по умолчанию)

storage_domain

string

Задаёт целевой домен хранения для преобразованных дисков. Этот параметр обязателен.

url

string

URL, передаваемый инструменту virt-v2v для преобразования.

Например, vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1

username

string

Имя пользователя для аутентификации в VMware.

vnic_profile_mappings

list / elements=dictionary

Сопоставление внешнего профиля виртуального сетевого интерфейса с профилем, существующим в движке, когда state имеет значение registered. Профиль vnic_profile описывается следующим словарём:

По умолчанию: []

source_network_name

string

Имя исходной сети.

source_profile_name

string

Имя профиля, связанного с исходной сетью.

target_profile_id

string

Идентификатор целевого профиля в движке, на который выполняется сопоставление.

volatile

boolean

добавлено в ovirt.ovirt 2.2.0

Указывает, что эта конфигурация запуска будет удалена даже в случае перезагрузки, инициированной гостевой системой.

Варианты:

• false
• true

wait

boolean

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

Варианты:

• false
• true ← (по умолчанию)

wait_after_lease

integer

добавлено в ovirt.ovirt 2.1.0

Количество секунд, в течение которых модуль должен ожидать после изменения аренды.

По умолчанию: 5

watchdog

dictionary

Назначает виртуальной машине устройство watchdog.

Словарь watchdog может содержать следующие значения:

action

string

Действие, выполняемое при срабатывании watchdog. Например: none, reset, poweroff, pause или dump.

model

string

Модель устройства watchdog. Например: i6300esb, diag288 или null.

xen

dictionary

Словарь значений, используемых для подключения к XEN и импорта виртуальной машины в oVirt.

drivers_iso

string

Имя ISO-образа с драйверами, которые можно использовать в процессе преобразования virt-v2v.

sparse

boolean

Указывает политику выделения дискового пространства для создаваемой виртуальной машины. true — динамическое выделение, false — предварительное выделение.

Варианты:

• false
• true ← (по умолчанию)

storage_domain

string

Задаёт целевой домен хранения для преобразованных дисков. Этот параметр обязателен.

url

string

URL, передаваемый инструменту virt-v2v для преобразования.

Например, xen+ssh://root@zen.server. Этот параметр обязателен.

id

string

ID управляемой виртуальной машины

Возвращается: При успешном выполнении, если виртуальная машина найдена.

Пример: "7de90f31-222c-436c-a1ca-7e655bd5b60c"

vm

dictionary

Словарь со всеми атрибутами виртуальной машины. Атрибуты виртуальной машины можно найти в вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/vm. Кроме того, если пользователь указал ticket=true, этот модуль также вернёт в словаре vm параметр remote_vv_file, содержащий совместимый с remote-viewer файл для открытия консоли виртуальной машины. Обратите внимание, что этот файл содержит конфиденциальную информацию.

Возвращается: При успешном выполнении, если виртуальная машина найдена.