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 `cipassword`: `<string>` ::
43 cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.
45 `citype`: `<configdrive2 | nocloud>` ::
47 Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.
49 `ciuser`: `<string>` ::
51 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
53 `cores`: `<integer> (1 - N)` ('default =' `1`)::
55 The number of cores per socket.
57 `cpu`: `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
61 `cputype`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Conroe | EPYC | EPYC-IBPB | 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`);;
65 `flags`=`<+FLAG[;-FLAG...]>` ;;
67 List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl'.
69 `hidden`=`<boolean>` ('default =' `0`);;
71 Do not identify as a KVM virtual machine.
73 `cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
77 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
79 `cpuunits`: `<integer> (2 - 262144)` ('default =' `1024`)::
81 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.
83 `description`: `<string>` ::
85 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
87 `efidisk0`: `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
89 Configure a Disk for storing EFI vars
93 The drive's backing volume.
95 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
97 The drive's backing file's data format.
99 `size`=`<DiskSize>` ;;
101 Disk size. This is purely informational and has no effect.
103 `freeze`: `<boolean>` ::
105 Freeze CPU at startup (use 'c' monitor command to start execution).
107 `hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
109 Map host PCI devices into guest.
111 NOTE: This option allows direct access to host hardware. So it is no longer
112 possible to migrate such machines - use with special care.
114 CAUTION: Experimental! User reported problems with this option.
116 `host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
118 Host PCI device pass through. The PCI ID of a host's PCI device or a list
119 of PCI virtual functions of the host. HOSTPCIID syntax is:
121 'bus:dev.func' (hexadecimal numbers)
123 You can us the 'lspci' command to list existing PCI devices.
125 `pcie`=`<boolean>` ('default =' `0`);;
127 Choose the PCI-express bus (needs the 'q35' machine model).
129 `rombar`=`<boolean>` ('default =' `1`);;
131 Specify whether or not the device's ROM will be visible in the guest's memory map.
133 `romfile`=`<string>` ;;
135 Custom pci device rom filename (must be located in /usr/share/kvm/).
137 `x-vga`=`<boolean>` ('default =' `0`);;
139 Enable vfio-vga device support.
141 `hotplug`: `<string>` ('default =' `network,disk,usb`)::
143 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'.
145 `hugepages`: `<1024 | 2 | any>` ::
147 Enable/disable hugepages memory.
149 `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>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
151 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
153 `aio`=`<native | threads>` ;;
157 `backup`=`<boolean>` ;;
159 Whether the drive should be included when making backups.
163 Maximum r/w speed in bytes per second.
165 `bps_max_length`=`<seconds>` ;;
167 Maximum length of I/O bursts in seconds.
171 Maximum read speed in bytes per second.
173 `bps_rd_max_length`=`<seconds>` ;;
175 Maximum length of read I/O bursts in seconds.
179 Maximum write speed in bytes per second.
181 `bps_wr_max_length`=`<seconds>` ;;
183 Maximum length of write I/O bursts in seconds.
185 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
187 The drive's cache mode
189 `cyls`=`<integer>` ;;
191 Force the drive's physical geometry to have a specific cylinder count.
193 `detect_zeroes`=`<boolean>` ;;
195 Controls whether to detect and try to optimize writes of zeroes.
197 `discard`=`<ignore | on>` ;;
199 Controls whether to pass discard/trim requests to the underlying storage.
203 The drive's backing volume.
205 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
207 The drive's backing file's data format.
209 `heads`=`<integer>` ;;
211 Force the drive's physical geometry to have a specific head count.
215 Maximum r/w I/O in operations per second.
217 `iops_max`=`<iops>` ;;
219 Maximum unthrottled r/w I/O pool in operations per second.
221 `iops_max_length`=`<seconds>` ;;
223 Maximum length of I/O bursts in seconds.
225 `iops_rd`=`<iops>` ;;
227 Maximum read I/O in operations per second.
229 `iops_rd_max`=`<iops>` ;;
231 Maximum unthrottled read I/O pool in operations per second.
233 `iops_rd_max_length`=`<seconds>` ;;
235 Maximum length of read I/O bursts in seconds.
237 `iops_wr`=`<iops>` ;;
239 Maximum write I/O in operations per second.
241 `iops_wr_max`=`<iops>` ;;
243 Maximum unthrottled write I/O pool in operations per second.
245 `iops_wr_max_length`=`<seconds>` ;;
247 Maximum length of write I/O bursts in seconds.
251 Maximum r/w speed in megabytes per second.
253 `mbps_max`=`<mbps>` ;;
255 Maximum unthrottled r/w pool in megabytes per second.
257 `mbps_rd`=`<mbps>` ;;
259 Maximum read speed in megabytes per second.
261 `mbps_rd_max`=`<mbps>` ;;
263 Maximum unthrottled read pool in megabytes per second.
265 `mbps_wr`=`<mbps>` ;;
267 Maximum write speed in megabytes per second.
269 `mbps_wr_max`=`<mbps>` ;;
271 Maximum unthrottled write pool in megabytes per second.
273 `media`=`<cdrom | disk>` ('default =' `disk`);;
275 The drive's media type.
279 The drive's reported model name, url-encoded, up to 40 bytes long.
281 `replicate`=`<boolean>` ('default =' `1`);;
283 Whether the drive should considered for replication jobs.
285 `rerror`=`<ignore | report | stop>` ;;
289 `secs`=`<integer>` ;;
291 Force the drive's physical geometry to have a specific sector count.
293 `serial`=`<serial>` ;;
295 The drive's reported serial number, url-encoded, up to 20 bytes long.
297 `shared`=`<boolean>` ('default =' `0`);;
299 Mark this locally-managed volume as available on all nodes.
301 WARNING: This option does not share the volume automatically, it assumes it is shared already!
303 `size`=`<DiskSize>` ;;
305 Disk size. This is purely informational and has no effect.
307 `snapshot`=`<boolean>` ;;
309 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
311 `trans`=`<auto | lba | none>` ;;
313 Force disk geometry bios translation mode.
315 `werror`=`<enospc | ignore | report | stop>` ;;
319 `ipconfig[n]`: `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
321 cloud-init: Specify IP addresses and gateways for the corresponding interface.
323 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
325 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
326 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
328 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
330 `gw`=`<GatewayIPv4>` ;;
332 Default gateway for IPv4 traffic.
334 NOTE: Requires option(s): `ip`
336 `gw6`=`<GatewayIPv6>` ;;
338 Default gateway for IPv6 traffic.
340 NOTE: Requires option(s): `ip6`
342 `ip`=`<IPv4Format/CIDR>` ('default =' `dhcp`);;
344 IPv4 address in CIDR format.
346 `ip6`=`<IPv6Format/CIDR>` ('default =' `dhcp`);;
348 IPv6 address in CIDR format.
350 `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>` ::
352 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.
354 `kvm`: `<boolean>` ('default =' `1`)::
356 Enable/disable KVM hardware virtualization.
358 `localtime`: `<boolean>` ::
360 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
362 `lock`: `<backup | migrate | rollback | snapshot>` ::
366 `machine`: `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
368 Specific the Qemu machine type.
370 `memory`: `<integer> (16 - N)` ('default =' `512`)::
372 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
374 `migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
376 Set maximum tolerated downtime (in seconds) for migrations.
378 `migrate_speed`: `<integer> (0 - N)` ('default =' `0`)::
380 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
382 `name`: `<string>` ::
384 Set a name for the VM. Only used on the configuration web interface.
386 `nameserver`: `<string>` ::
388 cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
390 `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>]` ::
392 Specify network devices.
394 `bridge`=`<bridge>` ;;
396 Bridge to attach the network device to. The Proxmox VE standard bridge
399 If you do not specify a bridge, we create a kvm user (NATed) network
400 device, which provides DHCP and DNS services. The following addresses
407 The DHCP server assign addresses to the guest starting from 10.0.2.15.
409 `firewall`=`<boolean>` ;;
411 Whether this interface should be protected by the firewall.
413 `link_down`=`<boolean>` ;;
415 Whether this interface should be disconnected (like pulling the plug).
417 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
419 MAC address. That address must be unique withing your network. This is automatically generated if not specified.
421 `model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
423 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'.
425 `queues`=`<integer> (0 - 16)` ;;
427 Number of packet queues to be used on the device.
429 `rate`=`<number> (0 - N)` ;;
431 Rate limit in mbps (megabytes per second) as floating point number.
433 `tag`=`<integer> (1 - 4094)` ;;
435 VLAN tag to apply to packets on this interface.
437 `trunks`=`<vlanid[;vlanid...]>` ;;
439 VLAN trunks to pass through this interface.
441 `numa`: `<boolean>` ('default =' `0`)::
445 `numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
449 `cpus`=`<id[-id];...>` ;;
451 CPUs accessing this NUMA node.
453 `hostnodes`=`<id[-id];...>` ;;
455 Host NUMA nodes to use.
457 `memory`=`<number>` ;;
459 Amount of memory this NUMA node provides.
461 `policy`=`<bind | interleave | preferred>` ;;
463 NUMA allocation policy.
465 `onboot`: `<boolean>` ('default =' `0`)::
467 Specifies whether a VM will be started during system bootup.
469 `ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
471 Specify guest operating system. This is used to enable special
472 optimization/features for specific operating systems:
475 other;; unspecified OS
476 wxp;; Microsoft Windows XP
477 w2k;; Microsoft Windows 2000
478 w2k3;; Microsoft Windows 2003
479 w2k8;; Microsoft Windows 2008
480 wvista;; Microsoft Windows Vista
481 win7;; Microsoft Windows 7
482 win8;; Microsoft Windows 8/2012/2012r2
483 win10;; Microsoft Windows 10/2016
484 l24;; Linux 2.4 Kernel
485 l26;; Linux 2.6/3.X Kernel
486 solaris;; Solaris/OpenSolaris/OpenIndiania kernel
488 `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
490 Map host parallel devices (n is 0 to 2).
492 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
494 CAUTION: Experimental! User reported problems with this option.
496 `protection`: `<boolean>` ('default =' `0`)::
498 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
500 `reboot`: `<boolean>` ('default =' `1`)::
502 Allow reboot. If set to '0' the VM exit on reboot.
504 `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>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
506 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
508 `aio`=`<native | threads>` ;;
512 `backup`=`<boolean>` ;;
514 Whether the drive should be included when making backups.
518 Maximum r/w speed in bytes per second.
520 `bps_max_length`=`<seconds>` ;;
522 Maximum length of I/O bursts in seconds.
526 Maximum read speed in bytes per second.
528 `bps_rd_max_length`=`<seconds>` ;;
530 Maximum length of read I/O bursts in seconds.
534 Maximum write speed in bytes per second.
536 `bps_wr_max_length`=`<seconds>` ;;
538 Maximum length of write I/O bursts in seconds.
540 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
542 The drive's cache mode
544 `cyls`=`<integer>` ;;
546 Force the drive's physical geometry to have a specific cylinder count.
548 `detect_zeroes`=`<boolean>` ;;
550 Controls whether to detect and try to optimize writes of zeroes.
552 `discard`=`<ignore | on>` ;;
554 Controls whether to pass discard/trim requests to the underlying storage.
558 The drive's backing volume.
560 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
562 The drive's backing file's data format.
564 `heads`=`<integer>` ;;
566 Force the drive's physical geometry to have a specific head count.
570 Maximum r/w I/O in operations per second.
572 `iops_max`=`<iops>` ;;
574 Maximum unthrottled r/w I/O pool in operations per second.
576 `iops_max_length`=`<seconds>` ;;
578 Maximum length of I/O bursts in seconds.
580 `iops_rd`=`<iops>` ;;
582 Maximum read I/O in operations per second.
584 `iops_rd_max`=`<iops>` ;;
586 Maximum unthrottled read I/O pool in operations per second.
588 `iops_rd_max_length`=`<seconds>` ;;
590 Maximum length of read I/O bursts in seconds.
592 `iops_wr`=`<iops>` ;;
594 Maximum write I/O in operations per second.
596 `iops_wr_max`=`<iops>` ;;
598 Maximum unthrottled write I/O pool in operations per second.
600 `iops_wr_max_length`=`<seconds>` ;;
602 Maximum length of write I/O bursts in seconds.
606 Maximum r/w speed in megabytes per second.
608 `mbps_max`=`<mbps>` ;;
610 Maximum unthrottled r/w pool in megabytes per second.
612 `mbps_rd`=`<mbps>` ;;
614 Maximum read speed in megabytes per second.
616 `mbps_rd_max`=`<mbps>` ;;
618 Maximum unthrottled read pool in megabytes per second.
620 `mbps_wr`=`<mbps>` ;;
622 Maximum write speed in megabytes per second.
624 `mbps_wr_max`=`<mbps>` ;;
626 Maximum unthrottled write pool in megabytes per second.
628 `media`=`<cdrom | disk>` ('default =' `disk`);;
630 The drive's media type.
632 `replicate`=`<boolean>` ('default =' `1`);;
634 Whether the drive should considered for replication jobs.
636 `rerror`=`<ignore | report | stop>` ;;
640 `secs`=`<integer>` ;;
642 Force the drive's physical geometry to have a specific sector count.
644 `serial`=`<serial>` ;;
646 The drive's reported serial number, url-encoded, up to 20 bytes long.
648 `shared`=`<boolean>` ('default =' `0`);;
650 Mark this locally-managed volume as available on all nodes.
652 WARNING: This option does not share the volume automatically, it assumes it is shared already!
654 `size`=`<DiskSize>` ;;
656 Disk size. This is purely informational and has no effect.
658 `snapshot`=`<boolean>` ;;
660 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
662 `trans`=`<auto | lba | none>` ;;
664 Force disk geometry bios translation mode.
666 `werror`=`<enospc | ignore | report | stop>` ;;
670 `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>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
672 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
674 `aio`=`<native | threads>` ;;
678 `backup`=`<boolean>` ;;
680 Whether the drive should be included when making backups.
684 Maximum r/w speed in bytes per second.
686 `bps_max_length`=`<seconds>` ;;
688 Maximum length of I/O bursts in seconds.
692 Maximum read speed in bytes per second.
694 `bps_rd_max_length`=`<seconds>` ;;
696 Maximum length of read I/O bursts in seconds.
700 Maximum write speed in bytes per second.
702 `bps_wr_max_length`=`<seconds>` ;;
704 Maximum length of write I/O bursts in seconds.
706 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
708 The drive's cache mode
710 `cyls`=`<integer>` ;;
712 Force the drive's physical geometry to have a specific cylinder count.
714 `detect_zeroes`=`<boolean>` ;;
716 Controls whether to detect and try to optimize writes of zeroes.
718 `discard`=`<ignore | on>` ;;
720 Controls whether to pass discard/trim requests to the underlying storage.
724 The drive's backing volume.
726 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
728 The drive's backing file's data format.
730 `heads`=`<integer>` ;;
732 Force the drive's physical geometry to have a specific head count.
736 Maximum r/w I/O in operations per second.
738 `iops_max`=`<iops>` ;;
740 Maximum unthrottled r/w I/O pool in operations per second.
742 `iops_max_length`=`<seconds>` ;;
744 Maximum length of I/O bursts in seconds.
746 `iops_rd`=`<iops>` ;;
748 Maximum read I/O in operations per second.
750 `iops_rd_max`=`<iops>` ;;
752 Maximum unthrottled read I/O pool in operations per second.
754 `iops_rd_max_length`=`<seconds>` ;;
756 Maximum length of read I/O bursts in seconds.
758 `iops_wr`=`<iops>` ;;
760 Maximum write I/O in operations per second.
762 `iops_wr_max`=`<iops>` ;;
764 Maximum unthrottled write I/O pool in operations per second.
766 `iops_wr_max_length`=`<seconds>` ;;
768 Maximum length of write I/O bursts in seconds.
770 `iothread`=`<boolean>` ;;
772 Whether to use iothreads for this drive
776 Maximum r/w speed in megabytes per second.
778 `mbps_max`=`<mbps>` ;;
780 Maximum unthrottled r/w pool in megabytes per second.
782 `mbps_rd`=`<mbps>` ;;
784 Maximum read speed in megabytes per second.
786 `mbps_rd_max`=`<mbps>` ;;
788 Maximum unthrottled read pool in megabytes per second.
790 `mbps_wr`=`<mbps>` ;;
792 Maximum write speed in megabytes per second.
794 `mbps_wr_max`=`<mbps>` ;;
796 Maximum unthrottled write pool in megabytes per second.
798 `media`=`<cdrom | disk>` ('default =' `disk`);;
800 The drive's media type.
802 `queues`=`<integer> (2 - N)` ;;
806 `replicate`=`<boolean>` ('default =' `1`);;
808 Whether the drive should considered for replication jobs.
810 `rerror`=`<ignore | report | stop>` ;;
814 `scsiblock`=`<boolean>` ('default =' `0`);;
816 whether to use scsi-block for full passthrough of host block device
818 WARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host
820 `secs`=`<integer>` ;;
822 Force the drive's physical geometry to have a specific sector count.
824 `serial`=`<serial>` ;;
826 The drive's reported serial number, url-encoded, up to 20 bytes long.
828 `shared`=`<boolean>` ('default =' `0`);;
830 Mark this locally-managed volume as available on all nodes.
832 WARNING: This option does not share the volume automatically, it assumes it is shared already!
834 `size`=`<DiskSize>` ;;
836 Disk size. This is purely informational and has no effect.
838 `snapshot`=`<boolean>` ;;
840 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
842 `trans`=`<auto | lba | none>` ;;
844 Force disk geometry bios translation mode.
846 `werror`=`<enospc | ignore | report | stop>` ;;
850 `scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
852 SCSI controller model
854 `searchdomain`: `<string>` ::
856 cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
858 `serial[n]`: `(/dev/.+|socket)` ::
860 Create a serial device inside the VM (n is 0 to 3), and pass through a
861 host serial device (i.e. /dev/ttyS0), or create a unix socket on the
862 host side (use 'qm terminal' to open a terminal connection).
864 NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.
866 CAUTION: Experimental! User reported problems with this option.
868 `shares`: `<integer> (0 - 50000)` ('default =' `1000`)::
870 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
872 `smbios1`: `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
874 Specify SMBIOS type 1 fields.
876 `family`=`<string>` ;;
878 Set SMBIOS1 family string.
880 `manufacturer`=`<string>` ;;
882 Set SMBIOS1 manufacturer.
884 `product`=`<string>` ;;
886 Set SMBIOS1 product ID.
888 `serial`=`<string>` ;;
890 Set SMBIOS1 serial number.
894 Set SMBIOS1 SKU string.
900 `version`=`<string>` ;;
904 `smp`: `<integer> (1 - N)` ('default =' `1`)::
906 The number of CPUs. Please use option -sockets instead.
908 `sockets`: `<integer> (1 - N)` ('default =' `1`)::
910 The number of CPU sockets.
912 `sshkeys`: `<string>` ::
914 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
916 `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
918 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'.
920 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
922 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.
924 `tablet`: `<boolean>` ('default =' `1`)::
926 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).
928 `tdf`: `<boolean>` ('default =' `0`)::
930 Enable/disable time drift fix.
932 `template`: `<boolean>` ('default =' `0`)::
934 Enable/disable Template.
936 `unused[n]`: `<string>` ::
938 Reference to unused volumes. This is used internally, and should not be modified manually.
940 `usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
942 Configure an USB device (n is 0 to 4).
944 `host`=`<HOSTUSBDEVICE|spice>` ;;
946 The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
948 'bus-port(.port)*' (decimal numbers) or
949 'vendor_id:product_id' (hexadeciaml numbers) or
952 You can use the 'lsusb -t' command to list existing usb devices.
954 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
956 The value 'spice' can be used to add a usb redirection devices for spice.
958 `usb3`=`<boolean>` ('default =' `0`);;
960 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).
962 `vcpus`: `<integer> (1 - N)` ('default =' `0`)::
964 Number of hotplugged vcpus.
966 `vga`: `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
968 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.
970 `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>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
972 Use volume as VIRTIO hard disk (n is 0 to 15).
974 `aio`=`<native | threads>` ;;
978 `backup`=`<boolean>` ;;
980 Whether the drive should be included when making backups.
984 Maximum r/w speed in bytes per second.
986 `bps_max_length`=`<seconds>` ;;
988 Maximum length of I/O bursts in seconds.
992 Maximum read speed in bytes per second.
994 `bps_rd_max_length`=`<seconds>` ;;
996 Maximum length of read I/O bursts in seconds.
1000 Maximum write speed in bytes per second.
1002 `bps_wr_max_length`=`<seconds>` ;;
1004 Maximum length of write I/O bursts in seconds.
1006 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
1008 The drive's cache mode
1010 `cyls`=`<integer>` ;;
1012 Force the drive's physical geometry to have a specific cylinder count.
1014 `detect_zeroes`=`<boolean>` ;;
1016 Controls whether to detect and try to optimize writes of zeroes.
1018 `discard`=`<ignore | on>` ;;
1020 Controls whether to pass discard/trim requests to the underlying storage.
1022 `file`=`<volume>` ;;
1024 The drive's backing volume.
1026 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
1028 The drive's backing file's data format.
1030 `heads`=`<integer>` ;;
1032 Force the drive's physical geometry to have a specific head count.
1036 Maximum r/w I/O in operations per second.
1038 `iops_max`=`<iops>` ;;
1040 Maximum unthrottled r/w I/O pool in operations per second.
1042 `iops_max_length`=`<seconds>` ;;
1044 Maximum length of I/O bursts in seconds.
1046 `iops_rd`=`<iops>` ;;
1048 Maximum read I/O in operations per second.
1050 `iops_rd_max`=`<iops>` ;;
1052 Maximum unthrottled read I/O pool in operations per second.
1054 `iops_rd_max_length`=`<seconds>` ;;
1056 Maximum length of read I/O bursts in seconds.
1058 `iops_wr`=`<iops>` ;;
1060 Maximum write I/O in operations per second.
1062 `iops_wr_max`=`<iops>` ;;
1064 Maximum unthrottled write I/O pool in operations per second.
1066 `iops_wr_max_length`=`<seconds>` ;;
1068 Maximum length of write I/O bursts in seconds.
1070 `iothread`=`<boolean>` ;;
1072 Whether to use iothreads for this drive
1076 Maximum r/w speed in megabytes per second.
1078 `mbps_max`=`<mbps>` ;;
1080 Maximum unthrottled r/w pool in megabytes per second.
1082 `mbps_rd`=`<mbps>` ;;
1084 Maximum read speed in megabytes per second.
1086 `mbps_rd_max`=`<mbps>` ;;
1088 Maximum unthrottled read pool in megabytes per second.
1090 `mbps_wr`=`<mbps>` ;;
1092 Maximum write speed in megabytes per second.
1094 `mbps_wr_max`=`<mbps>` ;;
1096 Maximum unthrottled write pool in megabytes per second.
1098 `media`=`<cdrom | disk>` ('default =' `disk`);;
1100 The drive's media type.
1102 `replicate`=`<boolean>` ('default =' `1`);;
1104 Whether the drive should considered for replication jobs.
1106 `rerror`=`<ignore | report | stop>` ;;
1110 `secs`=`<integer>` ;;
1112 Force the drive's physical geometry to have a specific sector count.
1114 `serial`=`<serial>` ;;
1116 The drive's reported serial number, url-encoded, up to 20 bytes long.
1118 `shared`=`<boolean>` ('default =' `0`);;
1120 Mark this locally-managed volume as available on all nodes.
1122 WARNING: This option does not share the volume automatically, it assumes it is shared already!
1124 `size`=`<DiskSize>` ;;
1126 Disk size. This is purely informational and has no effect.
1128 `snapshot`=`<boolean>` ;;
1130 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
1132 `trans`=`<auto | lba | none>` ;;
1134 Force disk geometry bios translation mode.
1136 `werror`=`<enospc | ignore | report | stop>` ;;
1140 `vmstatestorage`: `<string>` ::
1142 Default storage for VM state volumes/files.
1144 `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1146 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)
1148 `action`=`<debug | none | pause | poweroff | reset | shutdown>` ;;
1150 The action to perform if after activation the guest fails to poll the watchdog in time.
1152 `model`=`<i6300esb | ib700>` ('default =' `i6300esb`);;
1154 Watchdog type to emulate.