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