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 | 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_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,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_length`=`<seconds>` ;;
161 Maximum length of read I/O bursts in seconds.
165 Maximum write speed in bytes per second.
167 `bps_wr_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_length`=`<seconds>` ;;
217 Maximum length of read I/O bursts in seconds.
219 `iops_rd_max`=`<iops>` ;;
221 Maximum unthrottled read I/O pool in operations per second.
223 `iops_wr`=`<iops>` ;;
225 Maximum write I/O in operations per second.
227 `iops_wr_length`=`<seconds>` ;;
229 Maximum length of write I/O bursts in seconds.
231 `iops_wr_max`=`<iops>` ;;
233 Maximum unthrottled write I/O pool in operations per second.
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 `rerror`=`<ignore | report | stop>` ;;
271 `secs`=`<integer>` ;;
273 Force the drive's physical geometry to have a specific sector count.
275 `serial`=`<serial>` ;;
277 The drive's reported serial number, url-encoded, up to 20 bytes long.
279 `size`=`<DiskSize>` ;;
281 Disk size. This is purely informational and has no effect.
283 `snapshot`=`<boolean>` ;;
285 Whether the drive should be included when making snapshots.
287 `trans`=`<auto | lba | none>` ;;
289 Force disk geometry bios translation mode.
291 `werror`=`<enospc | ignore | report | stop>` ;;
295 `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`)::
297 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
299 `kvm`: `<boolean>` ('default =' `1`)::
301 Enable/disable KVM hardware virtualization.
303 `localtime`: `<boolean>` ::
305 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
307 `lock`: `<backup | migrate | rollback | snapshot>` ::
311 `machine`: `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
313 Specific the Qemu machine type.
315 `memory`: `<integer> (16 - N)` ('default =' `512`)::
317 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
319 `migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
321 Set maximum tolerated downtime (in seconds) for migrations.
323 `migrate_speed`: `<integer> (0 - N)` ('default =' `0`)::
325 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
327 `name`: `<string>` ::
329 Set a name for the VM. Only used on the configuration web interface.
331 `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>]` ::
333 Specify network devices.
335 `bridge`=`<bridge>` ;;
337 Bridge to attach the network device to. The Proxmox VE standard bridge
340 If you do not specify a bridge, we create a kvm user (NATed) network
341 device, which provides DHCP and DNS services. The following addresses
348 The DHCP server assign addresses to the guest starting from 10.0.2.15.
350 `firewall`=`<boolean>` ;;
352 Whether this interface should be protected by the firewall.
354 `link_down`=`<boolean>` ;;
356 Whether this interface should be disconnected (like pulling the plug).
358 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
360 MAC address. That address must be unique withing your network. This is automatically generated if not specified.
362 `model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
364 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'.
366 `queues`=`<integer> (0 - 16)` ;;
368 Number of packet queues to be used on the device.
370 `rate`=`<number> (0 - N)` ;;
372 Rate limit in mbps (megabytes per second) as floating point number.
374 `tag`=`<integer> (1 - 4094)` ;;
376 VLAN tag to apply to packets on this interface.
378 `trunks`=`<vlanid[;vlanid...]>` ;;
380 VLAN trunks to pass through this interface.
382 `numa`: `<boolean>` ('default =' `0`)::
386 `numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
390 `cpus`=`<id[-id];...>` ;;
392 CPUs accessing this NUMA node.
394 `hostnodes`=`<id[-id];...>` ;;
396 Host NUMA nodes to use.
398 `memory`=`<number>` ;;
400 Amount of memory this NUMA node provides.
402 `policy`=`<bind | interleave | preferred>` ;;
404 NUMA allocation policy.
406 `onboot`: `<boolean>` ('default =' `0`)::
408 Specifies whether a VM will be started during system bootup.
410 `ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
412 Specify guest operating system. This is used to enable special
413 optimization/features for specific operating systems:
416 other;; unspecified OS
417 wxp;; Microsoft Windows XP
418 w2k;; Microsoft Windows 2000
419 w2k3;; Microsoft Windows 2003
420 w2k8;; Microsoft Windows 2008
421 wvista;; Microsoft Windows Vista
422 win7;; Microsoft Windows 7
423 win8;; Microsoft Windows 8/2012
424 l24;; Linux 2.4 Kernel
425 l26;; Linux 2.6/3.X Kernel
426 solaris;; Solaris/OpenSolaris/OpenIndiania kernel
428 `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
430 Map host parallel devices (n is 0 to 2).
432 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
434 CAUTION: Experimental! User reported problems with this option.
436 `protection`: `<boolean>` ('default =' `0`)::
438 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
440 `reboot`: `<boolean>` ('default =' `1`)::
442 Allow reboot. If set to '0' the VM exit on reboot.
444 `sata[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
446 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
448 `aio`=`<native | threads>` ;;
452 `backup`=`<boolean>` ;;
454 Whether the drive should be included when making backups.
458 Maximum r/w speed in bytes per second.
460 `bps_max_length`=`<seconds>` ;;
462 Maximum length of I/O bursts in seconds.
466 Maximum read speed in bytes per second.
468 `bps_rd_length`=`<seconds>` ;;
470 Maximum length of read I/O bursts in seconds.
474 Maximum write speed in bytes per second.
476 `bps_wr_length`=`<seconds>` ;;
478 Maximum length of write I/O bursts in seconds.
480 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
482 The drive's cache mode
484 `cyls`=`<integer>` ;;
486 Force the drive's physical geometry to have a specific cylinder count.
488 `detect_zeroes`=`<boolean>` ;;
490 Controls whether to detect and try to optimize writes of zeroes.
492 `discard`=`<ignore | on>` ;;
494 Controls whether to pass discard/trim requests to the underlying storage.
498 The drive's backing volume.
500 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
502 The drive's backing file's data format.
504 `heads`=`<integer>` ;;
506 Force the drive's physical geometry to have a specific head count.
510 Maximum r/w I/O in operations per second.
512 `iops_max`=`<iops>` ;;
514 Maximum unthrottled r/w I/O pool in operations per second.
516 `iops_max_length`=`<seconds>` ;;
518 Maximum length of I/O bursts in seconds.
520 `iops_rd`=`<iops>` ;;
522 Maximum read I/O in operations per second.
524 `iops_rd_length`=`<seconds>` ;;
526 Maximum length of read I/O bursts in seconds.
528 `iops_rd_max`=`<iops>` ;;
530 Maximum unthrottled read I/O pool in operations per second.
532 `iops_wr`=`<iops>` ;;
534 Maximum write I/O in operations per second.
536 `iops_wr_length`=`<seconds>` ;;
538 Maximum length of write I/O bursts in seconds.
540 `iops_wr_max`=`<iops>` ;;
542 Maximum unthrottled write I/O pool in operations per second.
546 Maximum r/w speed in megabytes per second.
548 `mbps_max`=`<mbps>` ;;
550 Maximum unthrottled r/w pool in megabytes per second.
552 `mbps_rd`=`<mbps>` ;;
554 Maximum read speed in megabytes per second.
556 `mbps_rd_max`=`<mbps>` ;;
558 Maximum unthrottled read pool in megabytes per second.
560 `mbps_wr`=`<mbps>` ;;
562 Maximum write speed in megabytes per second.
564 `mbps_wr_max`=`<mbps>` ;;
566 Maximum unthrottled write pool in megabytes per second.
568 `media`=`<cdrom | disk>` ('default =' `disk`);;
570 The drive's media type.
572 `rerror`=`<ignore | report | stop>` ;;
576 `secs`=`<integer>` ;;
578 Force the drive's physical geometry to have a specific sector count.
580 `serial`=`<serial>` ;;
582 The drive's reported serial number, url-encoded, up to 20 bytes long.
584 `size`=`<DiskSize>` ;;
586 Disk size. This is purely informational and has no effect.
588 `snapshot`=`<boolean>` ;;
590 Whether the drive should be included when making snapshots.
592 `trans`=`<auto | lba | none>` ;;
594 Force disk geometry bios translation mode.
596 `werror`=`<enospc | ignore | report | stop>` ;;
600 `scsi[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,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>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
602 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
604 `aio`=`<native | threads>` ;;
608 `backup`=`<boolean>` ;;
610 Whether the drive should be included when making backups.
614 Maximum r/w speed in bytes per second.
616 `bps_max_length`=`<seconds>` ;;
618 Maximum length of I/O bursts in seconds.
622 Maximum read speed in bytes per second.
624 `bps_rd_length`=`<seconds>` ;;
626 Maximum length of read I/O bursts in seconds.
630 Maximum write speed in bytes per second.
632 `bps_wr_length`=`<seconds>` ;;
634 Maximum length of write I/O bursts in seconds.
636 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
638 The drive's cache mode
640 `cyls`=`<integer>` ;;
642 Force the drive's physical geometry to have a specific cylinder count.
644 `detect_zeroes`=`<boolean>` ;;
646 Controls whether to detect and try to optimize writes of zeroes.
648 `discard`=`<ignore | on>` ;;
650 Controls whether to pass discard/trim requests to the underlying storage.
654 The drive's backing volume.
656 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
658 The drive's backing file's data format.
660 `heads`=`<integer>` ;;
662 Force the drive's physical geometry to have a specific head count.
666 Maximum r/w I/O in operations per second.
668 `iops_max`=`<iops>` ;;
670 Maximum unthrottled r/w I/O pool in operations per second.
672 `iops_max_length`=`<seconds>` ;;
674 Maximum length of I/O bursts in seconds.
676 `iops_rd`=`<iops>` ;;
678 Maximum read I/O in operations per second.
680 `iops_rd_length`=`<seconds>` ;;
682 Maximum length of read I/O bursts in seconds.
684 `iops_rd_max`=`<iops>` ;;
686 Maximum unthrottled read I/O pool in operations per second.
688 `iops_wr`=`<iops>` ;;
690 Maximum write I/O in operations per second.
692 `iops_wr_length`=`<seconds>` ;;
694 Maximum length of write I/O bursts in seconds.
696 `iops_wr_max`=`<iops>` ;;
698 Maximum unthrottled write I/O pool in operations per second.
700 `iothread`=`<boolean>` ;;
702 Whether to use iothreads for this drive
706 Maximum r/w speed in megabytes per second.
708 `mbps_max`=`<mbps>` ;;
710 Maximum unthrottled r/w pool in megabytes per second.
712 `mbps_rd`=`<mbps>` ;;
714 Maximum read speed in megabytes per second.
716 `mbps_rd_max`=`<mbps>` ;;
718 Maximum unthrottled read pool in megabytes per second.
720 `mbps_wr`=`<mbps>` ;;
722 Maximum write speed in megabytes per second.
724 `mbps_wr_max`=`<mbps>` ;;
726 Maximum unthrottled write pool in megabytes per second.
728 `media`=`<cdrom | disk>` ('default =' `disk`);;
730 The drive's media type.
732 `queues`=`<integer> (2 - N)` ;;
736 `scsiblock`=`<boolean>` ('default =' `0`);;
738 whether to use scsi-block for full passthrough of host block device
740 WARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host
742 `secs`=`<integer>` ;;
744 Force the drive's physical geometry to have a specific sector count.
746 `serial`=`<serial>` ;;
748 The drive's reported serial number, url-encoded, up to 20 bytes long.
750 `size`=`<DiskSize>` ;;
752 Disk size. This is purely informational and has no effect.
754 `snapshot`=`<boolean>` ;;
756 Whether the drive should be included when making snapshots.
758 `trans`=`<auto | lba | none>` ;;
760 Force disk geometry bios translation mode.
762 `werror`=`<enospc | ignore | report | stop>` ;;
766 `scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
768 SCSI controller model
770 `serial[n]`: `(/dev/.+|socket)` ::
772 Create a serial device inside the VM (n is 0 to 3), and pass through a
773 host serial device (i.e. /dev/ttyS0), or create a unix socket on the
774 host side (use 'qm terminal' to open a terminal connection).
776 NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.
778 CAUTION: Experimental! User reported problems with this option.
780 `shares`: `<integer> (0 - 50000)` ('default =' `1000`)::
782 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
784 `smbios1`: `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
786 Specify SMBIOS type 1 fields.
788 `family`=`<string>` ;;
790 Set SMBIOS1 family string.
792 `manufacturer`=`<string>` ;;
794 Set SMBIOS1 manufacturer.
796 `product`=`<string>` ;;
798 Set SMBIOS1 product ID.
800 `serial`=`<string>` ;;
802 Set SMBIOS1 serial number.
806 Set SMBIOS1 SKU string.
812 `version`=`<string>` ;;
816 `smp`: `<integer> (1 - N)` ('default =' `1`)::
818 The number of CPUs. Please use option -sockets instead.
820 `sockets`: `<integer> (1 - N)` ('default =' `1`)::
822 The number of CPU sockets.
824 `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
826 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'.
828 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
830 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.
832 `tablet`: `<boolean>` ('default =' `1`)::
834 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).
836 `tdf`: `<boolean>` ('default =' `0`)::
838 Enable/disable time drift fix.
840 `template`: `<boolean>` ('default =' `0`)::
842 Enable/disable Template.
844 `unused[n]`: `<string>` ::
846 Reference to unused volumes. This is used internally, and should not be modified manually.
848 `usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
850 Configure an USB device (n is 0 to 4).
852 `host`=`<HOSTUSBDEVICE|spice>` ;;
854 The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
856 'bus-port(.port)*' (decimal numbers) or
857 'vendor_id:product_id' (hexadeciaml numbers) or
860 You can use the 'lsusb -t' command to list existing usb devices.
862 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
864 The value 'spice' can be used to add a usb redirection devices for spice.
866 `usb3`=`<boolean>` ('default =' `0`);;
868 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).
870 `vcpus`: `<integer> (1 - N)` ('default =' `0`)::
872 Number of hotplugged vcpus.
874 `vga`: `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
876 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.
878 `virtio[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,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>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
880 Use volume as VIRTIO hard disk (n is 0 to 15).
882 `aio`=`<native | threads>` ;;
886 `backup`=`<boolean>` ;;
888 Whether the drive should be included when making backups.
892 Maximum r/w speed in bytes per second.
894 `bps_max_length`=`<seconds>` ;;
896 Maximum length of I/O bursts in seconds.
900 Maximum read speed in bytes per second.
902 `bps_rd_length`=`<seconds>` ;;
904 Maximum length of read I/O bursts in seconds.
908 Maximum write speed in bytes per second.
910 `bps_wr_length`=`<seconds>` ;;
912 Maximum length of write I/O bursts in seconds.
914 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
916 The drive's cache mode
918 `cyls`=`<integer>` ;;
920 Force the drive's physical geometry to have a specific cylinder count.
922 `detect_zeroes`=`<boolean>` ;;
924 Controls whether to detect and try to optimize writes of zeroes.
926 `discard`=`<ignore | on>` ;;
928 Controls whether to pass discard/trim requests to the underlying storage.
932 The drive's backing volume.
934 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
936 The drive's backing file's data format.
938 `heads`=`<integer>` ;;
940 Force the drive's physical geometry to have a specific head count.
944 Maximum r/w I/O in operations per second.
946 `iops_max`=`<iops>` ;;
948 Maximum unthrottled r/w I/O pool in operations per second.
950 `iops_max_length`=`<seconds>` ;;
952 Maximum length of I/O bursts in seconds.
954 `iops_rd`=`<iops>` ;;
956 Maximum read I/O in operations per second.
958 `iops_rd_length`=`<seconds>` ;;
960 Maximum length of read I/O bursts in seconds.
962 `iops_rd_max`=`<iops>` ;;
964 Maximum unthrottled read I/O pool in operations per second.
966 `iops_wr`=`<iops>` ;;
968 Maximum write I/O in operations per second.
970 `iops_wr_length`=`<seconds>` ;;
972 Maximum length of write I/O bursts in seconds.
974 `iops_wr_max`=`<iops>` ;;
976 Maximum unthrottled write I/O pool in operations per second.
978 `iothread`=`<boolean>` ;;
980 Whether to use iothreads for this drive
984 Maximum r/w speed in megabytes per second.
986 `mbps_max`=`<mbps>` ;;
988 Maximum unthrottled r/w pool in megabytes per second.
990 `mbps_rd`=`<mbps>` ;;
992 Maximum read speed in megabytes per second.
994 `mbps_rd_max`=`<mbps>` ;;
996 Maximum unthrottled read pool in megabytes per second.
998 `mbps_wr`=`<mbps>` ;;
1000 Maximum write speed in megabytes per second.
1002 `mbps_wr_max`=`<mbps>` ;;
1004 Maximum unthrottled write pool in megabytes per second.
1006 `media`=`<cdrom | disk>` ('default =' `disk`);;
1008 The drive's media type.
1010 `rerror`=`<ignore | report | stop>` ;;
1014 `secs`=`<integer>` ;;
1016 Force the drive's physical geometry to have a specific sector count.
1018 `serial`=`<serial>` ;;
1020 The drive's reported serial number, url-encoded, up to 20 bytes long.
1022 `size`=`<DiskSize>` ;;
1024 Disk size. This is purely informational and has no effect.
1026 `snapshot`=`<boolean>` ;;
1028 Whether the drive should be included when making snapshots.
1030 `trans`=`<auto | lba | none>` ;;
1032 Force disk geometry bios translation mode.
1034 `werror`=`<enospc | ignore | report | stop>` ;;
1038 `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1040 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)
1042 `action`=`<debug | none | pause | poweroff | reset | shutdown>` ;;
1044 The action to perform if after activation the guest fails to poll the watchdog in time.
1046 `model`=`<i6300esb | ib700>` ('default =' `i6300esb`);;
1048 Watchdog type to emulate.