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