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 `audio0`: `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]` ::
31 Configure a audio device, useful in combination with QXL/Spice.
33 `device`=`<AC97 | ich9-intel-hda | intel-hda>` ;;
35 Configure an audio device.
37 `driver`=`<spice>` ('default =' `spice`);;
39 Driver backend for the audio device.
41 `autostart`: `<boolean>` ('default =' `0`)::
43 Automatic restart after crash (currently ignored).
45 `balloon`: `<integer> (0 - N)` ::
47 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
49 `bios`: `<ovmf | seabios>` ('default =' `seabios`)::
51 Select BIOS implementation.
53 `boot`: `[acdn]{1,4}` ('default =' `cdn`)::
55 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
57 `bootdisk`: `(ide|sata|scsi|virtio)\d+` ::
59 Enable booting from specified disk.
61 `cdrom`: `<volume>` ::
63 This is an alias for option -ide2
65 `cicustom`: `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
67 cloud-init: Specify custom files to replace the automatically generated ones at start.
71 Specify a custom file containing all meta data passed to the VM via cloud-init. This is provider specific meaning configdrive2 and nocloud differ.
73 `network`=`<volume>` ;;
75 Specify a custom file containing all network data passed to the VM via cloud-init.
79 Specify a custom file containing all user data passed to the VM via cloud-init.
81 `cipassword`: `<string>` ::
83 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.
85 `citype`: `<configdrive2 | nocloud>` ::
87 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.
89 `ciuser`: `<string>` ::
91 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
93 `cores`: `<integer> (1 - N)` ('default =' `1`)::
95 The number of cores per socket.
97 `cpu`: `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]` ::
101 `cputype`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Cascadelake-Server | Conroe | EPYC | EPYC-IBPB | Haswell | Haswell-IBRS | Haswell-noTSX | Haswell-noTSX-IBRS | IvyBridge | IvyBridge-IBRS | KnightsMill | 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`);;
105 `flags`=`<+FLAG[;-FLAG...]>` ;;
107 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, md-clear, hv-tlbflush, hv-evmcs, aes.
109 `hidden`=`<boolean>` ('default =' `0`);;
111 Do not identify as a KVM virtual machine.
113 `hv-vendor-id`=`<vendor-id>` ;;
115 The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.
117 `cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
121 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
123 `cpuunits`: `<integer> (2 - 262144)` ('default =' `1024`)::
125 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.
127 `description`: `<string>` ::
129 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
131 `efidisk0`: `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
133 Configure a Disk for storing EFI vars
137 The drive's backing volume.
139 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
141 The drive's backing file's data format.
143 `size`=`<DiskSize>` ;;
145 Disk size. This is purely informational and has no effect.
147 `freeze`: `<boolean>` ::
149 Freeze CPU at startup (use 'c' monitor command to start execution).
151 `hookscript`: `<string>` ::
153 Script that will be executed during various steps in the vms lifetime.
155 `hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
157 Map host PCI devices into guest.
159 NOTE: This option allows direct access to host hardware. So it is no longer
160 possible to migrate such machines - use with special care.
162 CAUTION: Experimental! User reported problems with this option.
164 `host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
166 Host PCI device pass through. The PCI ID of a host's PCI device or a list
167 of PCI virtual functions of the host. HOSTPCIID syntax is:
169 'bus:dev.func' (hexadecimal numbers)
171 You can us the 'lspci' command to list existing PCI devices.
175 The type of mediated device to use.
176 An instance of this type will be created on startup of the VM and
177 will be cleaned up when the VM stops.
179 `pcie`=`<boolean>` ('default =' `0`);;
181 Choose the PCI-express bus (needs the 'q35' machine model).
183 `rombar`=`<boolean>` ('default =' `1`);;
185 Specify whether or not the device's ROM will be visible in the guest's memory map.
187 `romfile`=`<string>` ;;
189 Custom pci device rom filename (must be located in /usr/share/kvm/).
191 `x-vga`=`<boolean>` ('default =' `0`);;
193 Enable vfio-vga device support.
195 `hotplug`: `<string>` ('default =' `network,disk,usb`)::
197 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'.
199 `hugepages`: `<1024 | 2 | any>` ::
201 Enable/disable hugepages memory.
203 `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>] [,wwn=<wwn>]` ::
205 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
207 `aio`=`<native | threads>` ;;
211 `backup`=`<boolean>` ;;
213 Whether the drive should be included when making backups.
217 Maximum r/w speed in bytes per second.
219 `bps_max_length`=`<seconds>` ;;
221 Maximum length of I/O bursts in seconds.
225 Maximum read speed in bytes per second.
227 `bps_rd_max_length`=`<seconds>` ;;
229 Maximum length of read I/O bursts in seconds.
233 Maximum write speed in bytes per second.
235 `bps_wr_max_length`=`<seconds>` ;;
237 Maximum length of write I/O bursts in seconds.
239 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
241 The drive's cache mode
243 `cyls`=`<integer>` ;;
245 Force the drive's physical geometry to have a specific cylinder count.
247 `detect_zeroes`=`<boolean>` ;;
249 Controls whether to detect and try to optimize writes of zeroes.
251 `discard`=`<ignore | on>` ;;
253 Controls whether to pass discard/trim requests to the underlying storage.
257 The drive's backing volume.
259 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
261 The drive's backing file's data format.
263 `heads`=`<integer>` ;;
265 Force the drive's physical geometry to have a specific head count.
269 Maximum r/w I/O in operations per second.
271 `iops_max`=`<iops>` ;;
273 Maximum unthrottled r/w I/O pool in operations per second.
275 `iops_max_length`=`<seconds>` ;;
277 Maximum length of I/O bursts in seconds.
279 `iops_rd`=`<iops>` ;;
281 Maximum read I/O in operations per second.
283 `iops_rd_max`=`<iops>` ;;
285 Maximum unthrottled read I/O pool in operations per second.
287 `iops_rd_max_length`=`<seconds>` ;;
289 Maximum length of read I/O bursts in seconds.
291 `iops_wr`=`<iops>` ;;
293 Maximum write I/O in operations per second.
295 `iops_wr_max`=`<iops>` ;;
297 Maximum unthrottled write I/O pool in operations per second.
299 `iops_wr_max_length`=`<seconds>` ;;
301 Maximum length of write I/O bursts in seconds.
305 Maximum r/w speed in megabytes per second.
307 `mbps_max`=`<mbps>` ;;
309 Maximum unthrottled r/w pool in megabytes per second.
311 `mbps_rd`=`<mbps>` ;;
313 Maximum read speed in megabytes per second.
315 `mbps_rd_max`=`<mbps>` ;;
317 Maximum unthrottled read pool in megabytes per second.
319 `mbps_wr`=`<mbps>` ;;
321 Maximum write speed in megabytes per second.
323 `mbps_wr_max`=`<mbps>` ;;
325 Maximum unthrottled write pool in megabytes per second.
327 `media`=`<cdrom | disk>` ('default =' `disk`);;
329 The drive's media type.
333 The drive's reported model name, url-encoded, up to 40 bytes long.
335 `replicate`=`<boolean>` ('default =' `1`);;
337 Whether the drive should considered for replication jobs.
339 `rerror`=`<ignore | report | stop>` ;;
343 `secs`=`<integer>` ;;
345 Force the drive's physical geometry to have a specific sector count.
347 `serial`=`<serial>` ;;
349 The drive's reported serial number, url-encoded, up to 20 bytes long.
351 `shared`=`<boolean>` ('default =' `0`);;
353 Mark this locally-managed volume as available on all nodes.
355 WARNING: This option does not share the volume automatically, it assumes it is shared already!
357 `size`=`<DiskSize>` ;;
359 Disk size. This is purely informational and has no effect.
361 `snapshot`=`<boolean>` ;;
363 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
367 Whether to expose this drive as an SSD, rather than a rotational hard disk.
369 `trans`=`<auto | lba | none>` ;;
371 Force disk geometry bios translation mode.
373 `werror`=`<enospc | ignore | report | stop>` ;;
379 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
381 `ipconfig[n]`: `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
383 cloud-init: Specify IP addresses and gateways for the corresponding interface.
385 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
387 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
388 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
390 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
392 `gw`=`<GatewayIPv4>` ;;
394 Default gateway for IPv4 traffic.
396 NOTE: Requires option(s): `ip`
398 `gw6`=`<GatewayIPv6>` ;;
400 Default gateway for IPv6 traffic.
402 NOTE: Requires option(s): `ip6`
404 `ip`=`<IPv4Format/CIDR>` ('default =' `dhcp`);;
406 IPv4 address in CIDR format.
408 `ip6`=`<IPv6Format/CIDR>` ('default =' `dhcp`);;
410 IPv6 address in CIDR format.
412 `ivshmem`: `size=<integer> [,name=<string>]` ::
414 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
418 The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.
420 `size`=`<integer> (1 - N)` ;;
422 The size of the file in MB.
424 `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>` ::
426 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
428 `kvm`: `<boolean>` ('default =' `1`)::
430 Enable/disable KVM hardware virtualization.
432 `localtime`: `<boolean>` ::
434 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
436 `lock`: `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
440 `machine`: `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` ::
442 Specifies the Qemu machine type.
444 `memory`: `<integer> (16 - N)` ('default =' `512`)::
446 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
448 `migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
450 Set maximum tolerated downtime (in seconds) for migrations.
452 `migrate_speed`: `<integer> (0 - N)` ('default =' `0`)::
454 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
456 `name`: `<string>` ::
458 Set a name for the VM. Only used on the configuration web interface.
460 `nameserver`: `<string>` ::
462 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.
464 `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>]` ::
466 Specify network devices.
468 `bridge`=`<bridge>` ;;
470 Bridge to attach the network device to. The Proxmox VE standard bridge
473 If you do not specify a bridge, we create a kvm user (NATed) network
474 device, which provides DHCP and DNS services. The following addresses
481 The DHCP server assign addresses to the guest starting from 10.0.2.15.
483 `firewall`=`<boolean>` ;;
485 Whether this interface should be protected by the firewall.
487 `link_down`=`<boolean>` ;;
489 Whether this interface should be disconnected (like pulling the plug).
491 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
493 A common MAC address with the I/G (Individual/Group) bit not set.
495 `model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
497 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'.
499 `queues`=`<integer> (0 - 16)` ;;
501 Number of packet queues to be used on the device.
503 `rate`=`<number> (0 - N)` ;;
505 Rate limit in mbps (megabytes per second) as floating point number.
507 `tag`=`<integer> (1 - 4094)` ;;
509 VLAN tag to apply to packets on this interface.
511 `trunks`=`<vlanid[;vlanid...]>` ;;
513 VLAN trunks to pass through this interface.
515 `numa`: `<boolean>` ('default =' `0`)::
519 `numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
523 `cpus`=`<id[-id];...>` ;;
525 CPUs accessing this NUMA node.
527 `hostnodes`=`<id[-id];...>` ;;
529 Host NUMA nodes to use.
531 `memory`=`<number>` ;;
533 Amount of memory this NUMA node provides.
535 `policy`=`<bind | interleave | preferred>` ;;
537 NUMA allocation policy.
539 `onboot`: `<boolean>` ('default =' `0`)::
541 Specifies whether a VM will be started during system bootup.
543 `ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
545 Specify guest operating system. This is used to enable special
546 optimization/features for specific operating systems:
549 other;; unspecified OS
550 wxp;; Microsoft Windows XP
551 w2k;; Microsoft Windows 2000
552 w2k3;; Microsoft Windows 2003
553 w2k8;; Microsoft Windows 2008
554 wvista;; Microsoft Windows Vista
555 win7;; Microsoft Windows 7
556 win8;; Microsoft Windows 8/2012/2012r2
557 win10;; Microsoft Windows 10/2016
558 l24;; Linux 2.4 Kernel
559 l26;; Linux 2.6/3.X Kernel
560 solaris;; Solaris/OpenSolaris/OpenIndiania kernel
562 `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
564 Map host parallel devices (n is 0 to 2).
566 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
568 CAUTION: Experimental! User reported problems with this option.
570 `protection`: `<boolean>` ('default =' `0`)::
572 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
574 `reboot`: `<boolean>` ('default =' `1`)::
576 Allow reboot. If set to '0' the VM exit on reboot.
578 `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>] [,wwn=<wwn>]` ::
580 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
582 `aio`=`<native | threads>` ;;
586 `backup`=`<boolean>` ;;
588 Whether the drive should be included when making backups.
592 Maximum r/w speed in bytes per second.
594 `bps_max_length`=`<seconds>` ;;
596 Maximum length of I/O bursts in seconds.
600 Maximum read speed in bytes per second.
602 `bps_rd_max_length`=`<seconds>` ;;
604 Maximum length of read I/O bursts in seconds.
608 Maximum write speed in bytes per second.
610 `bps_wr_max_length`=`<seconds>` ;;
612 Maximum length of write I/O bursts in seconds.
614 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
616 The drive's cache mode
618 `cyls`=`<integer>` ;;
620 Force the drive's physical geometry to have a specific cylinder count.
622 `detect_zeroes`=`<boolean>` ;;
624 Controls whether to detect and try to optimize writes of zeroes.
626 `discard`=`<ignore | on>` ;;
628 Controls whether to pass discard/trim requests to the underlying storage.
632 The drive's backing volume.
634 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
636 The drive's backing file's data format.
638 `heads`=`<integer>` ;;
640 Force the drive's physical geometry to have a specific head count.
644 Maximum r/w I/O in operations per second.
646 `iops_max`=`<iops>` ;;
648 Maximum unthrottled r/w I/O pool in operations per second.
650 `iops_max_length`=`<seconds>` ;;
652 Maximum length of I/O bursts in seconds.
654 `iops_rd`=`<iops>` ;;
656 Maximum read I/O in operations per second.
658 `iops_rd_max`=`<iops>` ;;
660 Maximum unthrottled read I/O pool in operations per second.
662 `iops_rd_max_length`=`<seconds>` ;;
664 Maximum length of read I/O bursts in seconds.
666 `iops_wr`=`<iops>` ;;
668 Maximum write I/O in operations per second.
670 `iops_wr_max`=`<iops>` ;;
672 Maximum unthrottled write I/O pool in operations per second.
674 `iops_wr_max_length`=`<seconds>` ;;
676 Maximum length of write I/O bursts in seconds.
680 Maximum r/w speed in megabytes per second.
682 `mbps_max`=`<mbps>` ;;
684 Maximum unthrottled r/w pool in megabytes per second.
686 `mbps_rd`=`<mbps>` ;;
688 Maximum read speed in megabytes per second.
690 `mbps_rd_max`=`<mbps>` ;;
692 Maximum unthrottled read pool in megabytes per second.
694 `mbps_wr`=`<mbps>` ;;
696 Maximum write speed in megabytes per second.
698 `mbps_wr_max`=`<mbps>` ;;
700 Maximum unthrottled write pool in megabytes per second.
702 `media`=`<cdrom | disk>` ('default =' `disk`);;
704 The drive's media type.
706 `replicate`=`<boolean>` ('default =' `1`);;
708 Whether the drive should considered for replication jobs.
710 `rerror`=`<ignore | report | stop>` ;;
714 `secs`=`<integer>` ;;
716 Force the drive's physical geometry to have a specific sector count.
718 `serial`=`<serial>` ;;
720 The drive's reported serial number, url-encoded, up to 20 bytes long.
722 `shared`=`<boolean>` ('default =' `0`);;
724 Mark this locally-managed volume as available on all nodes.
726 WARNING: This option does not share the volume automatically, it assumes it is shared already!
728 `size`=`<DiskSize>` ;;
730 Disk size. This is purely informational and has no effect.
732 `snapshot`=`<boolean>` ;;
734 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
738 Whether to expose this drive as an SSD, rather than a rotational hard disk.
740 `trans`=`<auto | lba | none>` ;;
742 Force disk geometry bios translation mode.
744 `werror`=`<enospc | ignore | report | stop>` ;;
750 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
752 `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>] [,wwn=<wwn>]` ::
754 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
756 `aio`=`<native | threads>` ;;
760 `backup`=`<boolean>` ;;
762 Whether the drive should be included when making backups.
766 Maximum r/w speed in bytes per second.
768 `bps_max_length`=`<seconds>` ;;
770 Maximum length of I/O bursts in seconds.
774 Maximum read speed in bytes per second.
776 `bps_rd_max_length`=`<seconds>` ;;
778 Maximum length of read I/O bursts in seconds.
782 Maximum write speed in bytes per second.
784 `bps_wr_max_length`=`<seconds>` ;;
786 Maximum length of write I/O bursts in seconds.
788 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
790 The drive's cache mode
792 `cyls`=`<integer>` ;;
794 Force the drive's physical geometry to have a specific cylinder count.
796 `detect_zeroes`=`<boolean>` ;;
798 Controls whether to detect and try to optimize writes of zeroes.
800 `discard`=`<ignore | on>` ;;
802 Controls whether to pass discard/trim requests to the underlying storage.
806 The drive's backing volume.
808 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
810 The drive's backing file's data format.
812 `heads`=`<integer>` ;;
814 Force the drive's physical geometry to have a specific head count.
818 Maximum r/w I/O in operations per second.
820 `iops_max`=`<iops>` ;;
822 Maximum unthrottled r/w I/O pool in operations per second.
824 `iops_max_length`=`<seconds>` ;;
826 Maximum length of I/O bursts in seconds.
828 `iops_rd`=`<iops>` ;;
830 Maximum read I/O in operations per second.
832 `iops_rd_max`=`<iops>` ;;
834 Maximum unthrottled read I/O pool in operations per second.
836 `iops_rd_max_length`=`<seconds>` ;;
838 Maximum length of read I/O bursts in seconds.
840 `iops_wr`=`<iops>` ;;
842 Maximum write I/O in operations per second.
844 `iops_wr_max`=`<iops>` ;;
846 Maximum unthrottled write I/O pool in operations per second.
848 `iops_wr_max_length`=`<seconds>` ;;
850 Maximum length of write I/O bursts in seconds.
852 `iothread`=`<boolean>` ;;
854 Whether to use iothreads for this drive
858 Maximum r/w speed in megabytes per second.
860 `mbps_max`=`<mbps>` ;;
862 Maximum unthrottled r/w pool in megabytes per second.
864 `mbps_rd`=`<mbps>` ;;
866 Maximum read speed in megabytes per second.
868 `mbps_rd_max`=`<mbps>` ;;
870 Maximum unthrottled read pool in megabytes per second.
872 `mbps_wr`=`<mbps>` ;;
874 Maximum write speed in megabytes per second.
876 `mbps_wr_max`=`<mbps>` ;;
878 Maximum unthrottled write pool in megabytes per second.
880 `media`=`<cdrom | disk>` ('default =' `disk`);;
882 The drive's media type.
884 `queues`=`<integer> (2 - N)` ;;
888 `replicate`=`<boolean>` ('default =' `1`);;
890 Whether the drive should considered for replication jobs.
892 `rerror`=`<ignore | report | stop>` ;;
896 `scsiblock`=`<boolean>` ('default =' `0`);;
898 whether to use scsi-block for full passthrough of host block device
900 WARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host
902 `secs`=`<integer>` ;;
904 Force the drive's physical geometry to have a specific sector count.
906 `serial`=`<serial>` ;;
908 The drive's reported serial number, url-encoded, up to 20 bytes long.
910 `shared`=`<boolean>` ('default =' `0`);;
912 Mark this locally-managed volume as available on all nodes.
914 WARNING: This option does not share the volume automatically, it assumes it is shared already!
916 `size`=`<DiskSize>` ;;
918 Disk size. This is purely informational and has no effect.
920 `snapshot`=`<boolean>` ;;
922 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
926 Whether to expose this drive as an SSD, rather than a rotational hard disk.
928 `trans`=`<auto | lba | none>` ;;
930 Force disk geometry bios translation mode.
932 `werror`=`<enospc | ignore | report | stop>` ;;
938 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
940 `scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
942 SCSI controller model
944 `searchdomain`: `<string>` ::
946 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.
948 `serial[n]`: `(/dev/.+|socket)` ::
950 Create a serial device inside the VM (n is 0 to 3), and pass through a
951 host serial device (i.e. /dev/ttyS0), or create a unix socket on the
952 host side (use 'qm terminal' to open a terminal connection).
954 NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.
956 CAUTION: Experimental! User reported problems with this option.
958 `shares`: `<integer> (0 - 50000)` ('default =' `1000`)::
960 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.
962 `smbios1`: `[base64=<1|0>] [,family=<Base64 encoded string>] [,manufacturer=<Base64 encoded string>] [,product=<Base64 encoded string>] [,serial=<Base64 encoded string>] [,sku=<Base64 encoded string>] [,uuid=<UUID>] [,version=<Base64 encoded string>]` ::
964 Specify SMBIOS type 1 fields.
966 `base64`=`<boolean>` ;;
968 Flag to indicate that the SMBIOS values are base64 encoded
970 `family`=`<Base64 encoded string>` ;;
972 Set SMBIOS1 family string.
974 `manufacturer`=`<Base64 encoded string>` ;;
976 Set SMBIOS1 manufacturer.
978 `product`=`<Base64 encoded string>` ;;
980 Set SMBIOS1 product ID.
982 `serial`=`<Base64 encoded string>` ;;
984 Set SMBIOS1 serial number.
986 `sku`=`<Base64 encoded string>` ;;
988 Set SMBIOS1 SKU string.
994 `version`=`<Base64 encoded string>` ;;
998 `smp`: `<integer> (1 - N)` ('default =' `1`)::
1000 The number of CPUs. Please use option -sockets instead.
1002 `sockets`: `<integer> (1 - N)` ('default =' `1`)::
1004 The number of CPU sockets.
1006 `spice_enhancements`: `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
1008 Configure additional enhancements for SPICE.
1010 `foldersharing`=`<boolean>` ('default =' `0`);;
1012 Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.
1014 `videostreaming`=`<all | filter | off>` ('default =' `off`);;
1016 Enable video streaming. Uses compression for detected video streams.
1018 `sshkeys`: `<string>` ::
1020 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
1022 `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
1024 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'.
1026 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1028 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.
1030 `tablet`: `<boolean>` ('default =' `1`)::
1032 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).
1034 `tdf`: `<boolean>` ('default =' `0`)::
1036 Enable/disable time drift fix.
1038 `template`: `<boolean>` ('default =' `0`)::
1040 Enable/disable Template.
1042 `unused[n]`: `<string>` ::
1044 Reference to unused volumes. This is used internally, and should not be modified manually.
1046 `usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
1048 Configure an USB device (n is 0 to 4).
1050 `host`=`<HOSTUSBDEVICE|spice>` ;;
1052 The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
1054 'bus-port(.port)*' (decimal numbers) or
1055 'vendor_id:product_id' (hexadeciaml numbers) or
1058 You can use the 'lsusb -t' command to list existing usb devices.
1060 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
1062 The value 'spice' can be used to add a usb redirection devices for spice.
1064 `usb3`=`<boolean>` ('default =' `0`);;
1066 Specifies whether if given host option is a USB3 device or port.
1068 `vcpus`: `<integer> (1 - N)` ('default =' `0`)::
1070 Number of hotplugged vcpus.
1072 `vga`: `[[type=]<enum>] [,memory=<integer>]` ::
1074 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.
1075 You can also run without any graphic card, using a serial device as terminal.
1077 `memory`=`<integer> (4 - 512)` ;;
1079 Sets the VGA memory (in MiB). Has no effect with serial display.
1081 `type`=`<cirrus | none | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ('default =' `std`);;
1083 Select the VGA type.
1085 `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>]` ::
1087 Use volume as VIRTIO hard disk (n is 0 to 15).
1089 `aio`=`<native | threads>` ;;
1093 `backup`=`<boolean>` ;;
1095 Whether the drive should be included when making backups.
1099 Maximum r/w speed in bytes per second.
1101 `bps_max_length`=`<seconds>` ;;
1103 Maximum length of I/O bursts in seconds.
1107 Maximum read speed in bytes per second.
1109 `bps_rd_max_length`=`<seconds>` ;;
1111 Maximum length of read I/O bursts in seconds.
1115 Maximum write speed in bytes per second.
1117 `bps_wr_max_length`=`<seconds>` ;;
1119 Maximum length of write I/O bursts in seconds.
1121 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
1123 The drive's cache mode
1125 `cyls`=`<integer>` ;;
1127 Force the drive's physical geometry to have a specific cylinder count.
1129 `detect_zeroes`=`<boolean>` ;;
1131 Controls whether to detect and try to optimize writes of zeroes.
1133 `discard`=`<ignore | on>` ;;
1135 Controls whether to pass discard/trim requests to the underlying storage.
1137 `file`=`<volume>` ;;
1139 The drive's backing volume.
1141 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
1143 The drive's backing file's data format.
1145 `heads`=`<integer>` ;;
1147 Force the drive's physical geometry to have a specific head count.
1151 Maximum r/w I/O in operations per second.
1153 `iops_max`=`<iops>` ;;
1155 Maximum unthrottled r/w I/O pool in operations per second.
1157 `iops_max_length`=`<seconds>` ;;
1159 Maximum length of I/O bursts in seconds.
1161 `iops_rd`=`<iops>` ;;
1163 Maximum read I/O in operations per second.
1165 `iops_rd_max`=`<iops>` ;;
1167 Maximum unthrottled read I/O pool in operations per second.
1169 `iops_rd_max_length`=`<seconds>` ;;
1171 Maximum length of read I/O bursts in seconds.
1173 `iops_wr`=`<iops>` ;;
1175 Maximum write I/O in operations per second.
1177 `iops_wr_max`=`<iops>` ;;
1179 Maximum unthrottled write I/O pool in operations per second.
1181 `iops_wr_max_length`=`<seconds>` ;;
1183 Maximum length of write I/O bursts in seconds.
1185 `iothread`=`<boolean>` ;;
1187 Whether to use iothreads for this drive
1191 Maximum r/w speed in megabytes per second.
1193 `mbps_max`=`<mbps>` ;;
1195 Maximum unthrottled r/w pool in megabytes per second.
1197 `mbps_rd`=`<mbps>` ;;
1199 Maximum read speed in megabytes per second.
1201 `mbps_rd_max`=`<mbps>` ;;
1203 Maximum unthrottled read pool in megabytes per second.
1205 `mbps_wr`=`<mbps>` ;;
1207 Maximum write speed in megabytes per second.
1209 `mbps_wr_max`=`<mbps>` ;;
1211 Maximum unthrottled write pool in megabytes per second.
1213 `media`=`<cdrom | disk>` ('default =' `disk`);;
1215 The drive's media type.
1217 `replicate`=`<boolean>` ('default =' `1`);;
1219 Whether the drive should considered for replication jobs.
1221 `rerror`=`<ignore | report | stop>` ;;
1225 `secs`=`<integer>` ;;
1227 Force the drive's physical geometry to have a specific sector count.
1229 `serial`=`<serial>` ;;
1231 The drive's reported serial number, url-encoded, up to 20 bytes long.
1233 `shared`=`<boolean>` ('default =' `0`);;
1235 Mark this locally-managed volume as available on all nodes.
1237 WARNING: This option does not share the volume automatically, it assumes it is shared already!
1239 `size`=`<DiskSize>` ;;
1241 Disk size. This is purely informational and has no effect.
1243 `snapshot`=`<boolean>` ;;
1245 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
1247 `trans`=`<auto | lba | none>` ;;
1249 Force disk geometry bios translation mode.
1251 `werror`=`<enospc | ignore | report | stop>` ;;
1255 `vmgenid`: `<UUID>` ('default =' `1 (autogenerated)`)::
1257 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.
1258 Note that auto-creation only works when done throug API/CLI create or update methods, but not when manually editing the config file.
1260 `vmstatestorage`: `<string>` ::
1262 Default storage for VM state volumes/files.
1264 `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1266 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)
1268 `action`=`<debug | none | pause | poweroff | reset | shutdown>` ;;
1270 The action to perform if after activation the guest fails to poll the watchdog in time.
1272 `model`=`<i6300esb | ib700>` ('default =' `i6300esb`);;
1274 Watchdog type to emulate.