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