]> git.proxmox.com Git - pve-docs.git/blobdiff - qm.conf.5-opts.adoc
update generated docs
[pve-docs.git] / qm.conf.5-opts.adoc
index 125b4b072cc35861df1a227218ef042dd177c707..acc7d7598412a76c560dd83b3032ab1de9907b0a 100644 (file)
@@ -42,14 +42,18 @@ This is an alias for option -ide2
 
 The number of cores per socket.
 
-`cpu`: `[cputype=]<enum> [,hidden=<1|0>]` ::
+`cpu`: `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
 
 Emulated CPU type.
 
-`cputype`=`<486 | Broadwell | Broadwell-noTSX | Conroe | Haswell | Haswell-noTSX | IvyBridge | Nehalem | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | Westmere | athlon | core2duo | coreduo | host | kvm32 | kvm64 | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64>` ('default =' `kvm64`);;
+`cputype`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Conroe | Haswell | Haswell-IBRS | Haswell-noTSX | Haswell-noTSX-IBRS | IvyBridge | IvyBridge-IBRS | Nehalem | Nehalem-IBRS | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | SandyBridge-IBRS | Skylake-Client | Skylake-Client-IBRS | Skylake-Server | Skylake-Server-IBRS | Westmere | Westmere-IBRS | athlon | core2duo | coreduo | host | kvm32 | kvm64 | max | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64>` ('default =' `kvm64`);;
 
 Emulated CPU type.
 
+`flags`=`<+FLAG[;-FLAG...]>` ;;
+
+List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl'.
+
 `hidden`=`<boolean>` ('default =' `0`);;
 
 Do not identify as a KVM virtual machine.
@@ -60,11 +64,9 @@ Limit of CPU usage.
 +
 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
 
-`cpuunits`: `<integer> (0 - 500000)` ('default =' `1024`)::
+`cpuunits`: `<integer> (2 - 262144)` ('default =' `1024`)::
 
 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.
-+
-NOTE: You can disable fair-scheduler configuration by setting this to 0.
 
 `description`: `<string>` ::
 
@@ -132,7 +134,7 @@ Selectively enable hotplug features. This is a comma separated list of hotplug f
 
 Enable/disable hugepages memory.
 
-`ide[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`ide[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
 
 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
 
@@ -156,7 +158,7 @@ Maximum length of I/O bursts in seconds.
 
 Maximum read speed in bytes per second.
 
-`bps_rd_length`=`<seconds>` ;;
+`bps_rd_max_length`=`<seconds>` ;;
 
 Maximum length of read I/O bursts in seconds.
 
@@ -164,7 +166,7 @@ Maximum length of read I/O bursts in seconds.
 
 Maximum write speed in bytes per second.
 
-`bps_wr_length`=`<seconds>` ;;
+`bps_wr_max_length`=`<seconds>` ;;
 
 Maximum length of write I/O bursts in seconds.
 
@@ -212,26 +214,26 @@ Maximum length of I/O bursts in seconds.
 
 Maximum read I/O in operations per second.
 
-`iops_rd_length`=`<seconds>` ;;
-
-Maximum length of read I/O bursts in seconds.
-
 `iops_rd_max`=`<iops>` ;;
 
 Maximum unthrottled read I/O pool in operations per second.
 
-`iops_wr`=`<iops>` ;;
+`iops_rd_max_length`=`<seconds>` ;;
 
-Maximum write I/O in operations per second.
+Maximum length of read I/O bursts in seconds.
 
-`iops_wr_length`=`<seconds>` ;;
+`iops_wr`=`<iops>` ;;
 
-Maximum length of write I/O bursts in seconds.
+Maximum write I/O in operations per second.
 
 `iops_wr_max`=`<iops>` ;;
 
 Maximum unthrottled write I/O pool in operations per second.
 
+`iops_wr_max_length`=`<seconds>` ;;
+
+Maximum length of write I/O bursts in seconds.
+
 `mbps`=`<mbps>` ;;
 
 Maximum r/w speed in megabytes per second.
@@ -264,6 +266,10 @@ The drive's media type.
 
 The drive's reported model name, url-encoded, up to 40 bytes long.
 
+`replicate`=`<boolean>` ('default =' `1`);;
+
+Whether the drive should considered for replication jobs.
+
 `rerror`=`<ignore | report | stop>` ;;
 
 Read error action.
@@ -292,9 +298,9 @@ Force disk geometry bios translation mode.
 
 Write error action.
 
-`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`)::
+`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>` ::
 
-Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
+Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.
 
 `kvm`: `<boolean>` ('default =' `1`)::
 
@@ -420,7 +426,8 @@ w2k3;; Microsoft Windows 2003
 w2k8;; Microsoft Windows 2008
 wvista;; Microsoft Windows Vista
 win7;; Microsoft Windows 7
-win8;; Microsoft Windows 8/2012
+win8;; Microsoft Windows 8/2012/2012r2
+win10;; Microsoft Windows 10/2016
 l24;; Linux 2.4 Kernel
 l26;; Linux 2.6/3.X Kernel
 solaris;; Solaris/OpenSolaris/OpenIndiania kernel
@@ -441,7 +448,7 @@ Sets the protection flag of the VM. This will disable the remove VM and remove d
 
 Allow reboot. If set to '0' the VM exit on reboot.
 
-`sata[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`sata[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
 
 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
 
@@ -465,7 +472,7 @@ Maximum length of I/O bursts in seconds.
 
 Maximum read speed in bytes per second.
 
-`bps_rd_length`=`<seconds>` ;;
+`bps_rd_max_length`=`<seconds>` ;;
 
 Maximum length of read I/O bursts in seconds.
 
@@ -473,7 +480,7 @@ Maximum length of read I/O bursts in seconds.
 
 Maximum write speed in bytes per second.
 
-`bps_wr_length`=`<seconds>` ;;
+`bps_wr_max_length`=`<seconds>` ;;
 
 Maximum length of write I/O bursts in seconds.
 
@@ -521,26 +528,26 @@ Maximum length of I/O bursts in seconds.
 
 Maximum read I/O in operations per second.
 
-`iops_rd_length`=`<seconds>` ;;
-
-Maximum length of read I/O bursts in seconds.
-
 `iops_rd_max`=`<iops>` ;;
 
 Maximum unthrottled read I/O pool in operations per second.
 
-`iops_wr`=`<iops>` ;;
+`iops_rd_max_length`=`<seconds>` ;;
 
-Maximum write I/O in operations per second.
+Maximum length of read I/O bursts in seconds.
 
-`iops_wr_length`=`<seconds>` ;;
+`iops_wr`=`<iops>` ;;
 
-Maximum length of write I/O bursts in seconds.
+Maximum write I/O in operations per second.
 
 `iops_wr_max`=`<iops>` ;;
 
 Maximum unthrottled write I/O pool in operations per second.
 
+`iops_wr_max_length`=`<seconds>` ;;
+
+Maximum length of write I/O bursts in seconds.
+
 `mbps`=`<mbps>` ;;
 
 Maximum r/w speed in megabytes per second.
@@ -569,6 +576,10 @@ Maximum unthrottled write pool in megabytes per second.
 
 The drive's media type.
 
+`replicate`=`<boolean>` ('default =' `1`);;
+
+Whether the drive should considered for replication jobs.
+
 `rerror`=`<ignore | report | stop>` ;;
 
 Read error action.
@@ -597,7 +608,7 @@ Force disk geometry bios translation mode.
 
 Write error action.
 
-`scsi[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`scsi[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
 
 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
 
@@ -621,7 +632,7 @@ Maximum length of I/O bursts in seconds.
 
 Maximum read speed in bytes per second.
 
-`bps_rd_length`=`<seconds>` ;;
+`bps_rd_max_length`=`<seconds>` ;;
 
 Maximum length of read I/O bursts in seconds.
 
@@ -629,7 +640,7 @@ Maximum length of read I/O bursts in seconds.
 
 Maximum write speed in bytes per second.
 
-`bps_wr_length`=`<seconds>` ;;
+`bps_wr_max_length`=`<seconds>` ;;
 
 Maximum length of write I/O bursts in seconds.
 
@@ -677,26 +688,26 @@ Maximum length of I/O bursts in seconds.
 
 Maximum read I/O in operations per second.
 
-`iops_rd_length`=`<seconds>` ;;
-
-Maximum length of read I/O bursts in seconds.
-
 `iops_rd_max`=`<iops>` ;;
 
 Maximum unthrottled read I/O pool in operations per second.
 
-`iops_wr`=`<iops>` ;;
+`iops_rd_max_length`=`<seconds>` ;;
 
-Maximum write I/O in operations per second.
+Maximum length of read I/O bursts in seconds.
 
-`iops_wr_length`=`<seconds>` ;;
+`iops_wr`=`<iops>` ;;
 
-Maximum length of write I/O bursts in seconds.
+Maximum write I/O in operations per second.
 
 `iops_wr_max`=`<iops>` ;;
 
 Maximum unthrottled write I/O pool in operations per second.
 
+`iops_wr_max_length`=`<seconds>` ;;
+
+Maximum length of write I/O bursts in seconds.
+
 `iothread`=`<boolean>` ;;
 
 Whether to use iothreads for this drive
@@ -733,6 +744,14 @@ The drive's media type.
 
 Number of queues.
 
+`replicate`=`<boolean>` ('default =' `1`);;
+
+Whether the drive should considered for replication jobs.
+
+`rerror`=`<ignore | report | stop>` ;;
+
+Read error action.
+
 `scsiblock`=`<boolean>` ('default =' `0`);;
 
 whether to use scsi-block for full passthrough of host block device
@@ -875,7 +894,7 @@ Number of hotplugged vcpus.
 
 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.
 
-`virtio[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`virtio[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
 
 Use volume as VIRTIO hard disk (n is 0 to 15).
 
@@ -899,7 +918,7 @@ Maximum length of I/O bursts in seconds.
 
 Maximum read speed in bytes per second.
 
-`bps_rd_length`=`<seconds>` ;;
+`bps_rd_max_length`=`<seconds>` ;;
 
 Maximum length of read I/O bursts in seconds.
 
@@ -907,7 +926,7 @@ Maximum length of read I/O bursts in seconds.
 
 Maximum write speed in bytes per second.
 
-`bps_wr_length`=`<seconds>` ;;
+`bps_wr_max_length`=`<seconds>` ;;
 
 Maximum length of write I/O bursts in seconds.
 
@@ -955,26 +974,26 @@ Maximum length of I/O bursts in seconds.
 
 Maximum read I/O in operations per second.
 
-`iops_rd_length`=`<seconds>` ;;
-
-Maximum length of read I/O bursts in seconds.
-
 `iops_rd_max`=`<iops>` ;;
 
 Maximum unthrottled read I/O pool in operations per second.
 
-`iops_wr`=`<iops>` ;;
+`iops_rd_max_length`=`<seconds>` ;;
 
-Maximum write I/O in operations per second.
+Maximum length of read I/O bursts in seconds.
 
-`iops_wr_length`=`<seconds>` ;;
+`iops_wr`=`<iops>` ;;
 
-Maximum length of write I/O bursts in seconds.
+Maximum write I/O in operations per second.
 
 `iops_wr_max`=`<iops>` ;;
 
 Maximum unthrottled write I/O pool in operations per second.
 
+`iops_wr_max_length`=`<seconds>` ;;
+
+Maximum length of write I/O bursts in seconds.
+
 `iothread`=`<boolean>` ;;
 
 Whether to use iothreads for this drive
@@ -1007,6 +1026,10 @@ Maximum unthrottled write pool in megabytes per second.
 
 The drive's media type.
 
+`replicate`=`<boolean>` ('default =' `1`);;
+
+Whether the drive should considered for replication jobs.
+
 `rerror`=`<ignore | report | stop>` ;;
 
 Read error action.
@@ -1035,6 +1058,10 @@ Force disk geometry bios translation mode.
 
 Write error action.
 
+`vmstatestorage`: `<string>` ::
+
+Default storage for VM state volumes/files.
+
 `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
 
 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)