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`: `[acdn]{1,4}` ('default =' `cdn`)::
59 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
61 `bootdisk`: `(ide|sata|scsi|virtio)\d+` ::
63 Enable booting from specified disk.
65 `cdrom`: `<volume>` ::
67 This is an alias for option -ide2
69 `cicustom`: `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
71 cloud-init: Specify custom files to replace the automatically generated ones at start.
75 Specify a custom file containing all meta data passed to the VM via cloud-init. This is provider specific meaning configdrive2 and nocloud differ.
77 `network`=`<volume>` ;;
79 Specify a custom file containing all network data passed to the VM via cloud-init.
83 Specify a custom file containing all user data passed to the VM via cloud-init.
85 `cipassword`: `<string>` ::
87 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.
89 `citype`: `<configdrive2 | nocloud>` ::
91 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.
93 `ciuser`: `<string>` ::
95 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
97 `cores`: `<integer> (1 - N)` ('default =' `1`)::
99 The number of cores per socket.
101 `cpu`: `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
105 `cputype`=`<string>` ('default =' `kvm64`);;
107 Emulated CPU type. Can be default or custom name (custom model names must be prefixed with 'custom-').
109 `flags`=`<+FLAG[;-FLAG...]>` ;;
111 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.
113 `hidden`=`<boolean>` ('default =' `0`);;
115 Do not identify as a KVM virtual machine.
117 `hv-vendor-id`=`<vendor-id>` ;;
119 The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.
121 `phys-bits`=`<8-64|host>` ;;
123 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.
125 `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`);;
127 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.
129 `cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
133 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
135 `cpuunits`: `<integer> (2 - 262144)` ('default =' `1024`)::
137 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.
139 `description`: `<string>` ::
141 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
143 `efidisk0`: `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
145 Configure a Disk for storing EFI vars
149 The drive's backing volume.
151 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
153 The drive's backing file's data format.
155 `size`=`<DiskSize>` ;;
157 Disk size. This is purely informational and has no effect.
159 `freeze`: `<boolean>` ::
161 Freeze CPU at startup (use 'c' monitor command to start execution).
163 `hookscript`: `<string>` ::
165 Script that will be executed during various steps in the vms lifetime.
167 `hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
169 Map host PCI devices into guest.
171 NOTE: This option allows direct access to host hardware. So it is no longer
172 possible to migrate such machines - use with special care.
174 CAUTION: Experimental! User reported problems with this option.
176 `host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
178 Host PCI device pass through. The PCI ID of a host's PCI device or a list
179 of PCI virtual functions of the host. HOSTPCIID syntax is:
181 'bus:dev.func' (hexadecimal numbers)
183 You can us the 'lspci' command to list existing PCI devices.
185 `legacy-igd`=`<boolean>` ('default =' `0`);;
187 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'.
191 The type of mediated device to use.
192 An instance of this type will be created on startup of the VM and
193 will be cleaned up when the VM stops.
195 `pcie`=`<boolean>` ('default =' `0`);;
197 Choose the PCI-express bus (needs the 'q35' machine model).
199 `rombar`=`<boolean>` ('default =' `1`);;
201 Specify whether or not the device's ROM will be visible in the guest's memory map.
203 `romfile`=`<string>` ;;
205 Custom pci device rom filename (must be located in /usr/share/kvm/).
207 `x-vga`=`<boolean>` ('default =' `0`);;
209 Enable vfio-vga device support.
211 `hotplug`: `<string>` ('default =' `network,disk,usb`)::
213 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'.
215 `hugepages`: `<1024 | 2 | any>` ::
217 Enable/disable hugepages memory.
219 `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>]` ::
221 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
223 `aio`=`<native | threads>` ;;
227 `backup`=`<boolean>` ;;
229 Whether the drive should be included when making backups.
233 Maximum r/w speed in bytes per second.
235 `bps_max_length`=`<seconds>` ;;
237 Maximum length of I/O bursts in seconds.
241 Maximum read speed in bytes per second.
243 `bps_rd_max_length`=`<seconds>` ;;
245 Maximum length of read I/O bursts in seconds.
249 Maximum write speed in bytes per second.
251 `bps_wr_max_length`=`<seconds>` ;;
253 Maximum length of write I/O bursts in seconds.
255 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
257 The drive's cache mode
259 `cyls`=`<integer>` ;;
261 Force the drive's physical geometry to have a specific cylinder count.
263 `detect_zeroes`=`<boolean>` ;;
265 Controls whether to detect and try to optimize writes of zeroes.
267 `discard`=`<ignore | on>` ;;
269 Controls whether to pass discard/trim requests to the underlying storage.
273 The drive's backing volume.
275 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
277 The drive's backing file's data format.
279 `heads`=`<integer>` ;;
281 Force the drive's physical geometry to have a specific head count.
285 Maximum r/w I/O in operations per second.
287 `iops_max`=`<iops>` ;;
289 Maximum unthrottled r/w I/O pool in operations per second.
291 `iops_max_length`=`<seconds>` ;;
293 Maximum length of I/O bursts in seconds.
295 `iops_rd`=`<iops>` ;;
297 Maximum read I/O in operations per second.
299 `iops_rd_max`=`<iops>` ;;
301 Maximum unthrottled read I/O pool in operations per second.
303 `iops_rd_max_length`=`<seconds>` ;;
305 Maximum length of read I/O bursts in seconds.
307 `iops_wr`=`<iops>` ;;
309 Maximum write I/O in operations per second.
311 `iops_wr_max`=`<iops>` ;;
313 Maximum unthrottled write I/O pool in operations per second.
315 `iops_wr_max_length`=`<seconds>` ;;
317 Maximum length of write I/O bursts in seconds.
321 Maximum r/w speed in megabytes per second.
323 `mbps_max`=`<mbps>` ;;
325 Maximum unthrottled r/w pool in megabytes per second.
327 `mbps_rd`=`<mbps>` ;;
329 Maximum read speed in megabytes per second.
331 `mbps_rd_max`=`<mbps>` ;;
333 Maximum unthrottled read pool in megabytes per second.
335 `mbps_wr`=`<mbps>` ;;
337 Maximum write speed in megabytes per second.
339 `mbps_wr_max`=`<mbps>` ;;
341 Maximum unthrottled write pool in megabytes per second.
343 `media`=`<cdrom | disk>` ('default =' `disk`);;
345 The drive's media type.
349 The drive's reported model name, url-encoded, up to 40 bytes long.
351 `replicate`=`<boolean>` ('default =' `1`);;
353 Whether the drive should considered for replication jobs.
355 `rerror`=`<ignore | report | stop>` ;;
359 `secs`=`<integer>` ;;
361 Force the drive's physical geometry to have a specific sector count.
363 `serial`=`<serial>` ;;
365 The drive's reported serial number, url-encoded, up to 20 bytes long.
367 `shared`=`<boolean>` ('default =' `0`);;
369 Mark this locally-managed volume as available on all nodes.
371 WARNING: This option does not share the volume automatically, it assumes it is shared already!
373 `size`=`<DiskSize>` ;;
375 Disk size. This is purely informational and has no effect.
377 `snapshot`=`<boolean>` ;;
379 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
383 Whether to expose this drive as an SSD, rather than a rotational hard disk.
385 `trans`=`<auto | lba | none>` ;;
387 Force disk geometry bios translation mode.
389 `werror`=`<enospc | ignore | report | stop>` ;;
395 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
397 `ipconfig[n]`: `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
399 cloud-init: Specify IP addresses and gateways for the corresponding interface.
401 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
403 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
404 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
406 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
408 `gw`=`<GatewayIPv4>` ;;
410 Default gateway for IPv4 traffic.
412 NOTE: Requires option(s): `ip`
414 `gw6`=`<GatewayIPv6>` ;;
416 Default gateway for IPv6 traffic.
418 NOTE: Requires option(s): `ip6`
420 `ip`=`<IPv4Format/CIDR>` ('default =' `dhcp`);;
422 IPv4 address in CIDR format.
424 `ip6`=`<IPv6Format/CIDR>` ('default =' `dhcp`);;
426 IPv6 address in CIDR format.
428 `ivshmem`: `size=<integer> [,name=<string>]` ::
430 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
434 The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.
436 `size`=`<integer> (1 - N)` ;;
438 The size of the file in MB.
440 `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>` ::
442 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
444 `kvm`: `<boolean>` ('default =' `1`)::
446 Enable/disable KVM hardware virtualization.
448 `localtime`: `<boolean>` ::
450 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
452 `lock`: `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
456 `machine`: `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
458 Specifies the Qemu machine type.
460 `memory`: `<integer> (16 - N)` ('default =' `512`)::
462 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
464 `migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
466 Set maximum tolerated downtime (in seconds) for migrations.
468 `migrate_speed`: `<integer> (0 - N)` ('default =' `0`)::
470 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
472 `name`: `<string>` ::
474 Set a name for the VM. Only used on the configuration web interface.
476 `nameserver`: `<string>` ::
478 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.
480 `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>]` ::
482 Specify network devices.
484 `bridge`=`<bridge>` ;;
486 Bridge to attach the network device to. The Proxmox VE standard bridge
489 If you do not specify a bridge, we create a kvm user (NATed) network
490 device, which provides DHCP and DNS services. The following addresses
497 The DHCP server assign addresses to the guest starting from 10.0.2.15.
499 `firewall`=`<boolean>` ;;
501 Whether this interface should be protected by the firewall.
503 `link_down`=`<boolean>` ;;
505 Whether this interface should be disconnected (like pulling the plug).
507 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
509 A common MAC address with the I/G (Individual/Group) bit not set.
511 `model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
513 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'.
515 `mtu`=`<integer> (1 - 65520)` ;;
517 Force MTU, for VirtIO only. Set to '1' to use the bridge MTU
519 `queues`=`<integer> (0 - 16)` ;;
521 Number of packet queues to be used on the device.
523 `rate`=`<number> (0 - N)` ;;
525 Rate limit in mbps (megabytes per second) as floating point number.
527 `tag`=`<integer> (1 - 4094)` ;;
529 VLAN tag to apply to packets on this interface.
531 `trunks`=`<vlanid[;vlanid...]>` ;;
533 VLAN trunks to pass through this interface.
535 `numa`: `<boolean>` ('default =' `0`)::
539 `numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
543 `cpus`=`<id[-id];...>` ;;
545 CPUs accessing this NUMA node.
547 `hostnodes`=`<id[-id];...>` ;;
549 Host NUMA nodes to use.
551 `memory`=`<number>` ;;
553 Amount of memory this NUMA node provides.
555 `policy`=`<bind | interleave | preferred>` ;;
557 NUMA allocation policy.
559 `onboot`: `<boolean>` ('default =' `0`)::
561 Specifies whether a VM will be started during system bootup.
563 `ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
565 Specify guest operating system. This is used to enable special
566 optimization/features for specific operating systems:
569 other;; unspecified OS
570 wxp;; Microsoft Windows XP
571 w2k;; Microsoft Windows 2000
572 w2k3;; Microsoft Windows 2003
573 w2k8;; Microsoft Windows 2008
574 wvista;; Microsoft Windows Vista
575 win7;; Microsoft Windows 7
576 win8;; Microsoft Windows 8/2012/2012r2
577 win10;; Microsoft Windows 10/2016
578 l24;; Linux 2.4 Kernel
579 l26;; Linux 2.6 - 5.X Kernel
580 solaris;; Solaris/OpenSolaris/OpenIndiania kernel
582 `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
584 Map host parallel devices (n is 0 to 2).
586 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
588 CAUTION: Experimental! User reported problems with this option.
590 `protection`: `<boolean>` ('default =' `0`)::
592 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
594 `reboot`: `<boolean>` ('default =' `1`)::
596 Allow reboot. If set to '0' the VM exit on reboot.
598 `rng0`: `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
600 Configure a VirtIO-based Random Number Generator.
602 `max_bytes`=`<integer>` ('default =' `1024`);;
604 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!).
606 `period`=`<integer>` ('default =' `1000`);;
608 Every 'period' milliseconds the entropy-injection quota is reset, allowing the guest to retrieve another 'max_bytes' of entropy.
610 `source`=`</dev/hwrng | /dev/random | /dev/urandom>` ;;
612 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.
614 `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>]` ::
616 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
618 `aio`=`<native | threads>` ;;
622 `backup`=`<boolean>` ;;
624 Whether the drive should be included when making backups.
628 Maximum r/w speed in bytes per second.
630 `bps_max_length`=`<seconds>` ;;
632 Maximum length of I/O bursts in seconds.
636 Maximum read speed in bytes per second.
638 `bps_rd_max_length`=`<seconds>` ;;
640 Maximum length of read I/O bursts in seconds.
644 Maximum write speed in bytes per second.
646 `bps_wr_max_length`=`<seconds>` ;;
648 Maximum length of write I/O bursts in seconds.
650 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
652 The drive's cache mode
654 `cyls`=`<integer>` ;;
656 Force the drive's physical geometry to have a specific cylinder count.
658 `detect_zeroes`=`<boolean>` ;;
660 Controls whether to detect and try to optimize writes of zeroes.
662 `discard`=`<ignore | on>` ;;
664 Controls whether to pass discard/trim requests to the underlying storage.
668 The drive's backing volume.
670 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
672 The drive's backing file's data format.
674 `heads`=`<integer>` ;;
676 Force the drive's physical geometry to have a specific head count.
680 Maximum r/w I/O in operations per second.
682 `iops_max`=`<iops>` ;;
684 Maximum unthrottled r/w I/O pool in operations per second.
686 `iops_max_length`=`<seconds>` ;;
688 Maximum length of I/O bursts in seconds.
690 `iops_rd`=`<iops>` ;;
692 Maximum read I/O in operations per second.
694 `iops_rd_max`=`<iops>` ;;
696 Maximum unthrottled read I/O pool in operations per second.
698 `iops_rd_max_length`=`<seconds>` ;;
700 Maximum length of read I/O bursts in seconds.
702 `iops_wr`=`<iops>` ;;
704 Maximum write I/O in operations per second.
706 `iops_wr_max`=`<iops>` ;;
708 Maximum unthrottled write I/O pool in operations per second.
710 `iops_wr_max_length`=`<seconds>` ;;
712 Maximum length of write I/O bursts in seconds.
716 Maximum r/w speed in megabytes per second.
718 `mbps_max`=`<mbps>` ;;
720 Maximum unthrottled r/w pool in megabytes per second.
722 `mbps_rd`=`<mbps>` ;;
724 Maximum read speed in megabytes per second.
726 `mbps_rd_max`=`<mbps>` ;;
728 Maximum unthrottled read pool in megabytes per second.
730 `mbps_wr`=`<mbps>` ;;
732 Maximum write speed in megabytes per second.
734 `mbps_wr_max`=`<mbps>` ;;
736 Maximum unthrottled write pool in megabytes per second.
738 `media`=`<cdrom | disk>` ('default =' `disk`);;
740 The drive's media type.
742 `replicate`=`<boolean>` ('default =' `1`);;
744 Whether the drive should considered for replication jobs.
746 `rerror`=`<ignore | report | stop>` ;;
750 `secs`=`<integer>` ;;
752 Force the drive's physical geometry to have a specific sector count.
754 `serial`=`<serial>` ;;
756 The drive's reported serial number, url-encoded, up to 20 bytes long.
758 `shared`=`<boolean>` ('default =' `0`);;
760 Mark this locally-managed volume as available on all nodes.
762 WARNING: This option does not share the volume automatically, it assumes it is shared already!
764 `size`=`<DiskSize>` ;;
766 Disk size. This is purely informational and has no effect.
768 `snapshot`=`<boolean>` ;;
770 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
774 Whether to expose this drive as an SSD, rather than a rotational hard disk.
776 `trans`=`<auto | lba | none>` ;;
778 Force disk geometry bios translation mode.
780 `werror`=`<enospc | ignore | report | stop>` ;;
786 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
788 `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>]` ::
790 Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).
792 `aio`=`<native | threads>` ;;
796 `backup`=`<boolean>` ;;
798 Whether the drive should be included when making backups.
802 Maximum r/w speed in bytes per second.
804 `bps_max_length`=`<seconds>` ;;
806 Maximum length of I/O bursts in seconds.
810 Maximum read speed in bytes per second.
812 `bps_rd_max_length`=`<seconds>` ;;
814 Maximum length of read I/O bursts in seconds.
818 Maximum write speed in bytes per second.
820 `bps_wr_max_length`=`<seconds>` ;;
822 Maximum length of write I/O bursts in seconds.
824 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
826 The drive's cache mode
828 `cyls`=`<integer>` ;;
830 Force the drive's physical geometry to have a specific cylinder count.
832 `detect_zeroes`=`<boolean>` ;;
834 Controls whether to detect and try to optimize writes of zeroes.
836 `discard`=`<ignore | on>` ;;
838 Controls whether to pass discard/trim requests to the underlying storage.
842 The drive's backing volume.
844 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
846 The drive's backing file's data format.
848 `heads`=`<integer>` ;;
850 Force the drive's physical geometry to have a specific head count.
854 Maximum r/w I/O in operations per second.
856 `iops_max`=`<iops>` ;;
858 Maximum unthrottled r/w I/O pool in operations per second.
860 `iops_max_length`=`<seconds>` ;;
862 Maximum length of I/O bursts in seconds.
864 `iops_rd`=`<iops>` ;;
866 Maximum read I/O in operations per second.
868 `iops_rd_max`=`<iops>` ;;
870 Maximum unthrottled read I/O pool in operations per second.
872 `iops_rd_max_length`=`<seconds>` ;;
874 Maximum length of read I/O bursts in seconds.
876 `iops_wr`=`<iops>` ;;
878 Maximum write I/O in operations per second.
880 `iops_wr_max`=`<iops>` ;;
882 Maximum unthrottled write I/O pool in operations per second.
884 `iops_wr_max_length`=`<seconds>` ;;
886 Maximum length of write I/O bursts in seconds.
888 `iothread`=`<boolean>` ;;
890 Whether to use iothreads for this drive
894 Maximum r/w speed in megabytes per second.
896 `mbps_max`=`<mbps>` ;;
898 Maximum unthrottled r/w pool in megabytes per second.
900 `mbps_rd`=`<mbps>` ;;
902 Maximum read speed in megabytes per second.
904 `mbps_rd_max`=`<mbps>` ;;
906 Maximum unthrottled read pool in megabytes per second.
908 `mbps_wr`=`<mbps>` ;;
910 Maximum write speed in megabytes per second.
912 `mbps_wr_max`=`<mbps>` ;;
914 Maximum unthrottled write pool in megabytes per second.
916 `media`=`<cdrom | disk>` ('default =' `disk`);;
918 The drive's media type.
920 `queues`=`<integer> (2 - N)` ;;
924 `replicate`=`<boolean>` ('default =' `1`);;
926 Whether the drive should considered for replication jobs.
928 `rerror`=`<ignore | report | stop>` ;;
932 `scsiblock`=`<boolean>` ('default =' `0`);;
934 whether to use scsi-block for full passthrough of host block device
936 WARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host
938 `secs`=`<integer>` ;;
940 Force the drive's physical geometry to have a specific sector count.
942 `serial`=`<serial>` ;;
944 The drive's reported serial number, url-encoded, up to 20 bytes long.
946 `shared`=`<boolean>` ('default =' `0`);;
948 Mark this locally-managed volume as available on all nodes.
950 WARNING: This option does not share the volume automatically, it assumes it is shared already!
952 `size`=`<DiskSize>` ;;
954 Disk size. This is purely informational and has no effect.
956 `snapshot`=`<boolean>` ;;
958 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
962 Whether to expose this drive as an SSD, rather than a rotational hard disk.
964 `trans`=`<auto | lba | none>` ;;
966 Force disk geometry bios translation mode.
968 `werror`=`<enospc | ignore | report | stop>` ;;
974 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
976 `scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
978 SCSI controller model
980 `searchdomain`: `<string>` ::
982 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.
984 `serial[n]`: `(/dev/.+|socket)` ::
986 Create a serial device inside the VM (n is 0 to 3), and pass through a
987 host serial device (i.e. /dev/ttyS0), or create a unix socket on the
988 host side (use 'qm terminal' to open a terminal connection).
990 NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.
992 CAUTION: Experimental! User reported problems with this option.
994 `shares`: `<integer> (0 - 50000)` ('default =' `1000`)::
996 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.
998 `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>]` ::
1000 Specify SMBIOS type 1 fields.
1002 `base64`=`<boolean>` ;;
1004 Flag to indicate that the SMBIOS values are base64 encoded
1006 `family`=`<Base64 encoded string>` ;;
1008 Set SMBIOS1 family string.
1010 `manufacturer`=`<Base64 encoded string>` ;;
1012 Set SMBIOS1 manufacturer.
1014 `product`=`<Base64 encoded string>` ;;
1016 Set SMBIOS1 product ID.
1018 `serial`=`<Base64 encoded string>` ;;
1020 Set SMBIOS1 serial number.
1022 `sku`=`<Base64 encoded string>` ;;
1024 Set SMBIOS1 SKU string.
1030 `version`=`<Base64 encoded string>` ;;
1032 Set SMBIOS1 version.
1034 `smp`: `<integer> (1 - N)` ('default =' `1`)::
1036 The number of CPUs. Please use option -sockets instead.
1038 `sockets`: `<integer> (1 - N)` ('default =' `1`)::
1040 The number of CPU sockets.
1042 `spice_enhancements`: `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
1044 Configure additional enhancements for SPICE.
1046 `foldersharing`=`<boolean>` ('default =' `0`);;
1048 Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.
1050 `videostreaming`=`<all | filter | off>` ('default =' `off`);;
1052 Enable video streaming. Uses compression for detected video streams.
1054 `sshkeys`: `<string>` ::
1056 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
1058 `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
1060 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'.
1062 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1064 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.
1066 `tablet`: `<boolean>` ('default =' `1`)::
1068 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 (-vga=qxl).
1070 `tags`: `<string>` ::
1072 Tags of the VM. This is only meta information.
1074 `tdf`: `<boolean>` ('default =' `0`)::
1076 Enable/disable time drift fix.
1078 `template`: `<boolean>` ('default =' `0`)::
1080 Enable/disable Template.
1082 `unused[n]`: `[file=]<volume>` ::
1084 Reference to unused volumes. This is used internally, and should not be modified manually.
1086 `file`=`<volume>` ;;
1088 The drive's backing volume.
1090 `usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
1092 Configure an USB device (n is 0 to 4).
1094 `host`=`<HOSTUSBDEVICE|spice>` ;;
1096 The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
1098 'bus-port(.port)*' (decimal numbers) or
1099 'vendor_id:product_id' (hexadeciaml numbers) or
1102 You can use the 'lsusb -t' command to list existing usb devices.
1104 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
1106 The value 'spice' can be used to add a usb redirection devices for spice.
1108 `usb3`=`<boolean>` ('default =' `0`);;
1110 Specifies whether if given host option is a USB3 device or port.
1112 `vcpus`: `<integer> (1 - N)` ('default =' `0`)::
1114 Number of hotplugged vcpus.
1116 `vga`: `[[type=]<enum>] [,memory=<integer>]` ::
1118 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.
1119 You can also run without any graphic card, using a serial device as terminal.
1121 `memory`=`<integer> (4 - 512)` ;;
1123 Sets the VGA memory (in MiB). Has no effect with serial display.
1125 `type`=`<cirrus | none | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ('default =' `std`);;
1127 Select the VGA type.
1129 `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>]` ::
1131 Use volume as VIRTIO hard disk (n is 0 to 15).
1133 `aio`=`<native | threads>` ;;
1137 `backup`=`<boolean>` ;;
1139 Whether the drive should be included when making backups.
1143 Maximum r/w speed in bytes per second.
1145 `bps_max_length`=`<seconds>` ;;
1147 Maximum length of I/O bursts in seconds.
1151 Maximum read speed in bytes per second.
1153 `bps_rd_max_length`=`<seconds>` ;;
1155 Maximum length of read I/O bursts in seconds.
1159 Maximum write speed in bytes per second.
1161 `bps_wr_max_length`=`<seconds>` ;;
1163 Maximum length of write I/O bursts in seconds.
1165 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
1167 The drive's cache mode
1169 `cyls`=`<integer>` ;;
1171 Force the drive's physical geometry to have a specific cylinder count.
1173 `detect_zeroes`=`<boolean>` ;;
1175 Controls whether to detect and try to optimize writes of zeroes.
1177 `discard`=`<ignore | on>` ;;
1179 Controls whether to pass discard/trim requests to the underlying storage.
1181 `file`=`<volume>` ;;
1183 The drive's backing volume.
1185 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
1187 The drive's backing file's data format.
1189 `heads`=`<integer>` ;;
1191 Force the drive's physical geometry to have a specific head count.
1195 Maximum r/w I/O in operations per second.
1197 `iops_max`=`<iops>` ;;
1199 Maximum unthrottled r/w I/O pool in operations per second.
1201 `iops_max_length`=`<seconds>` ;;
1203 Maximum length of I/O bursts in seconds.
1205 `iops_rd`=`<iops>` ;;
1207 Maximum read I/O in operations per second.
1209 `iops_rd_max`=`<iops>` ;;
1211 Maximum unthrottled read I/O pool in operations per second.
1213 `iops_rd_max_length`=`<seconds>` ;;
1215 Maximum length of read I/O bursts in seconds.
1217 `iops_wr`=`<iops>` ;;
1219 Maximum write I/O in operations per second.
1221 `iops_wr_max`=`<iops>` ;;
1223 Maximum unthrottled write I/O pool in operations per second.
1225 `iops_wr_max_length`=`<seconds>` ;;
1227 Maximum length of write I/O bursts in seconds.
1229 `iothread`=`<boolean>` ;;
1231 Whether to use iothreads for this drive
1235 Maximum r/w speed in megabytes per second.
1237 `mbps_max`=`<mbps>` ;;
1239 Maximum unthrottled r/w pool in megabytes per second.
1241 `mbps_rd`=`<mbps>` ;;
1243 Maximum read speed in megabytes per second.
1245 `mbps_rd_max`=`<mbps>` ;;
1247 Maximum unthrottled read pool in megabytes per second.
1249 `mbps_wr`=`<mbps>` ;;
1251 Maximum write speed in megabytes per second.
1253 `mbps_wr_max`=`<mbps>` ;;
1255 Maximum unthrottled write pool in megabytes per second.
1257 `media`=`<cdrom | disk>` ('default =' `disk`);;
1259 The drive's media type.
1261 `replicate`=`<boolean>` ('default =' `1`);;
1263 Whether the drive should considered for replication jobs.
1265 `rerror`=`<ignore | report | stop>` ;;
1269 `secs`=`<integer>` ;;
1271 Force the drive's physical geometry to have a specific sector count.
1273 `serial`=`<serial>` ;;
1275 The drive's reported serial number, url-encoded, up to 20 bytes long.
1277 `shared`=`<boolean>` ('default =' `0`);;
1279 Mark this locally-managed volume as available on all nodes.
1281 WARNING: This option does not share the volume automatically, it assumes it is shared already!
1283 `size`=`<DiskSize>` ;;
1285 Disk size. This is purely informational and has no effect.
1287 `snapshot`=`<boolean>` ;;
1289 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
1291 `trans`=`<auto | lba | none>` ;;
1293 Force disk geometry bios translation mode.
1295 `werror`=`<enospc | ignore | report | stop>` ;;
1299 `vmgenid`: `<UUID>` ('default =' `1 (autogenerated)`)::
1301 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.
1302 Note that auto-creation only works when done throug API/CLI create or update methods, but not when manually editing the config file.
1304 `vmstatestorage`: `<string>` ::
1306 Default storage for VM state volumes/files.
1308 `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1310 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)
1312 `action`=`<debug | none | pause | poweroff | reset | shutdown>` ;;
1314 The action to perform if after activation the guest fails to poll the watchdog in time.
1316 `model`=`<i6300esb | ib700>` ('default =' `i6300esb`);;
1318 Watchdog type to emulate.