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