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.
39 This is an alias for option -ide2
41 `aio`=`(native | threads)` ;;
47 Whether the drive should be included when making backups.
51 Maximum r/w speed in bytes per second.
53 `bps_max_length`=`<seconds>` ;;
55 Maximum length of I/O bursts in seconds.
59 Maximum read speed in bytes per second.
61 `bps_rd_length`=`<seconds>` ;;
63 Maximum length of read I/O bursts in seconds.
67 Maximum write speed in bytes per second.
69 `bps_wr_length`=`<seconds>` ;;
71 Maximum length of write I/O bursts in seconds.
73 `cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
75 The drive's cache mode
79 Force the drive's physical geometry to have a specific cylinder count.
81 `detect_zeroes`=`boolean` ;;
83 Controls whether to detect and try to optimize writes of zeroes.
85 `discard`=`(ignore | on)` ;;
87 Controls whether to pass discard/trim requests to the underlying storage.
91 The drive's backing volume.
93 `format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
95 The drive's backing file's data format.
99 Force the drive's physical geometry to have a specific head count.
103 Maximum r/w I/O in operations per second.
105 `iops_max`=`<iops>` ;;
107 Maximum unthrottled r/w I/O pool in operations per second.
109 `iops_max_length`=`<seconds>` ;;
111 Maximum length of I/O bursts in seconds.
113 `iops_rd`=`<iops>` ;;
115 Maximum read I/O in operations per second.
117 `iops_rd_length`=`<seconds>` ;;
119 Maximum length of read I/O bursts in seconds.
121 `iops_rd_max`=`<iops>` ;;
123 Maximum unthrottled read I/O pool in operations per second.
125 `iops_wr`=`<iops>` ;;
127 Maximum write I/O in operations per second.
129 `iops_wr_length`=`<seconds>` ;;
131 Maximum length of write I/O bursts in seconds.
133 `iops_wr_max`=`<iops>` ;;
135 Maximum unthrottled write I/O pool in operations per second.
139 Maximum r/w speed in megabytes per second.
141 `mbps_max`=`<mbps>` ;;
143 Maximum unthrottled r/w pool in megabytes per second.
145 `mbps_rd`=`<mbps>` ;;
147 Maximum read speed in megabytes per second.
149 `mbps_rd_max`=`<mbps>` ;;
151 Maximum unthrottled read pool in megabytes per second.
153 `mbps_wr`=`<mbps>` ;;
155 Maximum write speed in megabytes per second.
157 `mbps_wr_max`=`<mbps>` ;;
159 Maximum unthrottled write pool in megabytes per second.
161 `media`=`(cdrom | disk)` (default=`disk`);;
163 The drive's media type.
167 The drive's reported model name, url-encoded, up to 40 bytes long.
169 `rerror`=`(ignore | report | stop)` ;;
175 Force the drive's physical geometry to have a specific sector count.
177 `serial`=`<serial>` ;;
179 The drive's reported serial number, url-encoded, up to 20 bytes long.
181 `size`=`<DiskSize>` ;;
183 Disk size. This is purely informational and has no effect.
185 `snapshot`=`boolean` ;;
187 Whether the drive should be included when making snapshots.
189 `trans`=`(auto | lba | none)` ;;
191 Force disk geometry bios translation mode.
193 `werror`=`(enospc | ignore | report | stop)` ;;
197 `cores`: `integer (1 - N)` (default=`1`)::
199 The number of cores per socket.
201 `cpu`: `[cputype=]<cputype> [,hidden=<1|0>]` ::
205 `cputype`=`<cputype>` (default=`kvm64`);;
209 `hidden`=`boolean` (default=`0`);;
211 Do not identify as a KVM virtual machine.
213 `cpulimit`: `number (0 - 128)` (default=`0`)::
217 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
219 `cpuunits`: `integer (0 - 500000)` (default=`1024`)::
221 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.
223 NOTE: You can disable fair-scheduler configuration by setting this to 0.
225 `description`: `string` ::
227 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
229 `efidisk0`: `[file=]<volume> [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,size=<DiskSize>]` ::
231 Configure a Disk for storing EFI vars
235 The drive's backing volume.
237 `format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
239 The drive's backing file's data format.
241 `size`=`<DiskSize>` ;;
243 Disk size. This is purely informational and has no effect.
245 `freeze`: `boolean` ::
247 Freeze CPU at startup (use 'c' monitor command to start execution).
249 `hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
251 Map host PCI devices into guest.
253 NOTE: This option allows direct access to host hardware. So it is no longer
254 possible to migrate such machines - use with special care.
256 CAUTION: Experimental! User reported problems with this option.
258 `host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
260 Host PCI device pass through. The PCI ID of a host's PCI device or a list
261 of PCI virtual functions of the host. HOSTPCIID syntax is:
263 'bus:dev.func' (hexadecimal numbers)
265 You can us the 'lspci' command to list existing PCI devices.
267 `pcie`=`boolean` (default=`0`);;
269 Choose the PCI-express bus (needs the 'q35' machine model).
271 `rombar`=`boolean` (default=`1`);;
273 Specify whether or not the device's ROM will be visible in the guest's memory map.
275 `x-vga`=`boolean` (default=`0`);;
277 Enable vfio-vga device support.
279 `hotplug`: `string` (default=`network,disk,usb`)::
281 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'.
283 `hugepages`: `(1024 | 2 | any)` ::
285 Enable/disable hugepages memory.
287 `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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
289 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
291 `aio`=`(native | threads)` ;;
295 `backup`=`boolean` ;;
297 Whether the drive should be included when making backups.
301 Maximum r/w speed in bytes per second.
303 `bps_max_length`=`<seconds>` ;;
305 Maximum length of I/O bursts in seconds.
309 Maximum read speed in bytes per second.
311 `bps_rd_length`=`<seconds>` ;;
313 Maximum length of read I/O bursts in seconds.
317 Maximum write speed in bytes per second.
319 `bps_wr_length`=`<seconds>` ;;
321 Maximum length of write I/O bursts in seconds.
323 `cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
325 The drive's cache mode
329 Force the drive's physical geometry to have a specific cylinder count.
331 `detect_zeroes`=`boolean` ;;
333 Controls whether to detect and try to optimize writes of zeroes.
335 `discard`=`(ignore | on)` ;;
337 Controls whether to pass discard/trim requests to the underlying storage.
341 The drive's backing volume.
343 `format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
345 The drive's backing file's data format.
349 Force the drive's physical geometry to have a specific head count.
353 Maximum r/w I/O in operations per second.
355 `iops_max`=`<iops>` ;;
357 Maximum unthrottled r/w I/O pool in operations per second.
359 `iops_max_length`=`<seconds>` ;;
361 Maximum length of I/O bursts in seconds.
363 `iops_rd`=`<iops>` ;;
365 Maximum read I/O in operations per second.
367 `iops_rd_length`=`<seconds>` ;;
369 Maximum length of read I/O bursts in seconds.
371 `iops_rd_max`=`<iops>` ;;
373 Maximum unthrottled read I/O pool in operations per second.
375 `iops_wr`=`<iops>` ;;
377 Maximum write I/O in operations per second.
379 `iops_wr_length`=`<seconds>` ;;
381 Maximum length of write I/O bursts in seconds.
383 `iops_wr_max`=`<iops>` ;;
385 Maximum unthrottled write I/O pool in operations per second.
389 Maximum r/w speed in megabytes per second.
391 `mbps_max`=`<mbps>` ;;
393 Maximum unthrottled r/w pool in megabytes per second.
395 `mbps_rd`=`<mbps>` ;;
397 Maximum read speed in megabytes per second.
399 `mbps_rd_max`=`<mbps>` ;;
401 Maximum unthrottled read pool in megabytes per second.
403 `mbps_wr`=`<mbps>` ;;
405 Maximum write speed in megabytes per second.
407 `mbps_wr_max`=`<mbps>` ;;
409 Maximum unthrottled write pool in megabytes per second.
411 `media`=`(cdrom | disk)` (default=`disk`);;
413 The drive's media type.
417 The drive's reported model name, url-encoded, up to 40 bytes long.
419 `rerror`=`(ignore | report | stop)` ;;
425 Force the drive's physical geometry to have a specific sector count.
427 `serial`=`<serial>` ;;
429 The drive's reported serial number, url-encoded, up to 20 bytes long.
431 `size`=`<DiskSize>` ;;
433 Disk size. This is purely informational and has no effect.
435 `snapshot`=`boolean` ;;
437 Whether the drive should be included when making snapshots.
439 `trans`=`(auto | lba | none)` ;;
441 Force disk geometry bios translation mode.
443 `werror`=`(enospc | ignore | report | stop)` ;;
447 `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`)::
449 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
451 `kvm`: `boolean` (default=`1`)::
453 Enable/disable KVM hardware virtualization.
455 `localtime`: `boolean` ::
457 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
459 `lock`: `(backup | migrate | rollback | snapshot)` ::
463 `machine`: `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
465 Specific the Qemu machine type.
467 `memory`: `integer (16 - N)` (default=`512`)::
469 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
471 `migrate_downtime`: `number (0 - N)` (default=`0.1`)::
473 Set maximum tolerated downtime (in seconds) for migrations.
475 `migrate_speed`: `integer (0 - N)` (default=`0`)::
477 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
481 Set a name for the VM. Only used on the configuration web interface.
483 `net[n]`: `[model=]<model> [,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>]` ::
485 Specify network devices.
487 `bridge`=`<bridge>` ;;
489 Bridge to attach the network device to. The Proxmox VE standard bridge
492 If you do not specify a bridge, we create a kvm user (NATed) network
493 device, which provides DHCP and DNS services. The following addresses
500 The DHCP server assign addresses to the guest starting from 10.0.2.15.
502 `firewall`=`boolean` ;;
504 Whether this interface should be protected by the firewall.
506 `link_down`=`boolean` ;;
508 Whether this interface should be disconnected (like pulling the plug).
510 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
512 MAC address. That address must be unique withing your network. This is automatically generated if not specified.
516 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'.
518 `queues`=`integer (0 - 16)` ;;
520 Number of packet queues to be used on the device.
522 `rate`=`number (0 - N)` ;;
524 Rate limit in mbps (megabytes per second) as floating point number.
526 `tag`=`integer (1 - 4094)` ;;
528 VLAN tag to apply to packets on this interface.
530 `trunks`=`<vlanid[;vlanid...]>` ;;
532 VLAN trunks to pass through this interface.
534 `numa`: `boolean` (default=`0`)::
538 `numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
542 `cpus`=`<id[-id];...>` ;;
544 CPUs accessing this NUMA node.
546 `hostnodes`=`<id[-id];...>` ;;
548 Host NUMA nodes to use.
552 Amount of memory this NUMA node provides.
554 `policy`=`(bind | interleave | preferred)` ;;
556 NUMA allocation policy.
558 `onboot`: `boolean` (default=`0`)::
560 Specifies whether a VM will be started during system bootup.
562 `ostype`: `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
564 Specify guest operating system. This is used to enable special
565 optimization/features for specific operating systems:
568 other;; unspecified OS
569 wxp;; Microsoft Windows XP
570 w2k;; Microsoft Windows 2000
571 w2k3;; Microsoft Windows 2003
572 w2k8;; Microsoft Windows 2008
573 wvista;; Microsoft Windows Vista
574 win7;; Microsoft Windows 7
575 win8;; Microsoft Windows 8/2012
576 l24;; Linux 2.4 Kernel
577 l26;; Linux 2.6/3.X Kernel
578 solaris;; Solaris/OpenSolaris/OpenIndiania kernel
580 `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
582 Map host parallel devices (n is 0 to 2).
584 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
586 CAUTION: Experimental! User reported problems with this option.
588 `protection`: `boolean` (default=`0`)::
590 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
592 `reboot`: `boolean` (default=`1`)::
594 Allow reboot. If set to '0' the VM exit on reboot.
596 `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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
598 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
600 `aio`=`(native | threads)` ;;
604 `backup`=`boolean` ;;
606 Whether the drive should be included when making backups.
610 Maximum r/w speed in bytes per second.
612 `bps_max_length`=`<seconds>` ;;
614 Maximum length of I/O bursts in seconds.
618 Maximum read speed in bytes per second.
620 `bps_rd_length`=`<seconds>` ;;
622 Maximum length of read I/O bursts in seconds.
626 Maximum write speed in bytes per second.
628 `bps_wr_length`=`<seconds>` ;;
630 Maximum length of write I/O bursts in seconds.
632 `cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
634 The drive's cache mode
638 Force the drive's physical geometry to have a specific cylinder count.
640 `detect_zeroes`=`boolean` ;;
642 Controls whether to detect and try to optimize writes of zeroes.
644 `discard`=`(ignore | on)` ;;
646 Controls whether to pass discard/trim requests to the underlying storage.
650 The drive's backing volume.
652 `format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
654 The drive's backing file's data format.
658 Force the drive's physical geometry to have a specific head count.
662 Maximum r/w I/O in operations per second.
664 `iops_max`=`<iops>` ;;
666 Maximum unthrottled r/w I/O pool in operations per second.
668 `iops_max_length`=`<seconds>` ;;
670 Maximum length of I/O bursts in seconds.
672 `iops_rd`=`<iops>` ;;
674 Maximum read I/O in operations per second.
676 `iops_rd_length`=`<seconds>` ;;
678 Maximum length of read I/O bursts in seconds.
680 `iops_rd_max`=`<iops>` ;;
682 Maximum unthrottled read I/O pool in operations per second.
684 `iops_wr`=`<iops>` ;;
686 Maximum write I/O in operations per second.
688 `iops_wr_length`=`<seconds>` ;;
690 Maximum length of write I/O bursts in seconds.
692 `iops_wr_max`=`<iops>` ;;
694 Maximum unthrottled write I/O pool in operations per second.
698 Maximum r/w speed in megabytes per second.
700 `mbps_max`=`<mbps>` ;;
702 Maximum unthrottled r/w pool in megabytes per second.
704 `mbps_rd`=`<mbps>` ;;
706 Maximum read speed in megabytes per second.
708 `mbps_rd_max`=`<mbps>` ;;
710 Maximum unthrottled read pool in megabytes per second.
712 `mbps_wr`=`<mbps>` ;;
714 Maximum write speed in megabytes per second.
716 `mbps_wr_max`=`<mbps>` ;;
718 Maximum unthrottled write pool in megabytes per second.
720 `media`=`(cdrom | disk)` (default=`disk`);;
722 The drive's media type.
724 `rerror`=`(ignore | report | stop)` ;;
730 Force the drive's physical geometry to have a specific sector count.
732 `serial`=`<serial>` ;;
734 The drive's reported serial number, url-encoded, up to 20 bytes long.
736 `size`=`<DiskSize>` ;;
738 Disk size. This is purely informational and has no effect.
740 `snapshot`=`boolean` ;;
742 Whether the drive should be included when making snapshots.
744 `trans`=`(auto | lba | none)` ;;
746 Force disk geometry bios translation mode.
748 `werror`=`(enospc | ignore | report | stop)` ;;
752 `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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
754 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
756 `aio`=`(native | threads)` ;;
760 `backup`=`boolean` ;;
762 Whether the drive should be included when making backups.
766 Maximum r/w speed in bytes per second.
768 `bps_max_length`=`<seconds>` ;;
770 Maximum length of I/O bursts in seconds.
774 Maximum read speed in bytes per second.
776 `bps_rd_length`=`<seconds>` ;;
778 Maximum length of read I/O bursts in seconds.
782 Maximum write speed in bytes per second.
784 `bps_wr_length`=`<seconds>` ;;
786 Maximum length of write I/O bursts in seconds.
788 `cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
790 The drive's cache mode
794 Force the drive's physical geometry to have a specific cylinder count.
796 `detect_zeroes`=`boolean` ;;
798 Controls whether to detect and try to optimize writes of zeroes.
800 `discard`=`(ignore | on)` ;;
802 Controls whether to pass discard/trim requests to the underlying storage.
806 The drive's backing volume.
808 `format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
810 The drive's backing file's data format.
814 Force the drive's physical geometry to have a specific head count.
818 Maximum r/w I/O in operations per second.
820 `iops_max`=`<iops>` ;;
822 Maximum unthrottled r/w I/O pool in operations per second.
824 `iops_max_length`=`<seconds>` ;;
826 Maximum length of I/O bursts in seconds.
828 `iops_rd`=`<iops>` ;;
830 Maximum read I/O in operations per second.
832 `iops_rd_length`=`<seconds>` ;;
834 Maximum length of read I/O bursts in seconds.
836 `iops_rd_max`=`<iops>` ;;
838 Maximum unthrottled read I/O pool in operations per second.
840 `iops_wr`=`<iops>` ;;
842 Maximum write I/O in operations per second.
844 `iops_wr_length`=`<seconds>` ;;
846 Maximum length of write I/O bursts in seconds.
848 `iops_wr_max`=`<iops>` ;;
850 Maximum unthrottled write I/O pool in operations per second.
852 `iothread`=`boolean` ;;
854 Whether to use iothreads for this drive
858 Maximum r/w speed in megabytes per second.
860 `mbps_max`=`<mbps>` ;;
862 Maximum unthrottled r/w pool in megabytes per second.
864 `mbps_rd`=`<mbps>` ;;
866 Maximum read speed in megabytes per second.
868 `mbps_rd_max`=`<mbps>` ;;
870 Maximum unthrottled read pool in megabytes per second.
872 `mbps_wr`=`<mbps>` ;;
874 Maximum write speed in megabytes per second.
876 `mbps_wr_max`=`<mbps>` ;;
878 Maximum unthrottled write pool in megabytes per second.
880 `media`=`(cdrom | disk)` (default=`disk`);;
882 The drive's media type.
884 `queues`=`integer (2 - N)` ;;
890 Force the drive's physical geometry to have a specific sector count.
892 `serial`=`<serial>` ;;
894 The drive's reported serial number, url-encoded, up to 20 bytes long.
896 `size`=`<DiskSize>` ;;
898 Disk size. This is purely informational and has no effect.
900 `snapshot`=`boolean` ;;
902 Whether the drive should be included when making snapshots.
904 `trans`=`(auto | lba | none)` ;;
906 Force disk geometry bios translation mode.
908 `werror`=`(enospc | ignore | report | stop)` ;;
912 `scsihw`: `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
914 SCSI controller model
916 `serial[n]`: `(/dev/.+|socket)` ::
918 Create a serial device inside the VM (n is 0 to 3), and pass through a
919 host serial device (i.e. /dev/ttyS0), or create a unix socket on the
920 host side (use 'qm terminal' to open a terminal connection).
922 NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.
924 CAUTION: Experimental! User reported problems with this option.
926 `shares`: `integer (0 - 50000)` (default=`1000`)::
928 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
930 `smbios1`: `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
932 Specify SMBIOS type 1 fields.
934 `family`=`<string>` ;;
936 Set SMBIOS1 family string.
938 `manufacturer`=`<string>` ;;
940 Set SMBIOS1 manufacturer.
942 `product`=`<string>` ;;
944 Set SMBIOS1 product ID.
946 `serial`=`<string>` ;;
948 Set SMBIOS1 serial number.
952 Set SMBIOS1 SKU string.
958 `version`=`<string>` ;;
962 `smp`: `integer (1 - N)` (default=`1`)::
964 The number of CPUs. Please use option -sockets instead.
966 `sockets`: `integer (1 - N)` (default=`1`)::
968 The number of CPU sockets.
970 `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
972 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'.
974 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
976 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.
978 `tablet`: `boolean` (default=`1`)::
980 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).
982 `tdf`: `boolean` (default=`0`)::
984 Enable/disable time drift fix.
986 `template`: `boolean` (default=`0`)::
988 Enable/disable Template.
990 `unused[n]`: `string` ::
992 Reference to unused volumes. This is used internally, and should not be modified manually.
994 `usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
996 Configure an USB device (n is 0 to 4).
998 `host`=`<HOSTUSBDEVICE|spice>` ;;
1000 The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
1002 'bus-port(.port)*' (decimal numbers) or
1003 'vendor_id:product_id' (hexadeciaml numbers) or
1006 You can use the 'lsusb -t' command to list existing usb devices.
1008 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
1010 The value 'spice' can be used to add a usb redirection devices for spice.
1012 `usb3`=`boolean` (default=`0`);;
1014 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).
1016 `vcpus`: `integer (1 - N)` (default=`0`)::
1018 Number of hotplugged vcpus.
1020 `vga`: `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
1022 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.
1024 `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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
1026 Use volume as VIRTIO hard disk (n is 0 to 15).
1028 `aio`=`(native | threads)` ;;
1032 `backup`=`boolean` ;;
1034 Whether the drive should be included when making backups.
1038 Maximum r/w speed in bytes per second.
1040 `bps_max_length`=`<seconds>` ;;
1042 Maximum length of I/O bursts in seconds.
1046 Maximum read speed in bytes per second.
1048 `bps_rd_length`=`<seconds>` ;;
1050 Maximum length of read I/O bursts in seconds.
1054 Maximum write speed in bytes per second.
1056 `bps_wr_length`=`<seconds>` ;;
1058 Maximum length of write I/O bursts in seconds.
1060 `cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
1062 The drive's cache mode
1066 Force the drive's physical geometry to have a specific cylinder count.
1068 `detect_zeroes`=`boolean` ;;
1070 Controls whether to detect and try to optimize writes of zeroes.
1072 `discard`=`(ignore | on)` ;;
1074 Controls whether to pass discard/trim requests to the underlying storage.
1076 `file`=`<volume>` ;;
1078 The drive's backing volume.
1080 `format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
1082 The drive's backing file's data format.
1084 `heads`=`integer` ;;
1086 Force the drive's physical geometry to have a specific head count.
1090 Maximum r/w I/O in operations per second.
1092 `iops_max`=`<iops>` ;;
1094 Maximum unthrottled r/w I/O pool in operations per second.
1096 `iops_max_length`=`<seconds>` ;;
1098 Maximum length of I/O bursts in seconds.
1100 `iops_rd`=`<iops>` ;;
1102 Maximum read I/O in operations per second.
1104 `iops_rd_length`=`<seconds>` ;;
1106 Maximum length of read I/O bursts in seconds.
1108 `iops_rd_max`=`<iops>` ;;
1110 Maximum unthrottled read I/O pool in operations per second.
1112 `iops_wr`=`<iops>` ;;
1114 Maximum write I/O in operations per second.
1116 `iops_wr_length`=`<seconds>` ;;
1118 Maximum length of write I/O bursts in seconds.
1120 `iops_wr_max`=`<iops>` ;;
1122 Maximum unthrottled write I/O pool in operations per second.
1124 `iothread`=`boolean` ;;
1126 Whether to use iothreads for this drive
1130 Maximum r/w speed in megabytes per second.
1132 `mbps_max`=`<mbps>` ;;
1134 Maximum unthrottled r/w pool in megabytes per second.
1136 `mbps_rd`=`<mbps>` ;;
1138 Maximum read speed in megabytes per second.
1140 `mbps_rd_max`=`<mbps>` ;;
1142 Maximum unthrottled read pool in megabytes per second.
1144 `mbps_wr`=`<mbps>` ;;
1146 Maximum write speed in megabytes per second.
1148 `mbps_wr_max`=`<mbps>` ;;
1150 Maximum unthrottled write pool in megabytes per second.
1152 `media`=`(cdrom | disk)` (default=`disk`);;
1154 The drive's media type.
1156 `rerror`=`(ignore | report | stop)` ;;
1162 Force the drive's physical geometry to have a specific sector count.
1164 `serial`=`<serial>` ;;
1166 The drive's reported serial number, url-encoded, up to 20 bytes long.
1168 `size`=`<DiskSize>` ;;
1170 Disk size. This is purely informational and has no effect.
1172 `snapshot`=`boolean` ;;
1174 Whether the drive should be included when making snapshots.
1176 `trans`=`(auto | lba | none)` ;;
1178 Force disk geometry bios translation mode.
1180 `werror`=`(enospc | ignore | report | stop)` ;;
1184 `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` ::
1186 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)
1188 `action`=`(debug | none | pause | poweroff | reset | shutdown)` ;;
1190 The action to perform if after activation the guest fails to poll the watchdog in time.
1192 `model`=`(i6300esb | ib700)` (default=`i6300esb`);;
1194 Watchdog type to emulate.