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.
+
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>` ::
Freeze CPU at startup (use 'c' monitor command to start execution).
-`hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
+`hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
Map host PCI devices into guest.
+
Specify whether or not the device's ROM will be visible in the guest's memory map.
+`romfile`=`<string>` ;;
+
+Custom pci device rom filename (must be located in /usr/share/kvm/).
+
`x-vga`=`<boolean>` ('default =' `0`);;
Enable vfio-vga device support.
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).
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.
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.
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.
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.
Specifies whether a VM will be started during system bootup.
-`ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp>` ::
+`ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
Specify guest operating system. This is used to enable special
optimization/features for specific operating systems:
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).
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.
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.
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.
The drive's media type.
+`replicate`=`<boolean>` ('default =' `1`);;
+
+Whether the drive should considered for replication jobs.
+
`rerror`=`<ignore | report | stop>` ;;
Read error action.
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>] [,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).
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.
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.
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
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
++
+WARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host
+
`secs`=`<integer>` ;;
Force the drive's physical geometry to have a specific sector count.
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).
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.
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.
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
The drive's media type.
+`replicate`=`<boolean>` ('default =' `1`);;
+
+Whether the drive should considered for replication jobs.
+
`rerror`=`<ignore | report | stop>` ;;
Read error action.
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)
projects / pve-docs.git / blobdiff