]> git.proxmox.com Git - pve-docs.git/blame - qm.conf.5-opts.adoc
fix #3593: add affinity to docs
[pve-docs.git] / qm.conf.5-opts.adoc
CommitLineData
013dc89f 1`acpi`: `<boolean>` ('default =' `1`)::
6ec3cd20
DM
2
3Enable/disable ACPI.
4
5c1699e5 5`agent`: `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
4d47f125 6
5370fa8c 7Enable/disable communication with the Qemu Guest Agent and its properties.
4d47f125
TL
8
9`enabled`=`<boolean>` ('default =' `0`);;
6ec3cd20 10
5370fa8c 11Enable/disable communication with a Qemu Guest Agent (QGA) running in the VM.
6ec3cd20 12
4d47f125
TL
13`fstrim_cloned_disks`=`<boolean>` ('default =' `0`);;
14
d2656385 15Run fstrim after moving a disk or migrating the VM.
4d47f125 16
5c1699e5
TL
17`type`=`<isa | virtio>` ('default =' `virtio`);;
18
19Select the agent type
20
e2d681b3
TL
21`arch`: `<aarch64 | x86_64>` ::
22
23Virtual processor architecture. Defaults to the host.
24
013dc89f 25`args`: `<string>` ::
6ec3cd20 26
04ce4dfa 27Arbitrary arguments passed to kvm, for example:
6ec3cd20
DM
28+
29args: -no-reboot -no-hpet
04ce4dfa
DM
30+
31NOTE: this option is for experts only.
6ec3cd20 32
d2656385 33`audio0`: `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` ::
1c532546
TL
34
35Configure a audio device, useful in combination with QXL/Spice.
36
37`device`=`<AC97 | ich9-intel-hda | intel-hda>` ;;
38
39Configure an audio device.
40
d2656385 41`driver`=`<none | spice>` ('default =' `spice`);;
1c532546
TL
42
43Driver backend for the audio device.
44
013dc89f 45`autostart`: `<boolean>` ('default =' `0`)::
6ec3cd20
DM
46
47Automatic restart after crash (currently ignored).
48
013dc89f 49`balloon`: `<integer> (0 - N)` ::
6ec3cd20 50
c2993fe5 51Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
6ec3cd20 52
013dc89f 53`bios`: `<ovmf | seabios>` ('default =' `seabios`)::
6ec3cd20
DM
54
55Select BIOS implementation.
56
4772952b 57`boot`: `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
6ec3cd20 58
5370fa8c 59Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.
4772952b
TL
60
61`legacy`=`<[acdn]{1,4}>` ('default =' `cdn`);;
62
63Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). Deprecated, use 'order=' instead.
64
65`order`=`<device[;device...]>` ;;
66
67The guest will attempt to boot from devices in the order they appear here.
68+
69Disks, optical drives and passed-through storage USB devices will be directly
70booted from, NICs will load PXE, and PCIe devices will either behave like disks
71(e.g. NVMe) or load an option ROM (e.g. RAID controller, hardware NIC).
72+
73Note that only devices in this list will be marked as bootable and thus loaded
74by the guest firmware (BIOS/UEFI). If you require multiple disks for booting
75(e.g. software-raid), you need to specify all of them here.
76+
77Overrides the deprecated 'legacy=[acdn]*' value when given.
6ec3cd20
DM
78
79`bootdisk`: `(ide|sata|scsi|virtio)\d+` ::
80
4772952b 81Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.
6ec3cd20 82
013dc89f 83`cdrom`: `<volume>` ::
6ec3cd20
DM
84
85This is an alias for option -ide2
86
5370fa8c 87`cicustom`: `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` ::
95895385
TL
88
89cloud-init: Specify custom files to replace the automatically generated ones at start.
90
91`meta`=`<volume>` ;;
92
4772952b
TL
93Specify a custom file containing all meta data passed to the VM via"
94 ." cloud-init. This is provider specific meaning configdrive2 and nocloud differ.
95895385
TL
95
96`network`=`<volume>` ;;
97
98Specify a custom file containing all network data passed to the VM via cloud-init.
99
100`user`=`<volume>` ;;
101
102Specify a custom file containing all user data passed to the VM via cloud-init.
103
5370fa8c
TL
104`vendor`=`<volume>` ;;
105
106Specify a custom file containing all vendor data passed to the VM via cloud-init.
107
27a7acb2
DM
108`cipassword`: `<string>` ::
109
110cloud-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.
111
d2656385 112`citype`: `<configdrive2 | nocloud | opennebula>` ::
27a7acb2
DM
113
114Specifies 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.
115
116`ciuser`: `<string>` ::
117
118cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
119
013dc89f 120`cores`: `<integer> (1 - N)` ('default =' `1`)::
6ec3cd20
DM
121
122The number of cores per socket.
123
04d22a9f 124`cpu`: `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
6ec3cd20
DM
125
126Emulated CPU type.
127
04d22a9f
TL
128`cputype`=`<string>` ('default =' `kvm64`);;
129
130Emulated CPU type. Can be default or custom name (custom model names must be prefixed with 'custom-').
131
132`flags`=`<+FLAG[;-FLAG...]>` ;;
133
7af2edf9 134List 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
135
136`hidden`=`<boolean>` ('default =' `0`);;
137
138Do not identify as a KVM virtual machine.
139
140`hv-vendor-id`=`<vendor-id>` ;;
141
142The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.
143
144`phys-bits`=`<8-64|host>` ;;
145
146The 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.
147
148`reported-model`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Cascadelake-Server | Cascadelake-Server-noTSX | Conroe | EPYC | EPYC-IBPB | 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`);;
149
150CPU 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.
151
013dc89f 152`cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
6ec3cd20
DM
153
154Limit of CPU usage.
155+
c2993fe5 156NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
6ec3cd20 157
1e6b30b5
DB
158`affinity`: `<string>`::
159
160Set of CPU cores to pin the virtual machine processes to. This is a comma sepparated list of numbers or ranges in list format as defined by the Linux man page for cpuset. ( e.g `0,4-6,9` )
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
5370fa8c 264Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`.
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
4772952b
TL
536cloud-init: Sets DNS server IP address for a container. Create will'
537 .' automatically use the setting from the host if neither searchdomain nor nameserver'
538 .' are set.
27a7acb2 539
ac70d7d1 540`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
541
542Specify network devices.
c2993fe5
DM
543
544`bridge`=`<bridge>` ;;
545
546Bridge to attach the network device to. The Proxmox VE standard bridge
547is called 'vmbr0'.
6ec3cd20 548+
c2993fe5
DM
549If you do not specify a bridge, we create a kvm user (NATed) network
550device, which provides DHCP and DNS services. The following addresses
551are used:
6ec3cd20 552+
c2993fe5
DM
553 10.0.2.2 Gateway
554 10.0.2.3 DNS Server
555 10.0.2.4 SMB Server
6ec3cd20
DM
556+
557The DHCP server assign addresses to the guest starting from 10.0.2.15.
558
013dc89f 559`firewall`=`<boolean>` ;;
c2993fe5
DM
560
561Whether this interface should be protected by the firewall.
562
013dc89f 563`link_down`=`<boolean>` ;;
c2993fe5
DM
564
565Whether this interface should be disconnected (like pulling the plug).
566
567`macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
568
95895385 569A common MAC address with the I/G (Individual/Group) bit not set.
c2993fe5 570
5370fa8c 571`model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | e1000e | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
c2993fe5
DM
572
573Network 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'.
574
ac70d7d1
TL
575`mtu`=`<integer> (1 - 65520)` ;;
576
577Force MTU, for VirtIO only. Set to '1' to use the bridge MTU
578
013dc89f 579`queues`=`<integer> (0 - 16)` ;;
c2993fe5
DM
580
581Number of packet queues to be used on the device.
582
013dc89f 583`rate`=`<number> (0 - N)` ;;
c2993fe5
DM
584
585Rate limit in mbps (megabytes per second) as floating point number.
586
013dc89f 587`tag`=`<integer> (1 - 4094)` ;;
c2993fe5
DM
588
589VLAN tag to apply to packets on this interface.
590
591`trunks`=`<vlanid[;vlanid...]>` ;;
592
593VLAN trunks to pass through this interface.
594
013dc89f 595`numa`: `<boolean>` ('default =' `0`)::
6ec3cd20
DM
596
597Enable/disable NUMA.
598
f004f5b9 599`numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
6ec3cd20 600
c2993fe5
DM
601NUMA topology.
602
603`cpus`=`<id[-id];...>` ;;
604
605CPUs accessing this NUMA node.
606
607`hostnodes`=`<id[-id];...>` ;;
608
609Host NUMA nodes to use.
610
013dc89f 611`memory`=`<number>` ;;
c2993fe5
DM
612
613Amount of memory this NUMA node provides.
614
013dc89f 615`policy`=`<bind | interleave | preferred>` ;;
c2993fe5
DM
616
617NUMA allocation policy.
6ec3cd20 618
013dc89f 619`onboot`: `<boolean>` ('default =' `0`)::
6ec3cd20
DM
620
621Specifies whether a VM will be started during system bootup.
622
5370fa8c 623`ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` ::
6ec3cd20 624
c2993fe5
DM
625Specify guest operating system. This is used to enable special
626optimization/features for specific operating systems:
6ec3cd20 627+
c2993fe5
DM
628[horizontal]
629other;; unspecified OS
630wxp;; Microsoft Windows XP
631w2k;; Microsoft Windows 2000
632w2k3;; Microsoft Windows 2003
633w2k8;; Microsoft Windows 2008
634wvista;; Microsoft Windows Vista
635win7;; Microsoft Windows 7
35a75dd3 636win8;; Microsoft Windows 8/2012/2012r2
d2656385 637win10;; Microsoft Windows 10/2016/2019
5370fa8c 638win11;; Microsoft Windows 11/2022
c2993fe5 639l24;; Linux 2.4 Kernel
5c1699e5 640l26;; Linux 2.6 - 5.X Kernel
c2993fe5 641solaris;; Solaris/OpenSolaris/OpenIndiania kernel
6ec3cd20
DM
642
643`parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
644
645Map host parallel devices (n is 0 to 2).
646+
4772952b
TL
647NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such
648machines - use with special care.
6ec3cd20 649+
c2993fe5 650CAUTION: Experimental! User reported problems with this option.
6ec3cd20 651
013dc89f 652`protection`: `<boolean>` ('default =' `0`)::
6ec3cd20 653
c2993fe5 654Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
6ec3cd20 655
013dc89f 656`reboot`: `<boolean>` ('default =' `1`)::
6ec3cd20
DM
657
658Allow reboot. If set to '0' the VM exit on reboot.
659
c5aa7e14
TL
660`rng0`: `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
661
662Configure a VirtIO-based Random Number Generator.
663
664`max_bytes`=`<integer>` ('default =' `1024`);;
665
5370fa8c 666Maximum 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
667
668`period`=`<integer>` ('default =' `1000`);;
669
670Every 'period' milliseconds the entropy-injection quota is reset, allowing the guest to retrieve another 'max_bytes' of entropy.
671
672`source`=`</dev/hwrng | /dev/random | /dev/urandom>` ;;
673
5370fa8c 674The 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 675
8f4d9c87 676`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 677
7af2edf9 678Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
6ec3cd20 679
8f4d9c87 680`aio`=`<io_uring | native | threads>` ;;
c2993fe5
DM
681
682AIO type to use.
683
013dc89f 684`backup`=`<boolean>` ;;
c2993fe5
DM
685
686Whether the drive should be included when making backups.
687
688`bps`=`<bps>` ;;
689
de0983cb
DM
690Maximum r/w speed in bytes per second.
691
692`bps_max_length`=`<seconds>` ;;
693
694Maximum length of I/O bursts in seconds.
c2993fe5
DM
695
696`bps_rd`=`<bps>` ;;
697
de0983cb
DM
698Maximum read speed in bytes per second.
699
5d9c884c 700`bps_rd_max_length`=`<seconds>` ;;
de0983cb
DM
701
702Maximum length of read I/O bursts in seconds.
c2993fe5
DM
703
704`bps_wr`=`<bps>` ;;
705
de0983cb
DM
706Maximum write speed in bytes per second.
707
5d9c884c 708`bps_wr_max_length`=`<seconds>` ;;
de0983cb
DM
709
710Maximum length of write I/O bursts in seconds.
c2993fe5 711
013dc89f 712`cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
c2993fe5
DM
713
714The drive's cache mode
715
013dc89f 716`cyls`=`<integer>` ;;
c2993fe5
DM
717
718Force the drive's physical geometry to have a specific cylinder count.
719
013dc89f 720`detect_zeroes`=`<boolean>` ;;
c2993fe5
DM
721
722Controls whether to detect and try to optimize writes of zeroes.
723
013dc89f 724`discard`=`<ignore | on>` ;;
c2993fe5
DM
725
726Controls whether to pass discard/trim requests to the underlying storage.
727
728`file`=`<volume>` ;;
729
730The drive's backing volume.
731
013dc89f 732`format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
c2993fe5
DM
733
734The drive's backing file's data format.
735
013dc89f 736`heads`=`<integer>` ;;
c2993fe5
DM
737
738Force the drive's physical geometry to have a specific head count.
739
740`iops`=`<iops>` ;;
741
de0983cb 742Maximum r/w I/O in operations per second.
c2993fe5
DM
743
744`iops_max`=`<iops>` ;;
745
de0983cb
DM
746Maximum unthrottled r/w I/O pool in operations per second.
747
748`iops_max_length`=`<seconds>` ;;
749
750Maximum length of I/O bursts in seconds.
c2993fe5
DM
751
752`iops_rd`=`<iops>` ;;
753
de0983cb
DM
754Maximum read I/O in operations per second.
755
c2993fe5
DM
756`iops_rd_max`=`<iops>` ;;
757
de0983cb 758Maximum unthrottled read I/O pool in operations per second.
c2993fe5 759
5d9c884c 760`iops_rd_max_length`=`<seconds>` ;;
c2993fe5 761
5d9c884c 762Maximum length of read I/O bursts in seconds.
de0983cb 763
5d9c884c 764`iops_wr`=`<iops>` ;;
de0983cb 765
5d9c884c 766Maximum write I/O in operations per second.
c2993fe5
DM
767
768`iops_wr_max`=`<iops>` ;;
769
de0983cb 770Maximum unthrottled write I/O pool in operations per second.
c2993fe5 771
5d9c884c
DM
772`iops_wr_max_length`=`<seconds>` ;;
773
774Maximum length of write I/O bursts in seconds.
775
c2993fe5
DM
776`mbps`=`<mbps>` ;;
777
de0983cb 778Maximum r/w speed in megabytes per second.
c2993fe5
DM
779
780`mbps_max`=`<mbps>` ;;
781
de0983cb 782Maximum unthrottled r/w pool in megabytes per second.
c2993fe5
DM
783
784`mbps_rd`=`<mbps>` ;;
785
de0983cb 786Maximum read speed in megabytes per second.
c2993fe5
DM
787
788`mbps_rd_max`=`<mbps>` ;;
789
de0983cb 790Maximum unthrottled read pool in megabytes per second.
c2993fe5
DM
791
792`mbps_wr`=`<mbps>` ;;
793
de0983cb 794Maximum write speed in megabytes per second.
c2993fe5
DM
795
796`mbps_wr_max`=`<mbps>` ;;
797
de0983cb 798Maximum unthrottled write pool in megabytes per second.
c2993fe5 799
013dc89f 800`media`=`<cdrom | disk>` ('default =' `disk`);;
c2993fe5
DM
801
802The drive's media type.
803
5d9c884c
DM
804`replicate`=`<boolean>` ('default =' `1`);;
805
806Whether the drive should considered for replication jobs.
807
013dc89f 808`rerror`=`<ignore | report | stop>` ;;
c2993fe5
DM
809
810Read error action.
811
013dc89f 812`secs`=`<integer>` ;;
c2993fe5
DM
813
814Force the drive's physical geometry to have a specific sector count.
815
816`serial`=`<serial>` ;;
817
818The drive's reported serial number, url-encoded, up to 20 bytes long.
819
27a7acb2
DM
820`shared`=`<boolean>` ('default =' `0`);;
821
822Mark this locally-managed volume as available on all nodes.
823+
824WARNING: This option does not share the volume automatically, it assumes it is shared already!
825
c2993fe5
DM
826`size`=`<DiskSize>` ;;
827
828Disk size. This is purely informational and has no effect.
829
013dc89f 830`snapshot`=`<boolean>` ;;
c2993fe5 831
27a7acb2 832Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
c2993fe5 833
25203dc1
NC
834`ssd`=`<boolean>` ;;
835
836Whether to expose this drive as an SSD, rather than a rotational hard disk.
837
013dc89f 838`trans`=`<auto | lba | none>` ;;
c2993fe5
DM
839
840Force disk geometry bios translation mode.
841
013dc89f 842`werror`=`<enospc | ignore | report | stop>` ;;
c2993fe5
DM
843
844Write error action.
845
95895385
TL
846`wwn`=`<wwn>` ;;
847
848The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
849
5370fa8c 850`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 851
7af2edf9 852Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).
6ec3cd20 853
8f4d9c87 854`aio`=`<io_uring | native | threads>` ;;
c2993fe5
DM
855
856AIO type to use.
857
013dc89f 858`backup`=`<boolean>` ;;
c2993fe5
DM
859
860Whether the drive should be included when making backups.
861
862`bps`=`<bps>` ;;
863
de0983cb
DM
864Maximum r/w speed in bytes per second.
865
866`bps_max_length`=`<seconds>` ;;
867
868Maximum length of I/O bursts in seconds.
c2993fe5
DM
869
870`bps_rd`=`<bps>` ;;
871
de0983cb
DM
872Maximum read speed in bytes per second.
873
5d9c884c 874`bps_rd_max_length`=`<seconds>` ;;
de0983cb
DM
875
876Maximum length of read I/O bursts in seconds.
c2993fe5
DM
877
878`bps_wr`=`<bps>` ;;
879
de0983cb
DM
880Maximum write speed in bytes per second.
881
5d9c884c 882`bps_wr_max_length`=`<seconds>` ;;
de0983cb
DM
883
884Maximum length of write I/O bursts in seconds.
c2993fe5 885
013dc89f 886`cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
c2993fe5
DM
887
888The drive's cache mode
889
013dc89f 890`cyls`=`<integer>` ;;
c2993fe5
DM
891
892Force the drive's physical geometry to have a specific cylinder count.
893
013dc89f 894`detect_zeroes`=`<boolean>` ;;
c2993fe5
DM
895
896Controls whether to detect and try to optimize writes of zeroes.
897
013dc89f 898`discard`=`<ignore | on>` ;;
c2993fe5
DM
899
900Controls whether to pass discard/trim requests to the underlying storage.
901
902`file`=`<volume>` ;;
903
904The drive's backing volume.
905
013dc89f 906`format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
c2993fe5
DM
907
908The drive's backing file's data format.
909
013dc89f 910`heads`=`<integer>` ;;
c2993fe5
DM
911
912Force the drive's physical geometry to have a specific head count.
913
914`iops`=`<iops>` ;;
915
de0983cb 916Maximum r/w I/O in operations per second.
c2993fe5
DM
917
918`iops_max`=`<iops>` ;;
919
de0983cb
DM
920Maximum unthrottled r/w I/O pool in operations per second.
921
922`iops_max_length`=`<seconds>` ;;
923
924Maximum length of I/O bursts in seconds.
c2993fe5
DM
925
926`iops_rd`=`<iops>` ;;
927
de0983cb
DM
928Maximum read I/O in operations per second.
929
c2993fe5
DM
930`iops_rd_max`=`<iops>` ;;
931
de0983cb 932Maximum unthrottled read I/O pool in operations per second.
c2993fe5 933
5d9c884c 934`iops_rd_max_length`=`<seconds>` ;;
c2993fe5 935
5d9c884c 936Maximum length of read I/O bursts in seconds.
de0983cb 937
5d9c884c 938`iops_wr`=`<iops>` ;;
de0983cb 939
5d9c884c 940Maximum write I/O in operations per second.
c2993fe5
DM
941
942`iops_wr_max`=`<iops>` ;;
943
de0983cb 944Maximum unthrottled write I/O pool in operations per second.
c2993fe5 945
5d9c884c
DM
946`iops_wr_max_length`=`<seconds>` ;;
947
948Maximum length of write I/O bursts in seconds.
949
013dc89f 950`iothread`=`<boolean>` ;;
c2993fe5
DM
951
952Whether to use iothreads for this drive
953
954`mbps`=`<mbps>` ;;
955
de0983cb 956Maximum r/w speed in megabytes per second.
c2993fe5
DM
957
958`mbps_max`=`<mbps>` ;;
959
de0983cb 960Maximum unthrottled r/w pool in megabytes per second.
c2993fe5
DM
961
962`mbps_rd`=`<mbps>` ;;
963
de0983cb 964Maximum read speed in megabytes per second.
c2993fe5
DM
965
966`mbps_rd_max`=`<mbps>` ;;
967
de0983cb 968Maximum unthrottled read pool in megabytes per second.
c2993fe5
DM
969
970`mbps_wr`=`<mbps>` ;;
971
de0983cb 972Maximum write speed in megabytes per second.
c2993fe5
DM
973
974`mbps_wr_max`=`<mbps>` ;;
975
de0983cb 976Maximum unthrottled write pool in megabytes per second.
c2993fe5 977
013dc89f 978`media`=`<cdrom | disk>` ('default =' `disk`);;
c2993fe5
DM
979
980The drive's media type.
981
013dc89f 982`queues`=`<integer> (2 - N)` ;;
c2993fe5
DM
983
984Number of queues.
985
5d9c884c
DM
986`replicate`=`<boolean>` ('default =' `1`);;
987
988Whether the drive should considered for replication jobs.
989
990`rerror`=`<ignore | report | stop>` ;;
991
992Read error action.
993
5370fa8c
TL
994`ro`=`<boolean>` ;;
995
996Whether the drive is read-only.
997
52e44c50
FG
998`scsiblock`=`<boolean>` ('default =' `0`);;
999
1000whether to use scsi-block for full passthrough of host block device
1001+
1002WARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host
1003
013dc89f 1004`secs`=`<integer>` ;;
c2993fe5
DM
1005
1006Force the drive's physical geometry to have a specific sector count.
1007
1008`serial`=`<serial>` ;;
1009
1010The drive's reported serial number, url-encoded, up to 20 bytes long.
1011
27a7acb2
DM
1012`shared`=`<boolean>` ('default =' `0`);;
1013
1014Mark this locally-managed volume as available on all nodes.
1015+
1016WARNING: This option does not share the volume automatically, it assumes it is shared already!
1017
c2993fe5
DM
1018`size`=`<DiskSize>` ;;
1019
1020Disk size. This is purely informational and has no effect.
1021
013dc89f 1022`snapshot`=`<boolean>` ;;
c2993fe5 1023
27a7acb2 1024Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.
c2993fe5 1025
25203dc1
NC
1026`ssd`=`<boolean>` ;;
1027
1028Whether to expose this drive as an SSD, rather than a rotational hard disk.
1029
013dc89f 1030`trans`=`<auto | lba | none>` ;;
c2993fe5
DM
1031
1032Force disk geometry bios translation mode.
1033
013dc89f 1034`werror`=`<enospc | ignore | report | stop>` ;;
c2993fe5
DM
1035
1036Write error action.
1037
95895385
TL
1038`wwn`=`<wwn>` ;;
1039
1040The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
1041
013dc89f 1042`scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
6ec3cd20 1043
c2993fe5 1044SCSI controller model
6ec3cd20 1045
27a7acb2
DM
1046`searchdomain`: `<string>` ::
1047
4772952b
TL
1048cloud-init: Sets DNS search domains for a container. Create will'
1049 .' automatically use the setting from the host if neither searchdomain nor nameserver'
1050 .' 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
c2993fe5
DM
1177Configure an USB device (n is 0 to 4).
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
1c532546 1196Specifies whether if given host option is a USB3 device or port.
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