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