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> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
49 `cputype`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Conroe | 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`);;
53 `flags`=`<+FLAG[;-FLAG...]>` ;;
55 List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl'.
57 `hidden`=`<boolean>` ('default =' `0`);;
59 Do not identify as a KVM virtual machine.
61 `cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
65 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
67 `cpuunits`: `<integer> (2 - 262144)` ('default =' `1024`)::
69 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.
71 `description`: `<string>` ::
73 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
75 `efidisk0`: `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
77 Configure a Disk for storing EFI vars
81 The drive's backing volume.
83 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
85 The drive's backing file's data format.
87 `size`=`<DiskSize>` ;;
89 Disk size. This is purely informational and has no effect.
91 `freeze`: `<boolean>` ::
93 Freeze CPU at startup (use 'c' monitor command to start execution).
95 `hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
97 Map host PCI devices into guest.
99 NOTE: This option allows direct access to host hardware. So it is no longer
100 possible to migrate such machines - use with special care.
102 CAUTION: Experimental! User reported problems with this option.
104 `host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
106 Host PCI device pass through. The PCI ID of a host's PCI device or a list
107 of PCI virtual functions of the host. HOSTPCIID syntax is:
109 'bus:dev.func' (hexadecimal numbers)
111 You can us the 'lspci' command to list existing PCI devices.
113 `pcie`=`<boolean>` ('default =' `0`);;
115 Choose the PCI-express bus (needs the 'q35' machine model).
117 `rombar`=`<boolean>` ('default =' `1`);;
119 Specify whether or not the device's ROM will be visible in the guest's memory map.
121 `romfile`=`<string>` ;;
123 Custom pci device rom filename (must be located in /usr/share/kvm/).
125 `x-vga`=`<boolean>` ('default =' `0`);;
127 Enable vfio-vga device support.
129 `hotplug`: `<string>` ('default =' `network,disk,usb`)::
131 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'.
133 `hugepages`: `<1024 | 2 | any>` ::
135 Enable/disable hugepages memory.
137 `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>]` ::
139 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
141 `aio`=`<native | threads>` ;;
145 `backup`=`<boolean>` ;;
147 Whether the drive should be included when making backups.
151 Maximum r/w speed in bytes per second.
153 `bps_max_length`=`<seconds>` ;;
155 Maximum length of I/O bursts in seconds.
159 Maximum read speed in bytes per second.
161 `bps_rd_max_length`=`<seconds>` ;;
163 Maximum length of read I/O bursts in seconds.
167 Maximum write speed in bytes per second.
169 `bps_wr_max_length`=`<seconds>` ;;
171 Maximum length of write I/O bursts in seconds.
173 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
175 The drive's cache mode
177 `cyls`=`<integer>` ;;
179 Force the drive's physical geometry to have a specific cylinder count.
181 `detect_zeroes`=`<boolean>` ;;
183 Controls whether to detect and try to optimize writes of zeroes.
185 `discard`=`<ignore | on>` ;;
187 Controls whether to pass discard/trim requests to the underlying storage.
191 The drive's backing volume.
193 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
195 The drive's backing file's data format.
197 `heads`=`<integer>` ;;
199 Force the drive's physical geometry to have a specific head count.
203 Maximum r/w I/O in operations per second.
205 `iops_max`=`<iops>` ;;
207 Maximum unthrottled r/w I/O pool in operations per second.
209 `iops_max_length`=`<seconds>` ;;
211 Maximum length of I/O bursts in seconds.
213 `iops_rd`=`<iops>` ;;
215 Maximum read I/O in operations per second.
217 `iops_rd_max`=`<iops>` ;;
219 Maximum unthrottled read I/O pool in operations per second.
221 `iops_rd_max_length`=`<seconds>` ;;
223 Maximum length of read I/O bursts in seconds.
225 `iops_wr`=`<iops>` ;;
227 Maximum write I/O in operations per second.
229 `iops_wr_max`=`<iops>` ;;
231 Maximum unthrottled write I/O pool in operations per second.
233 `iops_wr_max_length`=`<seconds>` ;;
235 Maximum length of write I/O bursts in seconds.
239 Maximum r/w speed in megabytes per second.
241 `mbps_max`=`<mbps>` ;;
243 Maximum unthrottled r/w pool in megabytes per second.
245 `mbps_rd`=`<mbps>` ;;
247 Maximum read speed in megabytes per second.
249 `mbps_rd_max`=`<mbps>` ;;
251 Maximum unthrottled read pool in megabytes per second.
253 `mbps_wr`=`<mbps>` ;;
255 Maximum write speed in megabytes per second.
257 `mbps_wr_max`=`<mbps>` ;;
259 Maximum unthrottled write pool in megabytes per second.
261 `media`=`<cdrom | disk>` ('default =' `disk`);;
263 The drive's media type.
267 The drive's reported model name, url-encoded, up to 40 bytes long.
269 `replicate`=`<boolean>` ('default =' `1`);;
271 Whether the drive should considered for replication jobs.
273 `rerror`=`<ignore | report | stop>` ;;
277 `secs`=`<integer>` ;;
279 Force the drive's physical geometry to have a specific sector count.
281 `serial`=`<serial>` ;;
283 The drive's reported serial number, url-encoded, up to 20 bytes long.
285 `size`=`<DiskSize>` ;;
287 Disk size. This is purely informational and has no effect.
289 `snapshot`=`<boolean>` ;;
291 Whether the drive should be included when making snapshots.
293 `trans`=`<auto | lba | none>` ;;
295 Force disk geometry bios translation mode.
297 `werror`=`<enospc | ignore | report | stop>` ;;
301 `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>` ::
303 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.
305 `kvm`: `<boolean>` ('default =' `1`)::
307 Enable/disable KVM hardware virtualization.
309 `localtime`: `<boolean>` ::
311 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
313 `lock`: `<backup | migrate | rollback | snapshot>` ::
317 `machine`: `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
319 Specific the Qemu machine type.
321 `memory`: `<integer> (16 - N)` ('default =' `512`)::
323 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
325 `migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
327 Set maximum tolerated downtime (in seconds) for migrations.
329 `migrate_speed`: `<integer> (0 - N)` ('default =' `0`)::
331 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
333 `name`: `<string>` ::
335 Set a name for the VM. Only used on the configuration web interface.
337 `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>]` ::
339 Specify network devices.
341 `bridge`=`<bridge>` ;;
343 Bridge to attach the network device to. The Proxmox VE standard bridge
346 If you do not specify a bridge, we create a kvm user (NATed) network
347 device, which provides DHCP and DNS services. The following addresses
354 The DHCP server assign addresses to the guest starting from 10.0.2.15.
356 `firewall`=`<boolean>` ;;
358 Whether this interface should be protected by the firewall.
360 `link_down`=`<boolean>` ;;
362 Whether this interface should be disconnected (like pulling the plug).
364 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
366 MAC address. That address must be unique withing your network. This is automatically generated if not specified.
368 `model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
370 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'.
372 `queues`=`<integer> (0 - 16)` ;;
374 Number of packet queues to be used on the device.
376 `rate`=`<number> (0 - N)` ;;
378 Rate limit in mbps (megabytes per second) as floating point number.
380 `tag`=`<integer> (1 - 4094)` ;;
382 VLAN tag to apply to packets on this interface.
384 `trunks`=`<vlanid[;vlanid...]>` ;;
386 VLAN trunks to pass through this interface.
388 `numa`: `<boolean>` ('default =' `0`)::
392 `numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
396 `cpus`=`<id[-id];...>` ;;
398 CPUs accessing this NUMA node.
400 `hostnodes`=`<id[-id];...>` ;;
402 Host NUMA nodes to use.
404 `memory`=`<number>` ;;
406 Amount of memory this NUMA node provides.
408 `policy`=`<bind | interleave | preferred>` ;;
410 NUMA allocation policy.
412 `onboot`: `<boolean>` ('default =' `0`)::
414 Specifies whether a VM will be started during system bootup.
416 `ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
418 Specify guest operating system. This is used to enable special
419 optimization/features for specific operating systems:
422 other;; unspecified OS
423 wxp;; Microsoft Windows XP
424 w2k;; Microsoft Windows 2000
425 w2k3;; Microsoft Windows 2003
426 w2k8;; Microsoft Windows 2008
427 wvista;; Microsoft Windows Vista
428 win7;; Microsoft Windows 7
429 win8;; Microsoft Windows 8/2012/2012r2
430 win10;; Microsoft Windows 10/2016
431 l24;; Linux 2.4 Kernel
432 l26;; Linux 2.6/3.X Kernel
433 solaris;; Solaris/OpenSolaris/OpenIndiania kernel
435 `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
437 Map host parallel devices (n is 0 to 2).
439 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
441 CAUTION: Experimental! User reported problems with this option.
443 `protection`: `<boolean>` ('default =' `0`)::
445 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
447 `reboot`: `<boolean>` ('default =' `1`)::
449 Allow reboot. If set to '0' the VM exit on reboot.
451 `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>]` ::
453 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
455 `aio`=`<native | threads>` ;;
459 `backup`=`<boolean>` ;;
461 Whether the drive should be included when making backups.
465 Maximum r/w speed in bytes per second.
467 `bps_max_length`=`<seconds>` ;;
469 Maximum length of I/O bursts in seconds.
473 Maximum read speed in bytes per second.
475 `bps_rd_max_length`=`<seconds>` ;;
477 Maximum length of read I/O bursts in seconds.
481 Maximum write speed in bytes per second.
483 `bps_wr_max_length`=`<seconds>` ;;
485 Maximum length of write I/O bursts in seconds.
487 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
489 The drive's cache mode
491 `cyls`=`<integer>` ;;
493 Force the drive's physical geometry to have a specific cylinder count.
495 `detect_zeroes`=`<boolean>` ;;
497 Controls whether to detect and try to optimize writes of zeroes.
499 `discard`=`<ignore | on>` ;;
501 Controls whether to pass discard/trim requests to the underlying storage.
505 The drive's backing volume.
507 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
509 The drive's backing file's data format.
511 `heads`=`<integer>` ;;
513 Force the drive's physical geometry to have a specific head count.
517 Maximum r/w I/O in operations per second.
519 `iops_max`=`<iops>` ;;
521 Maximum unthrottled r/w I/O pool in operations per second.
523 `iops_max_length`=`<seconds>` ;;
525 Maximum length of I/O bursts in seconds.
527 `iops_rd`=`<iops>` ;;
529 Maximum read I/O in operations per second.
531 `iops_rd_max`=`<iops>` ;;
533 Maximum unthrottled read I/O pool in operations per second.
535 `iops_rd_max_length`=`<seconds>` ;;
537 Maximum length of read I/O bursts in seconds.
539 `iops_wr`=`<iops>` ;;
541 Maximum write I/O in operations per second.
543 `iops_wr_max`=`<iops>` ;;
545 Maximum unthrottled write I/O pool in operations per second.
547 `iops_wr_max_length`=`<seconds>` ;;
549 Maximum length of write I/O bursts in seconds.
553 Maximum r/w speed in megabytes per second.
555 `mbps_max`=`<mbps>` ;;
557 Maximum unthrottled r/w pool in megabytes per second.
559 `mbps_rd`=`<mbps>` ;;
561 Maximum read speed in megabytes per second.
563 `mbps_rd_max`=`<mbps>` ;;
565 Maximum unthrottled read pool in megabytes per second.
567 `mbps_wr`=`<mbps>` ;;
569 Maximum write speed in megabytes per second.
571 `mbps_wr_max`=`<mbps>` ;;
573 Maximum unthrottled write pool in megabytes per second.
575 `media`=`<cdrom | disk>` ('default =' `disk`);;
577 The drive's media type.
579 `replicate`=`<boolean>` ('default =' `1`);;
581 Whether the drive should considered for replication jobs.
583 `rerror`=`<ignore | report | stop>` ;;
587 `secs`=`<integer>` ;;
589 Force the drive's physical geometry to have a specific sector count.
591 `serial`=`<serial>` ;;
593 The drive's reported serial number, url-encoded, up to 20 bytes long.
595 `size`=`<DiskSize>` ;;
597 Disk size. This is purely informational and has no effect.
599 `snapshot`=`<boolean>` ;;
601 Whether the drive should be included when making snapshots.
603 `trans`=`<auto | lba | none>` ;;
605 Force disk geometry bios translation mode.
607 `werror`=`<enospc | ignore | report | stop>` ;;
611 `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>]` ::
613 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
615 `aio`=`<native | threads>` ;;
619 `backup`=`<boolean>` ;;
621 Whether the drive should be included when making backups.
625 Maximum r/w speed in bytes per second.
627 `bps_max_length`=`<seconds>` ;;
629 Maximum length of I/O bursts in seconds.
633 Maximum read speed in bytes per second.
635 `bps_rd_max_length`=`<seconds>` ;;
637 Maximum length of read I/O bursts in seconds.
641 Maximum write speed in bytes per second.
643 `bps_wr_max_length`=`<seconds>` ;;
645 Maximum length of write I/O bursts in seconds.
647 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
649 The drive's cache mode
651 `cyls`=`<integer>` ;;
653 Force the drive's physical geometry to have a specific cylinder count.
655 `detect_zeroes`=`<boolean>` ;;
657 Controls whether to detect and try to optimize writes of zeroes.
659 `discard`=`<ignore | on>` ;;
661 Controls whether to pass discard/trim requests to the underlying storage.
665 The drive's backing volume.
667 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
669 The drive's backing file's data format.
671 `heads`=`<integer>` ;;
673 Force the drive's physical geometry to have a specific head count.
677 Maximum r/w I/O in operations per second.
679 `iops_max`=`<iops>` ;;
681 Maximum unthrottled r/w I/O pool in operations per second.
683 `iops_max_length`=`<seconds>` ;;
685 Maximum length of I/O bursts in seconds.
687 `iops_rd`=`<iops>` ;;
689 Maximum read I/O in operations per second.
691 `iops_rd_max`=`<iops>` ;;
693 Maximum unthrottled read I/O pool in operations per second.
695 `iops_rd_max_length`=`<seconds>` ;;
697 Maximum length of read I/O bursts in seconds.
699 `iops_wr`=`<iops>` ;;
701 Maximum write I/O in operations per second.
703 `iops_wr_max`=`<iops>` ;;
705 Maximum unthrottled write I/O pool in operations per second.
707 `iops_wr_max_length`=`<seconds>` ;;
709 Maximum length of write I/O bursts in seconds.
711 `iothread`=`<boolean>` ;;
713 Whether to use iothreads for this drive
717 Maximum r/w speed in megabytes per second.
719 `mbps_max`=`<mbps>` ;;
721 Maximum unthrottled r/w pool in megabytes per second.
723 `mbps_rd`=`<mbps>` ;;
725 Maximum read speed in megabytes per second.
727 `mbps_rd_max`=`<mbps>` ;;
729 Maximum unthrottled read pool in megabytes per second.
731 `mbps_wr`=`<mbps>` ;;
733 Maximum write speed in megabytes per second.
735 `mbps_wr_max`=`<mbps>` ;;
737 Maximum unthrottled write pool in megabytes per second.
739 `media`=`<cdrom | disk>` ('default =' `disk`);;
741 The drive's media type.
743 `queues`=`<integer> (2 - N)` ;;
747 `replicate`=`<boolean>` ('default =' `1`);;
749 Whether the drive should considered for replication jobs.
751 `rerror`=`<ignore | report | stop>` ;;
755 `scsiblock`=`<boolean>` ('default =' `0`);;
757 whether to use scsi-block for full passthrough of host block device
759 WARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host
761 `secs`=`<integer>` ;;
763 Force the drive's physical geometry to have a specific sector count.
765 `serial`=`<serial>` ;;
767 The drive's reported serial number, url-encoded, up to 20 bytes long.
769 `size`=`<DiskSize>` ;;
771 Disk size. This is purely informational and has no effect.
773 `snapshot`=`<boolean>` ;;
775 Whether the drive should be included when making snapshots.
777 `trans`=`<auto | lba | none>` ;;
779 Force disk geometry bios translation mode.
781 `werror`=`<enospc | ignore | report | stop>` ;;
785 `scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
787 SCSI controller model
789 `serial[n]`: `(/dev/.+|socket)` ::
791 Create a serial device inside the VM (n is 0 to 3), and pass through a
792 host serial device (i.e. /dev/ttyS0), or create a unix socket on the
793 host side (use 'qm terminal' to open a terminal connection).
795 NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.
797 CAUTION: Experimental! User reported problems with this option.
799 `shares`: `<integer> (0 - 50000)` ('default =' `1000`)::
801 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
803 `smbios1`: `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
805 Specify SMBIOS type 1 fields.
807 `family`=`<string>` ;;
809 Set SMBIOS1 family string.
811 `manufacturer`=`<string>` ;;
813 Set SMBIOS1 manufacturer.
815 `product`=`<string>` ;;
817 Set SMBIOS1 product ID.
819 `serial`=`<string>` ;;
821 Set SMBIOS1 serial number.
825 Set SMBIOS1 SKU string.
831 `version`=`<string>` ;;
835 `smp`: `<integer> (1 - N)` ('default =' `1`)::
837 The number of CPUs. Please use option -sockets instead.
839 `sockets`: `<integer> (1 - N)` ('default =' `1`)::
841 The number of CPU sockets.
843 `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
845 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'.
847 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
849 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.
851 `tablet`: `<boolean>` ('default =' `1`)::
853 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).
855 `tdf`: `<boolean>` ('default =' `0`)::
857 Enable/disable time drift fix.
859 `template`: `<boolean>` ('default =' `0`)::
861 Enable/disable Template.
863 `unused[n]`: `<string>` ::
865 Reference to unused volumes. This is used internally, and should not be modified manually.
867 `usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
869 Configure an USB device (n is 0 to 4).
871 `host`=`<HOSTUSBDEVICE|spice>` ;;
873 The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
875 'bus-port(.port)*' (decimal numbers) or
876 'vendor_id:product_id' (hexadeciaml numbers) or
879 You can use the 'lsusb -t' command to list existing usb devices.
881 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
883 The value 'spice' can be used to add a usb redirection devices for spice.
885 `usb3`=`<boolean>` ('default =' `0`);;
887 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).
889 `vcpus`: `<integer> (1 - N)` ('default =' `0`)::
891 Number of hotplugged vcpus.
893 `vga`: `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
895 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.
897 `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>]` ::
899 Use volume as VIRTIO hard disk (n is 0 to 15).
901 `aio`=`<native | threads>` ;;
905 `backup`=`<boolean>` ;;
907 Whether the drive should be included when making backups.
911 Maximum r/w speed in bytes per second.
913 `bps_max_length`=`<seconds>` ;;
915 Maximum length of I/O bursts in seconds.
919 Maximum read speed in bytes per second.
921 `bps_rd_max_length`=`<seconds>` ;;
923 Maximum length of read I/O bursts in seconds.
927 Maximum write speed in bytes per second.
929 `bps_wr_max_length`=`<seconds>` ;;
931 Maximum length of write I/O bursts in seconds.
933 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
935 The drive's cache mode
937 `cyls`=`<integer>` ;;
939 Force the drive's physical geometry to have a specific cylinder count.
941 `detect_zeroes`=`<boolean>` ;;
943 Controls whether to detect and try to optimize writes of zeroes.
945 `discard`=`<ignore | on>` ;;
947 Controls whether to pass discard/trim requests to the underlying storage.
951 The drive's backing volume.
953 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
955 The drive's backing file's data format.
957 `heads`=`<integer>` ;;
959 Force the drive's physical geometry to have a specific head count.
963 Maximum r/w I/O in operations per second.
965 `iops_max`=`<iops>` ;;
967 Maximum unthrottled r/w I/O pool in operations per second.
969 `iops_max_length`=`<seconds>` ;;
971 Maximum length of I/O bursts in seconds.
973 `iops_rd`=`<iops>` ;;
975 Maximum read I/O in operations per second.
977 `iops_rd_max`=`<iops>` ;;
979 Maximum unthrottled read I/O pool in operations per second.
981 `iops_rd_max_length`=`<seconds>` ;;
983 Maximum length of read I/O bursts in seconds.
985 `iops_wr`=`<iops>` ;;
987 Maximum write I/O in operations per second.
989 `iops_wr_max`=`<iops>` ;;
991 Maximum unthrottled write I/O pool in operations per second.
993 `iops_wr_max_length`=`<seconds>` ;;
995 Maximum length of write I/O bursts in seconds.
997 `iothread`=`<boolean>` ;;
999 Whether to use iothreads for this drive
1003 Maximum r/w speed in megabytes per second.
1005 `mbps_max`=`<mbps>` ;;
1007 Maximum unthrottled r/w pool in megabytes per second.
1009 `mbps_rd`=`<mbps>` ;;
1011 Maximum read speed in megabytes per second.
1013 `mbps_rd_max`=`<mbps>` ;;
1015 Maximum unthrottled read pool in megabytes per second.
1017 `mbps_wr`=`<mbps>` ;;
1019 Maximum write speed in megabytes per second.
1021 `mbps_wr_max`=`<mbps>` ;;
1023 Maximum unthrottled write pool in megabytes per second.
1025 `media`=`<cdrom | disk>` ('default =' `disk`);;
1027 The drive's media type.
1029 `replicate`=`<boolean>` ('default =' `1`);;
1031 Whether the drive should considered for replication jobs.
1033 `rerror`=`<ignore | report | stop>` ;;
1037 `secs`=`<integer>` ;;
1039 Force the drive's physical geometry to have a specific sector count.
1041 `serial`=`<serial>` ;;
1043 The drive's reported serial number, url-encoded, up to 20 bytes long.
1045 `size`=`<DiskSize>` ;;
1047 Disk size. This is purely informational and has no effect.
1049 `snapshot`=`<boolean>` ;;
1051 Whether the drive should be included when making snapshots.
1053 `trans`=`<auto | lba | none>` ;;
1055 Force disk geometry bios translation mode.
1057 `werror`=`<enospc | ignore | report | stop>` ;;
1061 `vmstatestorage`: `<string>` ::
1063 Default storage for VM state volumes/files.
1065 `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1067 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)
1069 `action`=`<debug | none | pause | poweroff | reset | shutdown>` ;;
1071 The action to perform if after activation the guest fails to poll the watchdog in time.
1073 `model`=`<i6300esb | ib700>` ('default =' `i6300esb`);;
1075 Watchdog type to emulate.