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