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