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