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.
105 `cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
109 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
111 `cpuunits`: `<integer> (2 - 262144)` ('default =' `1024`)::
113 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.
115 `description`: `<string>` ::
117 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
119 `efidisk0`: `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
121 Configure a Disk for storing EFI vars
125 The drive's backing volume.
127 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
129 The drive's backing file's data format.
131 `size`=`<DiskSize>` ;;
133 Disk size. This is purely informational and has no effect.
135 `freeze`: `<boolean>` ::
137 Freeze CPU at startup (use 'c' monitor command to start execution).
139 `hookscript`: `<string>` ::
141 Script that will be executed during various steps in the vms lifetime.
143 `hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
145 Map host PCI devices into guest.
147 NOTE: This option allows direct access to host hardware. So it is no longer
148 possible to migrate such machines - use with special care.
150 CAUTION: Experimental! User reported problems with this option.
152 `host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
154 Host PCI device pass through. The PCI ID of a host's PCI device or a list
155 of PCI virtual functions of the host. HOSTPCIID syntax is:
157 'bus:dev.func' (hexadecimal numbers)
159 You can us the 'lspci' command to list existing PCI devices.
161 `legacy-igd`=`<boolean>` ('default =' `0`);;
163 Pass this device in legacy IGD mode, making it the primary and exclusive graphics device in the VM. Requires 'pc-i440fx' machine type and VGA set to 'none'.
167 The type of mediated device to use.
168 An instance of this type will be created on startup of the VM and
169 will be cleaned up when the VM stops.
171 `pcie`=`<boolean>` ('default =' `0`);;
173 Choose the PCI-express bus (needs the 'q35' machine model).
175 `rombar`=`<boolean>` ('default =' `1`);;
177 Specify whether or not the device's ROM will be visible in the guest's memory map.
179 `romfile`=`<string>` ;;
181 Custom pci device rom filename (must be located in /usr/share/kvm/).
183 `x-vga`=`<boolean>` ('default =' `0`);;
185 Enable vfio-vga device support.
187 `hotplug`: `<string>` ('default =' `network,disk,usb`)::
189 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'.
191 `hugepages`: `<1024 | 2 | any>` ::
193 Enable/disable hugepages memory.
195 `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>]` ::
197 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
199 `aio`=`<native | threads>` ;;
203 `backup`=`<boolean>` ;;
205 Whether the drive should be included when making backups.
209 Maximum r/w speed in bytes per second.
211 `bps_max_length`=`<seconds>` ;;
213 Maximum length of I/O bursts in seconds.
217 Maximum read speed in bytes per second.
219 `bps_rd_max_length`=`<seconds>` ;;
221 Maximum length of read I/O bursts in seconds.
225 Maximum write speed in bytes per second.
227 `bps_wr_max_length`=`<seconds>` ;;
229 Maximum length of write I/O bursts in seconds.
231 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
233 The drive's cache mode
235 `cyls`=`<integer>` ;;
237 Force the drive's physical geometry to have a specific cylinder count.
239 `detect_zeroes`=`<boolean>` ;;
241 Controls whether to detect and try to optimize writes of zeroes.
243 `discard`=`<ignore | on>` ;;
245 Controls whether to pass discard/trim requests to the underlying storage.
249 The drive's backing volume.
251 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
253 The drive's backing file's data format.
255 `heads`=`<integer>` ;;
257 Force the drive's physical geometry to have a specific head count.
261 Maximum r/w I/O in operations per second.
263 `iops_max`=`<iops>` ;;
265 Maximum unthrottled r/w I/O pool in operations per second.
267 `iops_max_length`=`<seconds>` ;;
269 Maximum length of I/O bursts in seconds.
271 `iops_rd`=`<iops>` ;;
273 Maximum read I/O in operations per second.
275 `iops_rd_max`=`<iops>` ;;
277 Maximum unthrottled read I/O pool in operations per second.
279 `iops_rd_max_length`=`<seconds>` ;;
281 Maximum length of read I/O bursts in seconds.
283 `iops_wr`=`<iops>` ;;
285 Maximum write I/O in operations per second.
287 `iops_wr_max`=`<iops>` ;;
289 Maximum unthrottled write I/O pool in operations per second.
291 `iops_wr_max_length`=`<seconds>` ;;
293 Maximum length of write I/O bursts in seconds.
297 Maximum r/w speed in megabytes per second.
299 `mbps_max`=`<mbps>` ;;
301 Maximum unthrottled r/w pool in megabytes per second.
303 `mbps_rd`=`<mbps>` ;;
305 Maximum read speed in megabytes per second.
307 `mbps_rd_max`=`<mbps>` ;;
309 Maximum unthrottled read pool in megabytes per second.
311 `mbps_wr`=`<mbps>` ;;
313 Maximum write speed in megabytes per second.
315 `mbps_wr_max`=`<mbps>` ;;
317 Maximum unthrottled write pool in megabytes per second.
319 `media`=`<cdrom | disk>` ('default =' `disk`);;
321 The drive's media type.
325 The drive's reported model name, url-encoded, up to 40 bytes long.
327 `replicate`=`<boolean>` ('default =' `1`);;
329 Whether the drive should considered for replication jobs.
331 `rerror`=`<ignore | report | stop>` ;;
335 `secs`=`<integer>` ;;
337 Force the drive's physical geometry to have a specific sector count.
339 `serial`=`<serial>` ;;
341 The drive's reported serial number, url-encoded, up to 20 bytes long.
343 `shared`=`<boolean>` ('default =' `0`);;
345 Mark this locally-managed volume as available on all nodes.
347 WARNING: This option does not share the volume automatically, it assumes it is shared already!
349 `size`=`<DiskSize>` ;;
351 Disk size. This is purely informational and has no effect.
353 `snapshot`=`<boolean>` ;;
355 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
359 Whether to expose this drive as an SSD, rather than a rotational hard disk.
361 `trans`=`<auto | lba | none>` ;;
363 Force disk geometry bios translation mode.
365 `werror`=`<enospc | ignore | report | stop>` ;;
371 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
373 `ipconfig[n]`: `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
375 cloud-init: Specify IP addresses and gateways for the corresponding interface.
377 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
379 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
380 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
382 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
384 `gw`=`<GatewayIPv4>` ;;
386 Default gateway for IPv4 traffic.
388 NOTE: Requires option(s): `ip`
390 `gw6`=`<GatewayIPv6>` ;;
392 Default gateway for IPv6 traffic.
394 NOTE: Requires option(s): `ip6`
396 `ip`=`<IPv4Format/CIDR>` ('default =' `dhcp`);;
398 IPv4 address in CIDR format.
400 `ip6`=`<IPv6Format/CIDR>` ('default =' `dhcp`);;
402 IPv6 address in CIDR format.
404 `ivshmem`: `size=<integer> [,name=<string>]` ::
406 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
410 The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.
412 `size`=`<integer> (1 - N)` ;;
414 The size of the file in MB.
416 `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>` ::
418 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
420 `kvm`: `<boolean>` ('default =' `1`)::
422 Enable/disable KVM hardware virtualization.
424 `localtime`: `<boolean>` ::
426 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
428 `lock`: `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
432 `machine`: `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
434 Specifies the Qemu machine type.
436 `memory`: `<integer> (16 - N)` ('default =' `512`)::
438 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
440 `migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
442 Set maximum tolerated downtime (in seconds) for migrations.
444 `migrate_speed`: `<integer> (0 - N)` ('default =' `0`)::
446 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
448 `name`: `<string>` ::
450 Set a name for the VM. Only used on the configuration web interface.
452 `nameserver`: `<string>` ::
454 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.
456 `net[n]`: `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
458 Specify network devices.
460 `bridge`=`<bridge>` ;;
462 Bridge to attach the network device to. The Proxmox VE standard bridge
465 If you do not specify a bridge, we create a kvm user (NATed) network
466 device, which provides DHCP and DNS services. The following addresses
473 The DHCP server assign addresses to the guest starting from 10.0.2.15.
475 `firewall`=`<boolean>` ;;
477 Whether this interface should be protected by the firewall.
479 `link_down`=`<boolean>` ;;
481 Whether this interface should be disconnected (like pulling the plug).
483 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
485 A common MAC address with the I/G (Individual/Group) bit not set.
487 `model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
489 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'.
491 `mtu`=`<integer> (1 - 65520)` ;;
493 Force MTU, for VirtIO only. Set to '1' to use the bridge MTU
495 `queues`=`<integer> (0 - 16)` ;;
497 Number of packet queues to be used on the device.
499 `rate`=`<number> (0 - N)` ;;
501 Rate limit in mbps (megabytes per second) as floating point number.
503 `tag`=`<integer> (1 - 4094)` ;;
505 VLAN tag to apply to packets on this interface.
507 `trunks`=`<vlanid[;vlanid...]>` ;;
509 VLAN trunks to pass through this interface.
511 `numa`: `<boolean>` ('default =' `0`)::
515 `numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
519 `cpus`=`<id[-id];...>` ;;
521 CPUs accessing this NUMA node.
523 `hostnodes`=`<id[-id];...>` ;;
525 Host NUMA nodes to use.
527 `memory`=`<number>` ;;
529 Amount of memory this NUMA node provides.
531 `policy`=`<bind | interleave | preferred>` ;;
533 NUMA allocation policy.
535 `onboot`: `<boolean>` ('default =' `0`)::
537 Specifies whether a VM will be started during system bootup.
539 `ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
541 Specify guest operating system. This is used to enable special
542 optimization/features for specific operating systems:
545 other;; unspecified OS
546 wxp;; Microsoft Windows XP
547 w2k;; Microsoft Windows 2000
548 w2k3;; Microsoft Windows 2003
549 w2k8;; Microsoft Windows 2008
550 wvista;; Microsoft Windows Vista
551 win7;; Microsoft Windows 7
552 win8;; Microsoft Windows 8/2012/2012r2
553 win10;; Microsoft Windows 10/2016
554 l24;; Linux 2.4 Kernel
555 l26;; Linux 2.6 - 5.X Kernel
556 solaris;; Solaris/OpenSolaris/OpenIndiania kernel
558 `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
560 Map host parallel devices (n is 0 to 2).
562 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
564 CAUTION: Experimental! User reported problems with this option.
566 `protection`: `<boolean>` ('default =' `0`)::
568 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
570 `reboot`: `<boolean>` ('default =' `1`)::
572 Allow reboot. If set to '0' the VM exit on reboot.
574 `rng0`: `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
576 Configure a VirtIO-based Random Number Generator.
578 `max_bytes`=`<integer>` ('default =' `1024`);;
580 Maximum bytes of entropy injected into the guest every 'period' milliseconds. Prefer a lower value when using /dev/random as source. Use 0 to disable limiting (potentially dangerous!).
582 `period`=`<integer>` ('default =' `1000`);;
584 Every 'period' milliseconds the entropy-injection quota is reset, allowing the guest to retrieve another 'max_bytes' of entropy.
586 `source`=`</dev/hwrng | /dev/random | /dev/urandom>` ;;
588 The file on the host to gather entropy from. In most cases /dev/urandom should be preferred over /dev/random to avoid entropy-starvation issues on the host. Using urandom does *not* decrease security in any meaningful way, as it's still seeded from real entropy, and the bytes provided will most likely be mixed with real entropy on the guest as well. /dev/hwrng can be used to pass through a hardware RNG from the host.
590 `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>]` ::
592 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
594 `aio`=`<native | threads>` ;;
598 `backup`=`<boolean>` ;;
600 Whether the drive should be included when making backups.
604 Maximum r/w speed in bytes per second.
606 `bps_max_length`=`<seconds>` ;;
608 Maximum length of I/O bursts in seconds.
612 Maximum read speed in bytes per second.
614 `bps_rd_max_length`=`<seconds>` ;;
616 Maximum length of read I/O bursts in seconds.
620 Maximum write speed in bytes per second.
622 `bps_wr_max_length`=`<seconds>` ;;
624 Maximum length of write I/O bursts in seconds.
626 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
628 The drive's cache mode
630 `cyls`=`<integer>` ;;
632 Force the drive's physical geometry to have a specific cylinder count.
634 `detect_zeroes`=`<boolean>` ;;
636 Controls whether to detect and try to optimize writes of zeroes.
638 `discard`=`<ignore | on>` ;;
640 Controls whether to pass discard/trim requests to the underlying storage.
644 The drive's backing volume.
646 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
648 The drive's backing file's data format.
650 `heads`=`<integer>` ;;
652 Force the drive's physical geometry to have a specific head count.
656 Maximum r/w I/O in operations per second.
658 `iops_max`=`<iops>` ;;
660 Maximum unthrottled r/w I/O pool in operations per second.
662 `iops_max_length`=`<seconds>` ;;
664 Maximum length of I/O bursts in seconds.
666 `iops_rd`=`<iops>` ;;
668 Maximum read I/O in operations per second.
670 `iops_rd_max`=`<iops>` ;;
672 Maximum unthrottled read I/O pool in operations per second.
674 `iops_rd_max_length`=`<seconds>` ;;
676 Maximum length of read I/O bursts in seconds.
678 `iops_wr`=`<iops>` ;;
680 Maximum write I/O in operations per second.
682 `iops_wr_max`=`<iops>` ;;
684 Maximum unthrottled write I/O pool in operations per second.
686 `iops_wr_max_length`=`<seconds>` ;;
688 Maximum length of write I/O bursts in seconds.
692 Maximum r/w speed in megabytes per second.
694 `mbps_max`=`<mbps>` ;;
696 Maximum unthrottled r/w pool in megabytes per second.
698 `mbps_rd`=`<mbps>` ;;
700 Maximum read speed in megabytes per second.
702 `mbps_rd_max`=`<mbps>` ;;
704 Maximum unthrottled read pool in megabytes per second.
706 `mbps_wr`=`<mbps>` ;;
708 Maximum write speed in megabytes per second.
710 `mbps_wr_max`=`<mbps>` ;;
712 Maximum unthrottled write pool in megabytes per second.
714 `media`=`<cdrom | disk>` ('default =' `disk`);;
716 The drive's media type.
718 `replicate`=`<boolean>` ('default =' `1`);;
720 Whether the drive should considered for replication jobs.
722 `rerror`=`<ignore | report | stop>` ;;
726 `secs`=`<integer>` ;;
728 Force the drive's physical geometry to have a specific sector count.
730 `serial`=`<serial>` ;;
732 The drive's reported serial number, url-encoded, up to 20 bytes long.
734 `shared`=`<boolean>` ('default =' `0`);;
736 Mark this locally-managed volume as available on all nodes.
738 WARNING: This option does not share the volume automatically, it assumes it is shared already!
740 `size`=`<DiskSize>` ;;
742 Disk size. This is purely informational and has no effect.
744 `snapshot`=`<boolean>` ;;
746 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
750 Whether to expose this drive as an SSD, rather than a rotational hard disk.
752 `trans`=`<auto | lba | none>` ;;
754 Force disk geometry bios translation mode.
756 `werror`=`<enospc | ignore | report | stop>` ;;
762 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
764 `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>]` ::
766 Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).
768 `aio`=`<native | threads>` ;;
772 `backup`=`<boolean>` ;;
774 Whether the drive should be included when making backups.
778 Maximum r/w speed in bytes per second.
780 `bps_max_length`=`<seconds>` ;;
782 Maximum length of I/O bursts in seconds.
786 Maximum read speed in bytes per second.
788 `bps_rd_max_length`=`<seconds>` ;;
790 Maximum length of read I/O bursts in seconds.
794 Maximum write speed in bytes per second.
796 `bps_wr_max_length`=`<seconds>` ;;
798 Maximum length of write I/O bursts in seconds.
800 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
802 The drive's cache mode
804 `cyls`=`<integer>` ;;
806 Force the drive's physical geometry to have a specific cylinder count.
808 `detect_zeroes`=`<boolean>` ;;
810 Controls whether to detect and try to optimize writes of zeroes.
812 `discard`=`<ignore | on>` ;;
814 Controls whether to pass discard/trim requests to the underlying storage.
818 The drive's backing volume.
820 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
822 The drive's backing file's data format.
824 `heads`=`<integer>` ;;
826 Force the drive's physical geometry to have a specific head count.
830 Maximum r/w I/O in operations per second.
832 `iops_max`=`<iops>` ;;
834 Maximum unthrottled r/w I/O pool in operations per second.
836 `iops_max_length`=`<seconds>` ;;
838 Maximum length of I/O bursts in seconds.
840 `iops_rd`=`<iops>` ;;
842 Maximum read I/O in operations per second.
844 `iops_rd_max`=`<iops>` ;;
846 Maximum unthrottled read I/O pool in operations per second.
848 `iops_rd_max_length`=`<seconds>` ;;
850 Maximum length of read I/O bursts in seconds.
852 `iops_wr`=`<iops>` ;;
854 Maximum write I/O in operations per second.
856 `iops_wr_max`=`<iops>` ;;
858 Maximum unthrottled write I/O pool in operations per second.
860 `iops_wr_max_length`=`<seconds>` ;;
862 Maximum length of write I/O bursts in seconds.
864 `iothread`=`<boolean>` ;;
866 Whether to use iothreads for this drive
870 Maximum r/w speed in megabytes per second.
872 `mbps_max`=`<mbps>` ;;
874 Maximum unthrottled r/w pool in megabytes per second.
876 `mbps_rd`=`<mbps>` ;;
878 Maximum read speed in megabytes per second.
880 `mbps_rd_max`=`<mbps>` ;;
882 Maximum unthrottled read pool in megabytes per second.
884 `mbps_wr`=`<mbps>` ;;
886 Maximum write speed in megabytes per second.
888 `mbps_wr_max`=`<mbps>` ;;
890 Maximum unthrottled write pool in megabytes per second.
892 `media`=`<cdrom | disk>` ('default =' `disk`);;
894 The drive's media type.
896 `queues`=`<integer> (2 - N)` ;;
900 `replicate`=`<boolean>` ('default =' `1`);;
902 Whether the drive should considered for replication jobs.
904 `rerror`=`<ignore | report | stop>` ;;
908 `scsiblock`=`<boolean>` ('default =' `0`);;
910 whether to use scsi-block for full passthrough of host block device
912 WARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host
914 `secs`=`<integer>` ;;
916 Force the drive's physical geometry to have a specific sector count.
918 `serial`=`<serial>` ;;
920 The drive's reported serial number, url-encoded, up to 20 bytes long.
922 `shared`=`<boolean>` ('default =' `0`);;
924 Mark this locally-managed volume as available on all nodes.
926 WARNING: This option does not share the volume automatically, it assumes it is shared already!
928 `size`=`<DiskSize>` ;;
930 Disk size. This is purely informational and has no effect.
932 `snapshot`=`<boolean>` ;;
934 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
938 Whether to expose this drive as an SSD, rather than a rotational hard disk.
940 `trans`=`<auto | lba | none>` ;;
942 Force disk geometry bios translation mode.
944 `werror`=`<enospc | ignore | report | stop>` ;;
950 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
952 `scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
954 SCSI controller model
956 `searchdomain`: `<string>` ::
958 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.
960 `serial[n]`: `(/dev/.+|socket)` ::
962 Create a serial device inside the VM (n is 0 to 3), and pass through a
963 host serial device (i.e. /dev/ttyS0), or create a unix socket on the
964 host side (use 'qm terminal' to open a terminal connection).
966 NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.
968 CAUTION: Experimental! User reported problems with this option.
970 `shares`: `<integer> (0 - 50000)` ('default =' `1000`)::
972 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.
974 `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>]` ::
976 Specify SMBIOS type 1 fields.
978 `base64`=`<boolean>` ;;
980 Flag to indicate that the SMBIOS values are base64 encoded
982 `family`=`<Base64 encoded string>` ;;
984 Set SMBIOS1 family string.
986 `manufacturer`=`<Base64 encoded string>` ;;
988 Set SMBIOS1 manufacturer.
990 `product`=`<Base64 encoded string>` ;;
992 Set SMBIOS1 product ID.
994 `serial`=`<Base64 encoded string>` ;;
996 Set SMBIOS1 serial number.
998 `sku`=`<Base64 encoded string>` ;;
1000 Set SMBIOS1 SKU string.
1006 `version`=`<Base64 encoded string>` ;;
1008 Set SMBIOS1 version.
1010 `smp`: `<integer> (1 - N)` ('default =' `1`)::
1012 The number of CPUs. Please use option -sockets instead.
1014 `sockets`: `<integer> (1 - N)` ('default =' `1`)::
1016 The number of CPU sockets.
1018 `spice_enhancements`: `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
1020 Configure additional enhancements for SPICE.
1022 `foldersharing`=`<boolean>` ('default =' `0`);;
1024 Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.
1026 `videostreaming`=`<all | filter | off>` ('default =' `off`);;
1028 Enable video streaming. Uses compression for detected video streams.
1030 `sshkeys`: `<string>` ::
1032 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
1034 `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
1036 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'.
1038 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1040 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.
1042 `tablet`: `<boolean>` ('default =' `1`)::
1044 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).
1046 `tags`: `<string>` ::
1048 Tags of the VM. This is only meta information.
1050 `tdf`: `<boolean>` ('default =' `0`)::
1052 Enable/disable time drift fix.
1054 `template`: `<boolean>` ('default =' `0`)::
1056 Enable/disable Template.
1058 `unused[n]`: `[file=]<volume>` ::
1060 Reference to unused volumes. This is used internally, and should not be modified manually.
1062 `file`=`<volume>` ;;
1064 The drive's backing volume.
1066 `usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
1068 Configure an USB device (n is 0 to 4).
1070 `host`=`<HOSTUSBDEVICE|spice>` ;;
1072 The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
1074 'bus-port(.port)*' (decimal numbers) or
1075 'vendor_id:product_id' (hexadeciaml numbers) or
1078 You can use the 'lsusb -t' command to list existing usb devices.
1080 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
1082 The value 'spice' can be used to add a usb redirection devices for spice.
1084 `usb3`=`<boolean>` ('default =' `0`);;
1086 Specifies whether if given host option is a USB3 device or port.
1088 `vcpus`: `<integer> (1 - N)` ('default =' `0`)::
1090 Number of hotplugged vcpus.
1092 `vga`: `[[type=]<enum>] [,memory=<integer>]` ::
1094 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.
1095 You can also run without any graphic card, using a serial device as terminal.
1097 `memory`=`<integer> (4 - 512)` ;;
1099 Sets the VGA memory (in MiB). Has no effect with serial display.
1101 `type`=`<cirrus | none | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ('default =' `std`);;
1103 Select the VGA type.
1105 `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>]` ::
1107 Use volume as VIRTIO hard disk (n is 0 to 15).
1109 `aio`=`<native | threads>` ;;
1113 `backup`=`<boolean>` ;;
1115 Whether the drive should be included when making backups.
1119 Maximum r/w speed in bytes per second.
1121 `bps_max_length`=`<seconds>` ;;
1123 Maximum length of I/O bursts in seconds.
1127 Maximum read speed in bytes per second.
1129 `bps_rd_max_length`=`<seconds>` ;;
1131 Maximum length of read I/O bursts in seconds.
1135 Maximum write speed in bytes per second.
1137 `bps_wr_max_length`=`<seconds>` ;;
1139 Maximum length of write I/O bursts in seconds.
1141 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
1143 The drive's cache mode
1145 `cyls`=`<integer>` ;;
1147 Force the drive's physical geometry to have a specific cylinder count.
1149 `detect_zeroes`=`<boolean>` ;;
1151 Controls whether to detect and try to optimize writes of zeroes.
1153 `discard`=`<ignore | on>` ;;
1155 Controls whether to pass discard/trim requests to the underlying storage.
1157 `file`=`<volume>` ;;
1159 The drive's backing volume.
1161 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
1163 The drive's backing file's data format.
1165 `heads`=`<integer>` ;;
1167 Force the drive's physical geometry to have a specific head count.
1171 Maximum r/w I/O in operations per second.
1173 `iops_max`=`<iops>` ;;
1175 Maximum unthrottled r/w I/O pool in operations per second.
1177 `iops_max_length`=`<seconds>` ;;
1179 Maximum length of I/O bursts in seconds.
1181 `iops_rd`=`<iops>` ;;
1183 Maximum read I/O in operations per second.
1185 `iops_rd_max`=`<iops>` ;;
1187 Maximum unthrottled read I/O pool in operations per second.
1189 `iops_rd_max_length`=`<seconds>` ;;
1191 Maximum length of read I/O bursts in seconds.
1193 `iops_wr`=`<iops>` ;;
1195 Maximum write I/O in operations per second.
1197 `iops_wr_max`=`<iops>` ;;
1199 Maximum unthrottled write I/O pool in operations per second.
1201 `iops_wr_max_length`=`<seconds>` ;;
1203 Maximum length of write I/O bursts in seconds.
1205 `iothread`=`<boolean>` ;;
1207 Whether to use iothreads for this drive
1211 Maximum r/w speed in megabytes per second.
1213 `mbps_max`=`<mbps>` ;;
1215 Maximum unthrottled r/w pool in megabytes per second.
1217 `mbps_rd`=`<mbps>` ;;
1219 Maximum read speed in megabytes per second.
1221 `mbps_rd_max`=`<mbps>` ;;
1223 Maximum unthrottled read pool in megabytes per second.
1225 `mbps_wr`=`<mbps>` ;;
1227 Maximum write speed in megabytes per second.
1229 `mbps_wr_max`=`<mbps>` ;;
1231 Maximum unthrottled write pool in megabytes per second.
1233 `media`=`<cdrom | disk>` ('default =' `disk`);;
1235 The drive's media type.
1237 `replicate`=`<boolean>` ('default =' `1`);;
1239 Whether the drive should considered for replication jobs.
1241 `rerror`=`<ignore | report | stop>` ;;
1245 `secs`=`<integer>` ;;
1247 Force the drive's physical geometry to have a specific sector count.
1249 `serial`=`<serial>` ;;
1251 The drive's reported serial number, url-encoded, up to 20 bytes long.
1253 `shared`=`<boolean>` ('default =' `0`);;
1255 Mark this locally-managed volume as available on all nodes.
1257 WARNING: This option does not share the volume automatically, it assumes it is shared already!
1259 `size`=`<DiskSize>` ;;
1261 Disk size. This is purely informational and has no effect.
1263 `snapshot`=`<boolean>` ;;
1265 Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
1267 `trans`=`<auto | lba | none>` ;;
1269 Force disk geometry bios translation mode.
1271 `werror`=`<enospc | ignore | report | stop>` ;;
1275 `vmgenid`: `<UUID>` ('default =' `1 (autogenerated)`)::
1277 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.
1278 Note that auto-creation only works when done throug API/CLI create or update methods, but not when manually editing the config file.
1280 `vmstatestorage`: `<string>` ::
1282 Default storage for VM state volumes/files.
1284 `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1286 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)
1288 `action`=`<debug | none | pause | poweroff | reset | shutdown>` ;;
1290 The action to perform if after activation the guest fails to poll the watchdog in time.
1292 `model`=`<i6300esb | ib700>` ('default =' `i6300esb`);;
1294 Watchdog type to emulate.