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