pct: add note about storage:size syntax

[pve-docs.git] / qm.conf.5-opts.adoc

diff --git a/qm.conf.5-opts.adoc b/qm.conf.5-opts.adoc
index 125b4b072cc35861df1a227218ef042dd177c707..65cccb68de02116b42505ad00c83da0927b5f8de 100644 (file)
--- a/qm.conf.5-opts.adoc
+++ b/qm.conf.5-opts.adoc
@@ -46,7 +46,7 @@ The number of cores per socket.
 
 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-noTSX | Conroe | Haswell | Haswell-noTSX | IvyBridge | Nehalem | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | Skylake-Client | Westmere | athlon | core2duo | coreduo | host | kvm32 | kvm64 | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64>` ('default =' `kvm64`);;
 
 Emulated CPU type.
 
@@ -132,7 +132,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 +156,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 +164,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 +212,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 +264,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.
@@ -441,7 +445,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 +469,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 +477,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 +525,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 +573,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 +605,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 +629,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 +637,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 +685,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 +741,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 +891,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 +915,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 +923,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 +971,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 +1023,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.