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