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