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