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