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