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