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

affinity_group_mappings

список / элементы=словарь

Отображение, которое сопоставляет имя группы родства между OVF виртуальной машины и целевой группой родства, к которой эта виртуальная машина должна быть зарегистрирована, актуально, когда state зарегистрирована.

affinity_label_mappings

список / элементы=словарь

Отображение, которое сопоставляет имя метки родства между OVF виртуальной машины и целевой меткой, к которой эта виртуальная машина должна быть зарегистрирована, актуально, когда state зарегистрирована.

allow_partial_import

булево

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

Варианты:

• false
• true

auth

словарь / обязательно

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

ca_file

строка

Файл PEM, содержащий доверенные сертификаты CA.

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

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

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

compress

булево

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

Варианты:

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

headers

словарь

Словарь HTTP-заголовков, которые нужно добавить к каждому API-запросу.

hostname

строка

Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`.

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

Требуется либо url, либо hostname.

insecure

булево

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

Варианты:

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

kerberos

булево

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

Варианты:

• false
• true

password

строка

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

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

timeout

целое число

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

token

строка

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

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

url

строка

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

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

Требуется либо url, либо hostname.

username

строка

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

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

ballooning_enabled

булево

Если true, использовать баллонирование памяти.

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

Варианты:

• false
• true

bios_type

строка

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

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

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

Варианты:

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

boot_devices

список / элементы=строка

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

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

Варианты:

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

boot_menu

булево

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

Варианты:

• false
• true

cd_iso

string

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

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

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

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

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

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

aliases: sysprep_persist

boolean

Если да, параметры 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 для настройки различных хуков.

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

name

string

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

regexp

string

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

value

string

Значение для настройки настраиваемого свойства.

delete_protected

boolean

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

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

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

Варианты:

• false
• true

description

string

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

disk_format

string

Указывает формат диска.

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

Если используется формат raw, хранилище диска будет выделено сразу (preallocated).

Обратите внимание, что этот параметр не является идемпотентным, так как в настоящее время изменить формат диска через 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 экспортируется, этот параметр указывает, нужно ли перезаписать существующую ВМ с тем же именем.

Варианты:

• false
• true

export_domain

string

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

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

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

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

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

Варианты:

• false
• true

high_availability_priority

integer

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

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

host

string

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

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

host_devices

список / элементы=словарь

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

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

id

строка

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

initrd_path

строка

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

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

instance_type

строка

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

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

io_threads

целое число

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

kernel_params

строка

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

kernel_params_persist

логическое значение

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

Варианты:

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

kernel_path

строка

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

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

kvm

словарь

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

drivers_iso

строка

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

name

строка

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

password

строка

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

sparse

логическое значение

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

Варианты:

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

storage_domain

строка

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

url

строка

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

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

username

строка

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

lease

строка

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

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

lun_mappings

список / элементы=словарь

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

logical_unit_address

строка

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

logical_unit_id

строка

Логический номер устройства для идентификации логического устройства.

logical_unit_password)

строка

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

logical_unit_port

строка

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

logical_unit_portal

строка

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

logical_unit_target

строка

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, обновление не будет применено к виртуальной машине сразу и будет применено только при перезапуске виртуальной машины.

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

Варианты:

• false
• true

nics

list / elements=dictionary

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

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 узла в MiB.

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, он должен быть сначала включен на кластере.

/dev/urandom используется для версии кластера ≥ 4.1, а /dev/random для версии кластера ≤ 4.0

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 обновляет ВМ, и если у ВМ есть конфигурация следующего запуска, она будет перезагружена.

Пожалуйста, проверьте примечания для более подробного описания состояний.

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

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

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

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 запущен.

Варианты:

• 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 зарегистрирован. vnic_profile описывается следующим словарем:

source_network_name

string

Имя сети источника.

source_profile_name

string

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

target_profile_id

string

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

volatile

boolean

added in ovirt.ovirt 2.2.0

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

Варианты:

• false
• true

wait

boolean

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

Варианты:

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

wait_after_lease

integer

added in ovirt.ovirt 2.1.0

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

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

watchdog

dictionary

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

Watchdogs — это словарь, который может содержать следующие значения:

action

string

Действие watchdog, которое должно быть выполнено при срабатывании 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. Это обязательный параметр.