]> git.proxmox.com Git - pve-docs.git/blame - qm.conf.5-opts.adoc
config: remove reference to preceeding / from content-dirs
[pve-docs.git] / qm.conf.5-opts.adoc
CommitLineData
013dc89f 1`acpi`: `<boolean>` ('default =' `1`)::
6ec3cd20
DM
2
3Enable/disable ACPI.
4
4e7f60c2
TL
5`affinity`: `<string>` ::
6
81a3384d 7List of host cores used to execute guest processes, for example: 0,5,8-11
4e7f60c2 8
9d2e98ed 9`agent`: `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
4d47f125 10
9d2e98ed 11Enable/disable communication with the QEMU Guest Agent and its properties.
4d47f125
TL
12
13`enabled`=`<boolean>` ('default =' `0`);;
6ec3cd20 14
9d2e98ed
TL
15Enable/disable communication with a QEMU Guest Agent (QGA) running in the VM.
16
17`freeze-fs-on-backup`=`<boolean>` ('default =' `1`);;
18
19Freeze/thaw guest filesystems on backup for consistency.
6ec3cd20 20
4d47f125
TL
21`fstrim_cloned_disks`=`<boolean>` ('default =' `0`);;
22
d2656385 23Run fstrim after moving a disk or migrating the VM.
4d47f125 24
5c1699e5
TL
25`type`=`<isa | virtio>` ('default =' `virtio`);;
26
27Select the agent type
28
e2d681b3
TL
29`arch`: `<aarch64 | x86_64>` ::
30
31Virtual processor architecture. Defaults to the host.
32
013dc89f 33`args`: `<string>` ::
6ec3cd20 34
04ce4dfa 35Arbitrary arguments passed to kvm, for example:
6ec3cd20
DM
36+
37args: -no-reboot -no-hpet
04ce4dfa
DM
38+
39NOTE: this option is for experts only.
6ec3cd20 40
d2656385 41`audio0`: `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` ::
1c532546
TL
42
43Configure a audio device, useful in combination with QXL/Spice.
44
45`device`=`<AC97 | ich9-intel-hda | intel-hda>` ;;
46
47Configure an audio device.
48
d2656385 49`driver`=`<none | spice>` ('default =' `spice`);;
1c532546
TL
50
51Driver backend for the audio device.
52
013dc89f 53`autostart`: `<boolean>` ('default =' `0`)::
6ec3cd20
DM
54
55Automatic restart after crash (currently ignored).
56
013dc89f 57`balloon`: `<integer> (0 - N)` ::
6ec3cd20 58
9d2e98ed 59Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.
6ec3cd20 60
013dc89f 61`bios`: `<ovmf | seabios>` ('default =' `seabios`)::
6ec3cd20
DM
62
63Select BIOS implementation.
64
4772952b 65`boot`: `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
6ec3cd20 66
5370fa8c 67Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.
4772952b
TL
68
69`legacy`=`<[acdn]{1,4}>` ('default =' `cdn`);;
70
71Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). Deprecated, use 'order=' instead.
72
73`order`=`<device[;device...]>` ;;
74
75The guest will attempt to boot from devices in the order they appear here.
76+
77Disks, optical drives and passed-through storage USB devices will be directly
78booted from, NICs will load PXE, and PCIe devices will either behave like disks
79(e.g. NVMe) or load an option ROM (e.g. RAID controller, hardware NIC).
80+
81Note that only devices in this list will be marked as bootable and thus loaded
82by the guest firmware (BIOS/UEFI). If you require multiple disks for booting
83(e.g. software-raid), you need to specify all of them here.
84+
85Overrides the deprecated 'legacy=[acdn]*' value when given.
6ec3cd20
DM
86
87`bootdisk`: `(ide|sata|scsi|virtio)\d+` ::
88
4772952b 89Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.
6ec3cd20 90
013dc89f 91`cdrom`: `<volume>` ::
6ec3cd20
DM
92
93This is an alias for option -ide2
94
5370fa8c 95`cicustom`: `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` ::
95895385
TL
96
97cloud-init: Specify custom files to replace the automatically generated ones at start.
98
99`meta`=`<volume>` ;;
100
4772952b
TL
101Specify a custom file containing all meta data passed to the VM via"
102 ." cloud-init. This is provider specific meaning configdrive2 and nocloud differ.
95895385
TL
103
104`network`=`<volume>` ;;
105
9d2e98ed 106To pass a custom file containing all network data to the VM via cloud-init.
95895385
TL
107
108`user`=`<volume>` ;;
109
9d2e98ed 110To pass a custom file containing all user data to the VM via cloud-init.
95895385 111
5370fa8c
TL
112`vendor`=`<volume>` ;;
113
9d2e98ed 114To pass a custom file containing all vendor data to the VM via cloud-init.
5370fa8c 115
27a7acb2
DM
116`cipassword`: `<string>` ::
117
118cloud-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.
119
d2656385 120`citype`: `<configdrive2 | nocloud | opennebula>` ::
27a7acb2
DM
121
122Specifies 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.
123
124`ciuser`: `<string>` ::
125
126cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
127
013dc89f 128`cores`: `<integer> (1 - N)` ('default =' `1`)::
6ec3cd20
DM
129
130The number of cores per socket.
131
04d22a9f 132`cpu`: `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
6ec3cd20
DM
133
134Emulated CPU type.
135
04d22a9f
TL
136`cputype`=`<string>` ('default =' `kvm64`);;
137
138Emulated CPU type. Can be default or custom name (custom model names must be prefixed with 'custom-').
139
140`flags`=`<+FLAG[;-FLAG...]>` ;;
141
7af2edf9 142List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes
04d22a9f
TL
143
144`hidden`=`<boolean>` ('default =' `0`);;
145
146Do not identify as a KVM virtual machine.
147
148`hv-vendor-id`=`<vendor-id>` ;;
149
150The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.
151
152`phys-bits`=`<8-64|host>` ;;
153
154The physical memory address bits that are reported to the guest OS. Should be smaller or equal to the host's. Set to 'host' to use value from host CPU, but note that doing so will break live migration to CPUs with other values.
155
de786b48 156`reported-model`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Cascadelake-Server | Cascadelake-Server-noTSX | Conroe | EPYC | EPYC-IBPB | EPYC-Milan | EPYC-Rome | Haswell | Haswell-IBRS | Haswell-noTSX | Haswell-noTSX-IBRS | Icelake-Client | Icelake-Client-noTSX | Icelake-Server | Icelake-Server-noTSX | 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-Client-noTSX-IBRS | Skylake-Server | Skylake-Server-IBRS | Skylake-Server-noTSX-IBRS | Westmere | Westmere-IBRS | athlon | core2duo | coreduo | host | kvm32 | kvm64 | max | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64>` ('default =' `kvm64`);;
04d22a9f
TL
157
158CPU model and vendor to report to the guest. Must be a QEMU/KVM supported model. Only valid for custom CPU model definitions, default models will always report themselves to the guest OS.
159
013dc89f 160`cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
6ec3cd20
DM
161
162Limit of CPU usage.
163+
c2993fe5 164NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
6ec3cd20 165
7af2edf9 166`cpuunits`: `<integer> (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
6ec3cd20 167
c2993fe5 168CPU 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.
6ec3cd20 169
013dc89f 170`description`: `<string>` ::
6ec3cd20 171
8f4d9c87 172Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.
6ec3cd20 173
5370fa8c 174`efidisk0`: `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` ::
2c0dde61 175
9d2e98ed 176Configure a disk for storing EFI vars.
2c0dde61 177
5370fa8c
TL
178`efitype`=`<2m | 4m>` ('default =' `2m`);;
179
9d2e98ed 180Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified. Ignored for VMs with arch=aarc64 (ARM).
5370fa8c 181
2c0dde61
DM
182`file`=`<volume>` ;;
183
184The drive's backing volume.
185
013dc89f 186`format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
2c0dde61
DM
187
188The drive's backing file's data format.
189
5370fa8c
TL
190`pre-enrolled-keys`=`<boolean>` ('default =' `0`);;
191
192Use am EFI vars template with distribution-specific and Microsoft Standard keys enrolled, if used with 'efitype=4m'. Note that this will enable Secure Boot by default, though it can still be turned off from within the VM.
193
2c0dde61
DM
194`size`=`<DiskSize>` ;;
195
196Disk size. This is purely informational and has no effect.
197
013dc89f 198`freeze`: `<boolean>` ::
6ec3cd20
DM
199
200Freeze CPU at startup (use 'c' monitor command to start execution).
201
5f26e15b
TL
202`hookscript`: `<string>` ::
203
204Script that will be executed during various steps in the vms lifetime.
205
7af2edf9 206`hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,device-id=<hex id>] [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,sub-device-id=<hex id>] [,sub-vendor-id=<hex id>] [,vendor-id=<hex id>] [,x-vga=<1|0>]` ::
6ec3cd20 207
c2993fe5 208Map host PCI devices into guest.
57b78691 209+
bb4c8cf8 210NOTE: This option allows direct access to host hardware. So it is no longer
57b78691
DM
211possible to migrate such machines - use with special care.
212+
213CAUTION: Experimental! User reported problems with this option.
c2993fe5 214
7af2edf9
TL
215`device-id`=`<hex id>` ;;
216
217Override PCI device ID visible to guest
218
c2993fe5
DM
219`host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
220
bb4c8cf8 221Host PCI device pass through. The PCI ID of a host's PCI device or a list
c2993fe5 222of PCI virtual functions of the host. HOSTPCIID syntax is:
6ec3cd20
DM
223+
224'bus:dev.func' (hexadecimal numbers)
225+
c2993fe5 226You can us the 'lspci' command to list existing PCI devices.
c2993fe5 227
ac70d7d1
TL
228`legacy-igd`=`<boolean>` ('default =' `0`);;
229
230Pass 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'.
231
e2d681b3
TL
232`mdev`=`<string>` ;;
233
234The type of mediated device to use.
235An instance of this type will be created on startup of the VM and
236will be cleaned up when the VM stops.
237
013dc89f 238`pcie`=`<boolean>` ('default =' `0`);;
c2993fe5
DM
239
240Choose the PCI-express bus (needs the 'q35' machine model).
241
013dc89f 242`rombar`=`<boolean>` ('default =' `1`);;
c2993fe5
DM
243
244Specify whether or not the device's ROM will be visible in the guest's memory map.
245
52e44c50
FG
246`romfile`=`<string>` ;;
247
248Custom pci device rom filename (must be located in /usr/share/kvm/).
249
7af2edf9
TL
250`sub-device-id`=`<hex id>` ;;
251
252Override PCI subsystem device ID visible to guest
253
254`sub-vendor-id`=`<hex id>` ;;
255
256Override PCI subsystem vendor ID visible to guest
257
258`vendor-id`=`<hex id>` ;;
259
260Override PCI vendor ID visible to guest
261
013dc89f 262`x-vga`=`<boolean>` ('default =' `0`);;
c2993fe5
DM
263
264Enable vfio-vga device support.
6ec3cd20 265
013dc89f 266`hotplug`: `<string>` ('default =' `network,disk,usb`)::
6ec3cd20 267
4e7f60c2 268Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.
6ec3cd20 269
013dc89f 270`hugepages`: `<1024 | 2 | any>` ::
2c0dde61
DM
271
272Enable/disable hugepages memory.
273
8f4d9c87 274`ide[n]`: `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>]` ::
6ec3cd20 275
7af2edf9 276Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
6ec3cd20 277
8f4d9c87 278`aio`=`<io_uring | native | threads>` ;;
c2993fe5
DM
279
280AIO type to use.
281
013dc89f 282`backup`=`<boolean>` ;;
c2993fe5
DM
283
284Whether the drive should be included when making backups.
285
286`bps`=`<bps>` ;;
287
de0983cb
DM
288Maximum r/w speed in bytes per second.
289
290`bps_max_length`=`<seconds>` ;;
291
292Maximum length of I/O bursts in seconds.
c2993fe5
DM
293
294`bps_rd`=`<bps>` ;;
295
de0983cb
DM
296Maximum read speed in bytes per second.
297
5d9c884c 298`bps_rd_max_length`=`<seconds>` ;;
de0983cb
DM
299
300Maximum length of read I/O bursts in seconds.
c2993fe5
DM
301
302`bps_wr`=`<bps>` ;;
303
de0983cb
DM
304Maximum write speed in bytes per second.
305
5d9c884c 306`bps_wr_max_length`=`<seconds>` ;;
de0983cb
DM
307
308Maximum length of write I/O bursts in seconds.
c2993fe5 309
013dc89f 310`cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
c2993fe5
DM
311
312The drive's cache mode
313
013dc89f 314`cyls`=`<integer>` ;;
c2993fe5
DM
315
316Force the drive's physical geometry to have a specific cylinder count.
317
013dc89f 318`detect_zeroes`=`<boolean>` ;;
c2993fe5
DM
319
320Controls whether to detect and try to optimize writes of zeroes.
321
013dc89f 322`discard`=`<ignore | on>` ;;
c2993fe5
DM
323
324Controls whether to pass discard/trim requests to the underlying storage.
325
326`file`=`<volume>` ;;
327
328The drive's backing volume.
329
013dc89f 330`format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
c2993fe5
DM
331
332The drive's backing file's data format.
333
013dc89f 334`heads`=`<integer>` ;;
c2993fe5
DM
335
336Force the drive's physical geometry to have a specific head count.
337
338`iops`=`<iops>` ;;
339
de0983cb 340Maximum r/w I/O in operations per second.
c2993fe5
DM
341
342`iops_max`=`<iops>` ;;
343
de0983cb
DM
344Maximum unthrottled r/w I/O pool in operations per second.
345
346`iops_max_length`=`<seconds>` ;;
347
348Maximum length of I/O bursts in seconds.
c2993fe5
DM
349
350`iops_rd`=`<iops>` ;;
351
de0983cb
DM
352Maximum read I/O in operations per second.
353
c2993fe5
DM
354`iops_rd_max`=`<iops>` ;;
355
de0983cb 356Maximum unthrottled read I/O pool in operations per second.
c2993fe5 357
5d9c884c 358`iops_rd_max_length`=`<seconds>` ;;
c2993fe5 359
5d9c884c 360Maximum length of read I/O bursts in seconds.
de0983cb 361
5d9c884c 362`iops_wr`=`<iops>` ;;
de0983cb 363
5d9c884c 364Maximum write I/O in operations per second.
c2993fe5
DM
365
366`iops_wr_max`=`<iops>` ;;
367
de0983cb 368Maximum unthrottled write I/O pool in operations per second.
c2993fe5 369
5d9c884c
DM
370`iops_wr_max_length`=`<seconds>` ;;
371
372Maximum length of write I/O bursts in seconds.
373
c2993fe5
DM
374`mbps`=`<mbps>` ;;
375
de0983cb 376Maximum r/w speed in megabytes per second.
c2993fe5
DM
377
378`mbps_max`=`<mbps>` ;;
379
de0983cb 380Maximum unthrottled r/w pool in megabytes per second.
c2993fe5
DM
381
382`mbps_rd`=`<mbps>` ;;
383
de0983cb 384Maximum read speed in megabytes per second.
c2993fe5
DM
385
386`mbps_rd_max`=`<mbps>` ;;
387
de0983cb 388Maximum unthrottled read pool in megabytes per second.
c2993fe5
DM
389
390`mbps_wr`=`<mbps>` ;;
391
de0983cb 392Maximum write speed in megabytes per second.
c2993fe5
DM
393
394`mbps_wr_max`=`<mbps>` ;;
395
de0983cb 396Maximum unthrottled write pool in megabytes per second.
c2993fe5 397
013dc89f 398`media`=`<cdrom | disk>` ('default =' `disk`);;
c2993fe5
DM
399
400The drive's media type.
401
402`model`=`<model>` ;;
403
404The drive's reported model name, url-encoded, up to 40 bytes long.
405
5d9c884c
DM
406`replicate`=`<boolean>` ('default =' `1`);;
407
408Whether the drive should considered for replication jobs.
409
013dc89f 410`rerror`=`<ignore | report | stop>` ;;
c2993fe5
DM
411
412Read error action.
413
013dc89f 414`secs`=`<integer>` ;;
c2993fe5
DM
415
416Force the drive's physical geometry to have a specific sector count.
417
418`serial`=`<serial>` ;;
419
420The drive's reported serial number, url-encoded, up to 20 bytes long.
421
27a7acb2
DM
422`shared`=`<boolean>` ('default =' `0`);;
423
424Mark this locally-managed volume as available on all nodes.
425+
426WARNING: This option does not share the volume automatically, it assumes it is shared already!
427
c2993fe5
DM
428`size`=`<DiskSize>` ;;
429
430Disk size. This is purely informational and has no effect.
431
013dc89f 432`snapshot`=`<boolean>` ;;
c2993fe5 433
27a7acb2 434Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
c2993fe5 435
25203dc1
NC
436`ssd`=`<boolean>` ;;
437
438Whether to expose this drive as an SSD, rather than a rotational hard disk.
439
013dc89f 440`trans`=`<auto | lba | none>` ;;
c2993fe5
DM
441
442Force disk geometry bios translation mode.
443
013dc89f 444`werror`=`<enospc | ignore | report | stop>` ;;
c2993fe5
DM
445
446Write error action.
447
95895385
TL
448`wwn`=`<wwn>` ;;
449
450The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
451
27a7acb2
DM
452`ipconfig[n]`: `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
453
454cloud-init: Specify IP addresses and gateways for the corresponding interface.
455+
456IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
457+
4772952b
TL
458The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
459gateway should be provided.
d2656385
TL
460For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
461cloud-init 19.4 or newer.
27a7acb2 462+
4772952b
TL
463If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
464dhcp on IPv4.
27a7acb2
DM
465
466`gw`=`<GatewayIPv4>` ;;
467
468Default gateway for IPv4 traffic.
469+
470NOTE: Requires option(s): `ip`
471
472`gw6`=`<GatewayIPv6>` ;;
473
474Default gateway for IPv6 traffic.
475+
476NOTE: Requires option(s): `ip6`
477
478`ip`=`<IPv4Format/CIDR>` ('default =' `dhcp`);;
479
480IPv4 address in CIDR format.
481
482`ip6`=`<IPv6Format/CIDR>` ('default =' `dhcp`);;
483
484IPv6 address in CIDR format.
485
95895385
TL
486`ivshmem`: `size=<integer> [,name=<string>]` ::
487
488Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
489
490`name`=`<string>` ;;
491
492The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.
493
494`size`=`<integer> (1 - N)` ;;
495
496The size of the file in MB.
497
4772952b
TL
498`keephugepages`: `<boolean>` ('default =' `0`)::
499
500Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
501
35a75dd3 502`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>` ::
6ec3cd20 503
7af2edf9 504Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS.
6ec3cd20 505
013dc89f 506`kvm`: `<boolean>` ('default =' `1`)::
6ec3cd20
DM
507
508Enable/disable KVM hardware virtualization.
509
013dc89f 510`localtime`: `<boolean>` ::
6ec3cd20 511
5370fa8c 512Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.
6ec3cd20 513
95895385 514`lock`: `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
6ec3cd20
DM
515
516Lock/unlock the VM.
517
5c1699e5 518`machine`: `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
6ec3cd20 519
9d2e98ed 520Specifies the QEMU machine type.
6ec3cd20 521
013dc89f 522`memory`: `<integer> (16 - N)` ('default =' `512`)::
6ec3cd20 523
9d2e98ed 524Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.
6ec3cd20 525
013dc89f 526`migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
6ec3cd20
DM
527
528Set maximum tolerated downtime (in seconds) for migrations.
529
013dc89f 530`migrate_speed`: `<integer> (0 - N)` ('default =' `0`)::
6ec3cd20
DM
531
532Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
533
013dc89f 534`name`: `<string>` ::
6ec3cd20
DM
535
536Set a name for the VM. Only used on the configuration web interface.
537
27a7acb2
DM
538`nameserver`: `<string>` ::
539
de786b48 540cloud-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.
27a7acb2 541
ac70d7d1 542`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>]` ::
6ec3cd20
DM
543
544Specify network devices.
c2993fe5
DM
545
546`bridge`=`<bridge>` ;;
547
548Bridge to attach the network device to. The Proxmox VE standard bridge
549is called 'vmbr0'.
6ec3cd20 550+
c2993fe5
DM
551If you do not specify a bridge, we create a kvm user (NATed) network
552device, which provides DHCP and DNS services. The following addresses
553are used:
6ec3cd20 554+
c2993fe5
DM
555 10.0.2.2 Gateway
556 10.0.2.3 DNS Server
557 10.0.2.4 SMB Server
6ec3cd20
DM
558+
559The DHCP server assign addresses to the guest starting from 10.0.2.15.
560
013dc89f 561`firewall`=`<boolean>` ;;
c2993fe5
DM
562
563Whether this interface should be protected by the firewall.
564
013dc89f 565`link_down`=`<boolean>` ;;
c2993fe5
DM
566
567Whether this interface should be disconnected (like pulling the plug).
568
569`macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
570
95895385 571A common MAC address with the I/G (Individual/Group) bit not set.
c2993fe5 572
5370fa8c 573`model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | e1000e | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
c2993fe5
DM
574
575Network 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'.
576
ac70d7d1
TL
577`mtu`=`<integer> (1 - 65520)` ;;
578
579Force MTU, for VirtIO only. Set to '1' to use the bridge MTU
580
81a3384d 581`queues`=`<integer> (0 - 64)` ;;
c2993fe5
DM
582
583Number of packet queues to be used on the device.
584
013dc89f 585`rate`=`<number> (0 - N)` ;;
c2993fe5
DM
586
587Rate limit in mbps (megabytes per second) as floating point number.
588
013dc89f 589`tag`=`<integer> (1 - 4094)` ;;
c2993fe5
DM
590
591VLAN tag to apply to packets on this interface.
592
593`trunks`=`<vlanid[;vlanid...]>` ;;
594
595VLAN trunks to pass through this interface.
596
013dc89f 597`numa`: `<boolean>` ('default =' `0`)::
6ec3cd20
DM
598
599Enable/disable NUMA.
600
f004f5b9 601`numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
6ec3cd20 602
c2993fe5
DM
603NUMA topology.
604
605`cpus`=`<id[-id];...>` ;;
606
607CPUs accessing this NUMA node.
608
609`hostnodes`=`<id[-id];...>` ;;
610
611Host NUMA nodes to use.
612
013dc89f 613`memory`=`<number>` ;;
c2993fe5
DM
614
615Amount of memory this NUMA node provides.
616
013dc89f 617`policy`=`<bind | interleave | preferred>` ;;
c2993fe5
DM
618
619NUMA allocation policy.
6ec3cd20 620
013dc89f 621`onboot`: `<boolean>` ('default =' `0`)::
6ec3cd20
DM
622
623Specifies whether a VM will be started during system bootup.
624
5370fa8c 625`ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` ::
6ec3cd20 626
c2993fe5
DM
627Specify guest operating system. This is used to enable special
628optimization/features for specific operating systems:
6ec3cd20 629+
c2993fe5
DM
630[horizontal]
631other;; unspecified OS
632wxp;; Microsoft Windows XP
633w2k;; Microsoft Windows 2000
634w2k3;; Microsoft Windows 2003
635w2k8;; Microsoft Windows 2008
636wvista;; Microsoft Windows Vista
637win7;; Microsoft Windows 7
35a75dd3 638win8;; Microsoft Windows 8/2012/2012r2
d2656385 639win10;; Microsoft Windows 10/2016/2019
5370fa8c 640win11;; Microsoft Windows 11/2022
c2993fe5 641l24;; Linux 2.4 Kernel
9d2e98ed 642l26;; Linux 2.6 - 6.X Kernel
c2993fe5 643solaris;; Solaris/OpenSolaris/OpenIndiania kernel
6ec3cd20
DM
644
645`parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
646
647Map host parallel devices (n is 0 to 2).
648+
4772952b
TL
649NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such
650machines - use with special care.
6ec3cd20 651+
c2993fe5 652CAUTION: Experimental! User reported problems with this option.
6ec3cd20 653
013dc89f 654`protection`: `<boolean>` ('default =' `0`)::
6ec3cd20 655
c2993fe5 656Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
6ec3cd20 657
013dc89f 658`reboot`: `<boolean>` ('default =' `1`)::
6ec3cd20
DM
659
660Allow reboot. If set to '0' the VM exit on reboot.
661
c5aa7e14
TL
662`rng0`: `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
663
664Configure a VirtIO-based Random Number Generator.
665
666`max_bytes`=`<integer>` ('default =' `1024`);;
667
5370fa8c 668Maximum bytes of entropy allowed to get injected into the guest every 'period' milliseconds. Prefer a lower value when using '/dev/random' as source. Use `0` to disable limiting (potentially dangerous!).
c5aa7e14
TL
669
670`period`=`<integer>` ('default =' `1000`);;
671
672Every 'period' milliseconds the entropy-injection quota is reset, allowing the guest to retrieve another 'max_bytes' of entropy.
673
674`source`=`</dev/hwrng | /dev/random | /dev/urandom>` ;;
675
5370fa8c 676The 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.
c5aa7e14 677
8f4d9c87 678`sata[n]`: `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>]` ::
6ec3cd20 679
7af2edf9 680Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
6ec3cd20 681
8f4d9c87 682`aio`=`<io_uring | native | threads>` ;;
c2993fe5
DM
683
684AIO type to use.
685
013dc89f 686`backup`=`<boolean>` ;;
c2993fe5
DM
687
688Whether the drive should be included when making backups.
689
690`bps`=`<bps>` ;;
691
de0983cb
DM
692Maximum r/w speed in bytes per second.
693
694`bps_max_length`=`<seconds>` ;;
695
696Maximum length of I/O bursts in seconds.
c2993fe5
DM
697
698`bps_rd`=`<bps>` ;;
699
de0983cb
DM
700Maximum read speed in bytes per second.
701
5d9c884c 702`bps_rd_max_length`=`<seconds>` ;;
de0983cb
DM
703
704Maximum length of read I/O bursts in seconds.
c2993fe5
DM
705
706`bps_wr`=`<bps>` ;;
707
de0983cb
DM
708Maximum write speed in bytes per second.
709
5d9c884c 710`bps_wr_max_length`=`<seconds>` ;;
de0983cb
DM
711
712Maximum length of write I/O bursts in seconds.
c2993fe5 713
013dc89f 714`cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
c2993fe5
DM
715
716The drive's cache mode
717
013dc89f 718`cyls`=`<integer>` ;;
c2993fe5
DM
719
720Force the drive's physical geometry to have a specific cylinder count.
721
013dc89f 722`detect_zeroes`=`<boolean>` ;;
c2993fe5
DM
723
724Controls whether to detect and try to optimize writes of zeroes.
725
013dc89f 726`discard`=`<ignore | on>` ;;
c2993fe5
DM
727
728Controls whether to pass discard/trim requests to the underlying storage.
729
730`file`=`<volume>` ;;
731
732The drive's backing volume.
733
013dc89f 734`format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
c2993fe5
DM
735
736The drive's backing file's data format.
737
013dc89f 738`heads`=`<integer>` ;;
c2993fe5
DM
739
740Force the drive's physical geometry to have a specific head count.
741
742`iops`=`<iops>` ;;
743
de0983cb 744Maximum r/w I/O in operations per second.
c2993fe5
DM
745
746`iops_max`=`<iops>` ;;
747
de0983cb
DM
748Maximum unthrottled r/w I/O pool in operations per second.
749
750`iops_max_length`=`<seconds>` ;;
751
752Maximum length of I/O bursts in seconds.
c2993fe5
DM
753
754`iops_rd`=`<iops>` ;;
755
de0983cb
DM
756Maximum read I/O in operations per second.
757
c2993fe5
DM
758`iops_rd_max`=`<iops>` ;;
759
de0983cb 760Maximum unthrottled read I/O pool in operations per second.
c2993fe5 761
5d9c884c 762`iops_rd_max_length`=`<seconds>` ;;
c2993fe5 763
5d9c884c 764Maximum length of read I/O bursts in seconds.
de0983cb 765
5d9c884c 766`iops_wr`=`<iops>` ;;
de0983cb 767
5d9c884c 768Maximum write I/O in operations per second.
c2993fe5
DM
769
770`iops_wr_max`=`<iops>` ;;
771
de0983cb 772Maximum unthrottled write I/O pool in operations per second.
c2993fe5 773
5d9c884c
DM
774`iops_wr_max_length`=`<seconds>` ;;
775
776Maximum length of write I/O bursts in seconds.
777
c2993fe5
DM
778`mbps`=`<mbps>` ;;
779
de0983cb 780Maximum r/w speed in megabytes per second.
c2993fe5
DM
781
782`mbps_max`=`<mbps>` ;;
783
de0983cb 784Maximum unthrottled r/w pool in megabytes per second.
c2993fe5
DM
785
786`mbps_rd`=`<mbps>` ;;
787
de0983cb 788Maximum read speed in megabytes per second.
c2993fe5
DM
789
790`mbps_rd_max`=`<mbps>` ;;
791
de0983cb 792Maximum unthrottled read pool in megabytes per second.
c2993fe5
DM
793
794`mbps_wr`=`<mbps>` ;;
795
de0983cb 796Maximum write speed in megabytes per second.
c2993fe5
DM
797
798`mbps_wr_max`=`<mbps>` ;;
799
de0983cb 800Maximum unthrottled write pool in megabytes per second.
c2993fe5 801
013dc89f 802`media`=`<cdrom | disk>` ('default =' `disk`);;
c2993fe5
DM
803
804The drive's media type.
805
5d9c884c
DM
806`replicate`=`<boolean>` ('default =' `1`);;
807
808Whether the drive should considered for replication jobs.
809
013dc89f 810`rerror`=`<ignore | report | stop>` ;;
c2993fe5
DM
811
812Read error action.
813
013dc89f 814`secs`=`<integer>` ;;
c2993fe5
DM
815
816Force the drive's physical geometry to have a specific sector count.
817
818`serial`=`<serial>` ;;
819
820The drive's reported serial number, url-encoded, up to 20 bytes long.
821
27a7acb2
DM
822`shared`=`<boolean>` ('default =' `0`);;
823
824Mark this locally-managed volume as available on all nodes.
825+
826WARNING: This option does not share the volume automatically, it assumes it is shared already!
827
c2993fe5
DM
828`size`=`<DiskSize>` ;;
829
830Disk size. This is purely informational and has no effect.
831
013dc89f 832`snapshot`=`<boolean>` ;;
c2993fe5 833
27a7acb2 834Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
c2993fe5 835
25203dc1
NC
836`ssd`=`<boolean>` ;;
837
838Whether to expose this drive as an SSD, rather than a rotational hard disk.
839
013dc89f 840`trans`=`<auto | lba | none>` ;;
c2993fe5
DM
841
842Force disk geometry bios translation mode.
843
013dc89f 844`werror`=`<enospc | ignore | report | stop>` ;;
c2993fe5
DM
845
846Write error action.
847
95895385
TL
848`wwn`=`<wwn>` ;;
849
850The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
851
5370fa8c 852`scsi[n]`: `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,ro=<1|0>] [,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>]` ::
6ec3cd20 853
7af2edf9 854Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).
6ec3cd20 855
8f4d9c87 856`aio`=`<io_uring | native | threads>` ;;
c2993fe5
DM
857
858AIO type to use.
859
013dc89f 860`backup`=`<boolean>` ;;
c2993fe5
DM
861
862Whether the drive should be included when making backups.
863
864`bps`=`<bps>` ;;
865
de0983cb
DM
866Maximum r/w speed in bytes per second.
867
868`bps_max_length`=`<seconds>` ;;
869
870Maximum length of I/O bursts in seconds.
c2993fe5
DM
871
872`bps_rd`=`<bps>` ;;
873
de0983cb
DM
874Maximum read speed in bytes per second.
875
5d9c884c 876`bps_rd_max_length`=`<seconds>` ;;
de0983cb
DM
877
878Maximum length of read I/O bursts in seconds.
c2993fe5
DM
879
880`bps_wr`=`<bps>` ;;
881
de0983cb
DM
882Maximum write speed in bytes per second.
883
5d9c884c 884`bps_wr_max_length`=`<seconds>` ;;
de0983cb
DM
885
886Maximum length of write I/O bursts in seconds.
c2993fe5 887
013dc89f 888`cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
c2993fe5
DM
889
890The drive's cache mode
891
013dc89f 892`cyls`=`<integer>` ;;
c2993fe5
DM
893
894Force the drive's physical geometry to have a specific cylinder count.
895
013dc89f 896`detect_zeroes`=`<boolean>` ;;
c2993fe5
DM
897
898Controls whether to detect and try to optimize writes of zeroes.
899
013dc89f 900`discard`=`<ignore | on>` ;;
c2993fe5
DM
901
902Controls whether to pass discard/trim requests to the underlying storage.
903
904`file`=`<volume>` ;;
905
906The drive's backing volume.
907
013dc89f 908`format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
c2993fe5
DM
909
910The drive's backing file's data format.
911
013dc89f 912`heads`=`<integer>` ;;
c2993fe5
DM
913
914Force the drive's physical geometry to have a specific head count.
915
916`iops`=`<iops>` ;;
917
de0983cb 918Maximum r/w I/O in operations per second.
c2993fe5
DM
919
920`iops_max`=`<iops>` ;;
921
de0983cb
DM
922Maximum unthrottled r/w I/O pool in operations per second.
923
924`iops_max_length`=`<seconds>` ;;
925
926Maximum length of I/O bursts in seconds.
c2993fe5
DM
927
928`iops_rd`=`<iops>` ;;
929
de0983cb
DM
930Maximum read I/O in operations per second.
931
c2993fe5
DM
932`iops_rd_max`=`<iops>` ;;
933
de0983cb 934Maximum unthrottled read I/O pool in operations per second.
c2993fe5 935
5d9c884c 936`iops_rd_max_length`=`<seconds>` ;;
c2993fe5 937
5d9c884c 938Maximum length of read I/O bursts in seconds.
de0983cb 939
5d9c884c 940`iops_wr`=`<iops>` ;;
de0983cb 941
5d9c884c 942Maximum write I/O in operations per second.
c2993fe5
DM
943
944`iops_wr_max`=`<iops>` ;;
945
de0983cb 946Maximum unthrottled write I/O pool in operations per second.
c2993fe5 947
5d9c884c
DM
948`iops_wr_max_length`=`<seconds>` ;;
949
950Maximum length of write I/O bursts in seconds.
951
013dc89f 952`iothread`=`<boolean>` ;;
c2993fe5
DM
953
954Whether to use iothreads for this drive
955
956`mbps`=`<mbps>` ;;
957
de0983cb 958Maximum r/w speed in megabytes per second.
c2993fe5
DM
959
960`mbps_max`=`<mbps>` ;;
961
de0983cb 962Maximum unthrottled r/w pool in megabytes per second.
c2993fe5
DM
963
964`mbps_rd`=`<mbps>` ;;
965
de0983cb 966Maximum read speed in megabytes per second.
c2993fe5
DM
967
968`mbps_rd_max`=`<mbps>` ;;
969
de0983cb 970Maximum unthrottled read pool in megabytes per second.
c2993fe5
DM
971
972`mbps_wr`=`<mbps>` ;;
973
de0983cb 974Maximum write speed in megabytes per second.
c2993fe5
DM
975
976`mbps_wr_max`=`<mbps>` ;;
977
de0983cb 978Maximum unthrottled write pool in megabytes per second.
c2993fe5 979
013dc89f 980`media`=`<cdrom | disk>` ('default =' `disk`);;
c2993fe5
DM
981
982The drive's media type.
983
013dc89f 984`queues`=`<integer> (2 - N)` ;;
c2993fe5
DM
985
986Number of queues.
987
5d9c884c
DM
988`replicate`=`<boolean>` ('default =' `1`);;
989
990Whether the drive should considered for replication jobs.
991
992`rerror`=`<ignore | report | stop>` ;;
993
994Read error action.
995
5370fa8c
TL
996`ro`=`<boolean>` ;;
997
998Whether the drive is read-only.
999
52e44c50
FG
1000`scsiblock`=`<boolean>` ('default =' `0`);;
1001
1002whether to use scsi-block for full passthrough of host block device
1003+
1004WARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host
1005
013dc89f 1006`secs`=`<integer>` ;;
c2993fe5
DM
1007
1008Force the drive's physical geometry to have a specific sector count.
1009
1010`serial`=`<serial>` ;;
1011
1012The drive's reported serial number, url-encoded, up to 20 bytes long.
1013
27a7acb2
DM
1014`shared`=`<boolean>` ('default =' `0`);;
1015
1016Mark this locally-managed volume as available on all nodes.
1017+
1018WARNING: This option does not share the volume automatically, it assumes it is shared already!
1019
c2993fe5
DM
1020`size`=`<DiskSize>` ;;
1021
1022Disk size. This is purely informational and has no effect.
1023
013dc89f 1024`snapshot`=`<boolean>` ;;
c2993fe5 1025
27a7acb2 1026Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
c2993fe5 1027
25203dc1
NC
1028`ssd`=`<boolean>` ;;
1029
1030Whether to expose this drive as an SSD, rather than a rotational hard disk.
1031
013dc89f 1032`trans`=`<auto | lba | none>` ;;
c2993fe5
DM
1033
1034Force disk geometry bios translation mode.
1035
013dc89f 1036`werror`=`<enospc | ignore | report | stop>` ;;
c2993fe5
DM
1037
1038Write error action.
1039
95895385
TL
1040`wwn`=`<wwn>` ;;
1041
1042The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
1043
013dc89f 1044`scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
6ec3cd20 1045
c2993fe5 1046SCSI controller model
6ec3cd20 1047
27a7acb2
DM
1048`searchdomain`: `<string>` ::
1049
de786b48 1050cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
27a7acb2 1051
6ec3cd20
DM
1052`serial[n]`: `(/dev/.+|socket)` ::
1053
c2993fe5
DM
1054Create a serial device inside the VM (n is 0 to 3), and pass through a
1055host serial device (i.e. /dev/ttyS0), or create a unix socket on the
1056host side (use 'qm terminal' to open a terminal connection).
1057+
4772952b
TL
1058NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines -
1059use with special care.
6ec3cd20 1060+
c2993fe5 1061CAUTION: Experimental! User reported problems with this option.
6ec3cd20 1062
013dc89f 1063`shares`: `<integer> (0 - 50000)` ('default =' `1000`)::
6ec3cd20 1064
5da3d723 1065Amount 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.
6ec3cd20 1066
1e3f8156 1067`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>]` ::
6ec3cd20
DM
1068
1069Specify SMBIOS type 1 fields.
1070
1e3f8156
TL
1071`base64`=`<boolean>` ;;
1072
1073Flag to indicate that the SMBIOS values are base64 encoded
1074
1075`family`=`<Base64 encoded string>` ;;
c2993fe5
DM
1076
1077Set SMBIOS1 family string.
1078
1e3f8156 1079`manufacturer`=`<Base64 encoded string>` ;;
c2993fe5
DM
1080
1081Set SMBIOS1 manufacturer.
1082
1e3f8156 1083`product`=`<Base64 encoded string>` ;;
c2993fe5
DM
1084
1085Set SMBIOS1 product ID.
1086
1e3f8156 1087`serial`=`<Base64 encoded string>` ;;
c2993fe5
DM
1088
1089Set SMBIOS1 serial number.
1090
1e3f8156 1091`sku`=`<Base64 encoded string>` ;;
c2993fe5
DM
1092
1093Set SMBIOS1 SKU string.
1094
1095`uuid`=`<UUID>` ;;
1096
1097Set SMBIOS1 UUID.
1098
1e3f8156 1099`version`=`<Base64 encoded string>` ;;
c2993fe5
DM
1100
1101Set SMBIOS1 version.
1102
013dc89f 1103`smp`: `<integer> (1 - N)` ('default =' `1`)::
6ec3cd20
DM
1104
1105The number of CPUs. Please use option -sockets instead.
1106
013dc89f 1107`sockets`: `<integer> (1 - N)` ('default =' `1`)::
6ec3cd20
DM
1108
1109The number of CPU sockets.
1110
1c532546
TL
1111`spice_enhancements`: `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
1112
1113Configure additional enhancements for SPICE.
1114
1115`foldersharing`=`<boolean>` ('default =' `0`);;
1116
1117Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.
1118
1119`videostreaming`=`<all | filter | off>` ('default =' `off`);;
1120
1121Enable video streaming. Uses compression for detected video streams.
1122
27a7acb2
DM
1123`sshkeys`: `<string>` ::
1124
1125cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
1126
013dc89f 1127`startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
6ec3cd20 1128
4772952b 1129Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'.
6ec3cd20
DM
1130
1131`startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1132
c2993fe5 1133Startup 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.
6ec3cd20 1134
013dc89f 1135`tablet`: `<boolean>` ('default =' `1`)::
6ec3cd20 1136
4772952b 1137Enable/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 (`qm set <vmid> --vga qxl`).
6ec3cd20 1138
5c1699e5
TL
1139`tags`: `<string>` ::
1140
1141Tags of the VM. This is only meta information.
1142
013dc89f 1143`tdf`: `<boolean>` ('default =' `0`)::
6ec3cd20
DM
1144
1145Enable/disable time drift fix.
1146
013dc89f 1147`template`: `<boolean>` ('default =' `0`)::
6ec3cd20
DM
1148
1149Enable/disable Template.
1150
5370fa8c
TL
1151`tpmstate0`: `[file=]<volume> [,size=<DiskSize>] [,version=<v1.2|v2.0>]` ::
1152
7af2edf9 1153Configure a Disk for storing TPM state. The format is fixed to 'raw'.
5370fa8c
TL
1154
1155`file`=`<volume>` ;;
1156
1157The drive's backing volume.
1158
1159`size`=`<DiskSize>` ;;
1160
1161Disk size. This is purely informational and has no effect.
1162
1163`version`=`<v1.2 | v2.0>` ('default =' `v2.0`);;
1164
1165The TPM interface version. v2.0 is newer and should be preferred. Note that this cannot be changed later on.
1166
c5aa7e14 1167`unused[n]`: `[file=]<volume>` ::
6ec3cd20 1168
c2993fe5 1169Reference to unused volumes. This is used internally, and should not be modified manually.
6ec3cd20 1170
c5aa7e14
TL
1171`file`=`<volume>` ;;
1172
1173The drive's backing volume.
1174
f004f5b9 1175`usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
6ec3cd20 1176
4e7f60c2 1177Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14).
c2993fe5
DM
1178
1179`host`=`<HOSTUSBDEVICE|spice>` ;;
1180
1181The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
6ec3cd20 1182+
c2993fe5
DM
1183 'bus-port(.port)*' (decimal numbers) or
1184 'vendor_id:product_id' (hexadeciaml numbers) or
1185 'spice'
6ec3cd20
DM
1186+
1187You can use the 'lsusb -t' command to list existing usb devices.
1188+
4772952b
TL
1189NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such
1190machines - use with special care.
6ec3cd20
DM
1191+
1192The value 'spice' can be used to add a usb redirection devices for spice.
c2993fe5 1193
013dc89f 1194`usb3`=`<boolean>` ('default =' `0`);;
c2993fe5 1195
4e7f60c2 1196Specifies whether if given host option is a USB3 device or port. For modern guests (machine version >= 7.1 and ostype l26 and windows > 7), this flag is irrelevant (all devices are plugged into a xhci controller).
6ec3cd20 1197
013dc89f 1198`vcpus`: `<integer> (1 - N)` ('default =' `0`)::
6ec3cd20
DM
1199
1200Number of hotplugged vcpus.
1201
e2d681b3
TL
1202`vga`: `[[type=]<enum>] [,memory=<integer>]` ::
1203
1204Configure 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.
1205You can also run without any graphic card, using a serial device as terminal.
1206
1207`memory`=`<integer> (4 - 512)` ;;
1208
1209Sets the VGA memory (in MiB). Has no effect with serial display.
1210
7af2edf9 1211`type`=`<cirrus | none | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | virtio-gl | vmware>` ('default =' `std`);;
6ec3cd20 1212
e2d681b3 1213Select the VGA type.
6ec3cd20 1214
5370fa8c 1215`virtio[n]`: `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,ro=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
6ec3cd20 1216
7af2edf9 1217Use volume as VIRTIO hard disk (n is 0 to 15).
6ec3cd20 1218
8f4d9c87 1219`aio`=`<io_uring | native | threads>` ;;
c2993fe5
DM
1220
1221AIO type to use.
1222
013dc89f 1223`backup`=`<boolean>` ;;
c2993fe5
DM
1224
1225Whether the drive should be included when making backups.
1226
1227`bps`=`<bps>` ;;
1228
de0983cb
DM
1229Maximum r/w speed in bytes per second.
1230
1231`bps_max_length`=`<seconds>` ;;
1232
1233Maximum length of I/O bursts in seconds.
c2993fe5
DM
1234
1235`bps_rd`=`<bps>` ;;
1236
de0983cb
DM
1237Maximum read speed in bytes per second.
1238
5d9c884c 1239`bps_rd_max_length`=`<seconds>` ;;
de0983cb
DM
1240
1241Maximum length of read I/O bursts in seconds.
c2993fe5
DM
1242
1243`bps_wr`=`<bps>` ;;
1244
de0983cb
DM
1245Maximum write speed in bytes per second.
1246
5d9c884c 1247`bps_wr_max_length`=`<seconds>` ;;
de0983cb
DM
1248
1249Maximum length of write I/O bursts in seconds.
c2993fe5 1250
013dc89f 1251`cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
c2993fe5
DM
1252
1253The drive's cache mode
1254
013dc89f 1255`cyls`=`<integer>` ;;
c2993fe5
DM
1256
1257Force the drive's physical geometry to have a specific cylinder count.
1258
013dc89f 1259`detect_zeroes`=`<boolean>` ;;
c2993fe5
DM
1260
1261Controls whether to detect and try to optimize writes of zeroes.
1262
013dc89f 1263`discard`=`<ignore | on>` ;;
c2993fe5
DM
1264
1265Controls whether to pass discard/trim requests to the underlying storage.
1266
1267`file`=`<volume>` ;;
1268
1269The drive's backing volume.
1270
013dc89f 1271`format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
c2993fe5
DM
1272
1273The drive's backing file's data format.
1274
013dc89f 1275`heads`=`<integer>` ;;
c2993fe5
DM
1276
1277Force the drive's physical geometry to have a specific head count.
1278
1279`iops`=`<iops>` ;;
1280
de0983cb 1281Maximum r/w I/O in operations per second.
c2993fe5
DM
1282
1283`iops_max`=`<iops>` ;;
1284
de0983cb
DM
1285Maximum unthrottled r/w I/O pool in operations per second.
1286
1287`iops_max_length`=`<seconds>` ;;
1288
1289Maximum length of I/O bursts in seconds.
c2993fe5
DM
1290
1291`iops_rd`=`<iops>` ;;
1292
de0983cb
DM
1293Maximum read I/O in operations per second.
1294
c2993fe5
DM
1295`iops_rd_max`=`<iops>` ;;
1296
de0983cb 1297Maximum unthrottled read I/O pool in operations per second.
c2993fe5 1298
5d9c884c 1299`iops_rd_max_length`=`<seconds>` ;;
c2993fe5 1300
5d9c884c 1301Maximum length of read I/O bursts in seconds.
de0983cb 1302
5d9c884c 1303`iops_wr`=`<iops>` ;;
de0983cb 1304
5d9c884c 1305Maximum write I/O in operations per second.
c2993fe5
DM
1306
1307`iops_wr_max`=`<iops>` ;;
1308
de0983cb 1309Maximum unthrottled write I/O pool in operations per second.
c2993fe5 1310
5d9c884c
DM
1311`iops_wr_max_length`=`<seconds>` ;;
1312
1313Maximum length of write I/O bursts in seconds.
1314
013dc89f 1315`iothread`=`<boolean>` ;;
c2993fe5
DM
1316
1317Whether to use iothreads for this drive
1318
1319`mbps`=`<mbps>` ;;
1320
de0983cb 1321Maximum r/w speed in megabytes per second.
c2993fe5
DM
1322
1323`mbps_max`=`<mbps>` ;;
1324
de0983cb 1325Maximum unthrottled r/w pool in megabytes per second.
c2993fe5
DM
1326
1327`mbps_rd`=`<mbps>` ;;
1328
de0983cb 1329Maximum read speed in megabytes per second.
c2993fe5
DM
1330
1331`mbps_rd_max`=`<mbps>` ;;
1332
de0983cb 1333Maximum unthrottled read pool in megabytes per second.
c2993fe5
DM
1334
1335`mbps_wr`=`<mbps>` ;;
1336
de0983cb 1337Maximum write speed in megabytes per second.
c2993fe5
DM
1338
1339`mbps_wr_max`=`<mbps>` ;;
1340
de0983cb 1341Maximum unthrottled write pool in megabytes per second.
c2993fe5 1342
013dc89f 1343`media`=`<cdrom | disk>` ('default =' `disk`);;
c2993fe5
DM
1344
1345The drive's media type.
1346
5d9c884c
DM
1347`replicate`=`<boolean>` ('default =' `1`);;
1348
1349Whether the drive should considered for replication jobs.
1350
013dc89f 1351`rerror`=`<ignore | report | stop>` ;;
c2993fe5
DM
1352
1353Read error action.
1354
5370fa8c
TL
1355`ro`=`<boolean>` ;;
1356
1357Whether the drive is read-only.
1358
013dc89f 1359`secs`=`<integer>` ;;
c2993fe5
DM
1360
1361Force the drive's physical geometry to have a specific sector count.
1362
1363`serial`=`<serial>` ;;
1364
1365The drive's reported serial number, url-encoded, up to 20 bytes long.
1366
27a7acb2
DM
1367`shared`=`<boolean>` ('default =' `0`);;
1368
1369Mark this locally-managed volume as available on all nodes.
1370+
1371WARNING: This option does not share the volume automatically, it assumes it is shared already!
1372
c2993fe5
DM
1373`size`=`<DiskSize>` ;;
1374
1375Disk size. This is purely informational and has no effect.
1376
013dc89f 1377`snapshot`=`<boolean>` ;;
c2993fe5 1378
27a7acb2 1379Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
c2993fe5 1380
013dc89f 1381`trans`=`<auto | lba | none>` ;;
c2993fe5
DM
1382
1383Force disk geometry bios translation mode.
1384
013dc89f 1385`werror`=`<enospc | ignore | report | stop>` ;;
c2993fe5
DM
1386
1387Write error action.
1388
4d47f125
TL
1389`vmgenid`: `<UUID>` ('default =' `1 (autogenerated)`)::
1390
1391The 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.
4772952b 1392Note that auto-creation only works when done through API/CLI create or update methods, but not when manually editing the config file.
4d47f125 1393
2489d6df
WB
1394`vmstatestorage`: `<string>` ::
1395
1396Default storage for VM state volumes/files.
1397
013dc89f 1398`watchdog`: `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
6ec3cd20 1399
c2993fe5
DM
1400Create 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)
1401
013dc89f 1402`action`=`<debug | none | pause | poweroff | reset | shutdown>` ;;
c2993fe5
DM
1403
1404The action to perform if after activation the guest fails to poll the watchdog in time.
1405
013dc89f 1406`model`=`<i6300esb | ib700>` ('default =' `i6300esb`);;
c2993fe5
DM
1407
1408Watchdog type to emulate.
6ec3cd20 1409