proxmox-mirrors/pve-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-docs synced 2025-04-29 03:50:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update auto generated docs

Browse Source
This commit is contained in:
Dietmar Maurer 2016-11-03 13:21:10 +01:00
parent 2f379f8cdd
commit de0983cb5f
10 changed files with 1298 additions and 366 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1075
api-viewer/apidata.js
View File

File diff suppressed because it is too large Load Diff

14
datacenter.cfg.5-opts.adoc
View File

@ -32,7 +32,19 @@ Prefix for autogenerated MAC addresses.
Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.
`migration`: `[type=]<secure|insecure> [,network=<CIDR>]` ::
For cluster wide migration settings.
`network`=`<CIDR>` ;;
CIDR of the (sub) network that is used for migration.
`type`=`(insecure | secure)` (default=`secure`);;
Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
`migration_unsecure`: `boolean` ::
Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration.
Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration. Deprecated, use the 'migration' property instead!

16
pct-mountpoint-opts.adoc
View File

@ -1,6 +1,6 @@
`rootfs`: `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]`
`rootfs`: `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]`
`mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]`
`mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]`
`acl`: `boolean` ::
@ -8,11 +8,11 @@ Explicitly enable or disable ACL support.
`backup`: `boolean` ::
Whether to include the mountpoint in backups (only used for volume mountpoints).
Whether to include the mount point in backups (only used for volume mount points).
`mp`: `<Path>` ::
Path to the mountpoint as seen from inside the container.
Path to the mount point as seen from inside the container.
+
NOTE: Must not contain any symlinks for security reasons.
@ -22,7 +22,13 @@ Enable user quotas inside the container (not supported with zfs subvolumes)
`ro`: `boolean` ::
Read-only mountpoint
Read-only mount point
`shared`: `boolean` (default=`0`)::
Mark this non-volume mount point as available on all nodes.
+
WARNING: This option does not share the mount point automatically, it assumes it is shared already!
`size`: `<DiskSize>` ::

34
pct.1-synopsis.adoc
View File

@ -66,6 +66,12 @@ The (unique) ID of the VM.
*pct cpusets*
Print the list of assigned CPU sets.
*pct create* `<vmid> <ostemplate>` `[OPTIONS]`
@ -91,6 +97,10 @@ Console mode. By default, the console command tries to open a connection to one
Attach a console device (/dev/console) to the container.
`-cores` `integer (1 - 128)` ::
The number of cores assigned to the container. A container can use all available cores by default.
`-cpulimit` `number (0 - 128)` (default=`0`)::
Limit of CPU usage.
@ -127,7 +137,7 @@ Lock/unlock the VM.
Amount of RAM for the VM in MB.
`-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
`-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
Use volume as container mount point.
@ -163,7 +173,7 @@ Sets the protection flag of the container. This will prevent the CT or CT's disk
Mark this as restore task.
`-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
`-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
Use volume as container root.
@ -336,7 +346,7 @@ Target node.
`-force` `boolean` ::
Force migration despite local bind / device mounts. WARNING: identical bind / device mounts need to be available on the target node.
Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.
`-online` `boolean` ::
@ -420,7 +430,7 @@ Owner user name or id. When using a name it must exist inside the container.
*pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
Resize a container mountpoint.
Resize a container mount point.
`<vmid>` `integer (1 - N)` ::
@ -464,6 +474,10 @@ Console mode. By default, the console command tries to open a connection to one
Attach a console device (/dev/console) to the container.
`-cores` `integer (1 - 128)` ::
The number of cores assigned to the container. A container can use all available cores by default.
`-cpulimit` `number (0 - 128)` (default=`0`)::
Limit of CPU usage.
@ -500,7 +514,7 @@ Lock/unlock the VM.
Amount of RAM for the VM in MB.
`-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
`-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
Use volume as container mount point.
@ -532,7 +546,7 @@ Add the VM to the specified pool.
Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
`-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
`-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
Use volume as container root.
@ -621,6 +635,10 @@ Console mode. By default, the console command tries to open a connection to one
Attach a console device (/dev/console) to the container.
`-cores` `integer (1 - 128)` ::
The number of cores assigned to the container. A container can use all available cores by default.
`-cpulimit` `number (0 - 128)` (default=`0`)::
Limit of CPU usage.
@ -657,7 +675,7 @@ Lock/unlock the VM.
Amount of RAM for the VM in MB.
`-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
`-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
Use volume as container mount point.
@ -681,7 +699,7 @@ OS type. This is used to setup configuration inside the container, and correspon
Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
`-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
`-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
Use volume as container root.

28
pct.conf.5-opts.adoc
View File

@ -10,6 +10,10 @@ Console mode. By default, the console command tries to open a connection to one
Attach a console device (/dev/console) to the container.
`cores`: `integer (1 - 128)` ::
The number of cores assigned to the container. A container can use all available cores by default.
`cpulimit`: `number (0 - 128)` (default=`0`)::
Limit of CPU usage.
@ -38,7 +42,7 @@ Lock/unlock the VM.
Amount of RAM for the VM in MB.
`mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
`mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
Use volume as container mount point.
@ -48,11 +52,11 @@ Explicitly enable or disable ACL support.
`backup`=`boolean` ;;
Whether to include the mountpoint in backups (only used for volume mountpoints).
Whether to include the mount point in backups (only used for volume mount points).
`mp`=`<Path>` ;;
Path to the mountpoint as seen from inside the container.
Path to the mount point as seen from inside the container.
+
NOTE: Must not contain any symlinks for security reasons.
@ -62,7 +66,13 @@ Enable user quotas inside the container (not supported with zfs subvolumes)
`ro`=`boolean` ;;
Read-only mountpoint
Read-only mount point
`shared`=`boolean` (default=`0`);;
Mark this non-volume mount point as available on all nodes.
+
WARNING: This option does not share the mount point automatically, it assumes it is shared already!
`size`=`<DiskSize>` ;;
@ -144,7 +154,7 @@ OS type. This is used to setup configuration inside the container, and correspon
Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
`rootfs`: `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
`rootfs`: `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
Use volume as container root.
@ -158,7 +168,13 @@ Enable user quotas inside the container (not supported with zfs subvolumes)
`ro`=`boolean` ;;
Read-only mountpoint
Read-only mount point
`shared`=`boolean` (default=`0`);;
Mark this non-volume mount point as available on all nodes.
+
WARNING: This option does not share the mount point automatically, it assumes it is shared already!
`size`=`<DiskSize>` ;;

29
pve-firewall-rules-opts.adoc
View File

@ -1,41 +1,24 @@
`-dest` `string` ::
Restrict packet destination address. This can refer to a single IP address,
an IP set ('+ipsetname') or an IP alias definition. You can also specify an
address range like '20.34.101.207-201.3.9.99', or a list of IP addresses
and networks (entries are separated by comma). Please do not mix IPv4 and
IPv6 addresses inside such lists.
Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.
`-dport` `string` ::
Restrict TCP/UDP destination port. You can use service names or simple
numbers (0-65535), as defined in '/etc/services'. Port ranges can be
specified with '\d+:\d+', for example '80:85', and you can use comma
separated list to match several ports or ranges.
Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.
`-iface` `string` ::
Network interface name. You have to use network configuration key names for
VMs and containers ('net\d+'). Host related rules can use arbitrary
strings.
Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.
`-proto` `string` ::
IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as
defined in '/etc/protocols'.
IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.
`-source` `string` ::
Restrict packet source address. This can refer to a single IP address, an
IP set ('+ipsetname') or an IP alias definition. You can also specify an
address range like '20.34.101.207-201.3.9.99', or a list of IP addresses
and networks (entries are separated by comma). Please do not mix IPv4 and
IPv6 addresses inside such lists.
Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.
`-sport` `string` ::
Restrict TCP/UDP source port. You can use service names or simple numbers
(0-65535), as defined in '/etc/services'. Port ranges can be specified with
'\d+:\d+', for example '80:85', and you can use comma separated list to
match several ports or ranges.
Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.

6
pve-firewall-vm-opts.adoc
View File

@ -8,11 +8,7 @@ Enable/disable firewall rules.
`ipfilter`: `boolean` ::
Enable default IP filters. This is equivalent to adding an empty
ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain
sane default restrictions such as restricting IPv6 link local addresses to
the one derived from the interface's MAC address. For containers the
configured IP addresses will be implicitly added.
Enable default IP filters. This is equivalent to adding an empty ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added.
`log_level_in`: `(alert | crit | debug | emerg | err | info | nolog | notice | warning)` ::

14
pvecm.1-synopsis.adoc
View File

@ -144,6 +144,20 @@ Output file name
*pvecm mtunnel* `[OPTIONS]`
Used by VM/CT migration - do not use manually.
`-get_migration_ip` `boolean` (default=`0`)::
return the migration IP, if configured
`-migration_network` `string` ::
the migration network used to detect the local migration IP
*pvecm nodes*
Displays the local view of the cluster nodes.

54
qm.1-synopsis.adoc
View File

@ -125,7 +125,7 @@ Emulated CPU type.
Limit of CPU usage.
`-cpuunits` `integer (0 - 500000)` (default=`1000`)::
`-cpuunits` `integer (0 - 500000)` (default=`1024`)::
CPU weight for a VM.
@ -133,7 +133,7 @@ CPU weight for a VM.
Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
`-efidisk0` `[file=]<volume> [,format=<image format>] [,size=<DiskSize>]` ::
`-efidisk0` `[file=]<volume> [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,size=<DiskSize>]` ::
Configure a Disk for storing EFI vars
@ -159,7 +159,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_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>]` ::
`-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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
@ -235,11 +235,11 @@ 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_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>]` ::
`-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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
`-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>]` ::
`-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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
@ -313,7 +313,7 @@ Number of hotplugged vcpus.
Select the VGA type.
`-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>]` ::
`-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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
Use volume as VIRTIO hard disk (n is 0 to 15).
@ -381,6 +381,16 @@ Determine the full status of active VMs.
*qm listsnapshot* `<vmid>`
List all snapshots.
`<vmid>` `integer (1 - N)` ::
The (unique) ID of the VM.
*qm migrate* `<vmid> <target>` `[OPTIONS]`
Migrate virtual machine. Creates a new migration task.
@ -397,6 +407,14 @@ Target node.
Allow to migrate VMs which use local devices. Only root may use this option.
`-migration_network` `string` ::
CIDR of the (sub) network that is used for migration.
`-migration_type` `(insecure | secure)` ::
Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
`-online` `boolean` ::
Use online/live migration.
@ -623,7 +641,7 @@ Emulated CPU type.
Limit of CPU usage.
`-cpuunits` `integer (0 - 500000)` (default=`1000`)::
`-cpuunits` `integer (0 - 500000)` (default=`1024`)::
CPU weight for a VM.
@ -639,7 +657,7 @@ Description for the VM. Only used on the configuration web interface. This is sa
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
`-efidisk0` `[file=]<volume> [,format=<image format>] [,size=<DiskSize>]` ::
`-efidisk0` `[file=]<volume> [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,size=<DiskSize>]` ::
Configure a Disk for storing EFI vars
@ -665,7 +683,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_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>]` ::
`-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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
@ -741,11 +759,11 @@ Allow reboot. If set to '0' the VM exit on reboot.
Revert a pending change.
`-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>]` ::
`-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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
`-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>]` ::
`-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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
@ -813,7 +831,7 @@ Number of hotplugged vcpus.
Select the VGA type.
`-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>]` ::
`-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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
Use volume as VIRTIO hard disk (n is 0 to 15).
@ -851,7 +869,7 @@ Make sure the VM stops.
`-keepActive` `boolean` (default=`0`)::
Do not decativate storage volumes.
Do not deactivate storage volumes.
`-skiplock` `boolean` ::
@ -901,6 +919,14 @@ Specific the Qemu machine type.
The cluster node name.
`-migration_network` `string` ::
CIDR of the (sub) network that is used for migration.
`-migration_type` `(insecure | secure)` ::
Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
`-skiplock` `boolean` ::
Ignore locks - only root is allowed to use this option.
@ -938,7 +964,7 @@ The (unique) ID of the VM.
`-keepActive` `boolean` (default=`0`)::
Do not decativate storage volumes.
Do not deactivate storage volumes.
`-migratedfrom` `string` ::

394
qm.conf.5-opts.adoc
View File

@ -38,6 +38,162 @@ Enable booting from specified disk.
This is an alias for option -ide2
`aio`=`(native | threads)` ;;
AIO type to use.
`backup`=`boolean` ;;
Whether the drive should be included when making backups.
`bps`=`<bps>` ;;
Maximum r/w speed in bytes per second.
`bps_max_length`=`<seconds>` ;;
Maximum length of I/O bursts in seconds.
`bps_rd`=`<bps>` ;;
Maximum read speed in bytes per second.
`bps_rd_length`=`<seconds>` ;;
Maximum length of read I/O bursts in seconds.
`bps_wr`=`<bps>` ;;
Maximum write speed in bytes per second.
`bps_wr_length`=`<seconds>` ;;
Maximum length of write I/O bursts in seconds.
`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
The drive's cache mode
`cyls`=`integer` ;;
Force the drive's physical geometry to have a specific cylinder count.
`detect_zeroes`=`boolean` ;;
Controls whether to detect and try to optimize writes of zeroes.
`discard`=`(ignore | on)` ;;
Controls whether to pass discard/trim requests to the underlying storage.
`file`=`<volume>` ;;
The drive's backing volume.
`format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
The drive's backing file's data format.
`heads`=`integer` ;;
Force the drive's physical geometry to have a specific head count.
`iops`=`<iops>` ;;
Maximum r/w I/O in operations per second.
`iops_max`=`<iops>` ;;
Maximum unthrottled r/w I/O pool in operations per second.
`iops_max_length`=`<seconds>` ;;
Maximum length of I/O bursts in seconds.
`iops_rd`=`<iops>` ;;
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>` ;;
Maximum write I/O in operations per second.
`iops_wr_length`=`<seconds>` ;;
Maximum length of write I/O bursts in seconds.
`iops_wr_max`=`<iops>` ;;
Maximum unthrottled write I/O pool in operations per second.
`mbps`=`<mbps>` ;;
Maximum r/w speed in megabytes per second.
`mbps_max`=`<mbps>` ;;
Maximum unthrottled r/w pool in megabytes per second.
`mbps_rd`=`<mbps>` ;;
Maximum read speed in megabytes per second.
`mbps_rd_max`=`<mbps>` ;;
Maximum unthrottled read pool in megabytes per second.
`mbps_wr`=`<mbps>` ;;
Maximum write speed in megabytes per second.
`mbps_wr_max`=`<mbps>` ;;
Maximum unthrottled write pool in megabytes per second.
`media`=`(cdrom | disk)` (default=`disk`);;
The drive's media type.
`model`=`<model>` ;;
The drive's reported model name, url-encoded, up to 40 bytes long.
`rerror`=`(ignore | report | stop)` ;;
Read error action.
`secs`=`integer` ;;
Force the drive's physical geometry to have a specific sector count.
`serial`=`<serial>` ;;
The drive's reported serial number, url-encoded, up to 20 bytes long.
`size`=`<DiskSize>` ;;
Disk size. This is purely informational and has no effect.
`snapshot`=`boolean` ;;
Whether the drive should be included when making snapshots.
`trans`=`(auto | lba | none)` ;;
Force disk geometry bios translation mode.
`werror`=`(enospc | ignore | report | stop)` ;;
Write error action.
`cores`: `integer (1 - N)` (default=`1`)::
The number of cores per socket.
@ -60,7 +216,7 @@ 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=`1000`)::
`cpuunits`: `integer (0 - 500000)` (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.
+
@ -70,7 +226,7 @@ NOTE: You can disable fair-scheduler configuration by setting this to 0.
Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
`efidisk0`: `[file=]<volume> [,format=<image format>] [,size=<DiskSize>]` ::
`efidisk0`: `[file=]<volume> [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,size=<DiskSize>]` ::
Configure a Disk for storing EFI vars
@ -78,7 +234,7 @@ Configure a Disk for storing EFI vars
The drive's backing volume.
`format`=`<image format>` ;;
`format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
The drive's backing file's data format.
@ -128,7 +284,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_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>]` ::
`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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
@ -142,15 +298,27 @@ Whether the drive should be included when making backups.
`bps`=`<bps>` ;;
Maximum r/w speed speed in bytes per second.
Maximum r/w speed in bytes per second.
`bps_max_length`=`<seconds>` ;;
Maximum length of I/O bursts in seconds.
`bps_rd`=`<bps>` ;;
Maximum read speed speed in bytes per second.
Maximum read speed in bytes per second.
`bps_rd_length`=`<seconds>` ;;
Maximum length of read I/O bursts in seconds.
`bps_wr`=`<bps>` ;;
Maximum write speed speed in bytes per second.
Maximum write speed in bytes per second.
`bps_wr_length`=`<seconds>` ;;
Maximum length of write I/O bursts in seconds.
`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
@ -172,7 +340,7 @@ Controls whether to pass discard/trim requests to the underlying storage.
The drive's backing volume.
`format`=`<image format>` ;;
`format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
The drive's backing file's data format.
@ -182,51 +350,63 @@ Force the drive's physical geometry to have a specific head count.
`iops`=`<iops>` ;;
Maximum r/w I/O speed in operations per second.
Maximum r/w I/O in operations per second.
`iops_max`=`<iops>` ;;
Maximum unthrottled r/w I/O pool speed in operations per second.
Maximum unthrottled r/w I/O pool in operations per second.
`iops_max_length`=`<seconds>` ;;
Maximum length of I/O bursts in seconds.
`iops_rd`=`<iops>` ;;
Maximum read I/O speed in operations per second.
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 speed in operations per second.
Maximum unthrottled read I/O pool in operations per second.
`iops_wr`=`<iops>` ;;
Maximum write I/O speed in operations per second.
Maximum write I/O in operations per second.
`iops_wr_length`=`<seconds>` ;;
Maximum length of write I/O bursts in seconds.
`iops_wr_max`=`<iops>` ;;
Maximum unthrottled write I/O pool speed in operations per second.
Maximum unthrottled write I/O pool in operations per second.
`mbps`=`<mbps>` ;;
Maximum r/w speed speed in megabytes per second.
Maximum r/w speed in megabytes per second.
`mbps_max`=`<mbps>` ;;
Maximum unthrottled r/w pool speed in megabytes per second.
Maximum unthrottled r/w pool in megabytes per second.
`mbps_rd`=`<mbps>` ;;
Maximum read speed speed in megabytes per second.
Maximum read speed in megabytes per second.
`mbps_rd_max`=`<mbps>` ;;
Maximum unthrottled read pool speed in megabytes per second.
Maximum unthrottled read pool in megabytes per second.
`mbps_wr`=`<mbps>` ;;
Maximum write speed speed in megabytes per second.
Maximum write speed in megabytes per second.
`mbps_wr_max`=`<mbps>` ;;
Maximum unthrottled write pool speed in megabytes per second.
Maximum unthrottled write pool in megabytes per second.
`media`=`(cdrom | disk)` (default=`disk`);;
@ -413,7 +593,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_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>]` ::
`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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
@ -427,15 +607,27 @@ Whether the drive should be included when making backups.
`bps`=`<bps>` ;;
Maximum r/w speed speed in bytes per second.
Maximum r/w speed in bytes per second.
`bps_max_length`=`<seconds>` ;;
Maximum length of I/O bursts in seconds.
`bps_rd`=`<bps>` ;;
Maximum read speed speed in bytes per second.
Maximum read speed in bytes per second.
`bps_rd_length`=`<seconds>` ;;
Maximum length of read I/O bursts in seconds.
`bps_wr`=`<bps>` ;;
Maximum write speed speed in bytes per second.
Maximum write speed in bytes per second.
`bps_wr_length`=`<seconds>` ;;
Maximum length of write I/O bursts in seconds.
`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
@ -457,7 +649,7 @@ Controls whether to pass discard/trim requests to the underlying storage.
The drive's backing volume.
`format`=`<image format>` ;;
`format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
The drive's backing file's data format.
@ -467,51 +659,63 @@ Force the drive's physical geometry to have a specific head count.
`iops`=`<iops>` ;;
Maximum r/w I/O speed in operations per second.
Maximum r/w I/O in operations per second.
`iops_max`=`<iops>` ;;
Maximum unthrottled r/w I/O pool speed in operations per second.
Maximum unthrottled r/w I/O pool in operations per second.
`iops_max_length`=`<seconds>` ;;
Maximum length of I/O bursts in seconds.
`iops_rd`=`<iops>` ;;
Maximum read I/O speed in operations per second.
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 speed in operations per second.
Maximum unthrottled read I/O pool in operations per second.
`iops_wr`=`<iops>` ;;
Maximum write I/O speed in operations per second.
Maximum write I/O in operations per second.
`iops_wr_length`=`<seconds>` ;;
Maximum length of write I/O bursts in seconds.
`iops_wr_max`=`<iops>` ;;
Maximum unthrottled write I/O pool speed in operations per second.
Maximum unthrottled write I/O pool in operations per second.
`mbps`=`<mbps>` ;;
Maximum r/w speed speed in megabytes per second.
Maximum r/w speed in megabytes per second.
`mbps_max`=`<mbps>` ;;
Maximum unthrottled r/w pool speed in megabytes per second.
Maximum unthrottled r/w pool in megabytes per second.
`mbps_rd`=`<mbps>` ;;
Maximum read speed speed in megabytes per second.
Maximum read speed in megabytes per second.
`mbps_rd_max`=`<mbps>` ;;
Maximum unthrottled read pool speed in megabytes per second.
Maximum unthrottled read pool in megabytes per second.
`mbps_wr`=`<mbps>` ;;
Maximum write speed speed in megabytes per second.
Maximum write speed in megabytes per second.
`mbps_wr_max`=`<mbps>` ;;
Maximum unthrottled write pool speed in megabytes per second.
Maximum unthrottled write pool in megabytes per second.
`media`=`(cdrom | disk)` (default=`disk`);;
@ -545,7 +749,7 @@ Force disk geometry bios translation mode.
Write error action.
`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>]` ::
`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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
@ -559,15 +763,27 @@ Whether the drive should be included when making backups.
`bps`=`<bps>` ;;
Maximum r/w speed speed in bytes per second.
Maximum r/w speed in bytes per second.
`bps_max_length`=`<seconds>` ;;
Maximum length of I/O bursts in seconds.
`bps_rd`=`<bps>` ;;
Maximum read speed speed in bytes per second.
Maximum read speed in bytes per second.
`bps_rd_length`=`<seconds>` ;;
Maximum length of read I/O bursts in seconds.
`bps_wr`=`<bps>` ;;
Maximum write speed speed in bytes per second.
Maximum write speed in bytes per second.
`bps_wr_length`=`<seconds>` ;;
Maximum length of write I/O bursts in seconds.
`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
@ -589,7 +805,7 @@ Controls whether to pass discard/trim requests to the underlying storage.
The drive's backing volume.
`format`=`<image format>` ;;
`format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
The drive's backing file's data format.
@ -599,27 +815,39 @@ Force the drive's physical geometry to have a specific head count.
`iops`=`<iops>` ;;
Maximum r/w I/O speed in operations per second.
Maximum r/w I/O in operations per second.
`iops_max`=`<iops>` ;;
Maximum unthrottled r/w I/O pool speed in operations per second.
Maximum unthrottled r/w I/O pool in operations per second.
`iops_max_length`=`<seconds>` ;;
Maximum length of I/O bursts in seconds.
`iops_rd`=`<iops>` ;;
Maximum read I/O speed in operations per second.
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 speed in operations per second.
Maximum unthrottled read I/O pool in operations per second.
`iops_wr`=`<iops>` ;;
Maximum write I/O speed in operations per second.
Maximum write I/O in operations per second.
`iops_wr_length`=`<seconds>` ;;
Maximum length of write I/O bursts in seconds.
`iops_wr_max`=`<iops>` ;;
Maximum unthrottled write I/O pool speed in operations per second.
Maximum unthrottled write I/O pool in operations per second.
`iothread`=`boolean` ;;
@ -627,27 +855,27 @@ Whether to use iothreads for this drive
`mbps`=`<mbps>` ;;
Maximum r/w speed speed in megabytes per second.
Maximum r/w speed in megabytes per second.
`mbps_max`=`<mbps>` ;;
Maximum unthrottled r/w pool speed in megabytes per second.
Maximum unthrottled r/w pool in megabytes per second.
`mbps_rd`=`<mbps>` ;;
Maximum read speed speed in megabytes per second.
Maximum read speed in megabytes per second.
`mbps_rd_max`=`<mbps>` ;;
Maximum unthrottled read pool speed in megabytes per second.
Maximum unthrottled read pool in megabytes per second.
`mbps_wr`=`<mbps>` ;;
Maximum write speed speed in megabytes per second.
Maximum write speed in megabytes per second.
`mbps_wr_max`=`<mbps>` ;;
Maximum unthrottled write pool speed in megabytes per second.
Maximum unthrottled write pool in megabytes per second.
`media`=`(cdrom | disk)` (default=`disk`);;
@ -793,7 +1021,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_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>]` ::
`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=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,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=<enospc|ignore|report|stop>]` ::
Use volume as VIRTIO hard disk (n is 0 to 15).
@ -807,15 +1035,27 @@ Whether the drive should be included when making backups.
`bps`=`<bps>` ;;
Maximum r/w speed speed in bytes per second.
Maximum r/w speed in bytes per second.
`bps_max_length`=`<seconds>` ;;
Maximum length of I/O bursts in seconds.
`bps_rd`=`<bps>` ;;
Maximum read speed speed in bytes per second.
Maximum read speed in bytes per second.
`bps_rd_length`=`<seconds>` ;;
Maximum length of read I/O bursts in seconds.
`bps_wr`=`<bps>` ;;
Maximum write speed speed in bytes per second.
Maximum write speed in bytes per second.
`bps_wr_length`=`<seconds>` ;;
Maximum length of write I/O bursts in seconds.
`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
@ -837,7 +1077,7 @@ Controls whether to pass discard/trim requests to the underlying storage.
The drive's backing volume.
`format`=`<image format>` ;;
`format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
The drive's backing file's data format.
@ -847,27 +1087,39 @@ Force the drive's physical geometry to have a specific head count.
`iops`=`<iops>` ;;
Maximum r/w I/O speed in operations per second.
Maximum r/w I/O in operations per second.
`iops_max`=`<iops>` ;;
Maximum unthrottled r/w I/O pool speed in operations per second.
Maximum unthrottled r/w I/O pool in operations per second.
`iops_max_length`=`<seconds>` ;;
Maximum length of I/O bursts in seconds.
`iops_rd`=`<iops>` ;;
Maximum read I/O speed in operations per second.
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 speed in operations per second.
Maximum unthrottled read I/O pool in operations per second.
`iops_wr`=`<iops>` ;;
Maximum write I/O speed in operations per second.
Maximum write I/O in operations per second.
`iops_wr_length`=`<seconds>` ;;
Maximum length of write I/O bursts in seconds.
`iops_wr_max`=`<iops>` ;;
Maximum unthrottled write I/O pool speed in operations per second.
Maximum unthrottled write I/O pool in operations per second.
`iothread`=`boolean` ;;
@ -875,27 +1127,27 @@ Whether to use iothreads for this drive
`mbps`=`<mbps>` ;;
Maximum r/w speed speed in megabytes per second.
Maximum r/w speed in megabytes per second.
`mbps_max`=`<mbps>` ;;
Maximum unthrottled r/w pool speed in megabytes per second.
Maximum unthrottled r/w pool in megabytes per second.
`mbps_rd`=`<mbps>` ;;
Maximum read speed speed in megabytes per second.
Maximum read speed in megabytes per second.
`mbps_rd_max`=`<mbps>` ;;
Maximum unthrottled read pool speed in megabytes per second.
Maximum unthrottled read pool in megabytes per second.
`mbps_wr`=`<mbps>` ;;
Maximum write speed speed in megabytes per second.
Maximum write speed in megabytes per second.
`mbps_wr_max`=`<mbps>` ;;
Maximum unthrottled write pool speed in megabytes per second.
Maximum unthrottled write pool in megabytes per second.
`media`=`(cdrom | disk)` (default=`disk`);;