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