1 `acpi`: `<boolean>` ('default =' `1`)::
5 `affinity`: `<string>` ::
7 List of host cores used to execute guest processes, for example: 0,5,8-11
9 `agent`: `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
11 Enable/disable communication with the QEMU Guest Agent and its properties.
13 `enabled`=`<boolean>` ('default =' `0`);;
15 Enable/disable communication with a QEMU Guest Agent (QGA) running in the VM.
17 `freeze-fs-on-backup`=`<boolean>` ('default =' `1`);;
19 Freeze/thaw guest filesystems on backup for consistency.
21 `fstrim_cloned_disks`=`<boolean>` ('default =' `0`);;
23 Run fstrim after moving a disk or migrating the VM.
25 `type`=`<isa | virtio>` ('default =' `virtio`);;
29 `arch`: `<aarch64 | x86_64>` ::
31 Virtual processor architecture. Defaults to the host.
35 Arbitrary arguments passed to kvm, for example:
37 args: -no-reboot -smbios 'type=0,vendor=FOO'
39 NOTE: this option is for experts only.
41 `audio0`: `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` ::
43 Configure a audio device, useful in combination with QXL/Spice.
45 `device`=`<AC97 | ich9-intel-hda | intel-hda>` ;;
47 Configure an audio device.
49 `driver`=`<none | spice>` ('default =' `spice`);;
51 Driver backend for the audio device.
53 `autostart`: `<boolean>` ('default =' `0`)::
55 Automatic restart after crash (currently ignored).
57 `balloon`: `<integer> (0 - N)` ::
59 Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.
61 `bios`: `<ovmf | seabios>` ('default =' `seabios`)::
63 Select BIOS implementation.
65 `boot`: `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
67 Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.
69 `legacy`=`<[acdn]{1,4}>` ('default =' `cdn`);;
71 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). Deprecated, use 'order=' instead.
73 `order`=`<device[;device...]>` ;;
75 The guest will attempt to boot from devices in the order they appear here.
77 Disks, optical drives and passed-through storage USB devices will be directly
78 booted from, NICs will load PXE, and PCIe devices will either behave like disks
79 (e.g. NVMe) or load an option ROM (e.g. RAID controller, hardware NIC).
81 Note that only devices in this list will be marked as bootable and thus loaded
82 by the guest firmware (BIOS/UEFI). If you require multiple disks for booting
83 (e.g. software-raid), you need to specify all of them here.
85 Overrides the deprecated 'legacy=[acdn]*' value when given.
87 `bootdisk`: `(ide|sata|scsi|virtio)\d+` ::
89 Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.
91 `cdrom`: `<volume>` ::
93 This is an alias for option -ide2
95 `cicustom`: `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` ::
97 cloud-init: Specify custom files to replace the automatically generated ones at start.
101 Specify a custom file containing all meta data passed to the VM via"
102 ." cloud-init. This is provider specific meaning configdrive2 and nocloud differ.
104 `network`=`<volume>` ;;
106 To pass a custom file containing all network data to the VM via cloud-init.
110 To pass a custom file containing all user data to the VM via cloud-init.
112 `vendor`=`<volume>` ;;
114 To pass a custom file containing all vendor data to the VM via cloud-init.
116 `cipassword`: `<string>` ::
118 cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.
120 `citype`: `<configdrive2 | nocloud | opennebula>` ::
122 Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.
124 `ciupgrade`: `<boolean>` ('default =' `1`)::
126 cloud-init: do an automatic package upgrade after the first boot.
128 `ciuser`: `<string>` ::
130 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
132 `cores`: `<integer> (1 - N)` ('default =' `1`)::
134 The number of cores per socket.
136 `cpu`: `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
140 `cputype`=`<string>` ('default =' `kvm64`);;
142 Emulated CPU type. Can be default or custom name (custom model names must be prefixed with 'custom-').
144 `flags`=`<+FLAG[;-FLAG...]>` ;;
146 List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes
148 `hidden`=`<boolean>` ('default =' `0`);;
150 Do not identify as a KVM virtual machine.
152 `hv-vendor-id`=`<vendor-id>` ;;
154 The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.
156 `phys-bits`=`<8-64|host>` ;;
158 The physical memory address bits that are reported to the guest OS. Should be smaller or equal to the host's. Set to 'host' to use value from host CPU, but note that doing so will break live migration to CPUs with other values.
160 `reported-model`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Cascadelake-Server | Cascadelake-Server-noTSX | Cascadelake-Server-v2 | Cascadelake-Server-v4 | Cascadelake-Server-v5 | Conroe | Cooperlake | Cooperlake-v2 | EPYC | EPYC-IBPB | EPYC-Milan | EPYC-Rome | EPYC-Rome-v2 | EPYC-v3 | Haswell | Haswell-IBRS | Haswell-noTSX | Haswell-noTSX-IBRS | Icelake-Client | Icelake-Client-noTSX | Icelake-Server | Icelake-Server-noTSX | Icelake-Server-v3 | Icelake-Server-v4 | Icelake-Server-v5 | Icelake-Server-v6 | IvyBridge | IvyBridge-IBRS | KnightsMill | Nehalem | Nehalem-IBRS | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | SandyBridge-IBRS | SapphireRapids | Skylake-Client | Skylake-Client-IBRS | Skylake-Client-noTSX-IBRS | Skylake-Client-v4 | Skylake-Server | Skylake-Server-IBRS | Skylake-Server-noTSX-IBRS | Skylake-Server-v4 | Skylake-Server-v5 | Westmere | Westmere-IBRS | athlon | core2duo | coreduo | host | kvm32 | kvm64 | max | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64>` ('default =' `kvm64`);;
162 CPU model and vendor to report to the guest. Must be a QEMU/KVM supported model. Only valid for custom CPU model definitions, default models will always report themselves to the guest OS.
164 `cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
168 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
170 `cpuunits`: `<integer> (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
172 CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.
174 `description`: `<string>` ::
176 Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.
178 `efidisk0`: `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` ::
180 Configure a disk for storing EFI vars.
182 `efitype`=`<2m | 4m>` ('default =' `2m`);;
184 Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified. Ignored for VMs with arch=aarc64 (ARM).
188 The drive's backing volume.
190 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
192 The drive's backing file's data format.
194 `pre-enrolled-keys`=`<boolean>` ('default =' `0`);;
196 Use am EFI vars template with distribution-specific and Microsoft Standard keys enrolled, if used with 'efitype=4m'. Note that this will enable Secure Boot by default, though it can still be turned off from within the VM.
198 `size`=`<DiskSize>` ;;
200 Disk size. This is purely informational and has no effect.
202 `freeze`: `<boolean>` ::
204 Freeze CPU at startup (use 'c' monitor command to start execution).
206 `hookscript`: `<string>` ::
208 Script that will be executed during various steps in the vms lifetime.
210 `hostpci[n]`: `[[host=]<HOSTPCIID[;HOSTPCIID2...]>] [,device-id=<hex id>] [,legacy-igd=<1|0>] [,mapping=<mapping-id>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,sub-device-id=<hex id>] [,sub-vendor-id=<hex id>] [,vendor-id=<hex id>] [,x-vga=<1|0>]` ::
212 Map host PCI devices into guest.
214 NOTE: This option allows direct access to host hardware. So it is no longer
215 possible to migrate such machines - use with special care.
217 CAUTION: Experimental! User reported problems with this option.
219 `device-id`=`<hex id>` ;;
221 Override PCI device ID visible to guest
223 `host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
225 Host PCI device pass through. The PCI ID of a host's PCI device or a list
226 of PCI virtual functions of the host. HOSTPCIID syntax is:
228 'bus:dev.func' (hexadecimal numbers)
230 You can us the 'lspci' command to list existing PCI devices.
232 Either this or the 'mapping' key must be set.
234 `legacy-igd`=`<boolean>` ('default =' `0`);;
236 Pass this device in legacy IGD mode, making it the primary and exclusive graphics device in the VM. Requires 'pc-i440fx' machine type and VGA set to 'none'.
238 `mapping`=`<mapping-id>` ;;
240 The ID of a cluster wide mapping. Either this or the default-key 'host' must be set.
244 The type of mediated device to use.
245 An instance of this type will be created on startup of the VM and
246 will be cleaned up when the VM stops.
248 `pcie`=`<boolean>` ('default =' `0`);;
250 Choose the PCI-express bus (needs the 'q35' machine model).
252 `rombar`=`<boolean>` ('default =' `1`);;
254 Specify whether or not the device's ROM will be visible in the guest's memory map.
256 `romfile`=`<string>` ;;
258 Custom pci device rom filename (must be located in /usr/share/kvm/).
260 `sub-device-id`=`<hex id>` ;;
262 Override PCI subsystem device ID visible to guest
264 `sub-vendor-id`=`<hex id>` ;;
266 Override PCI subsystem vendor ID visible to guest
268 `vendor-id`=`<hex id>` ;;
270 Override PCI vendor ID visible to guest
272 `x-vga`=`<boolean>` ('default =' `0`);;
274 Enable vfio-vga device support.
276 `hotplug`: `<string>` ('default =' `network,disk,usb`)::
278 Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.
280 `hugepages`: `<1024 | 2 | any>` ::
282 Enable/disable hugepages memory.
284 `ide[n]`: `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
286 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
288 `aio`=`<io_uring | native | threads>` ;;
292 `backup`=`<boolean>` ;;
294 Whether the drive should be included when making backups.
298 Maximum r/w speed in bytes per second.
300 `bps_max_length`=`<seconds>` ;;
302 Maximum length of I/O bursts in seconds.
306 Maximum read speed in bytes per second.
308 `bps_rd_max_length`=`<seconds>` ;;
310 Maximum length of read I/O bursts in seconds.
314 Maximum write speed in bytes per second.
316 `bps_wr_max_length`=`<seconds>` ;;
318 Maximum length of write I/O bursts in seconds.
320 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
322 The drive's cache mode
324 `cyls`=`<integer>` ;;
326 Force the drive's physical geometry to have a specific cylinder count.
328 `detect_zeroes`=`<boolean>` ;;
330 Controls whether to detect and try to optimize writes of zeroes.
332 `discard`=`<ignore | on>` ;;
334 Controls whether to pass discard/trim requests to the underlying storage.
338 The drive's backing volume.
340 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
342 The drive's backing file's data format.
344 `heads`=`<integer>` ;;
346 Force the drive's physical geometry to have a specific head count.
350 Maximum r/w I/O in operations per second.
352 `iops_max`=`<iops>` ;;
354 Maximum unthrottled r/w I/O pool in operations per second.
356 `iops_max_length`=`<seconds>` ;;
358 Maximum length of I/O bursts in seconds.
360 `iops_rd`=`<iops>` ;;
362 Maximum read I/O in operations per second.
364 `iops_rd_max`=`<iops>` ;;
366 Maximum unthrottled read I/O pool in operations per second.
368 `iops_rd_max_length`=`<seconds>` ;;
370 Maximum length of read I/O bursts in seconds.
372 `iops_wr`=`<iops>` ;;
374 Maximum write I/O in operations per second.
376 `iops_wr_max`=`<iops>` ;;
378 Maximum unthrottled write I/O pool in operations per second.
380 `iops_wr_max_length`=`<seconds>` ;;
382 Maximum length of write I/O bursts in seconds.
386 Maximum r/w speed in megabytes per second.
388 `mbps_max`=`<mbps>` ;;
390 Maximum unthrottled r/w pool in megabytes per second.
392 `mbps_rd`=`<mbps>` ;;
394 Maximum read speed in megabytes per second.
396 `mbps_rd_max`=`<mbps>` ;;
398 Maximum unthrottled read pool in megabytes per second.
400 `mbps_wr`=`<mbps>` ;;
402 Maximum write speed in megabytes per second.
404 `mbps_wr_max`=`<mbps>` ;;
406 Maximum unthrottled write pool in megabytes per second.
408 `media`=`<cdrom | disk>` ('default =' `disk`);;
410 The drive's media type.
414 The drive's reported model name, url-encoded, up to 40 bytes long.
416 `replicate`=`<boolean>` ('default =' `1`);;
418 Whether the drive should considered for replication jobs.
420 `rerror`=`<ignore | report | stop>` ;;
424 `secs`=`<integer>` ;;
426 Force the drive's physical geometry to have a specific sector count.
428 `serial`=`<serial>` ;;
430 The drive's reported serial number, url-encoded, up to 20 bytes long.
432 `shared`=`<boolean>` ('default =' `0`);;
434 Mark this locally-managed volume as available on all nodes.
436 WARNING: This option does not share the volume automatically, it assumes it is shared already!
438 `size`=`<DiskSize>` ;;
440 Disk size. This is purely informational and has no effect.
442 `snapshot`=`<boolean>` ;;
444 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
448 Whether to expose this drive as an SSD, rather than a rotational hard disk.
450 `trans`=`<auto | lba | none>` ;;
452 Force disk geometry bios translation mode.
454 `werror`=`<enospc | ignore | report | stop>` ;;
460 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
462 `ipconfig[n]`: `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
464 cloud-init: Specify IP addresses and gateways for the corresponding interface.
466 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
468 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
469 gateway should be provided.
470 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
471 cloud-init 19.4 or newer.
473 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
476 `gw`=`<GatewayIPv4>` ;;
478 Default gateway for IPv4 traffic.
480 NOTE: Requires option(s): `ip`
482 `gw6`=`<GatewayIPv6>` ;;
484 Default gateway for IPv6 traffic.
486 NOTE: Requires option(s): `ip6`
488 `ip`=`<IPv4Format/CIDR>` ('default =' `dhcp`);;
490 IPv4 address in CIDR format.
492 `ip6`=`<IPv6Format/CIDR>` ('default =' `dhcp`);;
494 IPv6 address in CIDR format.
496 `ivshmem`: `size=<integer> [,name=<string>]` ::
498 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
502 The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.
504 `size`=`<integer> (1 - N)` ;;
506 The size of the file in MB.
508 `keephugepages`: `<boolean>` ('default =' `0`)::
510 Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
512 `keyboard`: `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
514 Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS.
516 `kvm`: `<boolean>` ('default =' `1`)::
518 Enable/disable KVM hardware virtualization.
520 `localtime`: `<boolean>` ::
522 Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.
524 `lock`: `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
528 `machine`: `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
530 Specifies the QEMU machine type.
532 `memory`: `<integer> (16 - N)` ('default =' `512`)::
534 Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.
536 `migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
538 Set maximum tolerated downtime (in seconds) for migrations.
540 `migrate_speed`: `<integer> (0 - N)` ('default =' `0`)::
542 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
544 `name`: `<string>` ::
546 Set a name for the VM. Only used on the configuration web interface.
548 `nameserver`: `<string>` ::
550 cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
552 `net[n]`: `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
554 Specify network devices.
556 `bridge`=`<bridge>` ;;
558 Bridge to attach the network device to. The Proxmox VE standard bridge
561 If you do not specify a bridge, we create a kvm user (NATed) network
562 device, which provides DHCP and DNS services. The following addresses
569 The DHCP server assign addresses to the guest starting from 10.0.2.15.
571 `firewall`=`<boolean>` ;;
573 Whether this interface should be protected by the firewall.
575 `link_down`=`<boolean>` ;;
577 Whether this interface should be disconnected (like pulling the plug).
579 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
581 A common MAC address with the I/G (Individual/Group) bit not set.
583 `model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | e1000e | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
585 Network Card Model. The 'virtio' model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use 'e1000'.
587 `mtu`=`<integer> (1 - 65520)` ;;
589 Force MTU, for VirtIO only. Set to '1' to use the bridge MTU
591 `queues`=`<integer> (0 - 64)` ;;
593 Number of packet queues to be used on the device.
595 `rate`=`<number> (0 - N)` ;;
597 Rate limit in mbps (megabytes per second) as floating point number.
599 `tag`=`<integer> (1 - 4094)` ;;
601 VLAN tag to apply to packets on this interface.
603 `trunks`=`<vlanid[;vlanid...]>` ;;
605 VLAN trunks to pass through this interface.
607 `numa`: `<boolean>` ('default =' `0`)::
611 `numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
615 `cpus`=`<id[-id];...>` ;;
617 CPUs accessing this NUMA node.
619 `hostnodes`=`<id[-id];...>` ;;
621 Host NUMA nodes to use.
623 `memory`=`<number>` ;;
625 Amount of memory this NUMA node provides.
627 `policy`=`<bind | interleave | preferred>` ;;
629 NUMA allocation policy.
631 `onboot`: `<boolean>` ('default =' `0`)::
633 Specifies whether a VM will be started during system bootup.
635 `ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` ::
637 Specify guest operating system. This is used to enable special
638 optimization/features for specific operating systems:
641 other;; unspecified OS
642 wxp;; Microsoft Windows XP
643 w2k;; Microsoft Windows 2000
644 w2k3;; Microsoft Windows 2003
645 w2k8;; Microsoft Windows 2008
646 wvista;; Microsoft Windows Vista
647 win7;; Microsoft Windows 7
648 win8;; Microsoft Windows 8/2012/2012r2
649 win10;; Microsoft Windows 10/2016/2019
650 win11;; Microsoft Windows 11/2022
651 l24;; Linux 2.4 Kernel
652 l26;; Linux 2.6 - 6.X Kernel
653 solaris;; Solaris/OpenSolaris/OpenIndiania kernel
655 `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
657 Map host parallel devices (n is 0 to 2).
659 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such
660 machines - use with special care.
662 CAUTION: Experimental! User reported problems with this option.
664 `protection`: `<boolean>` ('default =' `0`)::
666 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
668 `reboot`: `<boolean>` ('default =' `1`)::
670 Allow reboot. If set to '0' the VM exit on reboot.
672 `rng0`: `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
674 Configure a VirtIO-based Random Number Generator.
676 `max_bytes`=`<integer>` ('default =' `1024`);;
678 Maximum bytes of entropy allowed to get injected into the guest every 'period' milliseconds. Prefer a lower value when using '/dev/random' as source. Use `0` to disable limiting (potentially dangerous!).
680 `period`=`<integer>` ('default =' `1000`);;
682 Every 'period' milliseconds the entropy-injection quota is reset, allowing the guest to retrieve another 'max_bytes' of entropy.
684 `source`=`</dev/hwrng | /dev/random | /dev/urandom>` ;;
686 The file on the host to gather entropy from. In most cases '/dev/urandom' should be preferred over '/dev/random' to avoid entropy-starvation issues on the host. Using urandom does *not* decrease security in any meaningful way, as it's still seeded from real entropy, and the bytes provided will most likely be mixed with real entropy on the guest as well. '/dev/hwrng' can be used to pass through a hardware RNG from the host.
688 `sata[n]`: `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
690 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
692 `aio`=`<io_uring | native | threads>` ;;
696 `backup`=`<boolean>` ;;
698 Whether the drive should be included when making backups.
702 Maximum r/w speed in bytes per second.
704 `bps_max_length`=`<seconds>` ;;
706 Maximum length of I/O bursts in seconds.
710 Maximum read speed in bytes per second.
712 `bps_rd_max_length`=`<seconds>` ;;
714 Maximum length of read I/O bursts in seconds.
718 Maximum write speed in bytes per second.
720 `bps_wr_max_length`=`<seconds>` ;;
722 Maximum length of write I/O bursts in seconds.
724 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
726 The drive's cache mode
728 `cyls`=`<integer>` ;;
730 Force the drive's physical geometry to have a specific cylinder count.
732 `detect_zeroes`=`<boolean>` ;;
734 Controls whether to detect and try to optimize writes of zeroes.
736 `discard`=`<ignore | on>` ;;
738 Controls whether to pass discard/trim requests to the underlying storage.
742 The drive's backing volume.
744 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
746 The drive's backing file's data format.
748 `heads`=`<integer>` ;;
750 Force the drive's physical geometry to have a specific head count.
754 Maximum r/w I/O in operations per second.
756 `iops_max`=`<iops>` ;;
758 Maximum unthrottled r/w I/O pool in operations per second.
760 `iops_max_length`=`<seconds>` ;;
762 Maximum length of I/O bursts in seconds.
764 `iops_rd`=`<iops>` ;;
766 Maximum read I/O in operations per second.
768 `iops_rd_max`=`<iops>` ;;
770 Maximum unthrottled read I/O pool in operations per second.
772 `iops_rd_max_length`=`<seconds>` ;;
774 Maximum length of read I/O bursts in seconds.
776 `iops_wr`=`<iops>` ;;
778 Maximum write I/O in operations per second.
780 `iops_wr_max`=`<iops>` ;;
782 Maximum unthrottled write I/O pool in operations per second.
784 `iops_wr_max_length`=`<seconds>` ;;
786 Maximum length of write I/O bursts in seconds.
790 Maximum r/w speed in megabytes per second.
792 `mbps_max`=`<mbps>` ;;
794 Maximum unthrottled r/w pool in megabytes per second.
796 `mbps_rd`=`<mbps>` ;;
798 Maximum read speed in megabytes per second.
800 `mbps_rd_max`=`<mbps>` ;;
802 Maximum unthrottled read pool in megabytes per second.
804 `mbps_wr`=`<mbps>` ;;
806 Maximum write speed in megabytes per second.
808 `mbps_wr_max`=`<mbps>` ;;
810 Maximum unthrottled write pool in megabytes per second.
812 `media`=`<cdrom | disk>` ('default =' `disk`);;
814 The drive's media type.
816 `replicate`=`<boolean>` ('default =' `1`);;
818 Whether the drive should considered for replication jobs.
820 `rerror`=`<ignore | report | stop>` ;;
824 `secs`=`<integer>` ;;
826 Force the drive's physical geometry to have a specific sector count.
828 `serial`=`<serial>` ;;
830 The drive's reported serial number, url-encoded, up to 20 bytes long.
832 `shared`=`<boolean>` ('default =' `0`);;
834 Mark this locally-managed volume as available on all nodes.
836 WARNING: This option does not share the volume automatically, it assumes it is shared already!
838 `size`=`<DiskSize>` ;;
840 Disk size. This is purely informational and has no effect.
842 `snapshot`=`<boolean>` ;;
844 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
848 Whether to expose this drive as an SSD, rather than a rotational hard disk.
850 `trans`=`<auto | lba | none>` ;;
852 Force disk geometry bios translation mode.
854 `werror`=`<enospc | ignore | report | stop>` ;;
860 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
862 `scsi[n]`: `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
864 Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).
866 `aio`=`<io_uring | native | threads>` ;;
870 `backup`=`<boolean>` ;;
872 Whether the drive should be included when making backups.
876 Maximum r/w speed in bytes per second.
878 `bps_max_length`=`<seconds>` ;;
880 Maximum length of I/O bursts in seconds.
884 Maximum read speed in bytes per second.
886 `bps_rd_max_length`=`<seconds>` ;;
888 Maximum length of read I/O bursts in seconds.
892 Maximum write speed in bytes per second.
894 `bps_wr_max_length`=`<seconds>` ;;
896 Maximum length of write I/O bursts in seconds.
898 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
900 The drive's cache mode
902 `cyls`=`<integer>` ;;
904 Force the drive's physical geometry to have a specific cylinder count.
906 `detect_zeroes`=`<boolean>` ;;
908 Controls whether to detect and try to optimize writes of zeroes.
910 `discard`=`<ignore | on>` ;;
912 Controls whether to pass discard/trim requests to the underlying storage.
916 The drive's backing volume.
918 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
920 The drive's backing file's data format.
922 `heads`=`<integer>` ;;
924 Force the drive's physical geometry to have a specific head count.
928 Maximum r/w I/O in operations per second.
930 `iops_max`=`<iops>` ;;
932 Maximum unthrottled r/w I/O pool in operations per second.
934 `iops_max_length`=`<seconds>` ;;
936 Maximum length of I/O bursts in seconds.
938 `iops_rd`=`<iops>` ;;
940 Maximum read I/O in operations per second.
942 `iops_rd_max`=`<iops>` ;;
944 Maximum unthrottled read I/O pool in operations per second.
946 `iops_rd_max_length`=`<seconds>` ;;
948 Maximum length of read I/O bursts in seconds.
950 `iops_wr`=`<iops>` ;;
952 Maximum write I/O in operations per second.
954 `iops_wr_max`=`<iops>` ;;
956 Maximum unthrottled write I/O pool in operations per second.
958 `iops_wr_max_length`=`<seconds>` ;;
960 Maximum length of write I/O bursts in seconds.
962 `iothread`=`<boolean>` ;;
964 Whether to use iothreads for this drive
968 Maximum r/w speed in megabytes per second.
970 `mbps_max`=`<mbps>` ;;
972 Maximum unthrottled r/w pool in megabytes per second.
974 `mbps_rd`=`<mbps>` ;;
976 Maximum read speed in megabytes per second.
978 `mbps_rd_max`=`<mbps>` ;;
980 Maximum unthrottled read pool in megabytes per second.
982 `mbps_wr`=`<mbps>` ;;
984 Maximum write speed in megabytes per second.
986 `mbps_wr_max`=`<mbps>` ;;
988 Maximum unthrottled write pool in megabytes per second.
990 `media`=`<cdrom | disk>` ('default =' `disk`);;
992 The drive's media type.
994 `queues`=`<integer> (2 - N)` ;;
998 `replicate`=`<boolean>` ('default =' `1`);;
1000 Whether the drive should considered for replication jobs.
1002 `rerror`=`<ignore | report | stop>` ;;
1008 Whether the drive is read-only.
1010 `scsiblock`=`<boolean>` ('default =' `0`);;
1012 whether to use scsi-block for full passthrough of host block device
1014 WARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host
1016 `secs`=`<integer>` ;;
1018 Force the drive's physical geometry to have a specific sector count.
1020 `serial`=`<serial>` ;;
1022 The drive's reported serial number, url-encoded, up to 20 bytes long.
1024 `shared`=`<boolean>` ('default =' `0`);;
1026 Mark this locally-managed volume as available on all nodes.
1028 WARNING: This option does not share the volume automatically, it assumes it is shared already!
1030 `size`=`<DiskSize>` ;;
1032 Disk size. This is purely informational and has no effect.
1034 `snapshot`=`<boolean>` ;;
1036 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
1038 `ssd`=`<boolean>` ;;
1040 Whether to expose this drive as an SSD, rather than a rotational hard disk.
1042 `trans`=`<auto | lba | none>` ;;
1044 Force disk geometry bios translation mode.
1046 `werror`=`<enospc | ignore | report | stop>` ;;
1052 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
1054 `scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
1056 SCSI controller model
1058 `searchdomain`: `<string>` ::
1060 cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
1062 `serial[n]`: `(/dev/.+|socket)` ::
1064 Create a serial device inside the VM (n is 0 to 3), and pass through a
1065 host serial device (i.e. /dev/ttyS0), or create a unix socket on the
1066 host side (use 'qm terminal' to open a terminal connection).
1068 NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines -
1069 use with special care.
1071 CAUTION: Experimental! User reported problems with this option.
1073 `shares`: `<integer> (0 - 50000)` ('default =' `1000`)::
1075 Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.
1077 `smbios1`: `[base64=<1|0>] [,family=<Base64 encoded string>] [,manufacturer=<Base64 encoded string>] [,product=<Base64 encoded string>] [,serial=<Base64 encoded string>] [,sku=<Base64 encoded string>] [,uuid=<UUID>] [,version=<Base64 encoded string>]` ::
1079 Specify SMBIOS type 1 fields.
1081 `base64`=`<boolean>` ;;
1083 Flag to indicate that the SMBIOS values are base64 encoded
1085 `family`=`<Base64 encoded string>` ;;
1087 Set SMBIOS1 family string.
1089 `manufacturer`=`<Base64 encoded string>` ;;
1091 Set SMBIOS1 manufacturer.
1093 `product`=`<Base64 encoded string>` ;;
1095 Set SMBIOS1 product ID.
1097 `serial`=`<Base64 encoded string>` ;;
1099 Set SMBIOS1 serial number.
1101 `sku`=`<Base64 encoded string>` ;;
1103 Set SMBIOS1 SKU string.
1109 `version`=`<Base64 encoded string>` ;;
1111 Set SMBIOS1 version.
1113 `smp`: `<integer> (1 - N)` ('default =' `1`)::
1115 The number of CPUs. Please use option -sockets instead.
1117 `sockets`: `<integer> (1 - N)` ('default =' `1`)::
1119 The number of CPU sockets.
1121 `spice_enhancements`: `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
1123 Configure additional enhancements for SPICE.
1125 `foldersharing`=`<boolean>` ('default =' `0`);;
1127 Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.
1129 `videostreaming`=`<all | filter | off>` ('default =' `off`);;
1131 Enable video streaming. Uses compression for detected video streams.
1133 `sshkeys`: `<string>` ::
1135 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
1137 `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
1139 Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'.
1141 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1143 Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
1145 `tablet`: `<boolean>` ('default =' `1`)::
1147 Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (`qm set <vmid> --vga qxl`).
1149 `tags`: `<string>` ::
1151 Tags of the VM. This is only meta information.
1153 `tdf`: `<boolean>` ('default =' `0`)::
1155 Enable/disable time drift fix.
1157 `template`: `<boolean>` ('default =' `0`)::
1159 Enable/disable Template.
1161 `tpmstate0`: `[file=]<volume> [,size=<DiskSize>] [,version=<v1.2|v2.0>]` ::
1163 Configure a Disk for storing TPM state. The format is fixed to 'raw'.
1165 `file`=`<volume>` ;;
1167 The drive's backing volume.
1169 `size`=`<DiskSize>` ;;
1171 Disk size. This is purely informational and has no effect.
1173 `version`=`<v1.2 | v2.0>` ('default =' `v2.0`);;
1175 The TPM interface version. v2.0 is newer and should be preferred. Note that this cannot be changed later on.
1177 `unused[n]`: `[file=]<volume>` ::
1179 Reference to unused volumes. This is used internally, and should not be modified manually.
1181 `file`=`<volume>` ;;
1183 The drive's backing volume.
1185 `usb[n]`: `[[host=]<HOSTUSBDEVICE|spice>] [,mapping=<mapping-id>] [,usb3=<1|0>]` ::
1187 Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14).
1189 `host`=`<HOSTUSBDEVICE|spice>` ;;
1191 The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
1193 'bus-port(.port)*' (decimal numbers) or
1194 'vendor_id:product_id' (hexadeciaml numbers) or
1197 You can use the 'lsusb -t' command to list existing usb devices.
1199 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such
1200 machines - use with special care.
1202 The value 'spice' can be used to add a usb redirection devices for spice.
1204 Either this or the 'mapping' key must be set.
1206 `mapping`=`<mapping-id>` ;;
1208 The ID of a cluster wide mapping. Either this or the default-key 'host' must be set.
1210 `usb3`=`<boolean>` ('default =' `0`);;
1212 Specifies whether if given host option is a USB3 device or port. For modern guests (machine version >= 7.1 and ostype l26 and windows > 7), this flag is irrelevant (all devices are plugged into a xhci controller).
1214 `vcpus`: `<integer> (1 - N)` ('default =' `0`)::
1216 Number of hotplugged vcpus.
1218 `vga`: `[[type=]<enum>] [,memory=<integer>]` ::
1220 Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is 'std' for all OS types besides some Windows versions (XP and older) which use 'cirrus'. The 'qxl' option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays them self.
1221 You can also run without any graphic card, using a serial device as terminal.
1223 `memory`=`<integer> (4 - 512)` ;;
1225 Sets the VGA memory (in MiB). Has no effect with serial display.
1227 `type`=`<cirrus | none | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | virtio-gl | vmware>` ('default =' `std`);;
1229 Select the VGA type.
1231 `virtio[n]`: `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,ro=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
1233 Use volume as VIRTIO hard disk (n is 0 to 15).
1235 `aio`=`<io_uring | native | threads>` ;;
1239 `backup`=`<boolean>` ;;
1241 Whether the drive should be included when making backups.
1245 Maximum r/w speed in bytes per second.
1247 `bps_max_length`=`<seconds>` ;;
1249 Maximum length of I/O bursts in seconds.
1253 Maximum read speed in bytes per second.
1255 `bps_rd_max_length`=`<seconds>` ;;
1257 Maximum length of read I/O bursts in seconds.
1261 Maximum write speed in bytes per second.
1263 `bps_wr_max_length`=`<seconds>` ;;
1265 Maximum length of write I/O bursts in seconds.
1267 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
1269 The drive's cache mode
1271 `cyls`=`<integer>` ;;
1273 Force the drive's physical geometry to have a specific cylinder count.
1275 `detect_zeroes`=`<boolean>` ;;
1277 Controls whether to detect and try to optimize writes of zeroes.
1279 `discard`=`<ignore | on>` ;;
1281 Controls whether to pass discard/trim requests to the underlying storage.
1283 `file`=`<volume>` ;;
1285 The drive's backing volume.
1287 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
1289 The drive's backing file's data format.
1291 `heads`=`<integer>` ;;
1293 Force the drive's physical geometry to have a specific head count.
1297 Maximum r/w I/O in operations per second.
1299 `iops_max`=`<iops>` ;;
1301 Maximum unthrottled r/w I/O pool in operations per second.
1303 `iops_max_length`=`<seconds>` ;;
1305 Maximum length of I/O bursts in seconds.
1307 `iops_rd`=`<iops>` ;;
1309 Maximum read I/O in operations per second.
1311 `iops_rd_max`=`<iops>` ;;
1313 Maximum unthrottled read I/O pool in operations per second.
1315 `iops_rd_max_length`=`<seconds>` ;;
1317 Maximum length of read I/O bursts in seconds.
1319 `iops_wr`=`<iops>` ;;
1321 Maximum write I/O in operations per second.
1323 `iops_wr_max`=`<iops>` ;;
1325 Maximum unthrottled write I/O pool in operations per second.
1327 `iops_wr_max_length`=`<seconds>` ;;
1329 Maximum length of write I/O bursts in seconds.
1331 `iothread`=`<boolean>` ;;
1333 Whether to use iothreads for this drive
1337 Maximum r/w speed in megabytes per second.
1339 `mbps_max`=`<mbps>` ;;
1341 Maximum unthrottled r/w pool in megabytes per second.
1343 `mbps_rd`=`<mbps>` ;;
1345 Maximum read speed in megabytes per second.
1347 `mbps_rd_max`=`<mbps>` ;;
1349 Maximum unthrottled read pool in megabytes per second.
1351 `mbps_wr`=`<mbps>` ;;
1353 Maximum write speed in megabytes per second.
1355 `mbps_wr_max`=`<mbps>` ;;
1357 Maximum unthrottled write pool in megabytes per second.
1359 `media`=`<cdrom | disk>` ('default =' `disk`);;
1361 The drive's media type.
1363 `replicate`=`<boolean>` ('default =' `1`);;
1365 Whether the drive should considered for replication jobs.
1367 `rerror`=`<ignore | report | stop>` ;;
1373 Whether the drive is read-only.
1375 `secs`=`<integer>` ;;
1377 Force the drive's physical geometry to have a specific sector count.
1379 `serial`=`<serial>` ;;
1381 The drive's reported serial number, url-encoded, up to 20 bytes long.
1383 `shared`=`<boolean>` ('default =' `0`);;
1385 Mark this locally-managed volume as available on all nodes.
1387 WARNING: This option does not share the volume automatically, it assumes it is shared already!
1389 `size`=`<DiskSize>` ;;
1391 Disk size. This is purely informational and has no effect.
1393 `snapshot`=`<boolean>` ;;
1395 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
1397 `trans`=`<auto | lba | none>` ;;
1399 Force disk geometry bios translation mode.
1401 `werror`=`<enospc | ignore | report | stop>` ;;
1405 `vmgenid`: `<UUID>` ('default =' `1 (autogenerated)`)::
1407 The VM generation ID (vmgenid) device exposes a 128-bit integer value identifier to the guest OS. This allows to notify the guest operating system when the virtual machine is executed with a different configuration (e.g. snapshot execution or creation from a template). The guest operating system notices the change, and is then able to react as appropriate by marking its copies of distributed databases as dirty, re-initializing its random number generator, etc.
1408 Note that auto-creation only works when done through API/CLI create or update methods, but not when manually editing the config file.
1410 `vmstatestorage`: `<string>` ::
1412 Default storage for VM state volumes/files.
1414 `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1416 Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)
1418 `action`=`<debug | none | pause | poweroff | reset | shutdown>` ;;
1420 The action to perform if after activation the guest fails to poll the watchdog in time.
1422 `model`=`<i6300esb | ib700>` ('default =' `i6300esb`);;
1424 Watchdog type to emulate.