1 `acpi`: `<boolean>` ('default =' `1`)::
5 `agent`: `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` ::
7 Enable/disable Qemu GuestAgent and its properties.
9 `enabled`=`<boolean>` ('default =' `0`);;
11 Enable/disable Qemu GuestAgent.
13 `fstrim_cloned_disks`=`<boolean>` ('default =' `0`);;
15 Run fstrim after cloning/moving a disk.
17 `arch`: `<aarch64 | x86_64>` ::
19 Virtual processor architecture. Defaults to the host.
23 Arbitrary arguments passed to kvm, for example:
25 args: -no-reboot -no-hpet
27 NOTE: this option is for experts only.
29 `autostart`: `<boolean>` ('default =' `0`)::
31 Automatic restart after crash (currently ignored).
33 `balloon`: `<integer> (0 - N)` ::
35 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
37 `bios`: `<ovmf | seabios>` ('default =' `seabios`)::
39 Select BIOS implementation.
41 `boot`: `[acdn]{1,4}` ('default =' `cdn`)::
43 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
45 `bootdisk`: `(ide|sata|scsi|virtio)\d+` ::
47 Enable booting from specified disk.
49 `cdrom`: `<volume>` ::
51 This is an alias for option -ide2
53 `cipassword`: `<string>` ::
55 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.
57 `citype`: `<configdrive2 | nocloud>` ::
59 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.
61 `ciuser`: `<string>` ::
63 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
65 `cores`: `<integer> (1 - N)` ('default =' `1`)::
67 The number of cores per socket.
69 `cpu`: `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]` ::
73 `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`);;
77 `flags`=`<+FLAG[;-FLAG...]>` ;;
79 List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb'.
81 `hidden`=`<boolean>` ('default =' `0`);;
83 Do not identify as a KVM virtual machine.
85 `hv-vendor-id`=`<vendor-id>` ;;
87 The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.
89 `cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
93 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
95 `cpuunits`: `<integer> (2 - 262144)` ('default =' `1024`)::
97 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.
99 `description`: `<string>` ::
101 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
103 `efidisk0`: `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
105 Configure a Disk for storing EFI vars
109 The drive's backing volume.
111 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
113 The drive's backing file's data format.
115 `size`=`<DiskSize>` ;;
117 Disk size. This is purely informational and has no effect.
119 `freeze`: `<boolean>` ::
121 Freeze CPU at startup (use 'c' monitor command to start execution).
123 `hookscript`: `<string>` ::
125 Script that will be executed during various steps in the vms lifetime.
127 `hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
129 Map host PCI devices into guest.
131 NOTE: This option allows direct access to host hardware. So it is no longer
132 possible to migrate such machines - use with special care.
134 CAUTION: Experimental! User reported problems with this option.
136 `host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
138 Host PCI device pass through. The PCI ID of a host's PCI device or a list
139 of PCI virtual functions of the host. HOSTPCIID syntax is:
141 'bus:dev.func' (hexadecimal numbers)
143 You can us the 'lspci' command to list existing PCI devices.
147 The type of mediated device to use.
148 An instance of this type will be created on startup of the VM and
149 will be cleaned up when the VM stops.
151 `pcie`=`<boolean>` ('default =' `0`);;
153 Choose the PCI-express bus (needs the 'q35' machine model).
155 `rombar`=`<boolean>` ('default =' `1`);;
157 Specify whether or not the device's ROM will be visible in the guest's memory map.
159 `romfile`=`<string>` ;;
161 Custom pci device rom filename (must be located in /usr/share/kvm/).
163 `x-vga`=`<boolean>` ('default =' `0`);;
165 Enable vfio-vga device support.
167 `hotplug`: `<string>` ('default =' `network,disk,usb`)::
169 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'.
171 `hugepages`: `<1024 | 2 | any>` ::
173 Enable/disable hugepages memory.
175 `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>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
177 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
179 `aio`=`<native | threads>` ;;
183 `backup`=`<boolean>` ;;
185 Whether the drive should be included when making backups.
189 Maximum r/w speed in bytes per second.
191 `bps_max_length`=`<seconds>` ;;
193 Maximum length of I/O bursts in seconds.
197 Maximum read speed in bytes per second.
199 `bps_rd_max_length`=`<seconds>` ;;
201 Maximum length of read I/O bursts in seconds.
205 Maximum write speed in bytes per second.
207 `bps_wr_max_length`=`<seconds>` ;;
209 Maximum length of write I/O bursts in seconds.
211 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
213 The drive's cache mode
215 `cyls`=`<integer>` ;;
217 Force the drive's physical geometry to have a specific cylinder count.
219 `detect_zeroes`=`<boolean>` ;;
221 Controls whether to detect and try to optimize writes of zeroes.
223 `discard`=`<ignore | on>` ;;
225 Controls whether to pass discard/trim requests to the underlying storage.
229 The drive's backing volume.
231 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
233 The drive's backing file's data format.
235 `heads`=`<integer>` ;;
237 Force the drive's physical geometry to have a specific head count.
241 Maximum r/w I/O in operations per second.
243 `iops_max`=`<iops>` ;;
245 Maximum unthrottled r/w I/O pool in operations per second.
247 `iops_max_length`=`<seconds>` ;;
249 Maximum length of I/O bursts in seconds.
251 `iops_rd`=`<iops>` ;;
253 Maximum read I/O in operations per second.
255 `iops_rd_max`=`<iops>` ;;
257 Maximum unthrottled read I/O pool in operations per second.
259 `iops_rd_max_length`=`<seconds>` ;;
261 Maximum length of read I/O bursts in seconds.
263 `iops_wr`=`<iops>` ;;
265 Maximum write I/O in operations per second.
267 `iops_wr_max`=`<iops>` ;;
269 Maximum unthrottled write I/O pool in operations per second.
271 `iops_wr_max_length`=`<seconds>` ;;
273 Maximum length of write I/O bursts in seconds.
277 Maximum r/w speed in megabytes per second.
279 `mbps_max`=`<mbps>` ;;
281 Maximum unthrottled r/w pool in megabytes per second.
283 `mbps_rd`=`<mbps>` ;;
285 Maximum read speed in megabytes per second.
287 `mbps_rd_max`=`<mbps>` ;;
289 Maximum unthrottled read pool in megabytes per second.
291 `mbps_wr`=`<mbps>` ;;
293 Maximum write speed in megabytes per second.
295 `mbps_wr_max`=`<mbps>` ;;
297 Maximum unthrottled write pool in megabytes per second.
299 `media`=`<cdrom | disk>` ('default =' `disk`);;
301 The drive's media type.
305 The drive's reported model name, url-encoded, up to 40 bytes long.
307 `replicate`=`<boolean>` ('default =' `1`);;
309 Whether the drive should considered for replication jobs.
311 `rerror`=`<ignore | report | stop>` ;;
315 `secs`=`<integer>` ;;
317 Force the drive's physical geometry to have a specific sector count.
319 `serial`=`<serial>` ;;
321 The drive's reported serial number, url-encoded, up to 20 bytes long.
323 `shared`=`<boolean>` ('default =' `0`);;
325 Mark this locally-managed volume as available on all nodes.
327 WARNING: This option does not share the volume automatically, it assumes it is shared already!
329 `size`=`<DiskSize>` ;;
331 Disk size. This is purely informational and has no effect.
333 `snapshot`=`<boolean>` ;;
335 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
339 Whether to expose this drive as an SSD, rather than a rotational hard disk.
341 `trans`=`<auto | lba | none>` ;;
343 Force disk geometry bios translation mode.
345 `werror`=`<enospc | ignore | report | stop>` ;;
349 `ipconfig[n]`: `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
351 cloud-init: Specify IP addresses and gateways for the corresponding interface.
353 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
355 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
356 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
358 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
360 `gw`=`<GatewayIPv4>` ;;
362 Default gateway for IPv4 traffic.
364 NOTE: Requires option(s): `ip`
366 `gw6`=`<GatewayIPv6>` ;;
368 Default gateway for IPv6 traffic.
370 NOTE: Requires option(s): `ip6`
372 `ip`=`<IPv4Format/CIDR>` ('default =' `dhcp`);;
374 IPv4 address in CIDR format.
376 `ip6`=`<IPv6Format/CIDR>` ('default =' `dhcp`);;
378 IPv6 address in CIDR format.
380 `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>` ::
382 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
384 `kvm`: `<boolean>` ('default =' `1`)::
386 Enable/disable KVM hardware virtualization.
388 `localtime`: `<boolean>` ::
390 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
392 `lock`: `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete>` ::
396 `machine`: `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` ::
398 Specifies the Qemu machine type.
400 `memory`: `<integer> (16 - N)` ('default =' `512`)::
402 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
404 `migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
406 Set maximum tolerated downtime (in seconds) for migrations.
408 `migrate_speed`: `<integer> (0 - N)` ('default =' `0`)::
410 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
412 `name`: `<string>` ::
414 Set a name for the VM. Only used on the configuration web interface.
416 `nameserver`: `<string>` ::
418 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.
420 `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>]` ::
422 Specify network devices.
424 `bridge`=`<bridge>` ;;
426 Bridge to attach the network device to. The Proxmox VE standard bridge
429 If you do not specify a bridge, we create a kvm user (NATed) network
430 device, which provides DHCP and DNS services. The following addresses
437 The DHCP server assign addresses to the guest starting from 10.0.2.15.
439 `firewall`=`<boolean>` ;;
441 Whether this interface should be protected by the firewall.
443 `link_down`=`<boolean>` ;;
445 Whether this interface should be disconnected (like pulling the plug).
447 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
449 MAC address. That address must be unique withing your network. This is automatically generated if not specified.
451 `model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
453 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'.
455 `queues`=`<integer> (0 - 16)` ;;
457 Number of packet queues to be used on the device.
459 `rate`=`<number> (0 - N)` ;;
461 Rate limit in mbps (megabytes per second) as floating point number.
463 `tag`=`<integer> (1 - 4094)` ;;
465 VLAN tag to apply to packets on this interface.
467 `trunks`=`<vlanid[;vlanid...]>` ;;
469 VLAN trunks to pass through this interface.
471 `numa`: `<boolean>` ('default =' `0`)::
475 `numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
479 `cpus`=`<id[-id];...>` ;;
481 CPUs accessing this NUMA node.
483 `hostnodes`=`<id[-id];...>` ;;
485 Host NUMA nodes to use.
487 `memory`=`<number>` ;;
489 Amount of memory this NUMA node provides.
491 `policy`=`<bind | interleave | preferred>` ;;
493 NUMA allocation policy.
495 `onboot`: `<boolean>` ('default =' `0`)::
497 Specifies whether a VM will be started during system bootup.
499 `ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
501 Specify guest operating system. This is used to enable special
502 optimization/features for specific operating systems:
505 other;; unspecified OS
506 wxp;; Microsoft Windows XP
507 w2k;; Microsoft Windows 2000
508 w2k3;; Microsoft Windows 2003
509 w2k8;; Microsoft Windows 2008
510 wvista;; Microsoft Windows Vista
511 win7;; Microsoft Windows 7
512 win8;; Microsoft Windows 8/2012/2012r2
513 win10;; Microsoft Windows 10/2016
514 l24;; Linux 2.4 Kernel
515 l26;; Linux 2.6/3.X Kernel
516 solaris;; Solaris/OpenSolaris/OpenIndiania kernel
518 `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
520 Map host parallel devices (n is 0 to 2).
522 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
524 CAUTION: Experimental! User reported problems with this option.
526 `protection`: `<boolean>` ('default =' `0`)::
528 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
530 `reboot`: `<boolean>` ('default =' `1`)::
532 Allow reboot. If set to '0' the VM exit on reboot.
534 `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>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
536 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
538 `aio`=`<native | threads>` ;;
542 `backup`=`<boolean>` ;;
544 Whether the drive should be included when making backups.
548 Maximum r/w speed in bytes per second.
550 `bps_max_length`=`<seconds>` ;;
552 Maximum length of I/O bursts in seconds.
556 Maximum read speed in bytes per second.
558 `bps_rd_max_length`=`<seconds>` ;;
560 Maximum length of read I/O bursts in seconds.
564 Maximum write speed in bytes per second.
566 `bps_wr_max_length`=`<seconds>` ;;
568 Maximum length of write I/O bursts in seconds.
570 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
572 The drive's cache mode
574 `cyls`=`<integer>` ;;
576 Force the drive's physical geometry to have a specific cylinder count.
578 `detect_zeroes`=`<boolean>` ;;
580 Controls whether to detect and try to optimize writes of zeroes.
582 `discard`=`<ignore | on>` ;;
584 Controls whether to pass discard/trim requests to the underlying storage.
588 The drive's backing volume.
590 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
592 The drive's backing file's data format.
594 `heads`=`<integer>` ;;
596 Force the drive's physical geometry to have a specific head count.
600 Maximum r/w I/O in operations per second.
602 `iops_max`=`<iops>` ;;
604 Maximum unthrottled r/w I/O pool in operations per second.
606 `iops_max_length`=`<seconds>` ;;
608 Maximum length of I/O bursts in seconds.
610 `iops_rd`=`<iops>` ;;
612 Maximum read I/O in operations per second.
614 `iops_rd_max`=`<iops>` ;;
616 Maximum unthrottled read I/O pool in operations per second.
618 `iops_rd_max_length`=`<seconds>` ;;
620 Maximum length of read I/O bursts in seconds.
622 `iops_wr`=`<iops>` ;;
624 Maximum write I/O in operations per second.
626 `iops_wr_max`=`<iops>` ;;
628 Maximum unthrottled write I/O pool in operations per second.
630 `iops_wr_max_length`=`<seconds>` ;;
632 Maximum length of write I/O bursts in seconds.
636 Maximum r/w speed in megabytes per second.
638 `mbps_max`=`<mbps>` ;;
640 Maximum unthrottled r/w pool in megabytes per second.
642 `mbps_rd`=`<mbps>` ;;
644 Maximum read speed in megabytes per second.
646 `mbps_rd_max`=`<mbps>` ;;
648 Maximum unthrottled read pool in megabytes per second.
650 `mbps_wr`=`<mbps>` ;;
652 Maximum write speed in megabytes per second.
654 `mbps_wr_max`=`<mbps>` ;;
656 Maximum unthrottled write pool in megabytes per second.
658 `media`=`<cdrom | disk>` ('default =' `disk`);;
660 The drive's media type.
662 `replicate`=`<boolean>` ('default =' `1`);;
664 Whether the drive should considered for replication jobs.
666 `rerror`=`<ignore | report | stop>` ;;
670 `secs`=`<integer>` ;;
672 Force the drive's physical geometry to have a specific sector count.
674 `serial`=`<serial>` ;;
676 The drive's reported serial number, url-encoded, up to 20 bytes long.
678 `shared`=`<boolean>` ('default =' `0`);;
680 Mark this locally-managed volume as available on all nodes.
682 WARNING: This option does not share the volume automatically, it assumes it is shared already!
684 `size`=`<DiskSize>` ;;
686 Disk size. This is purely informational and has no effect.
688 `snapshot`=`<boolean>` ;;
690 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
694 Whether to expose this drive as an SSD, rather than a rotational hard disk.
696 `trans`=`<auto | lba | none>` ;;
698 Force disk geometry bios translation mode.
700 `werror`=`<enospc | ignore | report | stop>` ;;
704 `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>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
706 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
708 `aio`=`<native | threads>` ;;
712 `backup`=`<boolean>` ;;
714 Whether the drive should be included when making backups.
718 Maximum r/w speed in bytes per second.
720 `bps_max_length`=`<seconds>` ;;
722 Maximum length of I/O bursts in seconds.
726 Maximum read speed in bytes per second.
728 `bps_rd_max_length`=`<seconds>` ;;
730 Maximum length of read I/O bursts in seconds.
734 Maximum write speed in bytes per second.
736 `bps_wr_max_length`=`<seconds>` ;;
738 Maximum length of write I/O bursts in seconds.
740 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
742 The drive's cache mode
744 `cyls`=`<integer>` ;;
746 Force the drive's physical geometry to have a specific cylinder count.
748 `detect_zeroes`=`<boolean>` ;;
750 Controls whether to detect and try to optimize writes of zeroes.
752 `discard`=`<ignore | on>` ;;
754 Controls whether to pass discard/trim requests to the underlying storage.
758 The drive's backing volume.
760 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
762 The drive's backing file's data format.
764 `heads`=`<integer>` ;;
766 Force the drive's physical geometry to have a specific head count.
770 Maximum r/w I/O in operations per second.
772 `iops_max`=`<iops>` ;;
774 Maximum unthrottled r/w I/O pool in operations per second.
776 `iops_max_length`=`<seconds>` ;;
778 Maximum length of I/O bursts in seconds.
780 `iops_rd`=`<iops>` ;;
782 Maximum read I/O in operations per second.
784 `iops_rd_max`=`<iops>` ;;
786 Maximum unthrottled read I/O pool in operations per second.
788 `iops_rd_max_length`=`<seconds>` ;;
790 Maximum length of read I/O bursts in seconds.
792 `iops_wr`=`<iops>` ;;
794 Maximum write I/O in operations per second.
796 `iops_wr_max`=`<iops>` ;;
798 Maximum unthrottled write I/O pool in operations per second.
800 `iops_wr_max_length`=`<seconds>` ;;
802 Maximum length of write I/O bursts in seconds.
804 `iothread`=`<boolean>` ;;
806 Whether to use iothreads for this drive
810 Maximum r/w speed in megabytes per second.
812 `mbps_max`=`<mbps>` ;;
814 Maximum unthrottled r/w pool in megabytes per second.
816 `mbps_rd`=`<mbps>` ;;
818 Maximum read speed in megabytes per second.
820 `mbps_rd_max`=`<mbps>` ;;
822 Maximum unthrottled read pool in megabytes per second.
824 `mbps_wr`=`<mbps>` ;;
826 Maximum write speed in megabytes per second.
828 `mbps_wr_max`=`<mbps>` ;;
830 Maximum unthrottled write pool in megabytes per second.
832 `media`=`<cdrom | disk>` ('default =' `disk`);;
834 The drive's media type.
836 `queues`=`<integer> (2 - N)` ;;
840 `replicate`=`<boolean>` ('default =' `1`);;
842 Whether the drive should considered for replication jobs.
844 `rerror`=`<ignore | report | stop>` ;;
848 `scsiblock`=`<boolean>` ('default =' `0`);;
850 whether to use scsi-block for full passthrough of host block device
852 WARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host
854 `secs`=`<integer>` ;;
856 Force the drive's physical geometry to have a specific sector count.
858 `serial`=`<serial>` ;;
860 The drive's reported serial number, url-encoded, up to 20 bytes long.
862 `shared`=`<boolean>` ('default =' `0`);;
864 Mark this locally-managed volume as available on all nodes.
866 WARNING: This option does not share the volume automatically, it assumes it is shared already!
868 `size`=`<DiskSize>` ;;
870 Disk size. This is purely informational and has no effect.
872 `snapshot`=`<boolean>` ;;
874 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
878 Whether to expose this drive as an SSD, rather than a rotational hard disk.
880 `trans`=`<auto | lba | none>` ;;
882 Force disk geometry bios translation mode.
884 `werror`=`<enospc | ignore | report | stop>` ;;
888 `scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
890 SCSI controller model
892 `searchdomain`: `<string>` ::
894 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.
896 `serial[n]`: `(/dev/.+|socket)` ::
898 Create a serial device inside the VM (n is 0 to 3), and pass through a
899 host serial device (i.e. /dev/ttyS0), or create a unix socket on the
900 host side (use 'qm terminal' to open a terminal connection).
902 NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.
904 CAUTION: Experimental! User reported problems with this option.
906 `shares`: `<integer> (0 - 50000)` ('default =' `1000`)::
908 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. Auto-ballooning is done by pvestatd.
910 `smbios1`: `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
912 Specify SMBIOS type 1 fields.
914 `family`=`<string>` ;;
916 Set SMBIOS1 family string.
918 `manufacturer`=`<string>` ;;
920 Set SMBIOS1 manufacturer.
922 `product`=`<string>` ;;
924 Set SMBIOS1 product ID.
926 `serial`=`<string>` ;;
928 Set SMBIOS1 serial number.
932 Set SMBIOS1 SKU string.
938 `version`=`<string>` ;;
942 `smp`: `<integer> (1 - N)` ('default =' `1`)::
944 The number of CPUs. Please use option -sockets instead.
946 `sockets`: `<integer> (1 - N)` ('default =' `1`)::
948 The number of CPU sockets.
950 `sshkeys`: `<string>` ::
952 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
954 `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
956 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'.
958 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
960 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.
962 `tablet`: `<boolean>` ('default =' `1`)::
964 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).
966 `tdf`: `<boolean>` ('default =' `0`)::
968 Enable/disable time drift fix.
970 `template`: `<boolean>` ('default =' `0`)::
972 Enable/disable Template.
974 `unused[n]`: `<string>` ::
976 Reference to unused volumes. This is used internally, and should not be modified manually.
978 `usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
980 Configure an USB device (n is 0 to 4).
982 `host`=`<HOSTUSBDEVICE|spice>` ;;
984 The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
986 'bus-port(.port)*' (decimal numbers) or
987 'vendor_id:product_id' (hexadeciaml numbers) or
990 You can use the 'lsusb -t' command to list existing usb devices.
992 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
994 The value 'spice' can be used to add a usb redirection devices for spice.
996 `usb3`=`<boolean>` ('default =' `0`);;
998 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).
1000 `vcpus`: `<integer> (1 - N)` ('default =' `0`)::
1002 Number of hotplugged vcpus.
1004 `vga`: `[[type=]<enum>] [,memory=<integer>]` ::
1006 Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is 'std' for all OS types besides some Windows versions (XP and older) which use 'cirrus'. The 'qxl' option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays them self.
1007 You can also run without any graphic card, using a serial device as terminal.
1009 `memory`=`<integer> (4 - 512)` ;;
1011 Sets the VGA memory (in MiB). Has no effect with serial display.
1013 `type`=`<cirrus | none | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ('default =' `std`);;
1015 Select the VGA type.
1017 `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>]` ::
1019 Use volume as VIRTIO hard disk (n is 0 to 15).
1021 `aio`=`<native | threads>` ;;
1025 `backup`=`<boolean>` ;;
1027 Whether the drive should be included when making backups.
1031 Maximum r/w speed in bytes per second.
1033 `bps_max_length`=`<seconds>` ;;
1035 Maximum length of I/O bursts in seconds.
1039 Maximum read speed in bytes per second.
1041 `bps_rd_max_length`=`<seconds>` ;;
1043 Maximum length of read I/O bursts in seconds.
1047 Maximum write speed in bytes per second.
1049 `bps_wr_max_length`=`<seconds>` ;;
1051 Maximum length of write I/O bursts in seconds.
1053 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
1055 The drive's cache mode
1057 `cyls`=`<integer>` ;;
1059 Force the drive's physical geometry to have a specific cylinder count.
1061 `detect_zeroes`=`<boolean>` ;;
1063 Controls whether to detect and try to optimize writes of zeroes.
1065 `discard`=`<ignore | on>` ;;
1067 Controls whether to pass discard/trim requests to the underlying storage.
1069 `file`=`<volume>` ;;
1071 The drive's backing volume.
1073 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
1075 The drive's backing file's data format.
1077 `heads`=`<integer>` ;;
1079 Force the drive's physical geometry to have a specific head count.
1083 Maximum r/w I/O in operations per second.
1085 `iops_max`=`<iops>` ;;
1087 Maximum unthrottled r/w I/O pool in operations per second.
1089 `iops_max_length`=`<seconds>` ;;
1091 Maximum length of I/O bursts in seconds.
1093 `iops_rd`=`<iops>` ;;
1095 Maximum read I/O in operations per second.
1097 `iops_rd_max`=`<iops>` ;;
1099 Maximum unthrottled read I/O pool in operations per second.
1101 `iops_rd_max_length`=`<seconds>` ;;
1103 Maximum length of read I/O bursts in seconds.
1105 `iops_wr`=`<iops>` ;;
1107 Maximum write I/O in operations per second.
1109 `iops_wr_max`=`<iops>` ;;
1111 Maximum unthrottled write I/O pool in operations per second.
1113 `iops_wr_max_length`=`<seconds>` ;;
1115 Maximum length of write I/O bursts in seconds.
1117 `iothread`=`<boolean>` ;;
1119 Whether to use iothreads for this drive
1123 Maximum r/w speed in megabytes per second.
1125 `mbps_max`=`<mbps>` ;;
1127 Maximum unthrottled r/w pool in megabytes per second.
1129 `mbps_rd`=`<mbps>` ;;
1131 Maximum read speed in megabytes per second.
1133 `mbps_rd_max`=`<mbps>` ;;
1135 Maximum unthrottled read pool in megabytes per second.
1137 `mbps_wr`=`<mbps>` ;;
1139 Maximum write speed in megabytes per second.
1141 `mbps_wr_max`=`<mbps>` ;;
1143 Maximum unthrottled write pool in megabytes per second.
1145 `media`=`<cdrom | disk>` ('default =' `disk`);;
1147 The drive's media type.
1149 `replicate`=`<boolean>` ('default =' `1`);;
1151 Whether the drive should considered for replication jobs.
1153 `rerror`=`<ignore | report | stop>` ;;
1157 `secs`=`<integer>` ;;
1159 Force the drive's physical geometry to have a specific sector count.
1161 `serial`=`<serial>` ;;
1163 The drive's reported serial number, url-encoded, up to 20 bytes long.
1165 `shared`=`<boolean>` ('default =' `0`);;
1167 Mark this locally-managed volume as available on all nodes.
1169 WARNING: This option does not share the volume automatically, it assumes it is shared already!
1171 `size`=`<DiskSize>` ;;
1173 Disk size. This is purely informational and has no effect.
1175 `snapshot`=`<boolean>` ;;
1177 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
1179 `trans`=`<auto | lba | none>` ;;
1181 Force disk geometry bios translation mode.
1183 `werror`=`<enospc | ignore | report | stop>` ;;
1187 `vmgenid`: `<UUID>` ('default =' `1 (autogenerated)`)::
1189 The VM generation ID (vmgenid) device exposes a 128-bit integer value identifier to the guest OS. This allows to notify the guest operating system when the virtual machine is executed with a different configuration (e.g. snapshot execution or creation from a template). The guest operating system notices the change, and is then able to react as appropriate by marking its copies of distributed databases as dirty, re-initializing its random number generator, etc.
1190 Note that auto-creation only works when done throug API/CLI create or update methods, but not when manually editing the config file.
1192 `vmstatestorage`: `<string>` ::
1194 Default storage for VM state volumes/files.
1196 `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1198 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)
1200 `action`=`<debug | none | pause | poweroff | reset | shutdown>` ;;
1202 The action to perform if after activation the guest fails to poll the watchdog in time.
1204 `model`=`<i6300esb | ib700>` ('default =' `i6300esb`);;
1206 Watchdog type to emulate.