run make update
[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 `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
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
81 `cores`: `<integer> (1 - N)` ('default =' `1`)::
82
83 The number of cores per socket.
84
85 `cpu`: `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]` ::
86
87 Emulated CPU type.
88
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`);;
90
91 Emulated CPU type.
92
93 `flags`=`<+FLAG[;-FLAG...]>` ;;
94
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'.
96
97 `hidden`=`<boolean>` ('default =' `0`);;
98
99 Do not identify as a KVM virtual machine.
100
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
105 `cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
106
107 Limit of CPU usage.
108 +
109 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
110
111 `cpuunits`: `<integer> (2 - 262144)` ('default =' `1024`)::
112
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.
114
115 `description`: `<string>` ::
116
117 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
118
119 `efidisk0`: `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
120
121 Configure a Disk for storing EFI vars
122
123 `file`=`<volume>` ;;
124
125 The drive's backing volume.
126
127 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
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
135 `freeze`: `<boolean>` ::
136
137 Freeze CPU at startup (use 'c' monitor command to start execution).
138
139 `hookscript`: `<string>` ::
140
141 Script that will be executed during various steps in the vms lifetime.
142
143 `hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
144
145 Map host PCI devices into guest.
146 +
147 NOTE: This option allows direct access to host hardware. So it is no longer
148 possible to migrate such machines - use with special care.
149 +
150 CAUTION: Experimental! User reported problems with this option.
151
152 `host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
153
154 Host PCI device pass through. The PCI ID of a host's PCI device or a list
155 of PCI virtual functions of the host. HOSTPCIID syntax is:
156 +
157 'bus:dev.func' (hexadecimal numbers)
158 +
159 You can us the 'lspci' command to list existing PCI devices.
160
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
167 `pcie`=`<boolean>` ('default =' `0`);;
168
169 Choose the PCI-express bus (needs the 'q35' machine model).
170
171 `rombar`=`<boolean>` ('default =' `1`);;
172
173 Specify whether or not the device's ROM will be visible in the guest's memory map.
174
175 `romfile`=`<string>` ;;
176
177 Custom pci device rom filename (must be located in /usr/share/kvm/).
178
179 `x-vga`=`<boolean>` ('default =' `0`);;
180
181 Enable vfio-vga device support.
182
183 `hotplug`: `<string>` ('default =' `network,disk,usb`)::
184
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'.
186
187 `hugepages`: `<1024 | 2 | any>` ::
188
189 Enable/disable hugepages memory.
190
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>]` ::
192
193 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
194
195 `aio`=`<native | threads>` ;;
196
197 AIO type to use.
198
199 `backup`=`<boolean>` ;;
200
201 Whether the drive should be included when making backups.
202
203 `bps`=`<bps>` ;;
204
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.
210
211 `bps_rd`=`<bps>` ;;
212
213 Maximum read speed in bytes per second.
214
215 `bps_rd_max_length`=`<seconds>` ;;
216
217 Maximum length of read I/O bursts in seconds.
218
219 `bps_wr`=`<bps>` ;;
220
221 Maximum write speed in bytes per second.
222
223 `bps_wr_max_length`=`<seconds>` ;;
224
225 Maximum length of write I/O bursts in seconds.
226
227 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
228
229 The drive's cache mode
230
231 `cyls`=`<integer>` ;;
232
233 Force the drive's physical geometry to have a specific cylinder count.
234
235 `detect_zeroes`=`<boolean>` ;;
236
237 Controls whether to detect and try to optimize writes of zeroes.
238
239 `discard`=`<ignore | on>` ;;
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
247 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
248
249 The drive's backing file's data format.
250
251 `heads`=`<integer>` ;;
252
253 Force the drive's physical geometry to have a specific head count.
254
255 `iops`=`<iops>` ;;
256
257 Maximum r/w I/O in operations per second.
258
259 `iops_max`=`<iops>` ;;
260
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.
266
267 `iops_rd`=`<iops>` ;;
268
269 Maximum read I/O in operations per second.
270
271 `iops_rd_max`=`<iops>` ;;
272
273 Maximum unthrottled read I/O pool in operations per second.
274
275 `iops_rd_max_length`=`<seconds>` ;;
276
277 Maximum length of read I/O bursts in seconds.
278
279 `iops_wr`=`<iops>` ;;
280
281 Maximum write I/O in operations per second.
282
283 `iops_wr_max`=`<iops>` ;;
284
285 Maximum unthrottled write I/O pool in operations per second.
286
287 `iops_wr_max_length`=`<seconds>` ;;
288
289 Maximum length of write I/O bursts in seconds.
290
291 `mbps`=`<mbps>` ;;
292
293 Maximum r/w speed in megabytes per second.
294
295 `mbps_max`=`<mbps>` ;;
296
297 Maximum unthrottled r/w pool in megabytes per second.
298
299 `mbps_rd`=`<mbps>` ;;
300
301 Maximum read speed in megabytes per second.
302
303 `mbps_rd_max`=`<mbps>` ;;
304
305 Maximum unthrottled read pool in megabytes per second.
306
307 `mbps_wr`=`<mbps>` ;;
308
309 Maximum write speed in megabytes per second.
310
311 `mbps_wr_max`=`<mbps>` ;;
312
313 Maximum unthrottled write pool in megabytes per second.
314
315 `media`=`<cdrom | disk>` ('default =' `disk`);;
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
323 `replicate`=`<boolean>` ('default =' `1`);;
324
325 Whether the drive should considered for replication jobs.
326
327 `rerror`=`<ignore | report | stop>` ;;
328
329 Read error action.
330
331 `secs`=`<integer>` ;;
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
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
345 `size`=`<DiskSize>` ;;
346
347 Disk size. This is purely informational and has no effect.
348
349 `snapshot`=`<boolean>` ;;
350
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.
352
353 `ssd`=`<boolean>` ;;
354
355 Whether to expose this drive as an SSD, rather than a rotational hard disk.
356
357 `trans`=`<auto | lba | none>` ;;
358
359 Force disk geometry bios translation mode.
360
361 `werror`=`<enospc | ignore | report | stop>` ;;
362
363 Write error action.
364
365 `wwn`=`<wwn>` ;;
366
367 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
368
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
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
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>` ::
413
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.
415
416 `kvm`: `<boolean>` ('default =' `1`)::
417
418 Enable/disable KVM hardware virtualization.
419
420 `localtime`: `<boolean>` ::
421
422 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
423
424 `lock`: `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
425
426 Lock/unlock the VM.
427
428 `machine`: `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` ::
429
430 Specifies the Qemu machine type.
431
432 `memory`: `<integer> (16 - N)` ('default =' `512`)::
433
434 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
435
436 `migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
437
438 Set maximum tolerated downtime (in seconds) for migrations.
439
440 `migrate_speed`: `<integer> (0 - N)` ('default =' `0`)::
441
442 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
443
444 `name`: `<string>` ::
445
446 Set a name for the VM. Only used on the configuration web interface.
447
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
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>]` ::
453
454 Specify network devices.
455
456 `bridge`=`<bridge>` ;;
457
458 Bridge to attach the network device to. The Proxmox VE standard bridge
459 is called 'vmbr0'.
460 +
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:
464 +
465  10.0.2.2   Gateway
466  10.0.2.3   DNS Server
467  10.0.2.4   SMB Server
468 +
469 The DHCP server assign addresses to the guest starting from 10.0.2.15.
470
471 `firewall`=`<boolean>` ;;
472
473 Whether this interface should be protected by the firewall.
474
475 `link_down`=`<boolean>` ;;
476
477 Whether this interface should be disconnected (like pulling the plug).
478
479 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
480
481 A common MAC address with the I/G (Individual/Group) bit not set.
482
483 `model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
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
487 `queues`=`<integer> (0 - 16)` ;;
488
489 Number of packet queues to be used on the device.
490
491 `rate`=`<number> (0 - N)` ;;
492
493 Rate limit in mbps (megabytes per second) as floating point number.
494
495 `tag`=`<integer> (1 - 4094)` ;;
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
503 `numa`: `<boolean>` ('default =' `0`)::
504
505 Enable/disable NUMA.
506
507 `numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
508
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
519 `memory`=`<number>` ;;
520
521 Amount of memory this NUMA node provides.
522
523 `policy`=`<bind | interleave | preferred>` ;;
524
525 NUMA allocation policy.
526
527 `onboot`: `<boolean>` ('default =' `0`)::
528
529 Specifies whether a VM will be started during system bootup.
530
531 `ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
532
533 Specify guest operating system. This is used to enable special
534 optimization/features for specific operating systems:
535 +
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
544 win8;; Microsoft Windows 8/2012/2012r2
545 win10;; Microsoft Windows 10/2016
546 l24;; Linux 2.4 Kernel
547 l26;; Linux 2.6/3.X Kernel
548 solaris;; Solaris/OpenSolaris/OpenIndiania kernel
549
550 `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
551
552 Map host parallel devices (n is 0 to 2).
553 +
554 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
555 +
556 CAUTION: Experimental! User reported problems with this option.
557
558 `protection`: `<boolean>` ('default =' `0`)::
559
560 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
561
562 `reboot`: `<boolean>` ('default =' `1`)::
563
564 Allow reboot. If set to '0' the VM exit on reboot.
565
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>]` ::
567
568 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
569
570 `aio`=`<native | threads>` ;;
571
572 AIO type to use.
573
574 `backup`=`<boolean>` ;;
575
576 Whether the drive should be included when making backups.
577
578 `bps`=`<bps>` ;;
579
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.
585
586 `bps_rd`=`<bps>` ;;
587
588 Maximum read speed in bytes per second.
589
590 `bps_rd_max_length`=`<seconds>` ;;
591
592 Maximum length of read I/O bursts in seconds.
593
594 `bps_wr`=`<bps>` ;;
595
596 Maximum write speed in bytes per second.
597
598 `bps_wr_max_length`=`<seconds>` ;;
599
600 Maximum length of write I/O bursts in seconds.
601
602 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
603
604 The drive's cache mode
605
606 `cyls`=`<integer>` ;;
607
608 Force the drive's physical geometry to have a specific cylinder count.
609
610 `detect_zeroes`=`<boolean>` ;;
611
612 Controls whether to detect and try to optimize writes of zeroes.
613
614 `discard`=`<ignore | on>` ;;
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
622 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
623
624 The drive's backing file's data format.
625
626 `heads`=`<integer>` ;;
627
628 Force the drive's physical geometry to have a specific head count.
629
630 `iops`=`<iops>` ;;
631
632 Maximum r/w I/O in operations per second.
633
634 `iops_max`=`<iops>` ;;
635
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.
641
642 `iops_rd`=`<iops>` ;;
643
644 Maximum read I/O in operations per second.
645
646 `iops_rd_max`=`<iops>` ;;
647
648 Maximum unthrottled read I/O pool in operations per second.
649
650 `iops_rd_max_length`=`<seconds>` ;;
651
652 Maximum length of read I/O bursts in seconds.
653
654 `iops_wr`=`<iops>` ;;
655
656 Maximum write I/O in operations per second.
657
658 `iops_wr_max`=`<iops>` ;;
659
660 Maximum unthrottled write I/O pool in operations per second.
661
662 `iops_wr_max_length`=`<seconds>` ;;
663
664 Maximum length of write I/O bursts in seconds.
665
666 `mbps`=`<mbps>` ;;
667
668 Maximum r/w speed in megabytes per second.
669
670 `mbps_max`=`<mbps>` ;;
671
672 Maximum unthrottled r/w pool in megabytes per second.
673
674 `mbps_rd`=`<mbps>` ;;
675
676 Maximum read speed in megabytes per second.
677
678 `mbps_rd_max`=`<mbps>` ;;
679
680 Maximum unthrottled read pool in megabytes per second.
681
682 `mbps_wr`=`<mbps>` ;;
683
684 Maximum write speed in megabytes per second.
685
686 `mbps_wr_max`=`<mbps>` ;;
687
688 Maximum unthrottled write pool in megabytes per second.
689
690 `media`=`<cdrom | disk>` ('default =' `disk`);;
691
692 The drive's media type.
693
694 `replicate`=`<boolean>` ('default =' `1`);;
695
696 Whether the drive should considered for replication jobs.
697
698 `rerror`=`<ignore | report | stop>` ;;
699
700 Read error action.
701
702 `secs`=`<integer>` ;;
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
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
716 `size`=`<DiskSize>` ;;
717
718 Disk size. This is purely informational and has no effect.
719
720 `snapshot`=`<boolean>` ;;
721
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.
723
724 `ssd`=`<boolean>` ;;
725
726 Whether to expose this drive as an SSD, rather than a rotational hard disk.
727
728 `trans`=`<auto | lba | none>` ;;
729
730 Force disk geometry bios translation mode.
731
732 `werror`=`<enospc | ignore | report | stop>` ;;
733
734 Write error action.
735
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>]` ::
741
742 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
743
744 `aio`=`<native | threads>` ;;
745
746 AIO type to use.
747
748 `backup`=`<boolean>` ;;
749
750 Whether the drive should be included when making backups.
751
752 `bps`=`<bps>` ;;
753
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.
759
760 `bps_rd`=`<bps>` ;;
761
762 Maximum read speed in bytes per second.
763
764 `bps_rd_max_length`=`<seconds>` ;;
765
766 Maximum length of read I/O bursts in seconds.
767
768 `bps_wr`=`<bps>` ;;
769
770 Maximum write speed in bytes per second.
771
772 `bps_wr_max_length`=`<seconds>` ;;
773
774 Maximum length of write I/O bursts in seconds.
775
776 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
777
778 The drive's cache mode
779
780 `cyls`=`<integer>` ;;
781
782 Force the drive's physical geometry to have a specific cylinder count.
783
784 `detect_zeroes`=`<boolean>` ;;
785
786 Controls whether to detect and try to optimize writes of zeroes.
787
788 `discard`=`<ignore | on>` ;;
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
796 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
797
798 The drive's backing file's data format.
799
800 `heads`=`<integer>` ;;
801
802 Force the drive's physical geometry to have a specific head count.
803
804 `iops`=`<iops>` ;;
805
806 Maximum r/w I/O in operations per second.
807
808 `iops_max`=`<iops>` ;;
809
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.
815
816 `iops_rd`=`<iops>` ;;
817
818 Maximum read I/O in operations per second.
819
820 `iops_rd_max`=`<iops>` ;;
821
822 Maximum unthrottled read I/O pool in operations per second.
823
824 `iops_rd_max_length`=`<seconds>` ;;
825
826 Maximum length of read I/O bursts in seconds.
827
828 `iops_wr`=`<iops>` ;;
829
830 Maximum write I/O in operations per second.
831
832 `iops_wr_max`=`<iops>` ;;
833
834 Maximum unthrottled write I/O pool in operations per second.
835
836 `iops_wr_max_length`=`<seconds>` ;;
837
838 Maximum length of write I/O bursts in seconds.
839
840 `iothread`=`<boolean>` ;;
841
842 Whether to use iothreads for this drive
843
844 `mbps`=`<mbps>` ;;
845
846 Maximum r/w speed in megabytes per second.
847
848 `mbps_max`=`<mbps>` ;;
849
850 Maximum unthrottled r/w pool in megabytes per second.
851
852 `mbps_rd`=`<mbps>` ;;
853
854 Maximum read speed in megabytes per second.
855
856 `mbps_rd_max`=`<mbps>` ;;
857
858 Maximum unthrottled read pool in megabytes per second.
859
860 `mbps_wr`=`<mbps>` ;;
861
862 Maximum write speed in megabytes per second.
863
864 `mbps_wr_max`=`<mbps>` ;;
865
866 Maximum unthrottled write pool in megabytes per second.
867
868 `media`=`<cdrom | disk>` ('default =' `disk`);;
869
870 The drive's media type.
871
872 `queues`=`<integer> (2 - N)` ;;
873
874 Number of queues.
875
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
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
890 `secs`=`<integer>` ;;
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
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
904 `size`=`<DiskSize>` ;;
905
906 Disk size. This is purely informational and has no effect.
907
908 `snapshot`=`<boolean>` ;;
909
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.
911
912 `ssd`=`<boolean>` ;;
913
914 Whether to expose this drive as an SSD, rather than a rotational hard disk.
915
916 `trans`=`<auto | lba | none>` ;;
917
918 Force disk geometry bios translation mode.
919
920 `werror`=`<enospc | ignore | report | stop>` ;;
921
922 Write error action.
923
924 `wwn`=`<wwn>` ;;
925
926 The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
927
928 `scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
929
930 SCSI controller model
931
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
936 `serial[n]`: `(/dev/.+|socket)` ::
937
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.
943 +
944 CAUTION: Experimental! User reported problems with this option.
945
946 `shares`: `<integer> (0 - 50000)` ('default =' `1000`)::
947
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.
949
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>]` ::
951
952 Specify SMBIOS type 1 fields.
953
954 `base64`=`<boolean>` ;;
955
956 Flag to indicate that the SMBIOS values are base64 encoded
957
958 `family`=`<Base64 encoded string>` ;;
959
960 Set SMBIOS1 family string.
961
962 `manufacturer`=`<Base64 encoded string>` ;;
963
964 Set SMBIOS1 manufacturer.
965
966 `product`=`<Base64 encoded string>` ;;
967
968 Set SMBIOS1 product ID.
969
970 `serial`=`<Base64 encoded string>` ;;
971
972 Set SMBIOS1 serial number.
973
974 `sku`=`<Base64 encoded string>` ;;
975
976 Set SMBIOS1 SKU string.
977
978 `uuid`=`<UUID>` ;;
979
980 Set SMBIOS1 UUID.
981
982 `version`=`<Base64 encoded string>` ;;
983
984 Set SMBIOS1 version.
985
986 `smp`: `<integer> (1 - N)` ('default =' `1`)::
987
988 The number of CPUs. Please use option -sockets instead.
989
990 `sockets`: `<integer> (1 - N)` ('default =' `1`)::
991
992 The number of CPU sockets.
993
994 `sshkeys`: `<string>` ::
995
996 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
997
998 `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
999
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'.
1001
1002 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1003
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.
1005
1006 `tablet`: `<boolean>` ('default =' `1`)::
1007
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).
1009
1010 `tdf`: `<boolean>` ('default =' `0`)::
1011
1012 Enable/disable time drift fix.
1013
1014 `template`: `<boolean>` ('default =' `0`)::
1015
1016 Enable/disable Template.
1017
1018 `unused[n]`: `<string>` ::
1019
1020 Reference to unused volumes. This is used internally, and should not be modified manually.
1021
1022 `usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
1023
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:
1029 +
1030  'bus-port(.port)*' (decimal numbers) or
1031  'vendor_id:product_id' (hexadeciaml numbers) or
1032  'spice'
1033 +
1034 You can use the 'lsusb -t' command to list existing usb devices.
1035 +
1036 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
1037 +
1038 The value 'spice' can be used to add a usb redirection devices for spice.
1039
1040 `usb3`=`<boolean>` ('default =' `0`);;
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).
1043
1044 `vcpus`: `<integer> (1 - N)` ('default =' `0`)::
1045
1046 Number of hotplugged vcpus.
1047
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
1057 `type`=`<cirrus | none | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ('default =' `std`);;
1058
1059 Select the VGA type.
1060
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>]` ::
1062
1063 Use volume as VIRTIO hard disk (n is 0 to 15).
1064
1065 `aio`=`<native | threads>` ;;
1066
1067 AIO type to use.
1068
1069 `backup`=`<boolean>` ;;
1070
1071 Whether the drive should be included when making backups.
1072
1073 `bps`=`<bps>` ;;
1074
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.
1080
1081 `bps_rd`=`<bps>` ;;
1082
1083 Maximum read speed in bytes per second.
1084
1085 `bps_rd_max_length`=`<seconds>` ;;
1086
1087 Maximum length of read I/O bursts in seconds.
1088
1089 `bps_wr`=`<bps>` ;;
1090
1091 Maximum write speed in bytes per second.
1092
1093 `bps_wr_max_length`=`<seconds>` ;;
1094
1095 Maximum length of write I/O bursts in seconds.
1096
1097 `cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
1098
1099 The drive's cache mode
1100
1101 `cyls`=`<integer>` ;;
1102
1103 Force the drive's physical geometry to have a specific cylinder count.
1104
1105 `detect_zeroes`=`<boolean>` ;;
1106
1107 Controls whether to detect and try to optimize writes of zeroes.
1108
1109 `discard`=`<ignore | on>` ;;
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
1117 `format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
1118
1119 The drive's backing file's data format.
1120
1121 `heads`=`<integer>` ;;
1122
1123 Force the drive's physical geometry to have a specific head count.
1124
1125 `iops`=`<iops>` ;;
1126
1127 Maximum r/w I/O in operations per second.
1128
1129 `iops_max`=`<iops>` ;;
1130
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.
1136
1137 `iops_rd`=`<iops>` ;;
1138
1139 Maximum read I/O in operations per second.
1140
1141 `iops_rd_max`=`<iops>` ;;
1142
1143 Maximum unthrottled read I/O pool in operations per second.
1144
1145 `iops_rd_max_length`=`<seconds>` ;;
1146
1147 Maximum length of read I/O bursts in seconds.
1148
1149 `iops_wr`=`<iops>` ;;
1150
1151 Maximum write I/O in operations per second.
1152
1153 `iops_wr_max`=`<iops>` ;;
1154
1155 Maximum unthrottled write I/O pool in operations per second.
1156
1157 `iops_wr_max_length`=`<seconds>` ;;
1158
1159 Maximum length of write I/O bursts in seconds.
1160
1161 `iothread`=`<boolean>` ;;
1162
1163 Whether to use iothreads for this drive
1164
1165 `mbps`=`<mbps>` ;;
1166
1167 Maximum r/w speed in megabytes per second.
1168
1169 `mbps_max`=`<mbps>` ;;
1170
1171 Maximum unthrottled r/w pool in megabytes per second.
1172
1173 `mbps_rd`=`<mbps>` ;;
1174
1175 Maximum read speed in megabytes per second.
1176
1177 `mbps_rd_max`=`<mbps>` ;;
1178
1179 Maximum unthrottled read pool in megabytes per second.
1180
1181 `mbps_wr`=`<mbps>` ;;
1182
1183 Maximum write speed in megabytes per second.
1184
1185 `mbps_wr_max`=`<mbps>` ;;
1186
1187 Maximum unthrottled write pool in megabytes per second.
1188
1189 `media`=`<cdrom | disk>` ('default =' `disk`);;
1190
1191 The drive's media type.
1192
1193 `replicate`=`<boolean>` ('default =' `1`);;
1194
1195 Whether the drive should considered for replication jobs.
1196
1197 `rerror`=`<ignore | report | stop>` ;;
1198
1199 Read error action.
1200
1201 `secs`=`<integer>` ;;
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
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
1215 `size`=`<DiskSize>` ;;
1216
1217 Disk size. This is purely informational and has no effect.
1218
1219 `snapshot`=`<boolean>` ;;
1220
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.
1222
1223 `trans`=`<auto | lba | none>` ;;
1224
1225 Force disk geometry bios translation mode.
1226
1227 `werror`=`<enospc | ignore | report | stop>` ;;
1228
1229 Write error action.
1230
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
1236 `vmstatestorage`: `<string>` ::
1237
1238 Default storage for VM state volumes/files.
1239
1240 `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1241
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
1244 `action`=`<debug | none | pause | poweroff | reset | shutdown>` ;;
1245
1246 The action to perform if after activation the guest fails to poll the watchdog in time.
1247
1248 `model`=`<i6300esb | ib700>` ('default =' `i6300esb`);;
1249
1250 Watchdog type to emulate.
1251