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