1 `acpi`: `<boolean>` ('default =' `1`)::
5 `agent`: `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` ::
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.
19 Arbitrary arguments passed to kvm, for example:
21 args: -no-reboot -no-hpet
23 NOTE: this option is for experts only.
25 `autostart`: `<boolean>` ('default =' `0`)::
27 Automatic restart after crash (currently ignored).
29 `balloon`: `<integer> (0 - N)` ::
31 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
33 `bios`: `<ovmf | seabios>` ('default =' `seabios`)::
35 Select BIOS implementation.
37 `boot`: `[acdn]{1,4}` ('default =' `cdn`)::
39 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
41 `bootdisk`: `(ide|sata|scsi|virtio)\d+` ::
43 Enable booting from specified disk.
45 `cdrom`: `<volume>` ::
47 This is an alias for option -ide2
49 `cipassword`: `<string>` ::
51 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.
53 `citype`: `<configdrive2 | nocloud>` ::
55 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.
57 `ciuser`: `<string>` ::
59 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
61 `cores`: `<integer> (1 - N)` ('default =' `1`)::
63 The number of cores per socket.
65 `cpu`: `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
69 `cputype`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Conroe | EPYC | EPYC-IBPB | Haswell | Haswell-IBRS | Haswell-noTSX | Haswell-noTSX-IBRS | IvyBridge | IvyBridge-IBRS | Nehalem | Nehalem-IBRS | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | SandyBridge-IBRS | Skylake-Client | Skylake-Client-IBRS | Skylake-Server | Skylake-Server-IBRS | Westmere | Westmere-IBRS | athlon | core2duo | coreduo | host | kvm32 | kvm64 | max | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64>` ('default =' `kvm64`);;
73 `flags`=`<+FLAG[;-FLAG...]>` ;;
75 List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb'.
77 `hidden`=`<boolean>` ('default =' `0`);;
79 Do not identify as a KVM virtual machine.
81 `cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
85 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
87 `cpuunits`: `<integer> (2 - 262144)` ('default =' `1024`)::
89 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.
91 `description`: `<string>` ::
93 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
95 `efidisk0`: `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
97 Configure a Disk for storing EFI vars
101 The drive's backing volume.
103 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
105 The drive's backing file's data format.
107 `size`=`<DiskSize>` ;;
109 Disk size. This is purely informational and has no effect.
111 `freeze`: `<boolean>` ::
113 Freeze CPU at startup (use 'c' monitor command to start execution).
115 `hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
117 Map host PCI devices into guest.
119 NOTE: This option allows direct access to host hardware. So it is no longer
120 possible to migrate such machines - use with special care.
122 CAUTION: Experimental! User reported problems with this option.
124 `host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
126 Host PCI device pass through. The PCI ID of a host's PCI device or a list
127 of PCI virtual functions of the host. HOSTPCIID syntax is:
129 'bus:dev.func' (hexadecimal numbers)
131 You can us the 'lspci' command to list existing PCI devices.
133 `pcie`=`<boolean>` ('default =' `0`);;
135 Choose the PCI-express bus (needs the 'q35' machine model).
137 `rombar`=`<boolean>` ('default =' `1`);;
139 Specify whether or not the device's ROM will be visible in the guest's memory map.
141 `romfile`=`<string>` ;;
143 Custom pci device rom filename (must be located in /usr/share/kvm/).
145 `x-vga`=`<boolean>` ('default =' `0`);;
147 Enable vfio-vga device support.
149 `hotplug`: `<string>` ('default =' `network,disk,usb`)::
151 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'.
153 `hugepages`: `<1024 | 2 | any>` ::
155 Enable/disable hugepages memory.
157 `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>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
159 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
161 `aio`=`<native | threads>` ;;
165 `backup`=`<boolean>` ;;
167 Whether the drive should be included when making backups.
171 Maximum r/w speed in bytes per second.
173 `bps_max_length`=`<seconds>` ;;
175 Maximum length of I/O bursts in seconds.
179 Maximum read speed in bytes per second.
181 `bps_rd_max_length`=`<seconds>` ;;
183 Maximum length of read I/O bursts in seconds.
187 Maximum write speed in bytes per second.
189 `bps_wr_max_length`=`<seconds>` ;;
191 Maximum length of write I/O bursts in seconds.
193 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
195 The drive's cache mode
197 `cyls`=`<integer>` ;;
199 Force the drive's physical geometry to have a specific cylinder count.
201 `detect_zeroes`=`<boolean>` ;;
203 Controls whether to detect and try to optimize writes of zeroes.
205 `discard`=`<ignore | on>` ;;
207 Controls whether to pass discard/trim requests to the underlying storage.
211 The drive's backing volume.
213 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
215 The drive's backing file's data format.
217 `heads`=`<integer>` ;;
219 Force the drive's physical geometry to have a specific head count.
223 Maximum r/w I/O in operations per second.
225 `iops_max`=`<iops>` ;;
227 Maximum unthrottled r/w I/O pool in operations per second.
229 `iops_max_length`=`<seconds>` ;;
231 Maximum length of I/O bursts in seconds.
233 `iops_rd`=`<iops>` ;;
235 Maximum read I/O in operations per second.
237 `iops_rd_max`=`<iops>` ;;
239 Maximum unthrottled read I/O pool in operations per second.
241 `iops_rd_max_length`=`<seconds>` ;;
243 Maximum length of read I/O bursts in seconds.
245 `iops_wr`=`<iops>` ;;
247 Maximum write I/O in operations per second.
249 `iops_wr_max`=`<iops>` ;;
251 Maximum unthrottled write I/O pool in operations per second.
253 `iops_wr_max_length`=`<seconds>` ;;
255 Maximum length of write I/O bursts in seconds.
259 Maximum r/w speed in megabytes per second.
261 `mbps_max`=`<mbps>` ;;
263 Maximum unthrottled r/w pool in megabytes per second.
265 `mbps_rd`=`<mbps>` ;;
267 Maximum read speed in megabytes per second.
269 `mbps_rd_max`=`<mbps>` ;;
271 Maximum unthrottled read pool in megabytes per second.
273 `mbps_wr`=`<mbps>` ;;
275 Maximum write speed in megabytes per second.
277 `mbps_wr_max`=`<mbps>` ;;
279 Maximum unthrottled write pool in megabytes per second.
281 `media`=`<cdrom | disk>` ('default =' `disk`);;
283 The drive's media type.
287 The drive's reported model name, url-encoded, up to 40 bytes long.
289 `replicate`=`<boolean>` ('default =' `1`);;
291 Whether the drive should considered for replication jobs.
293 `rerror`=`<ignore | report | stop>` ;;
297 `secs`=`<integer>` ;;
299 Force the drive's physical geometry to have a specific sector count.
301 `serial`=`<serial>` ;;
303 The drive's reported serial number, url-encoded, up to 20 bytes long.
305 `shared`=`<boolean>` ('default =' `0`);;
307 Mark this locally-managed volume as available on all nodes.
309 WARNING: This option does not share the volume automatically, it assumes it is shared already!
311 `size`=`<DiskSize>` ;;
313 Disk size. This is purely informational and has no effect.
315 `snapshot`=`<boolean>` ;;
317 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
319 `trans`=`<auto | lba | none>` ;;
321 Force disk geometry bios translation mode.
323 `werror`=`<enospc | ignore | report | stop>` ;;
327 `ipconfig[n]`: `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
329 cloud-init: Specify IP addresses and gateways for the corresponding interface.
331 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
333 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
334 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
336 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
338 `gw`=`<GatewayIPv4>` ;;
340 Default gateway for IPv4 traffic.
342 NOTE: Requires option(s): `ip`
344 `gw6`=`<GatewayIPv6>` ;;
346 Default gateway for IPv6 traffic.
348 NOTE: Requires option(s): `ip6`
350 `ip`=`<IPv4Format/CIDR>` ('default =' `dhcp`);;
352 IPv4 address in CIDR format.
354 `ip6`=`<IPv6Format/CIDR>` ('default =' `dhcp`);;
356 IPv6 address in CIDR format.
358 `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>` ::
360 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
362 `kvm`: `<boolean>` ('default =' `1`)::
364 Enable/disable KVM hardware virtualization.
366 `localtime`: `<boolean>` ::
368 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
370 `lock`: `<backup | migrate | rollback | snapshot>` ::
374 `machine`: `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
376 Specifies the Qemu machine type.
378 `memory`: `<integer> (16 - N)` ('default =' `512`)::
380 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
382 `migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
384 Set maximum tolerated downtime (in seconds) for migrations.
386 `migrate_speed`: `<integer> (0 - N)` ('default =' `0`)::
388 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
390 `name`: `<string>` ::
392 Set a name for the VM. Only used on the configuration web interface.
394 `nameserver`: `<string>` ::
396 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.
398 `net[n]`: `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
400 Specify network devices.
402 `bridge`=`<bridge>` ;;
404 Bridge to attach the network device to. The Proxmox VE standard bridge
407 If you do not specify a bridge, we create a kvm user (NATed) network
408 device, which provides DHCP and DNS services. The following addresses
415 The DHCP server assign addresses to the guest starting from 10.0.2.15.
417 `firewall`=`<boolean>` ;;
419 Whether this interface should be protected by the firewall.
421 `link_down`=`<boolean>` ;;
423 Whether this interface should be disconnected (like pulling the plug).
425 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
427 MAC address. That address must be unique withing your network. This is automatically generated if not specified.
429 `model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
431 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'.
433 `queues`=`<integer> (0 - 16)` ;;
435 Number of packet queues to be used on the device.
437 `rate`=`<number> (0 - N)` ;;
439 Rate limit in mbps (megabytes per second) as floating point number.
441 `tag`=`<integer> (1 - 4094)` ;;
443 VLAN tag to apply to packets on this interface.
445 `trunks`=`<vlanid[;vlanid...]>` ;;
447 VLAN trunks to pass through this interface.
449 `numa`: `<boolean>` ('default =' `0`)::
453 `numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
457 `cpus`=`<id[-id];...>` ;;
459 CPUs accessing this NUMA node.
461 `hostnodes`=`<id[-id];...>` ;;
463 Host NUMA nodes to use.
465 `memory`=`<number>` ;;
467 Amount of memory this NUMA node provides.
469 `policy`=`<bind | interleave | preferred>` ;;
471 NUMA allocation policy.
473 `onboot`: `<boolean>` ('default =' `0`)::
475 Specifies whether a VM will be started during system bootup.
477 `ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
479 Specify guest operating system. This is used to enable special
480 optimization/features for specific operating systems:
483 other;; unspecified OS
484 wxp;; Microsoft Windows XP
485 w2k;; Microsoft Windows 2000
486 w2k3;; Microsoft Windows 2003
487 w2k8;; Microsoft Windows 2008
488 wvista;; Microsoft Windows Vista
489 win7;; Microsoft Windows 7
490 win8;; Microsoft Windows 8/2012/2012r2
491 win10;; Microsoft Windows 10/2016
492 l24;; Linux 2.4 Kernel
493 l26;; Linux 2.6/3.X Kernel
494 solaris;; Solaris/OpenSolaris/OpenIndiania kernel
496 `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
498 Map host parallel devices (n is 0 to 2).
500 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
502 CAUTION: Experimental! User reported problems with this option.
504 `protection`: `<boolean>` ('default =' `0`)::
506 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
508 `reboot`: `<boolean>` ('default =' `1`)::
510 Allow reboot. If set to '0' the VM exit on reboot.
512 `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>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
514 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
516 `aio`=`<native | threads>` ;;
520 `backup`=`<boolean>` ;;
522 Whether the drive should be included when making backups.
526 Maximum r/w speed in bytes per second.
528 `bps_max_length`=`<seconds>` ;;
530 Maximum length of I/O bursts in seconds.
534 Maximum read speed in bytes per second.
536 `bps_rd_max_length`=`<seconds>` ;;
538 Maximum length of read I/O bursts in seconds.
542 Maximum write speed in bytes per second.
544 `bps_wr_max_length`=`<seconds>` ;;
546 Maximum length of write I/O bursts in seconds.
548 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
550 The drive's cache mode
552 `cyls`=`<integer>` ;;
554 Force the drive's physical geometry to have a specific cylinder count.
556 `detect_zeroes`=`<boolean>` ;;
558 Controls whether to detect and try to optimize writes of zeroes.
560 `discard`=`<ignore | on>` ;;
562 Controls whether to pass discard/trim requests to the underlying storage.
566 The drive's backing volume.
568 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
570 The drive's backing file's data format.
572 `heads`=`<integer>` ;;
574 Force the drive's physical geometry to have a specific head count.
578 Maximum r/w I/O in operations per second.
580 `iops_max`=`<iops>` ;;
582 Maximum unthrottled r/w I/O pool in operations per second.
584 `iops_max_length`=`<seconds>` ;;
586 Maximum length of I/O bursts in seconds.
588 `iops_rd`=`<iops>` ;;
590 Maximum read I/O in operations per second.
592 `iops_rd_max`=`<iops>` ;;
594 Maximum unthrottled read I/O pool in operations per second.
596 `iops_rd_max_length`=`<seconds>` ;;
598 Maximum length of read I/O bursts in seconds.
600 `iops_wr`=`<iops>` ;;
602 Maximum write I/O in operations per second.
604 `iops_wr_max`=`<iops>` ;;
606 Maximum unthrottled write I/O pool in operations per second.
608 `iops_wr_max_length`=`<seconds>` ;;
610 Maximum length of write I/O bursts in seconds.
614 Maximum r/w speed in megabytes per second.
616 `mbps_max`=`<mbps>` ;;
618 Maximum unthrottled r/w pool in megabytes per second.
620 `mbps_rd`=`<mbps>` ;;
622 Maximum read speed in megabytes per second.
624 `mbps_rd_max`=`<mbps>` ;;
626 Maximum unthrottled read pool in megabytes per second.
628 `mbps_wr`=`<mbps>` ;;
630 Maximum write speed in megabytes per second.
632 `mbps_wr_max`=`<mbps>` ;;
634 Maximum unthrottled write pool in megabytes per second.
636 `media`=`<cdrom | disk>` ('default =' `disk`);;
638 The drive's media type.
640 `replicate`=`<boolean>` ('default =' `1`);;
642 Whether the drive should considered for replication jobs.
644 `rerror`=`<ignore | report | stop>` ;;
648 `secs`=`<integer>` ;;
650 Force the drive's physical geometry to have a specific sector count.
652 `serial`=`<serial>` ;;
654 The drive's reported serial number, url-encoded, up to 20 bytes long.
656 `shared`=`<boolean>` ('default =' `0`);;
658 Mark this locally-managed volume as available on all nodes.
660 WARNING: This option does not share the volume automatically, it assumes it is shared already!
662 `size`=`<DiskSize>` ;;
664 Disk size. This is purely informational and has no effect.
666 `snapshot`=`<boolean>` ;;
668 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
670 `trans`=`<auto | lba | none>` ;;
672 Force disk geometry bios translation mode.
674 `werror`=`<enospc | ignore | report | stop>` ;;
678 `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>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
680 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
682 `aio`=`<native | threads>` ;;
686 `backup`=`<boolean>` ;;
688 Whether the drive should be included when making backups.
692 Maximum r/w speed in bytes per second.
694 `bps_max_length`=`<seconds>` ;;
696 Maximum length of I/O bursts in seconds.
700 Maximum read speed in bytes per second.
702 `bps_rd_max_length`=`<seconds>` ;;
704 Maximum length of read I/O bursts in seconds.
708 Maximum write speed in bytes per second.
710 `bps_wr_max_length`=`<seconds>` ;;
712 Maximum length of write I/O bursts in seconds.
714 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
716 The drive's cache mode
718 `cyls`=`<integer>` ;;
720 Force the drive's physical geometry to have a specific cylinder count.
722 `detect_zeroes`=`<boolean>` ;;
724 Controls whether to detect and try to optimize writes of zeroes.
726 `discard`=`<ignore | on>` ;;
728 Controls whether to pass discard/trim requests to the underlying storage.
732 The drive's backing volume.
734 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
736 The drive's backing file's data format.
738 `heads`=`<integer>` ;;
740 Force the drive's physical geometry to have a specific head count.
744 Maximum r/w I/O in operations per second.
746 `iops_max`=`<iops>` ;;
748 Maximum unthrottled r/w I/O pool in operations per second.
750 `iops_max_length`=`<seconds>` ;;
752 Maximum length of I/O bursts in seconds.
754 `iops_rd`=`<iops>` ;;
756 Maximum read I/O in operations per second.
758 `iops_rd_max`=`<iops>` ;;
760 Maximum unthrottled read I/O pool in operations per second.
762 `iops_rd_max_length`=`<seconds>` ;;
764 Maximum length of read I/O bursts in seconds.
766 `iops_wr`=`<iops>` ;;
768 Maximum write I/O in operations per second.
770 `iops_wr_max`=`<iops>` ;;
772 Maximum unthrottled write I/O pool in operations per second.
774 `iops_wr_max_length`=`<seconds>` ;;
776 Maximum length of write I/O bursts in seconds.
778 `iothread`=`<boolean>` ;;
780 Whether to use iothreads for this drive
784 Maximum r/w speed in megabytes per second.
786 `mbps_max`=`<mbps>` ;;
788 Maximum unthrottled r/w pool in megabytes per second.
790 `mbps_rd`=`<mbps>` ;;
792 Maximum read speed in megabytes per second.
794 `mbps_rd_max`=`<mbps>` ;;
796 Maximum unthrottled read pool in megabytes per second.
798 `mbps_wr`=`<mbps>` ;;
800 Maximum write speed in megabytes per second.
802 `mbps_wr_max`=`<mbps>` ;;
804 Maximum unthrottled write pool in megabytes per second.
806 `media`=`<cdrom | disk>` ('default =' `disk`);;
808 The drive's media type.
810 `queues`=`<integer> (2 - N)` ;;
814 `replicate`=`<boolean>` ('default =' `1`);;
816 Whether the drive should considered for replication jobs.
818 `rerror`=`<ignore | report | stop>` ;;
822 `scsiblock`=`<boolean>` ('default =' `0`);;
824 whether to use scsi-block for full passthrough of host block device
826 WARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host
828 `secs`=`<integer>` ;;
830 Force the drive's physical geometry to have a specific sector count.
832 `serial`=`<serial>` ;;
834 The drive's reported serial number, url-encoded, up to 20 bytes long.
836 `shared`=`<boolean>` ('default =' `0`);;
838 Mark this locally-managed volume as available on all nodes.
840 WARNING: This option does not share the volume automatically, it assumes it is shared already!
842 `size`=`<DiskSize>` ;;
844 Disk size. This is purely informational and has no effect.
846 `snapshot`=`<boolean>` ;;
848 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
850 `trans`=`<auto | lba | none>` ;;
852 Force disk geometry bios translation mode.
854 `werror`=`<enospc | ignore | report | stop>` ;;
858 `scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
860 SCSI controller model
862 `searchdomain`: `<string>` ::
864 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.
866 `serial[n]`: `(/dev/.+|socket)` ::
868 Create a serial device inside the VM (n is 0 to 3), and pass through a
869 host serial device (i.e. /dev/ttyS0), or create a unix socket on the
870 host side (use 'qm terminal' to open a terminal connection).
872 NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.
874 CAUTION: Experimental! User reported problems with this option.
876 `shares`: `<integer> (0 - 50000)` ('default =' `1000`)::
878 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.
880 `smbios1`: `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
882 Specify SMBIOS type 1 fields.
884 `family`=`<string>` ;;
886 Set SMBIOS1 family string.
888 `manufacturer`=`<string>` ;;
890 Set SMBIOS1 manufacturer.
892 `product`=`<string>` ;;
894 Set SMBIOS1 product ID.
896 `serial`=`<string>` ;;
898 Set SMBIOS1 serial number.
902 Set SMBIOS1 SKU string.
908 `version`=`<string>` ;;
912 `smp`: `<integer> (1 - N)` ('default =' `1`)::
914 The number of CPUs. Please use option -sockets instead.
916 `sockets`: `<integer> (1 - N)` ('default =' `1`)::
918 The number of CPU sockets.
920 `sshkeys`: `<string>` ::
922 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
924 `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
926 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'.
928 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
930 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.
932 `tablet`: `<boolean>` ('default =' `1`)::
934 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).
936 `tdf`: `<boolean>` ('default =' `0`)::
938 Enable/disable time drift fix.
940 `template`: `<boolean>` ('default =' `0`)::
942 Enable/disable Template.
944 `unused[n]`: `<string>` ::
946 Reference to unused volumes. This is used internally, and should not be modified manually.
948 `usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
950 Configure an USB device (n is 0 to 4).
952 `host`=`<HOSTUSBDEVICE|spice>` ;;
954 The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
956 'bus-port(.port)*' (decimal numbers) or
957 'vendor_id:product_id' (hexadeciaml numbers) or
960 You can use the 'lsusb -t' command to list existing usb devices.
962 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
964 The value 'spice' can be used to add a usb redirection devices for spice.
966 `usb3`=`<boolean>` ('default =' `0`);;
968 Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).
970 `vcpus`: `<integer> (1 - N)` ('default =' `0`)::
972 Number of hotplugged vcpus.
974 `vga`: `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ::
976 Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal.
978 `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>]` ::
980 Use volume as VIRTIO hard disk (n is 0 to 15).
982 `aio`=`<native | threads>` ;;
986 `backup`=`<boolean>` ;;
988 Whether the drive should be included when making backups.
992 Maximum r/w speed in bytes per second.
994 `bps_max_length`=`<seconds>` ;;
996 Maximum length of I/O bursts in seconds.
1000 Maximum read speed in bytes per second.
1002 `bps_rd_max_length`=`<seconds>` ;;
1004 Maximum length of read I/O bursts in seconds.
1008 Maximum write speed in bytes per second.
1010 `bps_wr_max_length`=`<seconds>` ;;
1012 Maximum length of write I/O bursts in seconds.
1014 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
1016 The drive's cache mode
1018 `cyls`=`<integer>` ;;
1020 Force the drive's physical geometry to have a specific cylinder count.
1022 `detect_zeroes`=`<boolean>` ;;
1024 Controls whether to detect and try to optimize writes of zeroes.
1026 `discard`=`<ignore | on>` ;;
1028 Controls whether to pass discard/trim requests to the underlying storage.
1030 `file`=`<volume>` ;;
1032 The drive's backing volume.
1034 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
1036 The drive's backing file's data format.
1038 `heads`=`<integer>` ;;
1040 Force the drive's physical geometry to have a specific head count.
1044 Maximum r/w I/O in operations per second.
1046 `iops_max`=`<iops>` ;;
1048 Maximum unthrottled r/w I/O pool in operations per second.
1050 `iops_max_length`=`<seconds>` ;;
1052 Maximum length of I/O bursts in seconds.
1054 `iops_rd`=`<iops>` ;;
1056 Maximum read I/O in operations per second.
1058 `iops_rd_max`=`<iops>` ;;
1060 Maximum unthrottled read I/O pool in operations per second.
1062 `iops_rd_max_length`=`<seconds>` ;;
1064 Maximum length of read I/O bursts in seconds.
1066 `iops_wr`=`<iops>` ;;
1068 Maximum write I/O in operations per second.
1070 `iops_wr_max`=`<iops>` ;;
1072 Maximum unthrottled write I/O pool in operations per second.
1074 `iops_wr_max_length`=`<seconds>` ;;
1076 Maximum length of write I/O bursts in seconds.
1078 `iothread`=`<boolean>` ;;
1080 Whether to use iothreads for this drive
1084 Maximum r/w speed in megabytes per second.
1086 `mbps_max`=`<mbps>` ;;
1088 Maximum unthrottled r/w pool in megabytes per second.
1090 `mbps_rd`=`<mbps>` ;;
1092 Maximum read speed in megabytes per second.
1094 `mbps_rd_max`=`<mbps>` ;;
1096 Maximum unthrottled read pool in megabytes per second.
1098 `mbps_wr`=`<mbps>` ;;
1100 Maximum write speed in megabytes per second.
1102 `mbps_wr_max`=`<mbps>` ;;
1104 Maximum unthrottled write pool in megabytes per second.
1106 `media`=`<cdrom | disk>` ('default =' `disk`);;
1108 The drive's media type.
1110 `replicate`=`<boolean>` ('default =' `1`);;
1112 Whether the drive should considered for replication jobs.
1114 `rerror`=`<ignore | report | stop>` ;;
1118 `secs`=`<integer>` ;;
1120 Force the drive's physical geometry to have a specific sector count.
1122 `serial`=`<serial>` ;;
1124 The drive's reported serial number, url-encoded, up to 20 bytes long.
1126 `shared`=`<boolean>` ('default =' `0`);;
1128 Mark this locally-managed volume as available on all nodes.
1130 WARNING: This option does not share the volume automatically, it assumes it is shared already!
1132 `size`=`<DiskSize>` ;;
1134 Disk size. This is purely informational and has no effect.
1136 `snapshot`=`<boolean>` ;;
1138 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
1140 `trans`=`<auto | lba | none>` ;;
1142 Force disk geometry bios translation mode.
1144 `werror`=`<enospc | ignore | report | stop>` ;;
1148 `vmgenid`: `<UUID>` ('default =' `1 (autogenerated)`)::
1150 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.
1151 Note that auto-creation only works when done throug API/CLI create or update methods, but not when manually editing the config file.
1153 `vmstatestorage`: `<string>` ::
1155 Default storage for VM state volumes/files.
1157 `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1159 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)
1161 `action`=`<debug | none | pause | poweroff | reset | shutdown>` ;;
1163 The action to perform if after activation the guest fails to poll the watchdog in time.
1165 `model`=`<i6300esb | ib700>` ('default =' `i6300esb`);;
1167 Watchdog type to emulate.