1 `acpi`: `<boolean>` ('default =' `1`)::
5 `agent`: `<boolean>` ('default =' `0`)::
7 Enable/disable Qemu GuestAgent.
11 Arbitrary arguments passed to kvm, for example:
13 args: -no-reboot -no-hpet
15 NOTE: this option is for experts only.
17 `autostart`: `<boolean>` ('default =' `0`)::
19 Automatic restart after crash (currently ignored).
21 `balloon`: `<integer> (0 - N)` ::
23 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
25 `bios`: `<ovmf | seabios>` ('default =' `seabios`)::
27 Select BIOS implementation.
29 `boot`: `[acdn]{1,4}` ('default =' `cdn`)::
31 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
33 `bootdisk`: `(ide|sata|scsi|virtio)\d+` ::
35 Enable booting from specified disk.
37 `cdrom`: `<volume>` ::
39 This is an alias for option -ide2
41 `cores`: `<integer> (1 - N)` ('default =' `1`)::
43 The number of cores per socket.
45 `cpu`: `[cputype=]<enum> [,hidden=<1|0>]` ::
49 `cputype`=`<486 | Broadwell | Broadwell-noTSX | Conroe | Haswell | Haswell-noTSX | IvyBridge | Nehalem | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | Skylake-Client | Westmere | athlon | core2duo | coreduo | host | kvm32 | kvm64 | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64>` ('default =' `kvm64`);;
53 `hidden`=`<boolean>` ('default =' `0`);;
55 Do not identify as a KVM virtual machine.
57 `cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
61 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
63 `cpuunits`: `<integer> (2 - 262144)` ('default =' `1024`)::
65 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.
67 `description`: `<string>` ::
69 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
71 `efidisk0`: `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
73 Configure a Disk for storing EFI vars
77 The drive's backing volume.
79 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
81 The drive's backing file's data format.
83 `size`=`<DiskSize>` ;;
85 Disk size. This is purely informational and has no effect.
87 `freeze`: `<boolean>` ::
89 Freeze CPU at startup (use 'c' monitor command to start execution).
91 `hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
93 Map host PCI devices into guest.
95 NOTE: This option allows direct access to host hardware. So it is no longer
96 possible to migrate such machines - use with special care.
98 CAUTION: Experimental! User reported problems with this option.
100 `host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
102 Host PCI device pass through. The PCI ID of a host's PCI device or a list
103 of PCI virtual functions of the host. HOSTPCIID syntax is:
105 'bus:dev.func' (hexadecimal numbers)
107 You can us the 'lspci' command to list existing PCI devices.
109 `pcie`=`<boolean>` ('default =' `0`);;
111 Choose the PCI-express bus (needs the 'q35' machine model).
113 `rombar`=`<boolean>` ('default =' `1`);;
115 Specify whether or not the device's ROM will be visible in the guest's memory map.
117 `romfile`=`<string>` ;;
119 Custom pci device rom filename (must be located in /usr/share/kvm/).
121 `x-vga`=`<boolean>` ('default =' `0`);;
123 Enable vfio-vga device support.
125 `hotplug`: `<string>` ('default =' `network,disk,usb`)::
127 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'.
129 `hugepages`: `<1024 | 2 | any>` ::
131 Enable/disable hugepages memory.
133 `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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
135 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
137 `aio`=`<native | threads>` ;;
141 `backup`=`<boolean>` ;;
143 Whether the drive should be included when making backups.
147 Maximum r/w speed in bytes per second.
149 `bps_max_length`=`<seconds>` ;;
151 Maximum length of I/O bursts in seconds.
155 Maximum read speed in bytes per second.
157 `bps_rd_max_length`=`<seconds>` ;;
159 Maximum length of read I/O bursts in seconds.
163 Maximum write speed in bytes per second.
165 `bps_wr_max_length`=`<seconds>` ;;
167 Maximum length of write I/O bursts in seconds.
169 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
171 The drive's cache mode
173 `cyls`=`<integer>` ;;
175 Force the drive's physical geometry to have a specific cylinder count.
177 `detect_zeroes`=`<boolean>` ;;
179 Controls whether to detect and try to optimize writes of zeroes.
181 `discard`=`<ignore | on>` ;;
183 Controls whether to pass discard/trim requests to the underlying storage.
187 The drive's backing volume.
189 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
191 The drive's backing file's data format.
193 `heads`=`<integer>` ;;
195 Force the drive's physical geometry to have a specific head count.
199 Maximum r/w I/O in operations per second.
201 `iops_max`=`<iops>` ;;
203 Maximum unthrottled r/w I/O pool in operations per second.
205 `iops_max_length`=`<seconds>` ;;
207 Maximum length of I/O bursts in seconds.
209 `iops_rd`=`<iops>` ;;
211 Maximum read I/O in operations per second.
213 `iops_rd_max`=`<iops>` ;;
215 Maximum unthrottled read I/O pool in operations per second.
217 `iops_rd_max_length`=`<seconds>` ;;
219 Maximum length of read I/O bursts in seconds.
221 `iops_wr`=`<iops>` ;;
223 Maximum write I/O in operations per second.
225 `iops_wr_max`=`<iops>` ;;
227 Maximum unthrottled write I/O pool in operations per second.
229 `iops_wr_max_length`=`<seconds>` ;;
231 Maximum length of write I/O bursts in seconds.
235 Maximum r/w speed in megabytes per second.
237 `mbps_max`=`<mbps>` ;;
239 Maximum unthrottled r/w pool in megabytes per second.
241 `mbps_rd`=`<mbps>` ;;
243 Maximum read speed in megabytes per second.
245 `mbps_rd_max`=`<mbps>` ;;
247 Maximum unthrottled read pool in megabytes per second.
249 `mbps_wr`=`<mbps>` ;;
251 Maximum write speed in megabytes per second.
253 `mbps_wr_max`=`<mbps>` ;;
255 Maximum unthrottled write pool in megabytes per second.
257 `media`=`<cdrom | disk>` ('default =' `disk`);;
259 The drive's media type.
263 The drive's reported model name, url-encoded, up to 40 bytes long.
265 `replicate`=`<boolean>` ('default =' `1`);;
267 Whether the drive should considered for replication jobs.
269 `rerror`=`<ignore | report | stop>` ;;
273 `secs`=`<integer>` ;;
275 Force the drive's physical geometry to have a specific sector count.
277 `serial`=`<serial>` ;;
279 The drive's reported serial number, url-encoded, up to 20 bytes long.
281 `size`=`<DiskSize>` ;;
283 Disk size. This is purely informational and has no effect.
285 `snapshot`=`<boolean>` ;;
287 Whether the drive should be included when making snapshots.
289 `trans`=`<auto | lba | none>` ;;
291 Force disk geometry bios translation mode.
293 `werror`=`<enospc | ignore | report | stop>` ;;
297 `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>` ('default =' `en-us`)::
299 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
301 `kvm`: `<boolean>` ('default =' `1`)::
303 Enable/disable KVM hardware virtualization.
305 `localtime`: `<boolean>` ::
307 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
309 `lock`: `<backup | migrate | rollback | snapshot>` ::
313 `machine`: `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
315 Specific the Qemu machine type.
317 `memory`: `<integer> (16 - N)` ('default =' `512`)::
319 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
321 `migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
323 Set maximum tolerated downtime (in seconds) for migrations.
325 `migrate_speed`: `<integer> (0 - N)` ('default =' `0`)::
327 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
329 `name`: `<string>` ::
331 Set a name for the VM. Only used on the configuration web interface.
333 `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>]` ::
335 Specify network devices.
337 `bridge`=`<bridge>` ;;
339 Bridge to attach the network device to. The Proxmox VE standard bridge
342 If you do not specify a bridge, we create a kvm user (NATed) network
343 device, which provides DHCP and DNS services. The following addresses
350 The DHCP server assign addresses to the guest starting from 10.0.2.15.
352 `firewall`=`<boolean>` ;;
354 Whether this interface should be protected by the firewall.
356 `link_down`=`<boolean>` ;;
358 Whether this interface should be disconnected (like pulling the plug).
360 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
362 MAC address. That address must be unique withing your network. This is automatically generated if not specified.
364 `model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
366 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'.
368 `queues`=`<integer> (0 - 16)` ;;
370 Number of packet queues to be used on the device.
372 `rate`=`<number> (0 - N)` ;;
374 Rate limit in mbps (megabytes per second) as floating point number.
376 `tag`=`<integer> (1 - 4094)` ;;
378 VLAN tag to apply to packets on this interface.
380 `trunks`=`<vlanid[;vlanid...]>` ;;
382 VLAN trunks to pass through this interface.
384 `numa`: `<boolean>` ('default =' `0`)::
388 `numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
392 `cpus`=`<id[-id];...>` ;;
394 CPUs accessing this NUMA node.
396 `hostnodes`=`<id[-id];...>` ;;
398 Host NUMA nodes to use.
400 `memory`=`<number>` ;;
402 Amount of memory this NUMA node provides.
404 `policy`=`<bind | interleave | preferred>` ;;
406 NUMA allocation policy.
408 `onboot`: `<boolean>` ('default =' `0`)::
410 Specifies whether a VM will be started during system bootup.
412 `ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
414 Specify guest operating system. This is used to enable special
415 optimization/features for specific operating systems:
418 other;; unspecified OS
419 wxp;; Microsoft Windows XP
420 w2k;; Microsoft Windows 2000
421 w2k3;; Microsoft Windows 2003
422 w2k8;; Microsoft Windows 2008
423 wvista;; Microsoft Windows Vista
424 win7;; Microsoft Windows 7
425 win8;; Microsoft Windows 8/2012
426 l24;; Linux 2.4 Kernel
427 l26;; Linux 2.6/3.X Kernel
428 solaris;; Solaris/OpenSolaris/OpenIndiania kernel
430 `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
432 Map host parallel devices (n is 0 to 2).
434 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
436 CAUTION: Experimental! User reported problems with this option.
438 `protection`: `<boolean>` ('default =' `0`)::
440 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
442 `reboot`: `<boolean>` ('default =' `1`)::
444 Allow reboot. If set to '0' the VM exit on reboot.
446 `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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
448 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
450 `aio`=`<native | threads>` ;;
454 `backup`=`<boolean>` ;;
456 Whether the drive should be included when making backups.
460 Maximum r/w speed in bytes per second.
462 `bps_max_length`=`<seconds>` ;;
464 Maximum length of I/O bursts in seconds.
468 Maximum read speed in bytes per second.
470 `bps_rd_max_length`=`<seconds>` ;;
472 Maximum length of read I/O bursts in seconds.
476 Maximum write speed in bytes per second.
478 `bps_wr_max_length`=`<seconds>` ;;
480 Maximum length of write I/O bursts in seconds.
482 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
484 The drive's cache mode
486 `cyls`=`<integer>` ;;
488 Force the drive's physical geometry to have a specific cylinder count.
490 `detect_zeroes`=`<boolean>` ;;
492 Controls whether to detect and try to optimize writes of zeroes.
494 `discard`=`<ignore | on>` ;;
496 Controls whether to pass discard/trim requests to the underlying storage.
500 The drive's backing volume.
502 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
504 The drive's backing file's data format.
506 `heads`=`<integer>` ;;
508 Force the drive's physical geometry to have a specific head count.
512 Maximum r/w I/O in operations per second.
514 `iops_max`=`<iops>` ;;
516 Maximum unthrottled r/w I/O pool in operations per second.
518 `iops_max_length`=`<seconds>` ;;
520 Maximum length of I/O bursts in seconds.
522 `iops_rd`=`<iops>` ;;
524 Maximum read I/O in operations per second.
526 `iops_rd_max`=`<iops>` ;;
528 Maximum unthrottled read I/O pool in operations per second.
530 `iops_rd_max_length`=`<seconds>` ;;
532 Maximum length of read I/O bursts in seconds.
534 `iops_wr`=`<iops>` ;;
536 Maximum write I/O in operations per second.
538 `iops_wr_max`=`<iops>` ;;
540 Maximum unthrottled write I/O pool in operations per second.
542 `iops_wr_max_length`=`<seconds>` ;;
544 Maximum length of write I/O bursts in seconds.
548 Maximum r/w speed in megabytes per second.
550 `mbps_max`=`<mbps>` ;;
552 Maximum unthrottled r/w pool in megabytes per second.
554 `mbps_rd`=`<mbps>` ;;
556 Maximum read speed in megabytes per second.
558 `mbps_rd_max`=`<mbps>` ;;
560 Maximum unthrottled read pool in megabytes per second.
562 `mbps_wr`=`<mbps>` ;;
564 Maximum write speed in megabytes per second.
566 `mbps_wr_max`=`<mbps>` ;;
568 Maximum unthrottled write pool in megabytes per second.
570 `media`=`<cdrom | disk>` ('default =' `disk`);;
572 The drive's media type.
574 `replicate`=`<boolean>` ('default =' `1`);;
576 Whether the drive should considered for replication jobs.
578 `rerror`=`<ignore | report | stop>` ;;
582 `secs`=`<integer>` ;;
584 Force the drive's physical geometry to have a specific sector count.
586 `serial`=`<serial>` ;;
588 The drive's reported serial number, url-encoded, up to 20 bytes long.
590 `size`=`<DiskSize>` ;;
592 Disk size. This is purely informational and has no effect.
594 `snapshot`=`<boolean>` ;;
596 Whether the drive should be included when making snapshots.
598 `trans`=`<auto | lba | none>` ;;
600 Force disk geometry bios translation mode.
602 `werror`=`<enospc | ignore | report | stop>` ;;
606 `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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
608 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
610 `aio`=`<native | threads>` ;;
614 `backup`=`<boolean>` ;;
616 Whether the drive should be included when making backups.
620 Maximum r/w speed in bytes per second.
622 `bps_max_length`=`<seconds>` ;;
624 Maximum length of I/O bursts in seconds.
628 Maximum read speed in bytes per second.
630 `bps_rd_max_length`=`<seconds>` ;;
632 Maximum length of read I/O bursts in seconds.
636 Maximum write speed in bytes per second.
638 `bps_wr_max_length`=`<seconds>` ;;
640 Maximum length of write I/O bursts in seconds.
642 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
644 The drive's cache mode
646 `cyls`=`<integer>` ;;
648 Force the drive's physical geometry to have a specific cylinder count.
650 `detect_zeroes`=`<boolean>` ;;
652 Controls whether to detect and try to optimize writes of zeroes.
654 `discard`=`<ignore | on>` ;;
656 Controls whether to pass discard/trim requests to the underlying storage.
660 The drive's backing volume.
662 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
664 The drive's backing file's data format.
666 `heads`=`<integer>` ;;
668 Force the drive's physical geometry to have a specific head count.
672 Maximum r/w I/O in operations per second.
674 `iops_max`=`<iops>` ;;
676 Maximum unthrottled r/w I/O pool in operations per second.
678 `iops_max_length`=`<seconds>` ;;
680 Maximum length of I/O bursts in seconds.
682 `iops_rd`=`<iops>` ;;
684 Maximum read I/O in operations per second.
686 `iops_rd_max`=`<iops>` ;;
688 Maximum unthrottled read I/O pool in operations per second.
690 `iops_rd_max_length`=`<seconds>` ;;
692 Maximum length of read I/O bursts in seconds.
694 `iops_wr`=`<iops>` ;;
696 Maximum write I/O in operations per second.
698 `iops_wr_max`=`<iops>` ;;
700 Maximum unthrottled write I/O pool in operations per second.
702 `iops_wr_max_length`=`<seconds>` ;;
704 Maximum length of write I/O bursts in seconds.
706 `iothread`=`<boolean>` ;;
708 Whether to use iothreads for this drive
712 Maximum r/w speed in megabytes per second.
714 `mbps_max`=`<mbps>` ;;
716 Maximum unthrottled r/w pool in megabytes per second.
718 `mbps_rd`=`<mbps>` ;;
720 Maximum read speed in megabytes per second.
722 `mbps_rd_max`=`<mbps>` ;;
724 Maximum unthrottled read pool in megabytes per second.
726 `mbps_wr`=`<mbps>` ;;
728 Maximum write speed in megabytes per second.
730 `mbps_wr_max`=`<mbps>` ;;
732 Maximum unthrottled write pool in megabytes per second.
734 `media`=`<cdrom | disk>` ('default =' `disk`);;
736 The drive's media type.
738 `queues`=`<integer> (2 - N)` ;;
742 `replicate`=`<boolean>` ('default =' `1`);;
744 Whether the drive should considered for replication jobs.
746 `rerror`=`<ignore | report | stop>` ;;
750 `scsiblock`=`<boolean>` ('default =' `0`);;
752 whether to use scsi-block for full passthrough of host block device
754 WARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host
756 `secs`=`<integer>` ;;
758 Force the drive's physical geometry to have a specific sector count.
760 `serial`=`<serial>` ;;
762 The drive's reported serial number, url-encoded, up to 20 bytes long.
764 `size`=`<DiskSize>` ;;
766 Disk size. This is purely informational and has no effect.
768 `snapshot`=`<boolean>` ;;
770 Whether the drive should be included when making snapshots.
772 `trans`=`<auto | lba | none>` ;;
774 Force disk geometry bios translation mode.
776 `werror`=`<enospc | ignore | report | stop>` ;;
780 `scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
782 SCSI controller model
784 `serial[n]`: `(/dev/.+|socket)` ::
786 Create a serial device inside the VM (n is 0 to 3), and pass through a
787 host serial device (i.e. /dev/ttyS0), or create a unix socket on the
788 host side (use 'qm terminal' to open a terminal connection).
790 NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.
792 CAUTION: Experimental! User reported problems with this option.
794 `shares`: `<integer> (0 - 50000)` ('default =' `1000`)::
796 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
798 `smbios1`: `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
800 Specify SMBIOS type 1 fields.
802 `family`=`<string>` ;;
804 Set SMBIOS1 family string.
806 `manufacturer`=`<string>` ;;
808 Set SMBIOS1 manufacturer.
810 `product`=`<string>` ;;
812 Set SMBIOS1 product ID.
814 `serial`=`<string>` ;;
816 Set SMBIOS1 serial number.
820 Set SMBIOS1 SKU string.
826 `version`=`<string>` ;;
830 `smp`: `<integer> (1 - N)` ('default =' `1`)::
832 The number of CPUs. Please use option -sockets instead.
834 `sockets`: `<integer> (1 - N)` ('default =' `1`)::
836 The number of CPU sockets.
838 `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
840 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'.
842 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
844 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.
846 `tablet`: `<boolean>` ('default =' `1`)::
848 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).
850 `tdf`: `<boolean>` ('default =' `0`)::
852 Enable/disable time drift fix.
854 `template`: `<boolean>` ('default =' `0`)::
856 Enable/disable Template.
858 `unused[n]`: `<string>` ::
860 Reference to unused volumes. This is used internally, and should not be modified manually.
862 `usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
864 Configure an USB device (n is 0 to 4).
866 `host`=`<HOSTUSBDEVICE|spice>` ;;
868 The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
870 'bus-port(.port)*' (decimal numbers) or
871 'vendor_id:product_id' (hexadeciaml numbers) or
874 You can use the 'lsusb -t' command to list existing usb devices.
876 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
878 The value 'spice' can be used to add a usb redirection devices for spice.
880 `usb3`=`<boolean>` ('default =' `0`);;
882 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).
884 `vcpus`: `<integer> (1 - N)` ('default =' `0`)::
886 Number of hotplugged vcpus.
888 `vga`: `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
890 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.
892 `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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
894 Use volume as VIRTIO hard disk (n is 0 to 15).
896 `aio`=`<native | threads>` ;;
900 `backup`=`<boolean>` ;;
902 Whether the drive should be included when making backups.
906 Maximum r/w speed in bytes per second.
908 `bps_max_length`=`<seconds>` ;;
910 Maximum length of I/O bursts in seconds.
914 Maximum read speed in bytes per second.
916 `bps_rd_max_length`=`<seconds>` ;;
918 Maximum length of read I/O bursts in seconds.
922 Maximum write speed in bytes per second.
924 `bps_wr_max_length`=`<seconds>` ;;
926 Maximum length of write I/O bursts in seconds.
928 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
930 The drive's cache mode
932 `cyls`=`<integer>` ;;
934 Force the drive's physical geometry to have a specific cylinder count.
936 `detect_zeroes`=`<boolean>` ;;
938 Controls whether to detect and try to optimize writes of zeroes.
940 `discard`=`<ignore | on>` ;;
942 Controls whether to pass discard/trim requests to the underlying storage.
946 The drive's backing volume.
948 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
950 The drive's backing file's data format.
952 `heads`=`<integer>` ;;
954 Force the drive's physical geometry to have a specific head count.
958 Maximum r/w I/O in operations per second.
960 `iops_max`=`<iops>` ;;
962 Maximum unthrottled r/w I/O pool in operations per second.
964 `iops_max_length`=`<seconds>` ;;
966 Maximum length of I/O bursts in seconds.
968 `iops_rd`=`<iops>` ;;
970 Maximum read I/O in operations per second.
972 `iops_rd_max`=`<iops>` ;;
974 Maximum unthrottled read I/O pool in operations per second.
976 `iops_rd_max_length`=`<seconds>` ;;
978 Maximum length of read I/O bursts in seconds.
980 `iops_wr`=`<iops>` ;;
982 Maximum write I/O in operations per second.
984 `iops_wr_max`=`<iops>` ;;
986 Maximum unthrottled write I/O pool in operations per second.
988 `iops_wr_max_length`=`<seconds>` ;;
990 Maximum length of write I/O bursts in seconds.
992 `iothread`=`<boolean>` ;;
994 Whether to use iothreads for this drive
998 Maximum r/w speed in megabytes per second.
1000 `mbps_max`=`<mbps>` ;;
1002 Maximum unthrottled r/w pool in megabytes per second.
1004 `mbps_rd`=`<mbps>` ;;
1006 Maximum read speed in megabytes per second.
1008 `mbps_rd_max`=`<mbps>` ;;
1010 Maximum unthrottled read pool in megabytes per second.
1012 `mbps_wr`=`<mbps>` ;;
1014 Maximum write speed in megabytes per second.
1016 `mbps_wr_max`=`<mbps>` ;;
1018 Maximum unthrottled write pool in megabytes per second.
1020 `media`=`<cdrom | disk>` ('default =' `disk`);;
1022 The drive's media type.
1024 `replicate`=`<boolean>` ('default =' `1`);;
1026 Whether the drive should considered for replication jobs.
1028 `rerror`=`<ignore | report | stop>` ;;
1032 `secs`=`<integer>` ;;
1034 Force the drive's physical geometry to have a specific sector count.
1036 `serial`=`<serial>` ;;
1038 The drive's reported serial number, url-encoded, up to 20 bytes long.
1040 `size`=`<DiskSize>` ;;
1042 Disk size. This is purely informational and has no effect.
1044 `snapshot`=`<boolean>` ;;
1046 Whether the drive should be included when making snapshots.
1048 `trans`=`<auto | lba | none>` ;;
1050 Force disk geometry bios translation mode.
1052 `werror`=`<enospc | ignore | report | stop>` ;;
1056 `vmstatestorage`: `<string>` ::
1058 Default storage for VM state volumes/files.
1060 `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1062 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)
1064 `action`=`<debug | none | pause | poweroff | reset | shutdown>` ;;
1066 The action to perform if after activation the guest fails to poll the watchdog in time.
1068 `model`=`<i6300esb | ib700>` ('default =' `i6300esb`);;
1070 Watchdog type to emulate.