From de0983cb5feb38143ada8d2f9fa99d4f7102d497 Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Thu, 3 Nov 2016 13:21:10 +0100 Subject: [PATCH] update auto generated docs --- api-viewer/apidata.js | 1075 ++++++++++++++++++++++++++-------- datacenter.cfg.5-opts.adoc | 14 +- pct-mountpoint-opts.adoc | 16 +- pct.1-synopsis.adoc | 34 +- pct.conf.5-opts.adoc | 28 +- pve-firewall-rules-opts.adoc | 29 +- pve-firewall-vm-opts.adoc | 6 +- pvecm.1-synopsis.adoc | 14 + qm.1-synopsis.adoc | 54 +- qm.conf.5-opts.adoc | 394 ++++++++++--- 10 files changed, 1298 insertions(+), 366 deletions(-) diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index a141a6f..ef12c93 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -2248,7 +2248,8 @@ var pveapi = [ [ "Sys.Modify" ] - ] + ], + "description" : "The 'tmpdir', 'dumpdir' and 'script' parameters are additionally restricted to the 'root@pam' user." }, "protected" : 1, "returns" : { @@ -3202,8 +3203,33 @@ var pveapi = [ "type" : "integer", "typetext" : "integer (1 - N)" }, + "migration" : { + "description" : "For cluster wide migration settings.", + "format" : { + "network" : { + "description" : "CIDR of the (sub) network that is used for migration.", + "format" : "CIDR", + "format_description" : "CIDR", + "optional" : 1, + "type" : "string" + }, + "type" : { + "default" : "secure", + "default_key" : 1, + "description" : "Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.", + "enum" : [ + "secure", + "insecure" + ], + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[type=] [,network=]" + }, "migration_unsecure" : { - "description" : "Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration.", + "description" : "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!", "optional" : 1, "type" : "boolean" } @@ -5210,7 +5236,7 @@ var pveapi = [ }, "cdrom" : { "description" : "This is an alias for option -ide2", - "format" : "pve-qm-drive", + "format" : "pve-qm-ide", "optional" : 1, "type" : "string", "typetext" : "volume" @@ -5285,7 +5311,7 @@ var pveapi = [ "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit." }, "cpuunits" : { - "default" : 1000, + "default" : 1024, "description" : "CPU weight for a VM.", "maximum" : 500000, "minimum" : 0, @@ -5365,23 +5391,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -5431,7 +5478,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -5441,73 +5487,94 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -5592,7 +5659,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "keyboard" : { "default" : "en-us", @@ -5932,23 +5999,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -5998,7 +6086,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -6008,73 +6095,94 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -6151,7 +6259,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "scsi[n]" : { "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).", @@ -6171,23 +6279,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -6237,7 +6366,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -6247,37 +6375,58 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" @@ -6288,37 +6437,37 @@ var pveapi = [ "type" : "boolean" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -6391,7 +6540,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "scsihw" : { "default" : "lsi", @@ -6558,23 +6707,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -6624,7 +6794,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -6634,37 +6803,58 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" @@ -6675,37 +6865,37 @@ var pveapi = [ "type" : "boolean" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -6782,7 +6972,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "vmid" : { "description" : "The (unique) ID of the VM.", @@ -6889,7 +7079,7 @@ var pveapi = [ }, "cdrom" : { "description" : "This is an alias for option -ide2", - "format" : "pve-qm-drive", + "format" : "pve-qm-ide", "optional" : 1, "type" : "string", "typetext" : "volume" @@ -6964,7 +7154,7 @@ var pveapi = [ "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit." }, "cpuunits" : { - "default" : 1000, + "default" : 1024, "description" : "CPU weight for a VM.", "maximum" : 500000, "minimum" : 0, @@ -7044,23 +7234,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -7110,7 +7321,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -7120,73 +7330,94 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -7271,7 +7502,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "keyboard" : { "default" : "en-us", @@ -7611,23 +7842,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -7677,7 +7929,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -7687,73 +7938,94 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -7830,7 +8102,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "scsi[n]" : { "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).", @@ -7850,23 +8122,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -7916,7 +8209,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -7926,37 +8218,58 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" @@ -7967,37 +8280,37 @@ var pveapi = [ "type" : "boolean" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -8070,7 +8383,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "scsihw" : { "default" : "lsi", @@ -8237,23 +8550,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -8303,7 +8637,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -8313,37 +8646,58 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" @@ -8354,37 +8708,37 @@ var pveapi = [ "type" : "boolean" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -8461,7 +8815,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "vmid" : { "description" : "The (unique) ID of the VM.", @@ -8886,6 +9240,21 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "migration_network" : { + "description" : "CIDR of the (sub) network that is used for migration.", + "format" : "CIDR", + "optional" : 1, + "type" : "string" + }, + "migration_type" : { + "description" : "Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.", + "enum" : [ + "secure", + "insecure" + ], + "optional" : 1, + "type" : "string" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", @@ -8942,7 +9311,7 @@ var pveapi = [ "properties" : { "keepActive" : { "default" : 0, - "description" : "Do not decativate storage volumes.", + "description" : "Do not deactivate storage volumes.", "optional" : 1, "type" : "boolean" }, @@ -9063,7 +9432,7 @@ var pveapi = [ }, "keepActive" : { "default" : 0, - "description" : "Do not decativate storage volumes.", + "description" : "Do not deactivate storage volumes.", "optional" : 1, "type" : "boolean" }, @@ -9655,6 +10024,21 @@ var pveapi = [ "optional" : 1, "type" : "boolean" }, + "migration_network" : { + "description" : "CIDR of the (sub) network that is used for migration.", + "format" : "CIDR", + "optional" : 1, + "type" : "string" + }, + "migration_type" : { + "description" : "Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.", + "enum" : [ + "secure", + "insecure" + ], + "optional" : 1, + "type" : "string" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", @@ -10501,7 +10885,7 @@ var pveapi = [ }, "cdrom" : { "description" : "This is an alias for option -ide2", - "format" : "pve-qm-drive", + "format" : "pve-qm-ide", "optional" : 1, "type" : "string", "typetext" : "volume" @@ -10576,7 +10960,7 @@ var pveapi = [ "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit." }, "cpuunits" : { - "default" : 1000, + "default" : 1024, "description" : "CPU weight for a VM.", "maximum" : 500000, "minimum" : 0, @@ -10644,23 +11028,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -10710,7 +11115,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -10720,73 +11124,94 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -10871,7 +11296,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "keyboard" : { "default" : "en-us", @@ -11211,23 +11636,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -11277,7 +11723,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -11287,73 +11732,94 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -11430,7 +11896,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "scsi[n]" : { "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).", @@ -11450,23 +11916,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -11516,7 +12003,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -11526,37 +12012,58 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" @@ -11567,37 +12074,37 @@ var pveapi = [ "type" : "boolean" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -11670,7 +12177,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "scsihw" : { "default" : "lsi", @@ -11844,23 +12351,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -11910,7 +12438,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -11920,37 +12447,58 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" @@ -11961,37 +12509,37 @@ var pveapi = [ "type" : "boolean" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -12068,7 +12616,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "vmid" : { "description" : "The (unique) ID of the VM.", @@ -12183,6 +12731,14 @@ var pveapi = [ "optional" : 1, "type" : "boolean" }, + "cores" : { + "description" : "The number of cores assigned to the container. A container can use all available cores by default.", + "maximum" : 128, + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : "integer (1 - 128)" + }, "cpulimit" : { "default" : 0, "description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.", @@ -12253,17 +12809,17 @@ var pveapi = [ "type" : "boolean" }, "backup" : { - "description" : "Whether to include the mountpoint in backups.", + "description" : "Whether to include the mount point in backups.", "optional" : 1, "type" : "boolean", - "verbose_description" : "Whether to include the mountpoint in backups (only used for volume mountpoints)." + "verbose_description" : "Whether to include the mount point in backups (only used for volume mount points)." }, "mp" : { - "description" : "Path to the mountpoint as seen from inside the container (must not contain symlinks).", + "description" : "Path to the mount point as seen from inside the container (must not contain symlinks).", "format" : "pve-lxc-mp-string", "format_description" : "Path", "type" : "string", - "verbose_description" : "Path to the mountpoint as seen from inside the container.\n\nNOTE: Must not contain any symlinks for security reasons." + "verbose_description" : "Path to the mount point as seen from inside the container.\n\nNOTE: Must not contain any symlinks for security reasons." }, "quota" : { "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)", @@ -12271,10 +12827,17 @@ var pveapi = [ "type" : "boolean" }, "ro" : { - "description" : "Read-only mountpoint", + "description" : "Read-only mount point", "optional" : 1, "type" : "boolean" }, + "shared" : { + "default" : 0, + "description" : "Mark this non-volume mount point as available on multiple nodes (see 'nodes')", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this non-volume mount point as available on all nodes.\n\nWARNING: This option does not share the mount point automatically, it assumes it is shared already!" + }, "size" : { "description" : "Volume size (read only value).", "format" : "disk-size", @@ -12292,7 +12855,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=]" + "typetext" : "[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]" }, "nameserver" : { "description" : "Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.", @@ -12442,10 +13005,17 @@ var pveapi = [ "type" : "boolean" }, "ro" : { - "description" : "Read-only mountpoint", + "description" : "Read-only mount point", "optional" : 1, "type" : "boolean" }, + "shared" : { + "default" : 0, + "description" : "Mark this non-volume mount point as available on multiple nodes (see 'nodes')", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this non-volume mount point as available on all nodes.\n\nWARNING: This option does not share the mount point automatically, it assumes it is shared already!" + }, "size" : { "description" : "Volume size (read only value).", "format" : "disk-size", @@ -12463,7 +13033,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[volume=] [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=]" + "typetext" : "[volume=] [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]" }, "searchdomain" : { "description" : "Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.", @@ -15185,7 +15755,7 @@ var pveapi = [ "additionalProperties" : 0, "properties" : { "force" : { - "description" : "Force migration despite local bind / device mounts. WARNING: identical bind / device mounts need to be available on the target node.", + "description" : "Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.", "optional" : 1, "type" : "boolean" }, @@ -15463,7 +16033,7 @@ var pveapi = [ { "info" : { "PUT" : { - "description" : "Resize a container mountpoint.", + "description" : "Resize a container mount point.", "method" : "PUT", "name" : "resize_vm", "parameters" : { @@ -15690,6 +16260,14 @@ var pveapi = [ "optional" : 1, "type" : "boolean" }, + "cores" : { + "description" : "The number of cores assigned to the container. A container can use all available cores by default.", + "maximum" : 128, + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : "integer (1 - 128)" + }, "cpulimit" : { "default" : 0, "description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.", @@ -15758,17 +16336,17 @@ var pveapi = [ "type" : "boolean" }, "backup" : { - "description" : "Whether to include the mountpoint in backups.", + "description" : "Whether to include the mount point in backups.", "optional" : 1, "type" : "boolean", - "verbose_description" : "Whether to include the mountpoint in backups (only used for volume mountpoints)." + "verbose_description" : "Whether to include the mount point in backups (only used for volume mount points)." }, "mp" : { - "description" : "Path to the mountpoint as seen from inside the container (must not contain symlinks).", + "description" : "Path to the mount point as seen from inside the container (must not contain symlinks).", "format" : "pve-lxc-mp-string", "format_description" : "Path", "type" : "string", - "verbose_description" : "Path to the mountpoint as seen from inside the container.\n\nNOTE: Must not contain any symlinks for security reasons." + "verbose_description" : "Path to the mount point as seen from inside the container.\n\nNOTE: Must not contain any symlinks for security reasons." }, "quota" : { "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)", @@ -15776,10 +16354,17 @@ var pveapi = [ "type" : "boolean" }, "ro" : { - "description" : "Read-only mountpoint", + "description" : "Read-only mount point", "optional" : 1, "type" : "boolean" }, + "shared" : { + "default" : 0, + "description" : "Mark this non-volume mount point as available on multiple nodes (see 'nodes')", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this non-volume mount point as available on all nodes.\n\nWARNING: This option does not share the mount point automatically, it assumes it is shared already!" + }, "size" : { "description" : "Volume size (read only value).", "format" : "disk-size", @@ -15797,7 +16382,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=]" + "typetext" : "[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]" }, "nameserver" : { "description" : "Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.", @@ -15969,10 +16554,17 @@ var pveapi = [ "type" : "boolean" }, "ro" : { - "description" : "Read-only mountpoint", + "description" : "Read-only mount point", "optional" : 1, "type" : "boolean" }, + "shared" : { + "default" : 0, + "description" : "Mark this non-volume mount point as available on multiple nodes (see 'nodes')", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this non-volume mount point as available on all nodes.\n\nWARNING: This option does not share the mount point automatically, it assumes it is shared already!" + }, "size" : { "description" : "Volume size (read only value).", "format" : "disk-size", @@ -15990,7 +16582,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[volume=] [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=]" + "typetext" : "[volume=] [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]" }, "searchdomain" : { "description" : "Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.", @@ -17253,7 +17845,7 @@ var pveapi = [ } }, "permissions" : { - "description" : "The user needs 'VM.Backup' permissions on any VM, and 'Datastore.AllocateSpace' on the backup storage.", + "description" : "The user needs 'VM.Backup' permissions on any VM, and 'Datastore.AllocateSpace' on the backup storage. The 'maxfiles', 'tmpdir', 'dumpdir', 'script', 'bwlimit' and 'ionice' parameters are restricted to the 'root@pam' user.", "user" : "all" }, "protected" : 1, @@ -19711,6 +20303,23 @@ var pveapi = [ "protected" : 1, "proxyto" : "node", "returns" : { + "properties" : { + "attributes" : { + "optional" : 1, + "type" : "array" + }, + "health" : { + "type" : "string" + }, + "text" : { + "optional" : 1, + "type" : "string" + }, + "type" : { + "optional" : 1, + "type" : "string" + } + }, "type" : "object" } } diff --git a/datacenter.cfg.5-opts.adoc b/datacenter.cfg.5-opts.adoc index fb6eac3..df9d74f 100644 --- a/datacenter.cfg.5-opts.adoc +++ b/datacenter.cfg.5-opts.adoc @@ -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=] [,network=]` :: + +For cluster wide migration settings. + +`network`=`` ;; + +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! diff --git a/pct-mountpoint-opts.adoc b/pct-mountpoint-opts.adoc index 129e6fd..afd63a8 100644 --- a/pct-mountpoint-opts.adoc +++ b/pct-mountpoint-opts.adoc @@ -1,6 +1,6 @@ -`rootfs`: `[volume=] [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=]` +`rootfs`: `[volume=] [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` -`mp[n]`: `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=]` +`mp[n]`: `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` `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 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`: `` :: diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc index dfb9fb3..5db7c22 100644 --- a/pct.1-synopsis.adoc +++ b/pct.1-synopsis.adoc @@ -66,6 +66,12 @@ The (unique) ID of the VM. +*pct cpusets* + +Print the list of assigned CPU sets. + + + *pct create* ` ` `[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=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=]` :: +`-mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: 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=] [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=]` :: +`-rootfs` `[volume=] [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: 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* ` ` `[OPTIONS]` -Resize a container mountpoint. +Resize a container mount point. `` `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=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=]` :: +`-mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: 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=] [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=]` :: +`-rootfs` `[volume=] [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: 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=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=]` :: +`-mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: 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=] [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=]` :: +`-rootfs` `[volume=] [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: Use volume as container root. diff --git a/pct.conf.5-opts.adoc b/pct.conf.5-opts.adoc index dc93cb8..61ed91d 100644 --- a/pct.conf.5-opts.adoc +++ b/pct.conf.5-opts.adoc @@ -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=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=]` :: +`mp[n]`: `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: 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 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`=`` ;; @@ -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=] [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=]` :: +`rootfs`: `[volume=] [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: 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`=`` ;; diff --git a/pve-firewall-rules-opts.adoc b/pve-firewall-rules-opts.adoc index 0a6361d..0d6dc04 100644 --- a/pve-firewall-rules-opts.adoc +++ b/pve-firewall-rules-opts.adoc @@ -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. diff --git a/pve-firewall-vm-opts.adoc b/pve-firewall-vm-opts.adoc index c510a7b..253346c 100644 --- a/pve-firewall-vm-opts.adoc +++ b/pve-firewall-vm-opts.adoc @@ -8,11 +8,7 @@ Enable/disable firewall rules. `ipfilter`: `boolean` :: -Enable default IP filters. This is equivalent to adding an empty -ipfilter-net 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 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)` :: diff --git a/pvecm.1-synopsis.adoc b/pvecm.1-synopsis.adoc index 4665974..7224366 100644 --- a/pvecm.1-synopsis.adoc +++ b/pvecm.1-synopsis.adoc @@ -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. diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index cafec11..fec08cf 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -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=] [,format=] [,size=]` :: +`-efidisk0` `[file=] [,format=] [,size=]` :: 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=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`-ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: 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=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`-sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). -`-scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`-scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: 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=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`-virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as VIRTIO hard disk (n is 0 to 15). @@ -381,6 +381,16 @@ Determine the full status of active VMs. +*qm listsnapshot* `` + +List all snapshots. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + *qm migrate* ` ` `[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=] [,format=] [,size=]` :: +`-efidisk0` `[file=] [,format=] [,size=]` :: 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=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`-ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: 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=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`-sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). -`-scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`-scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: 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=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`-virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: 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` :: diff --git a/qm.conf.5-opts.adoc b/qm.conf.5-opts.adoc index 1ad9cdd..485c5aa 100644 --- a/qm.conf.5-opts.adoc +++ b/qm.conf.5-opts.adoc @@ -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`=`` ;; + +Maximum r/w speed in bytes per second. + +`bps_max_length`=`` ;; + +Maximum length of I/O bursts in seconds. + +`bps_rd`=`` ;; + +Maximum read speed in bytes per second. + +`bps_rd_length`=`` ;; + +Maximum length of read I/O bursts in seconds. + +`bps_wr`=`` ;; + +Maximum write speed in bytes per second. + +`bps_wr_length`=`` ;; + +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`=`` ;; + +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`=`` ;; + +Maximum r/w I/O in operations per second. + +`iops_max`=`` ;; + +Maximum unthrottled r/w I/O pool in operations per second. + +`iops_max_length`=`` ;; + +Maximum length of I/O bursts in seconds. + +`iops_rd`=`` ;; + +Maximum read I/O in operations per second. + +`iops_rd_length`=`` ;; + +Maximum length of read I/O bursts in seconds. + +`iops_rd_max`=`` ;; + +Maximum unthrottled read I/O pool in operations per second. + +`iops_wr`=`` ;; + +Maximum write I/O in operations per second. + +`iops_wr_length`=`` ;; + +Maximum length of write I/O bursts in seconds. + +`iops_wr_max`=`` ;; + +Maximum unthrottled write I/O pool in operations per second. + +`mbps`=`` ;; + +Maximum r/w speed in megabytes per second. + +`mbps_max`=`` ;; + +Maximum unthrottled r/w pool in megabytes per second. + +`mbps_rd`=`` ;; + +Maximum read speed in megabytes per second. + +`mbps_rd_max`=`` ;; + +Maximum unthrottled read pool in megabytes per second. + +`mbps_wr`=`` ;; + +Maximum write speed in megabytes per second. + +`mbps_wr_max`=`` ;; + +Maximum unthrottled write pool in megabytes per second. + +`media`=`(cdrom | disk)` (default=`disk`);; + +The drive's media type. + +`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`=`` ;; + +The drive's reported serial number, url-encoded, up to 20 bytes long. + +`size`=`` ;; + +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=] [,format=] [,size=]` :: +`efidisk0`: `[file=] [,format=] [,size=]` :: Configure a Disk for storing EFI vars @@ -78,7 +234,7 @@ Configure a Disk for storing EFI vars The drive's backing volume. -`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=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`ide[n]`: `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: 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`=`` ;; -Maximum r/w speed speed in bytes per second. +Maximum r/w speed in bytes per second. + +`bps_max_length`=`` ;; + +Maximum length of I/O bursts in seconds. `bps_rd`=`` ;; -Maximum read speed speed in bytes per second. +Maximum read speed in bytes per second. + +`bps_rd_length`=`` ;; + +Maximum length of read I/O bursts in seconds. `bps_wr`=`` ;; -Maximum write speed speed in bytes per second. +Maximum write speed in bytes per second. + +`bps_wr_length`=`` ;; + +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`=`` ;; +`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`=`` ;; -Maximum r/w I/O speed in operations per second. +Maximum r/w I/O in operations per second. `iops_max`=`` ;; -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`=`` ;; + +Maximum length of I/O bursts in seconds. `iops_rd`=`` ;; -Maximum read I/O speed in operations per second. +Maximum read I/O in operations per second. + +`iops_rd_length`=`` ;; + +Maximum length of read I/O bursts in seconds. `iops_rd_max`=`` ;; -Maximum unthrottled read I/O pool speed in operations per second. +Maximum unthrottled read I/O pool in operations per second. `iops_wr`=`` ;; -Maximum write I/O speed in operations per second. +Maximum write I/O in operations per second. + +`iops_wr_length`=`` ;; + +Maximum length of write I/O bursts in seconds. `iops_wr_max`=`` ;; -Maximum unthrottled write I/O pool speed in operations per second. +Maximum unthrottled write I/O pool in operations per second. `mbps`=`` ;; -Maximum r/w speed speed in megabytes per second. +Maximum r/w speed in megabytes per second. `mbps_max`=`` ;; -Maximum unthrottled r/w pool speed in megabytes per second. +Maximum unthrottled r/w pool in megabytes per second. `mbps_rd`=`` ;; -Maximum read speed speed in megabytes per second. +Maximum read speed in megabytes per second. `mbps_rd_max`=`` ;; -Maximum unthrottled read pool speed in megabytes per second. +Maximum unthrottled read pool in megabytes per second. `mbps_wr`=`` ;; -Maximum write speed speed in megabytes per second. +Maximum write speed in megabytes per second. `mbps_wr_max`=`` ;; -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=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`sata[n]`: `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: 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`=`` ;; -Maximum r/w speed speed in bytes per second. +Maximum r/w speed in bytes per second. + +`bps_max_length`=`` ;; + +Maximum length of I/O bursts in seconds. `bps_rd`=`` ;; -Maximum read speed speed in bytes per second. +Maximum read speed in bytes per second. + +`bps_rd_length`=`` ;; + +Maximum length of read I/O bursts in seconds. `bps_wr`=`` ;; -Maximum write speed speed in bytes per second. +Maximum write speed in bytes per second. + +`bps_wr_length`=`` ;; + +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`=`` ;; +`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`=`` ;; -Maximum r/w I/O speed in operations per second. +Maximum r/w I/O in operations per second. `iops_max`=`` ;; -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`=`` ;; + +Maximum length of I/O bursts in seconds. `iops_rd`=`` ;; -Maximum read I/O speed in operations per second. +Maximum read I/O in operations per second. + +`iops_rd_length`=`` ;; + +Maximum length of read I/O bursts in seconds. `iops_rd_max`=`` ;; -Maximum unthrottled read I/O pool speed in operations per second. +Maximum unthrottled read I/O pool in operations per second. `iops_wr`=`` ;; -Maximum write I/O speed in operations per second. +Maximum write I/O in operations per second. + +`iops_wr_length`=`` ;; + +Maximum length of write I/O bursts in seconds. `iops_wr_max`=`` ;; -Maximum unthrottled write I/O pool speed in operations per second. +Maximum unthrottled write I/O pool in operations per second. `mbps`=`` ;; -Maximum r/w speed speed in megabytes per second. +Maximum r/w speed in megabytes per second. `mbps_max`=`` ;; -Maximum unthrottled r/w pool speed in megabytes per second. +Maximum unthrottled r/w pool in megabytes per second. `mbps_rd`=`` ;; -Maximum read speed speed in megabytes per second. +Maximum read speed in megabytes per second. `mbps_rd_max`=`` ;; -Maximum unthrottled read pool speed in megabytes per second. +Maximum unthrottled read pool in megabytes per second. `mbps_wr`=`` ;; -Maximum write speed speed in megabytes per second. +Maximum write speed in megabytes per second. `mbps_wr_max`=`` ;; -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=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`scsi[n]`: `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: 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`=`` ;; -Maximum r/w speed speed in bytes per second. +Maximum r/w speed in bytes per second. + +`bps_max_length`=`` ;; + +Maximum length of I/O bursts in seconds. `bps_rd`=`` ;; -Maximum read speed speed in bytes per second. +Maximum read speed in bytes per second. + +`bps_rd_length`=`` ;; + +Maximum length of read I/O bursts in seconds. `bps_wr`=`` ;; -Maximum write speed speed in bytes per second. +Maximum write speed in bytes per second. + +`bps_wr_length`=`` ;; + +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`=`` ;; +`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`=`` ;; -Maximum r/w I/O speed in operations per second. +Maximum r/w I/O in operations per second. `iops_max`=`` ;; -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`=`` ;; + +Maximum length of I/O bursts in seconds. `iops_rd`=`` ;; -Maximum read I/O speed in operations per second. +Maximum read I/O in operations per second. + +`iops_rd_length`=`` ;; + +Maximum length of read I/O bursts in seconds. `iops_rd_max`=`` ;; -Maximum unthrottled read I/O pool speed in operations per second. +Maximum unthrottled read I/O pool in operations per second. `iops_wr`=`` ;; -Maximum write I/O speed in operations per second. +Maximum write I/O in operations per second. + +`iops_wr_length`=`` ;; + +Maximum length of write I/O bursts in seconds. `iops_wr_max`=`` ;; -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`=`` ;; -Maximum r/w speed speed in megabytes per second. +Maximum r/w speed in megabytes per second. `mbps_max`=`` ;; -Maximum unthrottled r/w pool speed in megabytes per second. +Maximum unthrottled r/w pool in megabytes per second. `mbps_rd`=`` ;; -Maximum read speed speed in megabytes per second. +Maximum read speed in megabytes per second. `mbps_rd_max`=`` ;; -Maximum unthrottled read pool speed in megabytes per second. +Maximum unthrottled read pool in megabytes per second. `mbps_wr`=`` ;; -Maximum write speed speed in megabytes per second. +Maximum write speed in megabytes per second. `mbps_wr_max`=`` ;; -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=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`virtio[n]`: `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: 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`=`` ;; -Maximum r/w speed speed in bytes per second. +Maximum r/w speed in bytes per second. + +`bps_max_length`=`` ;; + +Maximum length of I/O bursts in seconds. `bps_rd`=`` ;; -Maximum read speed speed in bytes per second. +Maximum read speed in bytes per second. + +`bps_rd_length`=`` ;; + +Maximum length of read I/O bursts in seconds. `bps_wr`=`` ;; -Maximum write speed speed in bytes per second. +Maximum write speed in bytes per second. + +`bps_wr_length`=`` ;; + +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`=`` ;; +`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`=`` ;; -Maximum r/w I/O speed in operations per second. +Maximum r/w I/O in operations per second. `iops_max`=`` ;; -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`=`` ;; + +Maximum length of I/O bursts in seconds. `iops_rd`=`` ;; -Maximum read I/O speed in operations per second. +Maximum read I/O in operations per second. + +`iops_rd_length`=`` ;; + +Maximum length of read I/O bursts in seconds. `iops_rd_max`=`` ;; -Maximum unthrottled read I/O pool speed in operations per second. +Maximum unthrottled read I/O pool in operations per second. `iops_wr`=`` ;; -Maximum write I/O speed in operations per second. +Maximum write I/O in operations per second. + +`iops_wr_length`=`` ;; + +Maximum length of write I/O bursts in seconds. `iops_wr_max`=`` ;; -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`=`` ;; -Maximum r/w speed speed in megabytes per second. +Maximum r/w speed in megabytes per second. `mbps_max`=`` ;; -Maximum unthrottled r/w pool speed in megabytes per second. +Maximum unthrottled r/w pool in megabytes per second. `mbps_rd`=`` ;; -Maximum read speed speed in megabytes per second. +Maximum read speed in megabytes per second. `mbps_rd_max`=`` ;; -Maximum unthrottled read pool speed in megabytes per second. +Maximum unthrottled read pool in megabytes per second. `mbps_wr`=`` ;; -Maximum write speed speed in megabytes per second. +Maximum write speed in megabytes per second. `mbps_wr_max`=`` ;; -Maximum unthrottled write pool speed in megabytes per second. +Maximum unthrottled write pool in megabytes per second. `media`=`(cdrom | disk)` (default=`disk`);; -- 2.39.2