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