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>]` ::
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 `cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
89 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
91 `cpuunits`: `<integer> (2 - 262144)` ('default =' `1024`)::
93 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.
95 `description`: `<string>` ::
97 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
99 `efidisk0`: `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
101 Configure a Disk for storing EFI vars
105 The drive's backing volume.
107 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
109 The drive's backing file's data format.
111 `size`=`<DiskSize>` ;;
113 Disk size. This is purely informational and has no effect.
115 `freeze`: `<boolean>` ::
117 Freeze CPU at startup (use 'c' monitor command to start execution).
119 `hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
121 Map host PCI devices into guest.
123 NOTE: This option allows direct access to host hardware. So it is no longer
124 possible to migrate such machines - use with special care.
126 CAUTION: Experimental! User reported problems with this option.
128 `host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
130 Host PCI device pass through. The PCI ID of a host's PCI device or a list
131 of PCI virtual functions of the host. HOSTPCIID syntax is:
133 'bus:dev.func' (hexadecimal numbers)
135 You can us the 'lspci' command to list existing PCI devices.
139 The type of mediated device to use.
140 An instance of this type will be created on startup of the VM and
141 will be cleaned up when the VM stops.
143 `pcie`=`<boolean>` ('default =' `0`);;
145 Choose the PCI-express bus (needs the 'q35' machine model).
147 `rombar`=`<boolean>` ('default =' `1`);;
149 Specify whether or not the device's ROM will be visible in the guest's memory map.
151 `romfile`=`<string>` ;;
153 Custom pci device rom filename (must be located in /usr/share/kvm/).
155 `x-vga`=`<boolean>` ('default =' `0`);;
157 Enable vfio-vga device support.
159 `hotplug`: `<string>` ('default =' `network,disk,usb`)::
161 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'.
163 `hugepages`: `<1024 | 2 | any>` ::
165 Enable/disable hugepages memory.
167 `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>]` ::
169 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
171 `aio`=`<native | threads>` ;;
175 `backup`=`<boolean>` ;;
177 Whether the drive should be included when making backups.
181 Maximum r/w speed in bytes per second.
183 `bps_max_length`=`<seconds>` ;;
185 Maximum length of I/O bursts in seconds.
189 Maximum read speed in bytes per second.
191 `bps_rd_max_length`=`<seconds>` ;;
193 Maximum length of read I/O bursts in seconds.
197 Maximum write speed in bytes per second.
199 `bps_wr_max_length`=`<seconds>` ;;
201 Maximum length of write I/O bursts in seconds.
203 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
205 The drive's cache mode
207 `cyls`=`<integer>` ;;
209 Force the drive's physical geometry to have a specific cylinder count.
211 `detect_zeroes`=`<boolean>` ;;
213 Controls whether to detect and try to optimize writes of zeroes.
215 `discard`=`<ignore | on>` ;;
217 Controls whether to pass discard/trim requests to the underlying storage.
221 The drive's backing volume.
223 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
225 The drive's backing file's data format.
227 `heads`=`<integer>` ;;
229 Force the drive's physical geometry to have a specific head count.
233 Maximum r/w I/O in operations per second.
235 `iops_max`=`<iops>` ;;
237 Maximum unthrottled r/w I/O pool in operations per second.
239 `iops_max_length`=`<seconds>` ;;
241 Maximum length of I/O bursts in seconds.
243 `iops_rd`=`<iops>` ;;
245 Maximum read I/O in operations per second.
247 `iops_rd_max`=`<iops>` ;;
249 Maximum unthrottled read I/O pool in operations per second.
251 `iops_rd_max_length`=`<seconds>` ;;
253 Maximum length of read I/O bursts in seconds.
255 `iops_wr`=`<iops>` ;;
257 Maximum write I/O in operations per second.
259 `iops_wr_max`=`<iops>` ;;
261 Maximum unthrottled write I/O pool in operations per second.
263 `iops_wr_max_length`=`<seconds>` ;;
265 Maximum length of write I/O bursts in seconds.
269 Maximum r/w speed in megabytes per second.
271 `mbps_max`=`<mbps>` ;;
273 Maximum unthrottled r/w pool in megabytes per second.
275 `mbps_rd`=`<mbps>` ;;
277 Maximum read speed in megabytes per second.
279 `mbps_rd_max`=`<mbps>` ;;
281 Maximum unthrottled read pool in megabytes per second.
283 `mbps_wr`=`<mbps>` ;;
285 Maximum write speed in megabytes per second.
287 `mbps_wr_max`=`<mbps>` ;;
289 Maximum unthrottled write pool in megabytes per second.
291 `media`=`<cdrom | disk>` ('default =' `disk`);;
293 The drive's media type.
297 The drive's reported model name, url-encoded, up to 40 bytes long.
299 `replicate`=`<boolean>` ('default =' `1`);;
301 Whether the drive should considered for replication jobs.
303 `rerror`=`<ignore | report | stop>` ;;
307 `secs`=`<integer>` ;;
309 Force the drive's physical geometry to have a specific sector count.
311 `serial`=`<serial>` ;;
313 The drive's reported serial number, url-encoded, up to 20 bytes long.
315 `shared`=`<boolean>` ('default =' `0`);;
317 Mark this locally-managed volume as available on all nodes.
319 WARNING: This option does not share the volume automatically, it assumes it is shared already!
321 `size`=`<DiskSize>` ;;
323 Disk size. This is purely informational and has no effect.
325 `snapshot`=`<boolean>` ;;
327 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
331 Whether to expose this drive as an SSD, rather than a rotational hard disk.
333 `trans`=`<auto | lba | none>` ;;
335 Force disk geometry bios translation mode.
337 `werror`=`<enospc | ignore | report | stop>` ;;
341 `ipconfig[n]`: `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
343 cloud-init: Specify IP addresses and gateways for the corresponding interface.
345 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
347 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
348 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
350 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
352 `gw`=`<GatewayIPv4>` ;;
354 Default gateway for IPv4 traffic.
356 NOTE: Requires option(s): `ip`
358 `gw6`=`<GatewayIPv6>` ;;
360 Default gateway for IPv6 traffic.
362 NOTE: Requires option(s): `ip6`
364 `ip`=`<IPv4Format/CIDR>` ('default =' `dhcp`);;
366 IPv4 address in CIDR format.
368 `ip6`=`<IPv6Format/CIDR>` ('default =' `dhcp`);;
370 IPv6 address in CIDR format.
372 `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>` ::
374 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
376 `kvm`: `<boolean>` ('default =' `1`)::
378 Enable/disable KVM hardware virtualization.
380 `localtime`: `<boolean>` ::
382 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
384 `lock`: `<backup | migrate | rollback | snapshot>` ::
388 `machine`: `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` ::
390 Specifies the Qemu machine type.
392 `memory`: `<integer> (16 - N)` ('default =' `512`)::
394 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
396 `migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
398 Set maximum tolerated downtime (in seconds) for migrations.
400 `migrate_speed`: `<integer> (0 - N)` ('default =' `0`)::
402 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
404 `name`: `<string>` ::
406 Set a name for the VM. Only used on the configuration web interface.
408 `nameserver`: `<string>` ::
410 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.
412 `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>]` ::
414 Specify network devices.
416 `bridge`=`<bridge>` ;;
418 Bridge to attach the network device to. The Proxmox VE standard bridge
421 If you do not specify a bridge, we create a kvm user (NATed) network
422 device, which provides DHCP and DNS services. The following addresses
429 The DHCP server assign addresses to the guest starting from 10.0.2.15.
431 `firewall`=`<boolean>` ;;
433 Whether this interface should be protected by the firewall.
435 `link_down`=`<boolean>` ;;
437 Whether this interface should be disconnected (like pulling the plug).
439 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
441 MAC address. That address must be unique withing your network. This is automatically generated if not specified.
443 `model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
445 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'.
447 `queues`=`<integer> (0 - 16)` ;;
449 Number of packet queues to be used on the device.
451 `rate`=`<number> (0 - N)` ;;
453 Rate limit in mbps (megabytes per second) as floating point number.
455 `tag`=`<integer> (1 - 4094)` ;;
457 VLAN tag to apply to packets on this interface.
459 `trunks`=`<vlanid[;vlanid...]>` ;;
461 VLAN trunks to pass through this interface.
463 `numa`: `<boolean>` ('default =' `0`)::
467 `numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
471 `cpus`=`<id[-id];...>` ;;
473 CPUs accessing this NUMA node.
475 `hostnodes`=`<id[-id];...>` ;;
477 Host NUMA nodes to use.
479 `memory`=`<number>` ;;
481 Amount of memory this NUMA node provides.
483 `policy`=`<bind | interleave | preferred>` ;;
485 NUMA allocation policy.
487 `onboot`: `<boolean>` ('default =' `0`)::
489 Specifies whether a VM will be started during system bootup.
491 `ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
493 Specify guest operating system. This is used to enable special
494 optimization/features for specific operating systems:
497 other;; unspecified OS
498 wxp;; Microsoft Windows XP
499 w2k;; Microsoft Windows 2000
500 w2k3;; Microsoft Windows 2003
501 w2k8;; Microsoft Windows 2008
502 wvista;; Microsoft Windows Vista
503 win7;; Microsoft Windows 7
504 win8;; Microsoft Windows 8/2012/2012r2
505 win10;; Microsoft Windows 10/2016
506 l24;; Linux 2.4 Kernel
507 l26;; Linux 2.6/3.X Kernel
508 solaris;; Solaris/OpenSolaris/OpenIndiania kernel
510 `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
512 Map host parallel devices (n is 0 to 2).
514 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
516 CAUTION: Experimental! User reported problems with this option.
518 `protection`: `<boolean>` ('default =' `0`)::
520 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
522 `reboot`: `<boolean>` ('default =' `1`)::
524 Allow reboot. If set to '0' the VM exit on reboot.
526 `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>]` ::
528 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
530 `aio`=`<native | threads>` ;;
534 `backup`=`<boolean>` ;;
536 Whether the drive should be included when making backups.
540 Maximum r/w speed in bytes per second.
542 `bps_max_length`=`<seconds>` ;;
544 Maximum length of I/O bursts in seconds.
548 Maximum read speed in bytes per second.
550 `bps_rd_max_length`=`<seconds>` ;;
552 Maximum length of read I/O bursts in seconds.
556 Maximum write speed in bytes per second.
558 `bps_wr_max_length`=`<seconds>` ;;
560 Maximum length of write I/O bursts in seconds.
562 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
564 The drive's cache mode
566 `cyls`=`<integer>` ;;
568 Force the drive's physical geometry to have a specific cylinder count.
570 `detect_zeroes`=`<boolean>` ;;
572 Controls whether to detect and try to optimize writes of zeroes.
574 `discard`=`<ignore | on>` ;;
576 Controls whether to pass discard/trim requests to the underlying storage.
580 The drive's backing volume.
582 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
584 The drive's backing file's data format.
586 `heads`=`<integer>` ;;
588 Force the drive's physical geometry to have a specific head count.
592 Maximum r/w I/O in operations per second.
594 `iops_max`=`<iops>` ;;
596 Maximum unthrottled r/w I/O pool in operations per second.
598 `iops_max_length`=`<seconds>` ;;
600 Maximum length of I/O bursts in seconds.
602 `iops_rd`=`<iops>` ;;
604 Maximum read I/O in operations per second.
606 `iops_rd_max`=`<iops>` ;;
608 Maximum unthrottled read I/O pool in operations per second.
610 `iops_rd_max_length`=`<seconds>` ;;
612 Maximum length of read I/O bursts in seconds.
614 `iops_wr`=`<iops>` ;;
616 Maximum write I/O in operations per second.
618 `iops_wr_max`=`<iops>` ;;
620 Maximum unthrottled write I/O pool in operations per second.
622 `iops_wr_max_length`=`<seconds>` ;;
624 Maximum length of write I/O bursts in seconds.
628 Maximum r/w speed in megabytes per second.
630 `mbps_max`=`<mbps>` ;;
632 Maximum unthrottled r/w pool in megabytes per second.
634 `mbps_rd`=`<mbps>` ;;
636 Maximum read speed in megabytes per second.
638 `mbps_rd_max`=`<mbps>` ;;
640 Maximum unthrottled read pool in megabytes per second.
642 `mbps_wr`=`<mbps>` ;;
644 Maximum write speed in megabytes per second.
646 `mbps_wr_max`=`<mbps>` ;;
648 Maximum unthrottled write pool in megabytes per second.
650 `media`=`<cdrom | disk>` ('default =' `disk`);;
652 The drive's media type.
654 `replicate`=`<boolean>` ('default =' `1`);;
656 Whether the drive should considered for replication jobs.
658 `rerror`=`<ignore | report | stop>` ;;
662 `secs`=`<integer>` ;;
664 Force the drive's physical geometry to have a specific sector count.
666 `serial`=`<serial>` ;;
668 The drive's reported serial number, url-encoded, up to 20 bytes long.
670 `shared`=`<boolean>` ('default =' `0`);;
672 Mark this locally-managed volume as available on all nodes.
674 WARNING: This option does not share the volume automatically, it assumes it is shared already!
676 `size`=`<DiskSize>` ;;
678 Disk size. This is purely informational and has no effect.
680 `snapshot`=`<boolean>` ;;
682 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
686 Whether to expose this drive as an SSD, rather than a rotational hard disk.
688 `trans`=`<auto | lba | none>` ;;
690 Force disk geometry bios translation mode.
692 `werror`=`<enospc | ignore | report | stop>` ;;
696 `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>]` ::
698 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
700 `aio`=`<native | threads>` ;;
704 `backup`=`<boolean>` ;;
706 Whether the drive should be included when making backups.
710 Maximum r/w speed in bytes per second.
712 `bps_max_length`=`<seconds>` ;;
714 Maximum length of I/O bursts in seconds.
718 Maximum read speed in bytes per second.
720 `bps_rd_max_length`=`<seconds>` ;;
722 Maximum length of read I/O bursts in seconds.
726 Maximum write speed in bytes per second.
728 `bps_wr_max_length`=`<seconds>` ;;
730 Maximum length of write I/O bursts in seconds.
732 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
734 The drive's cache mode
736 `cyls`=`<integer>` ;;
738 Force the drive's physical geometry to have a specific cylinder count.
740 `detect_zeroes`=`<boolean>` ;;
742 Controls whether to detect and try to optimize writes of zeroes.
744 `discard`=`<ignore | on>` ;;
746 Controls whether to pass discard/trim requests to the underlying storage.
750 The drive's backing volume.
752 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
754 The drive's backing file's data format.
756 `heads`=`<integer>` ;;
758 Force the drive's physical geometry to have a specific head count.
762 Maximum r/w I/O in operations per second.
764 `iops_max`=`<iops>` ;;
766 Maximum unthrottled r/w I/O pool in operations per second.
768 `iops_max_length`=`<seconds>` ;;
770 Maximum length of I/O bursts in seconds.
772 `iops_rd`=`<iops>` ;;
774 Maximum read I/O in operations per second.
776 `iops_rd_max`=`<iops>` ;;
778 Maximum unthrottled read I/O pool in operations per second.
780 `iops_rd_max_length`=`<seconds>` ;;
782 Maximum length of read I/O bursts in seconds.
784 `iops_wr`=`<iops>` ;;
786 Maximum write I/O in operations per second.
788 `iops_wr_max`=`<iops>` ;;
790 Maximum unthrottled write I/O pool in operations per second.
792 `iops_wr_max_length`=`<seconds>` ;;
794 Maximum length of write I/O bursts in seconds.
796 `iothread`=`<boolean>` ;;
798 Whether to use iothreads for this drive
802 Maximum r/w speed in megabytes per second.
804 `mbps_max`=`<mbps>` ;;
806 Maximum unthrottled r/w pool in megabytes per second.
808 `mbps_rd`=`<mbps>` ;;
810 Maximum read speed in megabytes per second.
812 `mbps_rd_max`=`<mbps>` ;;
814 Maximum unthrottled read pool in megabytes per second.
816 `mbps_wr`=`<mbps>` ;;
818 Maximum write speed in megabytes per second.
820 `mbps_wr_max`=`<mbps>` ;;
822 Maximum unthrottled write pool in megabytes per second.
824 `media`=`<cdrom | disk>` ('default =' `disk`);;
826 The drive's media type.
828 `queues`=`<integer> (2 - N)` ;;
832 `replicate`=`<boolean>` ('default =' `1`);;
834 Whether the drive should considered for replication jobs.
836 `rerror`=`<ignore | report | stop>` ;;
840 `scsiblock`=`<boolean>` ('default =' `0`);;
842 whether to use scsi-block for full passthrough of host block device
844 WARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host
846 `secs`=`<integer>` ;;
848 Force the drive's physical geometry to have a specific sector count.
850 `serial`=`<serial>` ;;
852 The drive's reported serial number, url-encoded, up to 20 bytes long.
854 `shared`=`<boolean>` ('default =' `0`);;
856 Mark this locally-managed volume as available on all nodes.
858 WARNING: This option does not share the volume automatically, it assumes it is shared already!
860 `size`=`<DiskSize>` ;;
862 Disk size. This is purely informational and has no effect.
864 `snapshot`=`<boolean>` ;;
866 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
870 Whether to expose this drive as an SSD, rather than a rotational hard disk.
872 `trans`=`<auto | lba | none>` ;;
874 Force disk geometry bios translation mode.
876 `werror`=`<enospc | ignore | report | stop>` ;;
880 `scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
882 SCSI controller model
884 `searchdomain`: `<string>` ::
886 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.
888 `serial[n]`: `(/dev/.+|socket)` ::
890 Create a serial device inside the VM (n is 0 to 3), and pass through a
891 host serial device (i.e. /dev/ttyS0), or create a unix socket on the
892 host side (use 'qm terminal' to open a terminal connection).
894 NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.
896 CAUTION: Experimental! User reported problems with this option.
898 `shares`: `<integer> (0 - 50000)` ('default =' `1000`)::
900 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.
902 `smbios1`: `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
904 Specify SMBIOS type 1 fields.
906 `family`=`<string>` ;;
908 Set SMBIOS1 family string.
910 `manufacturer`=`<string>` ;;
912 Set SMBIOS1 manufacturer.
914 `product`=`<string>` ;;
916 Set SMBIOS1 product ID.
918 `serial`=`<string>` ;;
920 Set SMBIOS1 serial number.
924 Set SMBIOS1 SKU string.
930 `version`=`<string>` ;;
934 `smp`: `<integer> (1 - N)` ('default =' `1`)::
936 The number of CPUs. Please use option -sockets instead.
938 `sockets`: `<integer> (1 - N)` ('default =' `1`)::
940 The number of CPU sockets.
942 `sshkeys`: `<string>` ::
944 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
946 `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
948 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'.
950 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
952 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.
954 `tablet`: `<boolean>` ('default =' `1`)::
956 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).
958 `tdf`: `<boolean>` ('default =' `0`)::
960 Enable/disable time drift fix.
962 `template`: `<boolean>` ('default =' `0`)::
964 Enable/disable Template.
966 `unused[n]`: `<string>` ::
968 Reference to unused volumes. This is used internally, and should not be modified manually.
970 `usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
972 Configure an USB device (n is 0 to 4).
974 `host`=`<HOSTUSBDEVICE|spice>` ;;
976 The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
978 'bus-port(.port)*' (decimal numbers) or
979 'vendor_id:product_id' (hexadeciaml numbers) or
982 You can use the 'lsusb -t' command to list existing usb devices.
984 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
986 The value 'spice' can be used to add a usb redirection devices for spice.
988 `usb3`=`<boolean>` ('default =' `0`);;
990 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).
992 `vcpus`: `<integer> (1 - N)` ('default =' `0`)::
994 Number of hotplugged vcpus.
996 `vga`: `[[type=]<enum>] [,memory=<integer>]` ::
998 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.
999 You can also run without any graphic card, using a serial device as terminal.
1001 `memory`=`<integer> (4 - 512)` ;;
1003 Sets the VGA memory (in MiB). Has no effect with serial display.
1005 `type`=`<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ('default =' `std`);;
1007 Select the VGA type.
1009 `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>]` ::
1011 Use volume as VIRTIO hard disk (n is 0 to 15).
1013 `aio`=`<native | threads>` ;;
1017 `backup`=`<boolean>` ;;
1019 Whether the drive should be included when making backups.
1023 Maximum r/w speed in bytes per second.
1025 `bps_max_length`=`<seconds>` ;;
1027 Maximum length of I/O bursts in seconds.
1031 Maximum read speed in bytes per second.
1033 `bps_rd_max_length`=`<seconds>` ;;
1035 Maximum length of read I/O bursts in seconds.
1039 Maximum write speed in bytes per second.
1041 `bps_wr_max_length`=`<seconds>` ;;
1043 Maximum length of write I/O bursts in seconds.
1045 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
1047 The drive's cache mode
1049 `cyls`=`<integer>` ;;
1051 Force the drive's physical geometry to have a specific cylinder count.
1053 `detect_zeroes`=`<boolean>` ;;
1055 Controls whether to detect and try to optimize writes of zeroes.
1057 `discard`=`<ignore | on>` ;;
1059 Controls whether to pass discard/trim requests to the underlying storage.
1061 `file`=`<volume>` ;;
1063 The drive's backing volume.
1065 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
1067 The drive's backing file's data format.
1069 `heads`=`<integer>` ;;
1071 Force the drive's physical geometry to have a specific head count.
1075 Maximum r/w I/O in operations per second.
1077 `iops_max`=`<iops>` ;;
1079 Maximum unthrottled r/w I/O pool in operations per second.
1081 `iops_max_length`=`<seconds>` ;;
1083 Maximum length of I/O bursts in seconds.
1085 `iops_rd`=`<iops>` ;;
1087 Maximum read I/O in operations per second.
1089 `iops_rd_max`=`<iops>` ;;
1091 Maximum unthrottled read I/O pool in operations per second.
1093 `iops_rd_max_length`=`<seconds>` ;;
1095 Maximum length of read I/O bursts in seconds.
1097 `iops_wr`=`<iops>` ;;
1099 Maximum write I/O in operations per second.
1101 `iops_wr_max`=`<iops>` ;;
1103 Maximum unthrottled write I/O pool in operations per second.
1105 `iops_wr_max_length`=`<seconds>` ;;
1107 Maximum length of write I/O bursts in seconds.
1109 `iothread`=`<boolean>` ;;
1111 Whether to use iothreads for this drive
1115 Maximum r/w speed in megabytes per second.
1117 `mbps_max`=`<mbps>` ;;
1119 Maximum unthrottled r/w pool in megabytes per second.
1121 `mbps_rd`=`<mbps>` ;;
1123 Maximum read speed in megabytes per second.
1125 `mbps_rd_max`=`<mbps>` ;;
1127 Maximum unthrottled read pool in megabytes per second.
1129 `mbps_wr`=`<mbps>` ;;
1131 Maximum write speed in megabytes per second.
1133 `mbps_wr_max`=`<mbps>` ;;
1135 Maximum unthrottled write pool in megabytes per second.
1137 `media`=`<cdrom | disk>` ('default =' `disk`);;
1139 The drive's media type.
1141 `replicate`=`<boolean>` ('default =' `1`);;
1143 Whether the drive should considered for replication jobs.
1145 `rerror`=`<ignore | report | stop>` ;;
1149 `secs`=`<integer>` ;;
1151 Force the drive's physical geometry to have a specific sector count.
1153 `serial`=`<serial>` ;;
1155 The drive's reported serial number, url-encoded, up to 20 bytes long.
1157 `shared`=`<boolean>` ('default =' `0`);;
1159 Mark this locally-managed volume as available on all nodes.
1161 WARNING: This option does not share the volume automatically, it assumes it is shared already!
1163 `size`=`<DiskSize>` ;;
1165 Disk size. This is purely informational and has no effect.
1167 `snapshot`=`<boolean>` ;;
1169 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
1171 `trans`=`<auto | lba | none>` ;;
1173 Force disk geometry bios translation mode.
1175 `werror`=`<enospc | ignore | report | stop>` ;;
1179 `vmgenid`: `<UUID>` ('default =' `1 (autogenerated)`)::
1181 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.
1182 Note that auto-creation only works when done throug API/CLI create or update methods, but not when manually editing the config file.
1184 `vmstatestorage`: `<string>` ::
1186 Default storage for VM state volumes/files.
1188 `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1190 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)
1192 `action`=`<debug | none | pause | poweroff | reset | shutdown>` ;;
1194 The action to perform if after activation the guest fails to poll the watchdog in time.
1196 `model`=`<i6300esb | ib700>` ('default =' `i6300esb`);;
1198 Watchdog type to emulate.