]> git.proxmox.com Git - pve-docs.git/blame_incremental - qm.conf.5-opts.adoc
pve-dblatex.xsl: define all dblatec settings inside this file
[pve-docs.git] / qm.conf.5-opts.adoc
... / ...
CommitLineData
1`acpi`: `boolean` (default=`1`)::
2
3Enable/disable ACPI.
4
5`agent`: `boolean` (default=`0`)::
6
7Enable/disable Qemu GuestAgent.
8
9`args`: `string` ::
10
11Arbitrary arguments passed to kvm, for example:
12+
13args: -no-reboot -no-hpet
14+
15NOTE: this option is for experts only.
16
17`autostart`: `boolean` (default=`0`)::
18
19Automatic restart after crash (currently ignored).
20
21`balloon`: `integer (0 - N)` ::
22
23Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
24
25`bios`: `(ovmf | seabios)` (default=`seabios`)::
26
27Select BIOS implementation.
28
29`boot`: `[acdn]{1,4}` (default=`cdn`)::
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
37`cdrom`: `volume` ::
38
39This is an alias for option -ide2
40
41`cores`: `integer (1 - N)` (default=`1`)::
42
43The number of cores per socket.
44
45`cpu`: `[cputype=]<cputype> [,hidden=<1|0>]` ::
46
47Emulated CPU type.
48
49`cputype`=`<cputype>` (default=`kvm64`);;
50
51Emulated CPU type.
52
53`hidden`=`boolean` (default=`0`);;
54
55Do not identify as a KVM virtual machine.
56
57`cpulimit`: `number (0 - 128)` (default=`0`)::
58
59Limit of CPU usage.
60+
61NOTE: 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
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.
66+
67NOTE: You can disable fair-scheduler configuration by setting this to 0.
68
69`description`: `string` ::
70
71Description 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=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,size=<DiskSize>]` ::
74
75Configure a Disk for storing EFI vars
76
77`file`=`<volume>` ;;
78
79The drive's backing volume.
80
81`format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
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
89`freeze`: `boolean` ::
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
95Map host PCI devices into guest.
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.
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:
106+
107'bus:dev.func' (hexadecimal numbers)
108+
109You can us the 'lspci' command to list existing PCI devices.
110
111`pcie`=`boolean` (default=`0`);;
112
113Choose the PCI-express bus (needs the 'q35' machine model).
114
115`rombar`=`boolean` (default=`1`);;
116
117Specify whether or not the device's ROM will be visible in the guest's memory map.
118
119`x-vga`=`boolean` (default=`0`);;
120
121Enable vfio-vga device support.
122
123`hotplug`: `string` (default=`network,disk,usb`)::
124
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'.
126
127`hugepages`: `(1024 | 2 | any)` ::
128
129Enable/disable hugepages memory.
130
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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
132
133Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
134
135`aio`=`(native | threads)` ;;
136
137AIO type to use.
138
139`backup`=`boolean` ;;
140
141Whether the drive should be included when making backups.
142
143`bps`=`<bps>` ;;
144
145Maximum r/w speed in bytes per second.
146
147`bps_max_length`=`<seconds>` ;;
148
149Maximum length of I/O bursts in seconds.
150
151`bps_rd`=`<bps>` ;;
152
153Maximum read speed in bytes per second.
154
155`bps_rd_length`=`<seconds>` ;;
156
157Maximum length of read I/O bursts in seconds.
158
159`bps_wr`=`<bps>` ;;
160
161Maximum write speed in bytes per second.
162
163`bps_wr_length`=`<seconds>` ;;
164
165Maximum length of write I/O bursts in seconds.
166
167`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
168
169The drive's cache mode
170
171`cyls`=`integer` ;;
172
173Force the drive's physical geometry to have a specific cylinder count.
174
175`detect_zeroes`=`boolean` ;;
176
177Controls whether to detect and try to optimize writes of zeroes.
178
179`discard`=`(ignore | on)` ;;
180
181Controls whether to pass discard/trim requests to the underlying storage.
182
183`file`=`<volume>` ;;
184
185The drive's backing volume.
186
187`format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
188
189The drive's backing file's data format.
190
191`heads`=`integer` ;;
192
193Force the drive's physical geometry to have a specific head count.
194
195`iops`=`<iops>` ;;
196
197Maximum r/w I/O in operations per second.
198
199`iops_max`=`<iops>` ;;
200
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.
206
207`iops_rd`=`<iops>` ;;
208
209Maximum read I/O in operations per second.
210
211`iops_rd_length`=`<seconds>` ;;
212
213Maximum length of read I/O bursts in seconds.
214
215`iops_rd_max`=`<iops>` ;;
216
217Maximum unthrottled read I/O pool in operations per second.
218
219`iops_wr`=`<iops>` ;;
220
221Maximum write I/O in operations per second.
222
223`iops_wr_length`=`<seconds>` ;;
224
225Maximum length of write I/O bursts in seconds.
226
227`iops_wr_max`=`<iops>` ;;
228
229Maximum unthrottled write I/O pool in operations per second.
230
231`mbps`=`<mbps>` ;;
232
233Maximum r/w speed in megabytes per second.
234
235`mbps_max`=`<mbps>` ;;
236
237Maximum unthrottled r/w pool in megabytes per second.
238
239`mbps_rd`=`<mbps>` ;;
240
241Maximum read speed in megabytes per second.
242
243`mbps_rd_max`=`<mbps>` ;;
244
245Maximum unthrottled read pool in megabytes per second.
246
247`mbps_wr`=`<mbps>` ;;
248
249Maximum write speed in megabytes per second.
250
251`mbps_wr_max`=`<mbps>` ;;
252
253Maximum unthrottled write pool in megabytes per second.
254
255`media`=`(cdrom | disk)` (default=`disk`);;
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
263`rerror`=`(ignore | report | stop)` ;;
264
265Read error action.
266
267`secs`=`integer` ;;
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
279`snapshot`=`boolean` ;;
280
281Whether the drive should be included when making snapshots.
282
283`trans`=`(auto | lba | none)` ;;
284
285Force disk geometry bios translation mode.
286
287`werror`=`(enospc | ignore | report | stop)` ;;
288
289Write error action.
290
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`)::
292
293Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
294
295`kvm`: `boolean` (default=`1`)::
296
297Enable/disable KVM hardware virtualization.
298
299`localtime`: `boolean` ::
300
301Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
302
303`lock`: `(backup | migrate | rollback | snapshot)` ::
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
311`memory`: `integer (16 - N)` (default=`512`)::
312
313Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
314
315`migrate_downtime`: `number (0 - N)` (default=`0.1`)::
316
317Set maximum tolerated downtime (in seconds) for migrations.
318
319`migrate_speed`: `integer (0 - N)` (default=`0`)::
320
321Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
322
323`name`: `string` ::
324
325Set a name for the VM. Only used on the configuration web interface.
326
327`net[n]`: `[model=]<model> [,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>]` ::
328
329Specify network devices.
330
331`bridge`=`<bridge>` ;;
332
333Bridge to attach the network device to. The Proxmox VE standard bridge
334is called 'vmbr0'.
335+
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:
339+
340 10.0.2.2 Gateway
341 10.0.2.3 DNS Server
342 10.0.2.4 SMB Server
343+
344The DHCP server assign addresses to the guest starting from 10.0.2.15.
345
346`firewall`=`boolean` ;;
347
348Whether this interface should be protected by the firewall.
349
350`link_down`=`boolean` ;;
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
358`model`=`<model>` ;;
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
362`queues`=`integer (0 - 16)` ;;
363
364Number of packet queues to be used on the device.
365
366`rate`=`number (0 - N)` ;;
367
368Rate limit in mbps (megabytes per second) as floating point number.
369
370`tag`=`integer (1 - 4094)` ;;
371
372VLAN tag to apply to packets on this interface.
373
374`trunks`=`<vlanid[;vlanid...]>` ;;
375
376VLAN trunks to pass through this interface.
377
378`numa`: `boolean` (default=`0`)::
379
380Enable/disable NUMA.
381
382`numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
383
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
394`memory`=`number` ;;
395
396Amount of memory this NUMA node provides.
397
398`policy`=`(bind | interleave | preferred)` ;;
399
400NUMA allocation policy.
401
402`onboot`: `boolean` (default=`0`)::
403
404Specifies whether a VM will be started during system bootup.
405
406`ostype`: `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
407
408Specify guest operating system. This is used to enable special
409optimization/features for specific operating systems:
410+
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
423
424`parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
425
426Map host parallel devices (n is 0 to 2).
427+
428NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
429+
430CAUTION: Experimental! User reported problems with this option.
431
432`protection`: `boolean` (default=`0`)::
433
434Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
435
436`reboot`: `boolean` (default=`1`)::
437
438Allow reboot. If set to '0' the VM exit on reboot.
439
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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
441
442Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
443
444`aio`=`(native | threads)` ;;
445
446AIO type to use.
447
448`backup`=`boolean` ;;
449
450Whether the drive should be included when making backups.
451
452`bps`=`<bps>` ;;
453
454Maximum r/w speed in bytes per second.
455
456`bps_max_length`=`<seconds>` ;;
457
458Maximum length of I/O bursts in seconds.
459
460`bps_rd`=`<bps>` ;;
461
462Maximum read speed in bytes per second.
463
464`bps_rd_length`=`<seconds>` ;;
465
466Maximum length of read I/O bursts in seconds.
467
468`bps_wr`=`<bps>` ;;
469
470Maximum write speed in bytes per second.
471
472`bps_wr_length`=`<seconds>` ;;
473
474Maximum length of write I/O bursts in seconds.
475
476`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
477
478The drive's cache mode
479
480`cyls`=`integer` ;;
481
482Force the drive's physical geometry to have a specific cylinder count.
483
484`detect_zeroes`=`boolean` ;;
485
486Controls whether to detect and try to optimize writes of zeroes.
487
488`discard`=`(ignore | on)` ;;
489
490Controls whether to pass discard/trim requests to the underlying storage.
491
492`file`=`<volume>` ;;
493
494The drive's backing volume.
495
496`format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
497
498The drive's backing file's data format.
499
500`heads`=`integer` ;;
501
502Force the drive's physical geometry to have a specific head count.
503
504`iops`=`<iops>` ;;
505
506Maximum r/w I/O in operations per second.
507
508`iops_max`=`<iops>` ;;
509
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.
515
516`iops_rd`=`<iops>` ;;
517
518Maximum read I/O in operations per second.
519
520`iops_rd_length`=`<seconds>` ;;
521
522Maximum length of read I/O bursts in seconds.
523
524`iops_rd_max`=`<iops>` ;;
525
526Maximum unthrottled read I/O pool in operations per second.
527
528`iops_wr`=`<iops>` ;;
529
530Maximum write I/O in operations per second.
531
532`iops_wr_length`=`<seconds>` ;;
533
534Maximum length of write I/O bursts in seconds.
535
536`iops_wr_max`=`<iops>` ;;
537
538Maximum unthrottled write I/O pool in operations per second.
539
540`mbps`=`<mbps>` ;;
541
542Maximum r/w speed in megabytes per second.
543
544`mbps_max`=`<mbps>` ;;
545
546Maximum unthrottled r/w pool in megabytes per second.
547
548`mbps_rd`=`<mbps>` ;;
549
550Maximum read speed in megabytes per second.
551
552`mbps_rd_max`=`<mbps>` ;;
553
554Maximum unthrottled read pool in megabytes per second.
555
556`mbps_wr`=`<mbps>` ;;
557
558Maximum write speed in megabytes per second.
559
560`mbps_wr_max`=`<mbps>` ;;
561
562Maximum unthrottled write pool in megabytes per second.
563
564`media`=`(cdrom | disk)` (default=`disk`);;
565
566The drive's media type.
567
568`rerror`=`(ignore | report | stop)` ;;
569
570Read error action.
571
572`secs`=`integer` ;;
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
584`snapshot`=`boolean` ;;
585
586Whether the drive should be included when making snapshots.
587
588`trans`=`(auto | lba | none)` ;;
589
590Force disk geometry bios translation mode.
591
592`werror`=`(enospc | ignore | report | stop)` ;;
593
594Write error action.
595
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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
597
598Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
599
600`aio`=`(native | threads)` ;;
601
602AIO type to use.
603
604`backup`=`boolean` ;;
605
606Whether the drive should be included when making backups.
607
608`bps`=`<bps>` ;;
609
610Maximum r/w speed in bytes per second.
611
612`bps_max_length`=`<seconds>` ;;
613
614Maximum length of I/O bursts in seconds.
615
616`bps_rd`=`<bps>` ;;
617
618Maximum read speed in bytes per second.
619
620`bps_rd_length`=`<seconds>` ;;
621
622Maximum length of read I/O bursts in seconds.
623
624`bps_wr`=`<bps>` ;;
625
626Maximum write speed in bytes per second.
627
628`bps_wr_length`=`<seconds>` ;;
629
630Maximum length of write I/O bursts in seconds.
631
632`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
633
634The drive's cache mode
635
636`cyls`=`integer` ;;
637
638Force the drive's physical geometry to have a specific cylinder count.
639
640`detect_zeroes`=`boolean` ;;
641
642Controls whether to detect and try to optimize writes of zeroes.
643
644`discard`=`(ignore | on)` ;;
645
646Controls whether to pass discard/trim requests to the underlying storage.
647
648`file`=`<volume>` ;;
649
650The drive's backing volume.
651
652`format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
653
654The drive's backing file's data format.
655
656`heads`=`integer` ;;
657
658Force the drive's physical geometry to have a specific head count.
659
660`iops`=`<iops>` ;;
661
662Maximum r/w I/O in operations per second.
663
664`iops_max`=`<iops>` ;;
665
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.
671
672`iops_rd`=`<iops>` ;;
673
674Maximum read I/O in operations per second.
675
676`iops_rd_length`=`<seconds>` ;;
677
678Maximum length of read I/O bursts in seconds.
679
680`iops_rd_max`=`<iops>` ;;
681
682Maximum unthrottled read I/O pool in operations per second.
683
684`iops_wr`=`<iops>` ;;
685
686Maximum write I/O in operations per second.
687
688`iops_wr_length`=`<seconds>` ;;
689
690Maximum length of write I/O bursts in seconds.
691
692`iops_wr_max`=`<iops>` ;;
693
694Maximum unthrottled write I/O pool in operations per second.
695
696`iothread`=`boolean` ;;
697
698Whether to use iothreads for this drive
699
700`mbps`=`<mbps>` ;;
701
702Maximum r/w speed in megabytes per second.
703
704`mbps_max`=`<mbps>` ;;
705
706Maximum unthrottled r/w pool in megabytes per second.
707
708`mbps_rd`=`<mbps>` ;;
709
710Maximum read speed in megabytes per second.
711
712`mbps_rd_max`=`<mbps>` ;;
713
714Maximum unthrottled read pool in megabytes per second.
715
716`mbps_wr`=`<mbps>` ;;
717
718Maximum write speed in megabytes per second.
719
720`mbps_wr_max`=`<mbps>` ;;
721
722Maximum unthrottled write pool in megabytes per second.
723
724`media`=`(cdrom | disk)` (default=`disk`);;
725
726The drive's media type.
727
728`queues`=`integer (2 - N)` ;;
729
730Number of queues.
731
732`secs`=`integer` ;;
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
744`snapshot`=`boolean` ;;
745
746Whether the drive should be included when making snapshots.
747
748`trans`=`(auto | lba | none)` ;;
749
750Force disk geometry bios translation mode.
751
752`werror`=`(enospc | ignore | report | stop)` ;;
753
754Write error action.
755
756`scsihw`: `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
757
758SCSI controller model
759
760`serial[n]`: `(/dev/.+|socket)` ::
761
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.
767+
768CAUTION: Experimental! User reported problems with this option.
769
770`shares`: `integer (0 - 50000)` (default=`1000`)::
771
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
773
774`smbios1`: `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
775
776Specify SMBIOS type 1 fields.
777
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
806`smp`: `integer (1 - N)` (default=`1`)::
807
808The number of CPUs. Please use option -sockets instead.
809
810`sockets`: `integer (1 - N)` (default=`1`)::
811
812The number of CPU sockets.
813
814`startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
815
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'.
817
818`startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
819
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.
821
822`tablet`: `boolean` (default=`1`)::
823
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).
825
826`tdf`: `boolean` (default=`0`)::
827
828Enable/disable time drift fix.
829
830`template`: `boolean` (default=`0`)::
831
832Enable/disable Template.
833
834`unused[n]`: `string` ::
835
836Reference to unused volumes. This is used internally, and should not be modified manually.
837
838`usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
839
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:
845+
846 'bus-port(.port)*' (decimal numbers) or
847 'vendor_id:product_id' (hexadeciaml numbers) or
848 'spice'
849+
850You can use the 'lsusb -t' command to list existing usb devices.
851+
852NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
853+
854The value 'spice' can be used to add a usb redirection devices for spice.
855
856`usb3`=`boolean` (default=`0`);;
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).
859
860`vcpus`: `integer (1 - N)` (default=`0`)::
861
862Number of hotplugged vcpus.
863
864`vga`: `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
865
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.
867
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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
869
870Use volume as VIRTIO hard disk (n is 0 to 15).
871
872`aio`=`(native | threads)` ;;
873
874AIO type to use.
875
876`backup`=`boolean` ;;
877
878Whether the drive should be included when making backups.
879
880`bps`=`<bps>` ;;
881
882Maximum r/w speed in bytes per second.
883
884`bps_max_length`=`<seconds>` ;;
885
886Maximum length of I/O bursts in seconds.
887
888`bps_rd`=`<bps>` ;;
889
890Maximum read speed in bytes per second.
891
892`bps_rd_length`=`<seconds>` ;;
893
894Maximum length of read I/O bursts in seconds.
895
896`bps_wr`=`<bps>` ;;
897
898Maximum write speed in bytes per second.
899
900`bps_wr_length`=`<seconds>` ;;
901
902Maximum length of write I/O bursts in seconds.
903
904`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
905
906The drive's cache mode
907
908`cyls`=`integer` ;;
909
910Force the drive's physical geometry to have a specific cylinder count.
911
912`detect_zeroes`=`boolean` ;;
913
914Controls whether to detect and try to optimize writes of zeroes.
915
916`discard`=`(ignore | on)` ;;
917
918Controls whether to pass discard/trim requests to the underlying storage.
919
920`file`=`<volume>` ;;
921
922The drive's backing volume.
923
924`format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
925
926The drive's backing file's data format.
927
928`heads`=`integer` ;;
929
930Force the drive's physical geometry to have a specific head count.
931
932`iops`=`<iops>` ;;
933
934Maximum r/w I/O in operations per second.
935
936`iops_max`=`<iops>` ;;
937
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.
943
944`iops_rd`=`<iops>` ;;
945
946Maximum read I/O in operations per second.
947
948`iops_rd_length`=`<seconds>` ;;
949
950Maximum length of read I/O bursts in seconds.
951
952`iops_rd_max`=`<iops>` ;;
953
954Maximum unthrottled read I/O pool in operations per second.
955
956`iops_wr`=`<iops>` ;;
957
958Maximum write I/O in operations per second.
959
960`iops_wr_length`=`<seconds>` ;;
961
962Maximum length of write I/O bursts in seconds.
963
964`iops_wr_max`=`<iops>` ;;
965
966Maximum unthrottled write I/O pool in operations per second.
967
968`iothread`=`boolean` ;;
969
970Whether to use iothreads for this drive
971
972`mbps`=`<mbps>` ;;
973
974Maximum r/w speed in megabytes per second.
975
976`mbps_max`=`<mbps>` ;;
977
978Maximum unthrottled r/w pool in megabytes per second.
979
980`mbps_rd`=`<mbps>` ;;
981
982Maximum read speed in megabytes per second.
983
984`mbps_rd_max`=`<mbps>` ;;
985
986Maximum unthrottled read pool in megabytes per second.
987
988`mbps_wr`=`<mbps>` ;;
989
990Maximum write speed in megabytes per second.
991
992`mbps_wr_max`=`<mbps>` ;;
993
994Maximum unthrottled write pool in megabytes per second.
995
996`media`=`(cdrom | disk)` (default=`disk`);;
997
998The drive's media type.
999
1000`rerror`=`(ignore | report | stop)` ;;
1001
1002Read error action.
1003
1004`secs`=`integer` ;;
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
1016`snapshot`=`boolean` ;;
1017
1018Whether the drive should be included when making snapshots.
1019
1020`trans`=`(auto | lba | none)` ;;
1021
1022Force disk geometry bios translation mode.
1023
1024`werror`=`(enospc | ignore | report | stop)` ;;
1025
1026Write error action.
1027
1028`watchdog`: `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` ::
1029
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
1032`action`=`(debug | none | pause | poweroff | reset | shutdown)` ;;
1033
1034The action to perform if after activation the guest fails to poll the watchdog in time.
1035
1036`model`=`(i6300esb | ib700)` (default=`i6300esb`);;
1037
1038Watchdog type to emulate.
1039