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 cloning/moving a disk.
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>]` ::
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`=`<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>` ::
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
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).
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.
426 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
429 `gw`=`<GatewayIPv4>` ;;
431 Default gateway for IPv4 traffic.
433 NOTE: Requires option(s): `ip`
435 `gw6`=`<GatewayIPv6>` ;;
437 Default gateway for IPv6 traffic.
439 NOTE: Requires option(s): `ip6`
441 `ip`=`<IPv4Format/CIDR>` ('default =' `dhcp`);;
443 IPv4 address in CIDR format.
445 `ip6`=`<IPv6Format/CIDR>` ('default =' `dhcp`);;
447 IPv6 address in CIDR format.
449 `ivshmem`: `size=<integer> [,name=<string>]` ::
451 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
455 The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.
457 `size`=`<integer> (1 - N)` ;;
459 The size of the file in MB.
461 `keephugepages`: `<boolean>` ('default =' `0`)::
463 Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
465 `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>` ::
467 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
469 `kvm`: `<boolean>` ('default =' `1`)::
471 Enable/disable KVM hardware virtualization.
473 `localtime`: `<boolean>` ::
475 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
477 `lock`: `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
481 `machine`: `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
483 Specifies the Qemu machine type.
485 `memory`: `<integer> (16 - N)` ('default =' `512`)::
487 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
489 `migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
491 Set maximum tolerated downtime (in seconds) for migrations.
493 `migrate_speed`: `<integer> (0 - N)` ('default =' `0`)::
495 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
497 `name`: `<string>` ::
499 Set a name for the VM. Only used on the configuration web interface.
501 `nameserver`: `<string>` ::
503 cloud-init: Sets DNS server IP address for a container. Create will'
504 .' automatically use the setting from the host if neither searchdomain nor nameserver'
507 `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>]` ::
509 Specify network devices.
511 `bridge`=`<bridge>` ;;
513 Bridge to attach the network device to. The Proxmox VE standard bridge
516 If you do not specify a bridge, we create a kvm user (NATed) network
517 device, which provides DHCP and DNS services. The following addresses
524 The DHCP server assign addresses to the guest starting from 10.0.2.15.
526 `firewall`=`<boolean>` ;;
528 Whether this interface should be protected by the firewall.
530 `link_down`=`<boolean>` ;;
532 Whether this interface should be disconnected (like pulling the plug).
534 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
536 A common MAC address with the I/G (Individual/Group) bit not set.
538 `model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
540 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'.
542 `mtu`=`<integer> (1 - 65520)` ;;
544 Force MTU, for VirtIO only. Set to '1' to use the bridge MTU
546 `queues`=`<integer> (0 - 16)` ;;
548 Number of packet queues to be used on the device.
550 `rate`=`<number> (0 - N)` ;;
552 Rate limit in mbps (megabytes per second) as floating point number.
554 `tag`=`<integer> (1 - 4094)` ;;
556 VLAN tag to apply to packets on this interface.
558 `trunks`=`<vlanid[;vlanid...]>` ;;
560 VLAN trunks to pass through this interface.
562 `numa`: `<boolean>` ('default =' `0`)::
566 `numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
570 `cpus`=`<id[-id];...>` ;;
572 CPUs accessing this NUMA node.
574 `hostnodes`=`<id[-id];...>` ;;
576 Host NUMA nodes to use.
578 `memory`=`<number>` ;;
580 Amount of memory this NUMA node provides.
582 `policy`=`<bind | interleave | preferred>` ;;
584 NUMA allocation policy.
586 `onboot`: `<boolean>` ('default =' `0`)::
588 Specifies whether a VM will be started during system bootup.
590 `ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
592 Specify guest operating system. This is used to enable special
593 optimization/features for specific operating systems:
596 other;; unspecified OS
597 wxp;; Microsoft Windows XP
598 w2k;; Microsoft Windows 2000
599 w2k3;; Microsoft Windows 2003
600 w2k8;; Microsoft Windows 2008
601 wvista;; Microsoft Windows Vista
602 win7;; Microsoft Windows 7
603 win8;; Microsoft Windows 8/2012/2012r2
604 win10;; Microsoft Windows 10/2016
605 l24;; Linux 2.4 Kernel
606 l26;; Linux 2.6 - 5.X Kernel
607 solaris;; Solaris/OpenSolaris/OpenIndiania kernel
609 `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
611 Map host parallel devices (n is 0 to 2).
613 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such
614 machines - use with special care.
616 CAUTION: Experimental! User reported problems with this option.
618 `protection`: `<boolean>` ('default =' `0`)::
620 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
622 `reboot`: `<boolean>` ('default =' `1`)::
624 Allow reboot. If set to '0' the VM exit on reboot.
626 `rng0`: `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
628 Configure a VirtIO-based Random Number Generator.
630 `max_bytes`=`<integer>` ('default =' `1024`);;
632 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!).
634 `period`=`<integer>` ('default =' `1000`);;
636 Every 'period' milliseconds the entropy-injection quota is reset, allowing the guest to retrieve another 'max_bytes' of entropy.
638 `source`=`</dev/hwrng | /dev/random | /dev/urandom>` ;;
640 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.
642 `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>]` ::
644 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
646 `aio`=`<native | threads>` ;;
650 `backup`=`<boolean>` ;;
652 Whether the drive should be included when making backups.
656 Maximum r/w speed in bytes per second.
658 `bps_max_length`=`<seconds>` ;;
660 Maximum length of I/O bursts in seconds.
664 Maximum read speed in bytes per second.
666 `bps_rd_max_length`=`<seconds>` ;;
668 Maximum length of read I/O bursts in seconds.
672 Maximum write speed in bytes per second.
674 `bps_wr_max_length`=`<seconds>` ;;
676 Maximum length of write I/O bursts in seconds.
678 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
680 The drive's cache mode
682 `cyls`=`<integer>` ;;
684 Force the drive's physical geometry to have a specific cylinder count.
686 `detect_zeroes`=`<boolean>` ;;
688 Controls whether to detect and try to optimize writes of zeroes.
690 `discard`=`<ignore | on>` ;;
692 Controls whether to pass discard/trim requests to the underlying storage.
696 The drive's backing volume.
698 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
700 The drive's backing file's data format.
702 `heads`=`<integer>` ;;
704 Force the drive's physical geometry to have a specific head count.
708 Maximum r/w I/O in operations per second.
710 `iops_max`=`<iops>` ;;
712 Maximum unthrottled r/w I/O pool in operations per second.
714 `iops_max_length`=`<seconds>` ;;
716 Maximum length of I/O bursts in seconds.
718 `iops_rd`=`<iops>` ;;
720 Maximum read I/O in operations per second.
722 `iops_rd_max`=`<iops>` ;;
724 Maximum unthrottled read I/O pool in operations per second.
726 `iops_rd_max_length`=`<seconds>` ;;
728 Maximum length of read I/O bursts in seconds.
730 `iops_wr`=`<iops>` ;;
732 Maximum write I/O in operations per second.
734 `iops_wr_max`=`<iops>` ;;
736 Maximum unthrottled write I/O pool in operations per second.
738 `iops_wr_max_length`=`<seconds>` ;;
740 Maximum length of write I/O bursts in seconds.
744 Maximum r/w speed in megabytes per second.
746 `mbps_max`=`<mbps>` ;;
748 Maximum unthrottled r/w pool in megabytes per second.
750 `mbps_rd`=`<mbps>` ;;
752 Maximum read speed in megabytes per second.
754 `mbps_rd_max`=`<mbps>` ;;
756 Maximum unthrottled read pool in megabytes per second.
758 `mbps_wr`=`<mbps>` ;;
760 Maximum write speed in megabytes per second.
762 `mbps_wr_max`=`<mbps>` ;;
764 Maximum unthrottled write pool in megabytes per second.
766 `media`=`<cdrom | disk>` ('default =' `disk`);;
768 The drive's media type.
770 `replicate`=`<boolean>` ('default =' `1`);;
772 Whether the drive should considered for replication jobs.
774 `rerror`=`<ignore | report | stop>` ;;
778 `secs`=`<integer>` ;;
780 Force the drive's physical geometry to have a specific sector count.
782 `serial`=`<serial>` ;;
784 The drive's reported serial number, url-encoded, up to 20 bytes long.
786 `shared`=`<boolean>` ('default =' `0`);;
788 Mark this locally-managed volume as available on all nodes.
790 WARNING: This option does not share the volume automatically, it assumes it is shared already!
792 `size`=`<DiskSize>` ;;
794 Disk size. This is purely informational and has no effect.
796 `snapshot`=`<boolean>` ;;
798 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
802 Whether to expose this drive as an SSD, rather than a rotational hard disk.
804 `trans`=`<auto | lba | none>` ;;
806 Force disk geometry bios translation mode.
808 `werror`=`<enospc | ignore | report | stop>` ;;
814 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
816 `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>]` ::
818 Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).
820 `aio`=`<native | threads>` ;;
824 `backup`=`<boolean>` ;;
826 Whether the drive should be included when making backups.
830 Maximum r/w speed in bytes per second.
832 `bps_max_length`=`<seconds>` ;;
834 Maximum length of I/O bursts in seconds.
838 Maximum read speed in bytes per second.
840 `bps_rd_max_length`=`<seconds>` ;;
842 Maximum length of read I/O bursts in seconds.
846 Maximum write speed in bytes per second.
848 `bps_wr_max_length`=`<seconds>` ;;
850 Maximum length of write I/O bursts in seconds.
852 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
854 The drive's cache mode
856 `cyls`=`<integer>` ;;
858 Force the drive's physical geometry to have a specific cylinder count.
860 `detect_zeroes`=`<boolean>` ;;
862 Controls whether to detect and try to optimize writes of zeroes.
864 `discard`=`<ignore | on>` ;;
866 Controls whether to pass discard/trim requests to the underlying storage.
870 The drive's backing volume.
872 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
874 The drive's backing file's data format.
876 `heads`=`<integer>` ;;
878 Force the drive's physical geometry to have a specific head count.
882 Maximum r/w I/O in operations per second.
884 `iops_max`=`<iops>` ;;
886 Maximum unthrottled r/w I/O pool in operations per second.
888 `iops_max_length`=`<seconds>` ;;
890 Maximum length of I/O bursts in seconds.
892 `iops_rd`=`<iops>` ;;
894 Maximum read I/O in operations per second.
896 `iops_rd_max`=`<iops>` ;;
898 Maximum unthrottled read I/O pool in operations per second.
900 `iops_rd_max_length`=`<seconds>` ;;
902 Maximum length of read I/O bursts in seconds.
904 `iops_wr`=`<iops>` ;;
906 Maximum write I/O in operations per second.
908 `iops_wr_max`=`<iops>` ;;
910 Maximum unthrottled write I/O pool in operations per second.
912 `iops_wr_max_length`=`<seconds>` ;;
914 Maximum length of write I/O bursts in seconds.
916 `iothread`=`<boolean>` ;;
918 Whether to use iothreads for this drive
922 Maximum r/w speed in megabytes per second.
924 `mbps_max`=`<mbps>` ;;
926 Maximum unthrottled r/w pool in megabytes per second.
928 `mbps_rd`=`<mbps>` ;;
930 Maximum read speed in megabytes per second.
932 `mbps_rd_max`=`<mbps>` ;;
934 Maximum unthrottled read pool in megabytes per second.
936 `mbps_wr`=`<mbps>` ;;
938 Maximum write speed in megabytes per second.
940 `mbps_wr_max`=`<mbps>` ;;
942 Maximum unthrottled write pool in megabytes per second.
944 `media`=`<cdrom | disk>` ('default =' `disk`);;
946 The drive's media type.
948 `queues`=`<integer> (2 - N)` ;;
952 `replicate`=`<boolean>` ('default =' `1`);;
954 Whether the drive should considered for replication jobs.
956 `rerror`=`<ignore | report | stop>` ;;
960 `scsiblock`=`<boolean>` ('default =' `0`);;
962 whether to use scsi-block for full passthrough of host block device
964 WARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host
966 `secs`=`<integer>` ;;
968 Force the drive's physical geometry to have a specific sector count.
970 `serial`=`<serial>` ;;
972 The drive's reported serial number, url-encoded, up to 20 bytes long.
974 `shared`=`<boolean>` ('default =' `0`);;
976 Mark this locally-managed volume as available on all nodes.
978 WARNING: This option does not share the volume automatically, it assumes it is shared already!
980 `size`=`<DiskSize>` ;;
982 Disk size. This is purely informational and has no effect.
984 `snapshot`=`<boolean>` ;;
986 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
990 Whether to expose this drive as an SSD, rather than a rotational hard disk.
992 `trans`=`<auto | lba | none>` ;;
994 Force disk geometry bios translation mode.
996 `werror`=`<enospc | ignore | report | stop>` ;;
1002 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
1004 `scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
1006 SCSI controller model
1008 `searchdomain`: `<string>` ::
1010 cloud-init: Sets DNS search domains for a container. Create will'
1011 .' automatically use the setting from the host if neither searchdomain nor nameserver'
1014 `serial[n]`: `(/dev/.+|socket)` ::
1016 Create a serial device inside the VM (n is 0 to 3), and pass through a
1017 host serial device (i.e. /dev/ttyS0), or create a unix socket on the
1018 host side (use 'qm terminal' to open a terminal connection).
1020 NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines -
1021 use with special care.
1023 CAUTION: Experimental! User reported problems with this option.
1025 `shares`: `<integer> (0 - 50000)` ('default =' `1000`)::
1027 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.
1029 `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>]` ::
1031 Specify SMBIOS type 1 fields.
1033 `base64`=`<boolean>` ;;
1035 Flag to indicate that the SMBIOS values are base64 encoded
1037 `family`=`<Base64 encoded string>` ;;
1039 Set SMBIOS1 family string.
1041 `manufacturer`=`<Base64 encoded string>` ;;
1043 Set SMBIOS1 manufacturer.
1045 `product`=`<Base64 encoded string>` ;;
1047 Set SMBIOS1 product ID.
1049 `serial`=`<Base64 encoded string>` ;;
1051 Set SMBIOS1 serial number.
1053 `sku`=`<Base64 encoded string>` ;;
1055 Set SMBIOS1 SKU string.
1061 `version`=`<Base64 encoded string>` ;;
1063 Set SMBIOS1 version.
1065 `smp`: `<integer> (1 - N)` ('default =' `1`)::
1067 The number of CPUs. Please use option -sockets instead.
1069 `sockets`: `<integer> (1 - N)` ('default =' `1`)::
1071 The number of CPU sockets.
1073 `spice_enhancements`: `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
1075 Configure additional enhancements for SPICE.
1077 `foldersharing`=`<boolean>` ('default =' `0`);;
1079 Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.
1081 `videostreaming`=`<all | filter | off>` ('default =' `off`);;
1083 Enable video streaming. Uses compression for detected video streams.
1085 `sshkeys`: `<string>` ::
1087 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
1089 `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
1091 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'.
1093 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1095 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.
1097 `tablet`: `<boolean>` ('default =' `1`)::
1099 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`).
1101 `tags`: `<string>` ::
1103 Tags of the VM. This is only meta information.
1105 `tdf`: `<boolean>` ('default =' `0`)::
1107 Enable/disable time drift fix.
1109 `template`: `<boolean>` ('default =' `0`)::
1111 Enable/disable Template.
1113 `unused[n]`: `[file=]<volume>` ::
1115 Reference to unused volumes. This is used internally, and should not be modified manually.
1117 `file`=`<volume>` ;;
1119 The drive's backing volume.
1121 `usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
1123 Configure an USB device (n is 0 to 4).
1125 `host`=`<HOSTUSBDEVICE|spice>` ;;
1127 The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
1129 'bus-port(.port)*' (decimal numbers) or
1130 'vendor_id:product_id' (hexadeciaml numbers) or
1133 You can use the 'lsusb -t' command to list existing usb devices.
1135 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such
1136 machines - use with special care.
1138 The value 'spice' can be used to add a usb redirection devices for spice.
1140 `usb3`=`<boolean>` ('default =' `0`);;
1142 Specifies whether if given host option is a USB3 device or port.
1144 `vcpus`: `<integer> (1 - N)` ('default =' `0`)::
1146 Number of hotplugged vcpus.
1148 `vga`: `[[type=]<enum>] [,memory=<integer>]` ::
1150 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.
1151 You can also run without any graphic card, using a serial device as terminal.
1153 `memory`=`<integer> (4 - 512)` ;;
1155 Sets the VGA memory (in MiB). Has no effect with serial display.
1157 `type`=`<cirrus | none | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ('default =' `std`);;
1159 Select the VGA type.
1161 `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>]` ::
1163 Use volume as VIRTIO hard disk (n is 0 to 15).
1165 `aio`=`<native | threads>` ;;
1169 `backup`=`<boolean>` ;;
1171 Whether the drive should be included when making backups.
1175 Maximum r/w speed in bytes per second.
1177 `bps_max_length`=`<seconds>` ;;
1179 Maximum length of I/O bursts in seconds.
1183 Maximum read speed in bytes per second.
1185 `bps_rd_max_length`=`<seconds>` ;;
1187 Maximum length of read I/O bursts in seconds.
1191 Maximum write speed in bytes per second.
1193 `bps_wr_max_length`=`<seconds>` ;;
1195 Maximum length of write I/O bursts in seconds.
1197 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
1199 The drive's cache mode
1201 `cyls`=`<integer>` ;;
1203 Force the drive's physical geometry to have a specific cylinder count.
1205 `detect_zeroes`=`<boolean>` ;;
1207 Controls whether to detect and try to optimize writes of zeroes.
1209 `discard`=`<ignore | on>` ;;
1211 Controls whether to pass discard/trim requests to the underlying storage.
1213 `file`=`<volume>` ;;
1215 The drive's backing volume.
1217 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
1219 The drive's backing file's data format.
1221 `heads`=`<integer>` ;;
1223 Force the drive's physical geometry to have a specific head count.
1227 Maximum r/w I/O in operations per second.
1229 `iops_max`=`<iops>` ;;
1231 Maximum unthrottled r/w I/O pool in operations per second.
1233 `iops_max_length`=`<seconds>` ;;
1235 Maximum length of I/O bursts in seconds.
1237 `iops_rd`=`<iops>` ;;
1239 Maximum read I/O in operations per second.
1241 `iops_rd_max`=`<iops>` ;;
1243 Maximum unthrottled read I/O pool in operations per second.
1245 `iops_rd_max_length`=`<seconds>` ;;
1247 Maximum length of read I/O bursts in seconds.
1249 `iops_wr`=`<iops>` ;;
1251 Maximum write I/O in operations per second.
1253 `iops_wr_max`=`<iops>` ;;
1255 Maximum unthrottled write I/O pool in operations per second.
1257 `iops_wr_max_length`=`<seconds>` ;;
1259 Maximum length of write I/O bursts in seconds.
1261 `iothread`=`<boolean>` ;;
1263 Whether to use iothreads for this drive
1267 Maximum r/w speed in megabytes per second.
1269 `mbps_max`=`<mbps>` ;;
1271 Maximum unthrottled r/w pool in megabytes per second.
1273 `mbps_rd`=`<mbps>` ;;
1275 Maximum read speed in megabytes per second.
1277 `mbps_rd_max`=`<mbps>` ;;
1279 Maximum unthrottled read pool in megabytes per second.
1281 `mbps_wr`=`<mbps>` ;;
1283 Maximum write speed in megabytes per second.
1285 `mbps_wr_max`=`<mbps>` ;;
1287 Maximum unthrottled write pool in megabytes per second.
1289 `media`=`<cdrom | disk>` ('default =' `disk`);;
1291 The drive's media type.
1293 `replicate`=`<boolean>` ('default =' `1`);;
1295 Whether the drive should considered for replication jobs.
1297 `rerror`=`<ignore | report | stop>` ;;
1301 `secs`=`<integer>` ;;
1303 Force the drive's physical geometry to have a specific sector count.
1305 `serial`=`<serial>` ;;
1307 The drive's reported serial number, url-encoded, up to 20 bytes long.
1309 `shared`=`<boolean>` ('default =' `0`);;
1311 Mark this locally-managed volume as available on all nodes.
1313 WARNING: This option does not share the volume automatically, it assumes it is shared already!
1315 `size`=`<DiskSize>` ;;
1317 Disk size. This is purely informational and has no effect.
1319 `snapshot`=`<boolean>` ;;
1321 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
1323 `trans`=`<auto | lba | none>` ;;
1325 Force disk geometry bios translation mode.
1327 `werror`=`<enospc | ignore | report | stop>` ;;
1331 `vmgenid`: `<UUID>` ('default =' `1 (autogenerated)`)::
1333 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.
1334 Note that auto-creation only works when done through API/CLI create or update methods, but not when manually editing the config file.
1336 `vmstatestorage`: `<string>` ::
1338 Default storage for VM state volumes/files.
1340 `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1342 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)
1344 `action`=`<debug | none | pause | poweroff | reset | shutdown>` ;;
1346 The action to perform if after activation the guest fails to poll the watchdog in time.
1348 `model`=`<i6300esb | ib700>` ('default =' `i6300esb`);;
1350 Watchdog type to emulate.