1 `acpi`: `<boolean>` ('default =' `1`)::
5 `agent`: `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
7 Enable/disable Qemu GuestAgent and its properties.
9 `enabled`=`<boolean>` ('default =' `0`);;
11 Enable/disable Qemu GuestAgent.
13 `fstrim_cloned_disks`=`<boolean>` ('default =' `0`);;
15 Run fstrim after moving a disk or migrating the VM.
17 `type`=`<isa | virtio>` ('default =' `virtio`);;
21 `arch`: `<aarch64 | x86_64>` ::
23 Virtual processor architecture. Defaults to the host.
27 Arbitrary arguments passed to kvm, for example:
29 args: -no-reboot -no-hpet
31 NOTE: this option is for experts only.
33 `audio0`: `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` ::
35 Configure a audio device, useful in combination with QXL/Spice.
37 `device`=`<AC97 | ich9-intel-hda | intel-hda>` ;;
39 Configure an audio device.
41 `driver`=`<none | spice>` ('default =' `spice`);;
43 Driver backend for the audio device.
45 `autostart`: `<boolean>` ('default =' `0`)::
47 Automatic restart after crash (currently ignored).
49 `balloon`: `<integer> (0 - N)` ::
51 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
53 `bios`: `<ovmf | seabios>` ('default =' `seabios`)::
55 Select BIOS implementation.
57 `boot`: `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
59 Specify guest boot order. Use with 'order=', usage with no key or 'legacy=' is deprecated.
61 `legacy`=`<[acdn]{1,4}>` ('default =' `cdn`);;
63 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). Deprecated, use 'order=' instead.
65 `order`=`<device[;device...]>` ;;
67 The guest will attempt to boot from devices in the order they appear here.
69 Disks, optical drives and passed-through storage USB devices will be directly
70 booted from, NICs will load PXE, and PCIe devices will either behave like disks
71 (e.g. NVMe) or load an option ROM (e.g. RAID controller, hardware NIC).
73 Note that only devices in this list will be marked as bootable and thus loaded
74 by the guest firmware (BIOS/UEFI). If you require multiple disks for booting
75 (e.g. software-raid), you need to specify all of them here.
77 Overrides the deprecated 'legacy=[acdn]*' value when given.
79 `bootdisk`: `(ide|sata|scsi|virtio)\d+` ::
81 Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.
83 `cdrom`: `<volume>` ::
85 This is an alias for option -ide2
87 `cicustom`: `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
89 cloud-init: Specify custom files to replace the automatically generated ones at start.
93 Specify a custom file containing all meta data passed to the VM via"
94 ." cloud-init. This is provider specific meaning configdrive2 and nocloud differ.
96 `network`=`<volume>` ;;
98 Specify a custom file containing all network data passed to the VM via cloud-init.
102 Specify a custom file containing all user data passed to the VM via cloud-init.
104 `cipassword`: `<string>` ::
106 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.
108 `citype`: `<configdrive2 | nocloud | opennebula>` ::
110 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.
112 `ciuser`: `<string>` ::
114 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
116 `cores`: `<integer> (1 - N)` ('default =' `1`)::
118 The number of cores per socket.
120 `cpu`: `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
124 `cputype`=`<string>` ('default =' `kvm64`);;
126 Emulated CPU type. Can be default or custom name (custom model names must be prefixed with 'custom-').
128 `flags`=`<+FLAG[;-FLAG...]>` ;;
130 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.
132 `hidden`=`<boolean>` ('default =' `0`);;
134 Do not identify as a KVM virtual machine.
136 `hv-vendor-id`=`<vendor-id>` ;;
138 The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.
140 `phys-bits`=`<8-64|host>` ;;
142 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.
144 `reported-model`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Cascadelake-Server | Cascadelake-Server-noTSX | Conroe | EPYC | EPYC-IBPB | EPYC-Rome | Haswell | Haswell-IBRS | Haswell-noTSX | Haswell-noTSX-IBRS | Icelake-Client | Icelake-Client-noTSX | Icelake-Server | Icelake-Server-noTSX | IvyBridge | IvyBridge-IBRS | KnightsMill | Nehalem | Nehalem-IBRS | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | SandyBridge-IBRS | Skylake-Client | Skylake-Client-IBRS | Skylake-Client-noTSX-IBRS | Skylake-Server | Skylake-Server-IBRS | Skylake-Server-noTSX-IBRS | Westmere | Westmere-IBRS | athlon | core2duo | coreduo | host | kvm32 | kvm64 | max | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64>` ('default =' `kvm64`);;
146 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.
148 `cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
152 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
154 `cpuunits`: `<integer> (2 - 262144)` ('default =' `1024`)::
156 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.
158 `description`: `<string>` ::
160 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
162 `efidisk0`: `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
164 Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead.
168 The drive's backing volume.
170 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
172 The drive's backing file's data format.
174 `size`=`<DiskSize>` ;;
176 Disk size. This is purely informational and has no effect.
178 `freeze`: `<boolean>` ::
180 Freeze CPU at startup (use 'c' monitor command to start execution).
182 `hookscript`: `<string>` ::
184 Script that will be executed during various steps in the vms lifetime.
186 `hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
188 Map host PCI devices into guest.
190 NOTE: This option allows direct access to host hardware. So it is no longer
191 possible to migrate such machines - use with special care.
193 CAUTION: Experimental! User reported problems with this option.
195 `host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
197 Host PCI device pass through. The PCI ID of a host's PCI device or a list
198 of PCI virtual functions of the host. HOSTPCIID syntax is:
200 'bus:dev.func' (hexadecimal numbers)
202 You can us the 'lspci' command to list existing PCI devices.
204 `legacy-igd`=`<boolean>` ('default =' `0`);;
206 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'.
210 The type of mediated device to use.
211 An instance of this type will be created on startup of the VM and
212 will be cleaned up when the VM stops.
214 `pcie`=`<boolean>` ('default =' `0`);;
216 Choose the PCI-express bus (needs the 'q35' machine model).
218 `rombar`=`<boolean>` ('default =' `1`);;
220 Specify whether or not the device's ROM will be visible in the guest's memory map.
222 `romfile`=`<string>` ;;
224 Custom pci device rom filename (must be located in /usr/share/kvm/).
226 `x-vga`=`<boolean>` ('default =' `0`);;
228 Enable vfio-vga device support.
230 `hotplug`: `<string>` ('default =' `network,disk,usb`)::
232 Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.
234 `hugepages`: `<1024 | 2 | any>` ::
236 Enable/disable hugepages memory.
238 `ide[n]`: `[file=]<volume> [,aio=<native|threads>] [,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>]` ::
240 Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
242 `aio`=`<native | threads>` ;;
246 `backup`=`<boolean>` ;;
248 Whether the drive should be included when making backups.
252 Maximum r/w speed in bytes per second.
254 `bps_max_length`=`<seconds>` ;;
256 Maximum length of I/O bursts in seconds.
260 Maximum read speed in bytes per second.
262 `bps_rd_max_length`=`<seconds>` ;;
264 Maximum length of read I/O bursts in seconds.
268 Maximum write speed in bytes per second.
270 `bps_wr_max_length`=`<seconds>` ;;
272 Maximum length of write I/O bursts in seconds.
274 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
276 The drive's cache mode
278 `cyls`=`<integer>` ;;
280 Force the drive's physical geometry to have a specific cylinder count.
282 `detect_zeroes`=`<boolean>` ;;
284 Controls whether to detect and try to optimize writes of zeroes.
286 `discard`=`<ignore | on>` ;;
288 Controls whether to pass discard/trim requests to the underlying storage.
292 The drive's backing volume.
294 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
296 The drive's backing file's data format.
298 `heads`=`<integer>` ;;
300 Force the drive's physical geometry to have a specific head count.
304 Maximum r/w I/O in operations per second.
306 `iops_max`=`<iops>` ;;
308 Maximum unthrottled r/w I/O pool in operations per second.
310 `iops_max_length`=`<seconds>` ;;
312 Maximum length of I/O bursts in seconds.
314 `iops_rd`=`<iops>` ;;
316 Maximum read I/O in operations per second.
318 `iops_rd_max`=`<iops>` ;;
320 Maximum unthrottled read I/O pool in operations per second.
322 `iops_rd_max_length`=`<seconds>` ;;
324 Maximum length of read I/O bursts in seconds.
326 `iops_wr`=`<iops>` ;;
328 Maximum write I/O in operations per second.
330 `iops_wr_max`=`<iops>` ;;
332 Maximum unthrottled write I/O pool in operations per second.
334 `iops_wr_max_length`=`<seconds>` ;;
336 Maximum length of write I/O bursts in seconds.
340 Maximum r/w speed in megabytes per second.
342 `mbps_max`=`<mbps>` ;;
344 Maximum unthrottled r/w pool in megabytes per second.
346 `mbps_rd`=`<mbps>` ;;
348 Maximum read speed in megabytes per second.
350 `mbps_rd_max`=`<mbps>` ;;
352 Maximum unthrottled read pool in megabytes per second.
354 `mbps_wr`=`<mbps>` ;;
356 Maximum write speed in megabytes per second.
358 `mbps_wr_max`=`<mbps>` ;;
360 Maximum unthrottled write pool in megabytes per second.
362 `media`=`<cdrom | disk>` ('default =' `disk`);;
364 The drive's media type.
368 The drive's reported model name, url-encoded, up to 40 bytes long.
370 `replicate`=`<boolean>` ('default =' `1`);;
372 Whether the drive should considered for replication jobs.
374 `rerror`=`<ignore | report | stop>` ;;
378 `secs`=`<integer>` ;;
380 Force the drive's physical geometry to have a specific sector count.
382 `serial`=`<serial>` ;;
384 The drive's reported serial number, url-encoded, up to 20 bytes long.
386 `shared`=`<boolean>` ('default =' `0`);;
388 Mark this locally-managed volume as available on all nodes.
390 WARNING: This option does not share the volume automatically, it assumes it is shared already!
392 `size`=`<DiskSize>` ;;
394 Disk size. This is purely informational and has no effect.
396 `snapshot`=`<boolean>` ;;
398 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
402 Whether to expose this drive as an SSD, rather than a rotational hard disk.
404 `trans`=`<auto | lba | none>` ;;
406 Force disk geometry bios translation mode.
408 `werror`=`<enospc | ignore | report | stop>` ;;
414 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
416 `ipconfig[n]`: `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
418 cloud-init: Specify IP addresses and gateways for the corresponding interface.
420 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
422 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
423 gateway should be provided.
424 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
425 cloud-init 19.4 or newer.
427 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
430 `gw`=`<GatewayIPv4>` ;;
432 Default gateway for IPv4 traffic.
434 NOTE: Requires option(s): `ip`
436 `gw6`=`<GatewayIPv6>` ;;
438 Default gateway for IPv6 traffic.
440 NOTE: Requires option(s): `ip6`
442 `ip`=`<IPv4Format/CIDR>` ('default =' `dhcp`);;
444 IPv4 address in CIDR format.
446 `ip6`=`<IPv6Format/CIDR>` ('default =' `dhcp`);;
448 IPv6 address in CIDR format.
450 `ivshmem`: `size=<integer> [,name=<string>]` ::
452 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
456 The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.
458 `size`=`<integer> (1 - N)` ;;
460 The size of the file in MB.
462 `keephugepages`: `<boolean>` ('default =' `0`)::
464 Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
466 `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>` ::
468 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
470 `kvm`: `<boolean>` ('default =' `1`)::
472 Enable/disable KVM hardware virtualization.
474 `localtime`: `<boolean>` ::
476 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
478 `lock`: `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
482 `machine`: `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
484 Specifies the Qemu machine type.
486 `memory`: `<integer> (16 - N)` ('default =' `512`)::
488 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
490 `migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
492 Set maximum tolerated downtime (in seconds) for migrations.
494 `migrate_speed`: `<integer> (0 - N)` ('default =' `0`)::
496 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
498 `name`: `<string>` ::
500 Set a name for the VM. Only used on the configuration web interface.
502 `nameserver`: `<string>` ::
504 cloud-init: Sets DNS server IP address for a container. Create will'
505 .' automatically use the setting from the host if neither searchdomain nor nameserver'
508 `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>]` ::
510 Specify network devices.
512 `bridge`=`<bridge>` ;;
514 Bridge to attach the network device to. The Proxmox VE standard bridge
517 If you do not specify a bridge, we create a kvm user (NATed) network
518 device, which provides DHCP and DNS services. The following addresses
525 The DHCP server assign addresses to the guest starting from 10.0.2.15.
527 `firewall`=`<boolean>` ;;
529 Whether this interface should be protected by the firewall.
531 `link_down`=`<boolean>` ;;
533 Whether this interface should be disconnected (like pulling the plug).
535 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
537 A common MAC address with the I/G (Individual/Group) bit not set.
539 `model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
541 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'.
543 `mtu`=`<integer> (1 - 65520)` ;;
545 Force MTU, for VirtIO only. Set to '1' to use the bridge MTU
547 `queues`=`<integer> (0 - 16)` ;;
549 Number of packet queues to be used on the device.
551 `rate`=`<number> (0 - N)` ;;
553 Rate limit in mbps (megabytes per second) as floating point number.
555 `tag`=`<integer> (1 - 4094)` ;;
557 VLAN tag to apply to packets on this interface.
559 `trunks`=`<vlanid[;vlanid...]>` ;;
561 VLAN trunks to pass through this interface.
563 `numa`: `<boolean>` ('default =' `0`)::
567 `numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
571 `cpus`=`<id[-id];...>` ;;
573 CPUs accessing this NUMA node.
575 `hostnodes`=`<id[-id];...>` ;;
577 Host NUMA nodes to use.
579 `memory`=`<number>` ;;
581 Amount of memory this NUMA node provides.
583 `policy`=`<bind | interleave | preferred>` ;;
585 NUMA allocation policy.
587 `onboot`: `<boolean>` ('default =' `0`)::
589 Specifies whether a VM will be started during system bootup.
591 `ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
593 Specify guest operating system. This is used to enable special
594 optimization/features for specific operating systems:
597 other;; unspecified OS
598 wxp;; Microsoft Windows XP
599 w2k;; Microsoft Windows 2000
600 w2k3;; Microsoft Windows 2003
601 w2k8;; Microsoft Windows 2008
602 wvista;; Microsoft Windows Vista
603 win7;; Microsoft Windows 7
604 win8;; Microsoft Windows 8/2012/2012r2
605 win10;; Microsoft Windows 10/2016/2019
606 l24;; Linux 2.4 Kernel
607 l26;; Linux 2.6 - 5.X Kernel
608 solaris;; Solaris/OpenSolaris/OpenIndiania kernel
610 `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
612 Map host parallel devices (n is 0 to 2).
614 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such
615 machines - use with special care.
617 CAUTION: Experimental! User reported problems with this option.
619 `protection`: `<boolean>` ('default =' `0`)::
621 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
623 `reboot`: `<boolean>` ('default =' `1`)::
625 Allow reboot. If set to '0' the VM exit on reboot.
627 `rng0`: `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
629 Configure a VirtIO-based Random Number Generator.
631 `max_bytes`=`<integer>` ('default =' `1024`);;
633 Maximum bytes of entropy injected into the guest every 'period' milliseconds. Prefer a lower value when using /dev/random as source. Use 0 to disable limiting (potentially dangerous!).
635 `period`=`<integer>` ('default =' `1000`);;
637 Every 'period' milliseconds the entropy-injection quota is reset, allowing the guest to retrieve another 'max_bytes' of entropy.
639 `source`=`</dev/hwrng | /dev/random | /dev/urandom>` ;;
641 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.
643 `sata[n]`: `[file=]<volume> [,aio=<native|threads>] [,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>]` ::
645 Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
647 `aio`=`<native | threads>` ;;
651 `backup`=`<boolean>` ;;
653 Whether the drive should be included when making backups.
657 Maximum r/w speed in bytes per second.
659 `bps_max_length`=`<seconds>` ;;
661 Maximum length of I/O bursts in seconds.
665 Maximum read speed in bytes per second.
667 `bps_rd_max_length`=`<seconds>` ;;
669 Maximum length of read I/O bursts in seconds.
673 Maximum write speed in bytes per second.
675 `bps_wr_max_length`=`<seconds>` ;;
677 Maximum length of write I/O bursts in seconds.
679 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
681 The drive's cache mode
683 `cyls`=`<integer>` ;;
685 Force the drive's physical geometry to have a specific cylinder count.
687 `detect_zeroes`=`<boolean>` ;;
689 Controls whether to detect and try to optimize writes of zeroes.
691 `discard`=`<ignore | on>` ;;
693 Controls whether to pass discard/trim requests to the underlying storage.
697 The drive's backing volume.
699 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
701 The drive's backing file's data format.
703 `heads`=`<integer>` ;;
705 Force the drive's physical geometry to have a specific head count.
709 Maximum r/w I/O in operations per second.
711 `iops_max`=`<iops>` ;;
713 Maximum unthrottled r/w I/O pool in operations per second.
715 `iops_max_length`=`<seconds>` ;;
717 Maximum length of I/O bursts in seconds.
719 `iops_rd`=`<iops>` ;;
721 Maximum read I/O in operations per second.
723 `iops_rd_max`=`<iops>` ;;
725 Maximum unthrottled read I/O pool in operations per second.
727 `iops_rd_max_length`=`<seconds>` ;;
729 Maximum length of read I/O bursts in seconds.
731 `iops_wr`=`<iops>` ;;
733 Maximum write I/O in operations per second.
735 `iops_wr_max`=`<iops>` ;;
737 Maximum unthrottled write I/O pool in operations per second.
739 `iops_wr_max_length`=`<seconds>` ;;
741 Maximum length of write I/O bursts in seconds.
745 Maximum r/w speed in megabytes per second.
747 `mbps_max`=`<mbps>` ;;
749 Maximum unthrottled r/w pool in megabytes per second.
751 `mbps_rd`=`<mbps>` ;;
753 Maximum read speed in megabytes per second.
755 `mbps_rd_max`=`<mbps>` ;;
757 Maximum unthrottled read pool in megabytes per second.
759 `mbps_wr`=`<mbps>` ;;
761 Maximum write speed in megabytes per second.
763 `mbps_wr_max`=`<mbps>` ;;
765 Maximum unthrottled write pool in megabytes per second.
767 `media`=`<cdrom | disk>` ('default =' `disk`);;
769 The drive's media type.
771 `replicate`=`<boolean>` ('default =' `1`);;
773 Whether the drive should considered for replication jobs.
775 `rerror`=`<ignore | report | stop>` ;;
779 `secs`=`<integer>` ;;
781 Force the drive's physical geometry to have a specific sector count.
783 `serial`=`<serial>` ;;
785 The drive's reported serial number, url-encoded, up to 20 bytes long.
787 `shared`=`<boolean>` ('default =' `0`);;
789 Mark this locally-managed volume as available on all nodes.
791 WARNING: This option does not share the volume automatically, it assumes it is shared already!
793 `size`=`<DiskSize>` ;;
795 Disk size. This is purely informational and has no effect.
797 `snapshot`=`<boolean>` ;;
799 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
803 Whether to expose this drive as an SSD, rather than a rotational hard disk.
805 `trans`=`<auto | lba | none>` ;;
807 Force disk geometry bios translation mode.
809 `werror`=`<enospc | ignore | report | stop>` ;;
815 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
817 `scsi[n]`: `[file=]<volume> [,aio=<native|threads>] [,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>] [,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>]` ::
819 Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
821 `aio`=`<native | threads>` ;;
825 `backup`=`<boolean>` ;;
827 Whether the drive should be included when making backups.
831 Maximum r/w speed in bytes per second.
833 `bps_max_length`=`<seconds>` ;;
835 Maximum length of I/O bursts in seconds.
839 Maximum read speed in bytes per second.
841 `bps_rd_max_length`=`<seconds>` ;;
843 Maximum length of read I/O bursts in seconds.
847 Maximum write speed in bytes per second.
849 `bps_wr_max_length`=`<seconds>` ;;
851 Maximum length of write I/O bursts in seconds.
853 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
855 The drive's cache mode
857 `cyls`=`<integer>` ;;
859 Force the drive's physical geometry to have a specific cylinder count.
861 `detect_zeroes`=`<boolean>` ;;
863 Controls whether to detect and try to optimize writes of zeroes.
865 `discard`=`<ignore | on>` ;;
867 Controls whether to pass discard/trim requests to the underlying storage.
871 The drive's backing volume.
873 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
875 The drive's backing file's data format.
877 `heads`=`<integer>` ;;
879 Force the drive's physical geometry to have a specific head count.
883 Maximum r/w I/O in operations per second.
885 `iops_max`=`<iops>` ;;
887 Maximum unthrottled r/w I/O pool in operations per second.
889 `iops_max_length`=`<seconds>` ;;
891 Maximum length of I/O bursts in seconds.
893 `iops_rd`=`<iops>` ;;
895 Maximum read I/O in operations per second.
897 `iops_rd_max`=`<iops>` ;;
899 Maximum unthrottled read I/O pool in operations per second.
901 `iops_rd_max_length`=`<seconds>` ;;
903 Maximum length of read I/O bursts in seconds.
905 `iops_wr`=`<iops>` ;;
907 Maximum write I/O in operations per second.
909 `iops_wr_max`=`<iops>` ;;
911 Maximum unthrottled write I/O pool in operations per second.
913 `iops_wr_max_length`=`<seconds>` ;;
915 Maximum length of write I/O bursts in seconds.
917 `iothread`=`<boolean>` ;;
919 Whether to use iothreads for this drive
923 Maximum r/w speed in megabytes per second.
925 `mbps_max`=`<mbps>` ;;
927 Maximum unthrottled r/w pool in megabytes per second.
929 `mbps_rd`=`<mbps>` ;;
931 Maximum read speed in megabytes per second.
933 `mbps_rd_max`=`<mbps>` ;;
935 Maximum unthrottled read pool in megabytes per second.
937 `mbps_wr`=`<mbps>` ;;
939 Maximum write speed in megabytes per second.
941 `mbps_wr_max`=`<mbps>` ;;
943 Maximum unthrottled write pool in megabytes per second.
945 `media`=`<cdrom | disk>` ('default =' `disk`);;
947 The drive's media type.
949 `queues`=`<integer> (2 - N)` ;;
953 `replicate`=`<boolean>` ('default =' `1`);;
955 Whether the drive should considered for replication jobs.
957 `rerror`=`<ignore | report | stop>` ;;
961 `scsiblock`=`<boolean>` ('default =' `0`);;
963 whether to use scsi-block for full passthrough of host block device
965 WARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host
967 `secs`=`<integer>` ;;
969 Force the drive's physical geometry to have a specific sector count.
971 `serial`=`<serial>` ;;
973 The drive's reported serial number, url-encoded, up to 20 bytes long.
975 `shared`=`<boolean>` ('default =' `0`);;
977 Mark this locally-managed volume as available on all nodes.
979 WARNING: This option does not share the volume automatically, it assumes it is shared already!
981 `size`=`<DiskSize>` ;;
983 Disk size. This is purely informational and has no effect.
985 `snapshot`=`<boolean>` ;;
987 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
991 Whether to expose this drive as an SSD, rather than a rotational hard disk.
993 `trans`=`<auto | lba | none>` ;;
995 Force disk geometry bios translation mode.
997 `werror`=`<enospc | ignore | report | stop>` ;;
1003 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
1005 `scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
1007 SCSI controller model
1009 `searchdomain`: `<string>` ::
1011 cloud-init: Sets DNS search domains for a container. Create will'
1012 .' automatically use the setting from the host if neither searchdomain nor nameserver'
1015 `serial[n]`: `(/dev/.+|socket)` ::
1017 Create a serial device inside the VM (n is 0 to 3), and pass through a
1018 host serial device (i.e. /dev/ttyS0), or create a unix socket on the
1019 host side (use 'qm terminal' to open a terminal connection).
1021 NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines -
1022 use with special care.
1024 CAUTION: Experimental! User reported problems with this option.
1026 `shares`: `<integer> (0 - 50000)` ('default =' `1000`)::
1028 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.
1030 `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>]` ::
1032 Specify SMBIOS type 1 fields.
1034 `base64`=`<boolean>` ;;
1036 Flag to indicate that the SMBIOS values are base64 encoded
1038 `family`=`<Base64 encoded string>` ;;
1040 Set SMBIOS1 family string.
1042 `manufacturer`=`<Base64 encoded string>` ;;
1044 Set SMBIOS1 manufacturer.
1046 `product`=`<Base64 encoded string>` ;;
1048 Set SMBIOS1 product ID.
1050 `serial`=`<Base64 encoded string>` ;;
1052 Set SMBIOS1 serial number.
1054 `sku`=`<Base64 encoded string>` ;;
1056 Set SMBIOS1 SKU string.
1062 `version`=`<Base64 encoded string>` ;;
1064 Set SMBIOS1 version.
1066 `smp`: `<integer> (1 - N)` ('default =' `1`)::
1068 The number of CPUs. Please use option -sockets instead.
1070 `sockets`: `<integer> (1 - N)` ('default =' `1`)::
1072 The number of CPU sockets.
1074 `spice_enhancements`: `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
1076 Configure additional enhancements for SPICE.
1078 `foldersharing`=`<boolean>` ('default =' `0`);;
1080 Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.
1082 `videostreaming`=`<all | filter | off>` ('default =' `off`);;
1084 Enable video streaming. Uses compression for detected video streams.
1086 `sshkeys`: `<string>` ::
1088 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
1090 `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
1092 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'.
1094 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1096 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.
1098 `tablet`: `<boolean>` ('default =' `1`)::
1100 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`).
1102 `tags`: `<string>` ::
1104 Tags of the VM. This is only meta information.
1106 `tdf`: `<boolean>` ('default =' `0`)::
1108 Enable/disable time drift fix.
1110 `template`: `<boolean>` ('default =' `0`)::
1112 Enable/disable Template.
1114 `unused[n]`: `[file=]<volume>` ::
1116 Reference to unused volumes. This is used internally, and should not be modified manually.
1118 `file`=`<volume>` ;;
1120 The drive's backing volume.
1122 `usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
1124 Configure an USB device (n is 0 to 4).
1126 `host`=`<HOSTUSBDEVICE|spice>` ;;
1128 The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
1130 'bus-port(.port)*' (decimal numbers) or
1131 'vendor_id:product_id' (hexadeciaml numbers) or
1134 You can use the 'lsusb -t' command to list existing usb devices.
1136 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such
1137 machines - use with special care.
1139 The value 'spice' can be used to add a usb redirection devices for spice.
1141 `usb3`=`<boolean>` ('default =' `0`);;
1143 Specifies whether if given host option is a USB3 device or port.
1145 `vcpus`: `<integer> (1 - N)` ('default =' `0`)::
1147 Number of hotplugged vcpus.
1149 `vga`: `[[type=]<enum>] [,memory=<integer>]` ::
1151 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.
1152 You can also run without any graphic card, using a serial device as terminal.
1154 `memory`=`<integer> (4 - 512)` ;;
1156 Sets the VGA memory (in MiB). Has no effect with serial display.
1158 `type`=`<cirrus | none | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ('default =' `std`);;
1160 Select the VGA type.
1162 `virtio[n]`: `[file=]<volume> [,aio=<native|threads>] [,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>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
1164 Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
1166 `aio`=`<native | threads>` ;;
1170 `backup`=`<boolean>` ;;
1172 Whether the drive should be included when making backups.
1176 Maximum r/w speed in bytes per second.
1178 `bps_max_length`=`<seconds>` ;;
1180 Maximum length of I/O bursts in seconds.
1184 Maximum read speed in bytes per second.
1186 `bps_rd_max_length`=`<seconds>` ;;
1188 Maximum length of read I/O bursts in seconds.
1192 Maximum write speed in bytes per second.
1194 `bps_wr_max_length`=`<seconds>` ;;
1196 Maximum length of write I/O bursts in seconds.
1198 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
1200 The drive's cache mode
1202 `cyls`=`<integer>` ;;
1204 Force the drive's physical geometry to have a specific cylinder count.
1206 `detect_zeroes`=`<boolean>` ;;
1208 Controls whether to detect and try to optimize writes of zeroes.
1210 `discard`=`<ignore | on>` ;;
1212 Controls whether to pass discard/trim requests to the underlying storage.
1214 `file`=`<volume>` ;;
1216 The drive's backing volume.
1218 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
1220 The drive's backing file's data format.
1222 `heads`=`<integer>` ;;
1224 Force the drive's physical geometry to have a specific head count.
1228 Maximum r/w I/O in operations per second.
1230 `iops_max`=`<iops>` ;;
1232 Maximum unthrottled r/w I/O pool in operations per second.
1234 `iops_max_length`=`<seconds>` ;;
1236 Maximum length of I/O bursts in seconds.
1238 `iops_rd`=`<iops>` ;;
1240 Maximum read I/O in operations per second.
1242 `iops_rd_max`=`<iops>` ;;
1244 Maximum unthrottled read I/O pool in operations per second.
1246 `iops_rd_max_length`=`<seconds>` ;;
1248 Maximum length of read I/O bursts in seconds.
1250 `iops_wr`=`<iops>` ;;
1252 Maximum write I/O in operations per second.
1254 `iops_wr_max`=`<iops>` ;;
1256 Maximum unthrottled write I/O pool in operations per second.
1258 `iops_wr_max_length`=`<seconds>` ;;
1260 Maximum length of write I/O bursts in seconds.
1262 `iothread`=`<boolean>` ;;
1264 Whether to use iothreads for this drive
1268 Maximum r/w speed in megabytes per second.
1270 `mbps_max`=`<mbps>` ;;
1272 Maximum unthrottled r/w pool in megabytes per second.
1274 `mbps_rd`=`<mbps>` ;;
1276 Maximum read speed in megabytes per second.
1278 `mbps_rd_max`=`<mbps>` ;;
1280 Maximum unthrottled read pool in megabytes per second.
1282 `mbps_wr`=`<mbps>` ;;
1284 Maximum write speed in megabytes per second.
1286 `mbps_wr_max`=`<mbps>` ;;
1288 Maximum unthrottled write pool in megabytes per second.
1290 `media`=`<cdrom | disk>` ('default =' `disk`);;
1292 The drive's media type.
1294 `replicate`=`<boolean>` ('default =' `1`);;
1296 Whether the drive should considered for replication jobs.
1298 `rerror`=`<ignore | report | stop>` ;;
1302 `secs`=`<integer>` ;;
1304 Force the drive's physical geometry to have a specific sector count.
1306 `serial`=`<serial>` ;;
1308 The drive's reported serial number, url-encoded, up to 20 bytes long.
1310 `shared`=`<boolean>` ('default =' `0`);;
1312 Mark this locally-managed volume as available on all nodes.
1314 WARNING: This option does not share the volume automatically, it assumes it is shared already!
1316 `size`=`<DiskSize>` ;;
1318 Disk size. This is purely informational and has no effect.
1320 `snapshot`=`<boolean>` ;;
1322 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
1324 `trans`=`<auto | lba | none>` ;;
1326 Force disk geometry bios translation mode.
1328 `werror`=`<enospc | ignore | report | stop>` ;;
1332 `vmgenid`: `<UUID>` ('default =' `1 (autogenerated)`)::
1334 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.
1335 Note that auto-creation only works when done through API/CLI create or update methods, but not when manually editing the config file.
1337 `vmstatestorage`: `<string>` ::
1339 Default storage for VM state volumes/files.
1341 `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1343 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)
1345 `action`=`<debug | none | pause | poweroff | reset | shutdown>` ;;
1347 The action to perform if after activation the guest fails to poll the watchdog in time.
1349 `model`=`<i6300esb | ib700>` ('default =' `i6300esb`);;
1351 Watchdog type to emulate.