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