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