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