From 0695fdafa5384d77a856ce09c1fe880031e0a93f Mon Sep 17 00:00:00 2001 From: Thomas Lamprecht Date: Fri, 18 Jun 2021 19:36:45 +0200 Subject: [PATCH] update static and schema information Signed-off-by: Thomas Lamprecht --- api-viewer/apidata.js | 515 +++++++++++----------------------------- pveceph.1-synopsis.adoc | 12 +- pvenode.1-synopsis.adoc | 2 +- pvesm.1-synopsis.adoc | 10 +- vzdump.1-synopsis.adoc | 12 +- vzdump.conf.5-opts.adoc | 8 +- 6 files changed, 155 insertions(+), 404 deletions(-) diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index ad92e12..5404406 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -1,4 +1,4 @@ -var pveapi = [ +const apiSchema = [ { "children" : [ { @@ -1449,6 +1449,7 @@ var pveapi = [ "dest" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -1544,6 +1545,7 @@ var pveapi = [ "source" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -1690,6 +1692,7 @@ var pveapi = [ "dest" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -1778,6 +1781,7 @@ var pveapi = [ "source" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -2099,6 +2103,7 @@ var pveapi = [ "dest" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -2187,6 +2192,7 @@ var pveapi = [ "source" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -2293,6 +2299,7 @@ var pveapi = [ "dest" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -2374,6 +2381,7 @@ var pveapi = [ "source" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -3638,8 +3646,7 @@ var pveapi = [ "typetext" : "" }, "maxfiles" : { - "default" : 1, - "description" : "Maximal number of backup files per guest system.", + "description" : "Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system.", "minimum" : 1, "optional" : 1, "type" : "integer", @@ -3677,6 +3684,7 @@ var pveapi = [ "typetext" : "" }, "prune-backups" : { + "default" : "keep-all=1", "description" : "Use these retention options instead of those from the storage configuration.", "format" : "prune-backups", "optional" : 1, @@ -3692,7 +3700,7 @@ var pveapi = [ }, "remove" : { "default" : 1, - "description" : "Remove old backup files if there are more than 'maxfiles' backup files.", + "description" : "Prune older backups according to 'prune-backups'.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -3703,14 +3711,6 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "size" : { - "default" : 1024, - "description" : "Unused, will be removed in a future release.", - "minimum" : 500, - "optional" : 1, - "type" : "integer", - "typetext" : " (500 - N)" - }, "starttime" : { "description" : "Job Start time.", "pattern" : "\\d{1,2}:\\d{1,2}", @@ -3933,8 +3933,7 @@ var pveapi = [ "typetext" : "" }, "maxfiles" : { - "default" : 1, - "description" : "Maximal number of backup files per guest system.", + "description" : "Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system.", "minimum" : 1, "optional" : 1, "type" : "integer", @@ -3972,6 +3971,7 @@ var pveapi = [ "typetext" : "" }, "prune-backups" : { + "default" : "keep-all=1", "description" : "Use these retention options instead of those from the storage configuration.", "format" : "prune-backups", "optional" : 1, @@ -3987,7 +3987,7 @@ var pveapi = [ }, "remove" : { "default" : 1, - "description" : "Remove old backup files if there are more than 'maxfiles' backup files.", + "description" : "Prune older backups according to 'prune-backups'.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -3998,14 +3998,6 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "size" : { - "default" : 1024, - "description" : "Unused, will be removed in a future release.", - "minimum" : 500, - "optional" : 1, - "type" : "integer", - "typetext" : " (500 - N)" - }, "starttime" : { "description" : "Job Start time.", "pattern" : "\\d{1,2}:\\d{1,2}", @@ -8905,6 +8897,7 @@ var pveapi = [ "dest" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -8999,6 +8992,7 @@ var pveapi = [ "source" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -9127,6 +9121,7 @@ var pveapi = [ "dest" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -9214,6 +9209,7 @@ var pveapi = [ "source" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -23791,60 +23787,6 @@ var pveapi = [ "path" : "/nodes/{node}/qemu", "text" : "qemu" }, - { - "info" : { - "GET" : { - "allowtoken" : 1, - "description" : "List all custom and default CPU models.", - "method" : "GET", - "name" : "index", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "description" : "Only returns custom models when the current user has Sys.Audit on /nodes.", - "user" : "all" - }, - "returns" : { - "items" : { - "properties" : { - "custom" : { - "description" : "True if this is a custom CPU model.", - "type" : "boolean" - }, - "name" : { - "description" : "Name of the CPU model. Identifies it for subsequent API calls. Prefixed with 'custom-' for custom models.", - "type" : "string" - }, - "vendor" : { - "description" : "CPU vendor visible to the guest when this model is selected. Vendor of 'reported-model' in case of custom models.", - "type" : "string" - } - }, - "type" : "object" - }, - "links" : [ - { - "href" : "{name}", - "rel" : "child" - } - ], - "type" : "array" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/cpu", - "text" : "cpu" - }, { "children" : [ { @@ -26023,6 +25965,7 @@ var pveapi = [ "dest" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -26117,6 +26060,7 @@ var pveapi = [ "source" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -26245,6 +26189,7 @@ var pveapi = [ "dest" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -26332,6 +26277,7 @@ var pveapi = [ "source" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -30178,7 +30124,7 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "db_size" : { + "db_dev_size" : { "default" : "bluestore_block_db_size or 10% of OSD size", "description" : "Size in GiB for block.db.", "minimum" : 1, @@ -30212,7 +30158,7 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "wal_size" : { + "wal_dev_size" : { "default" : "bluestore_block_wal_size or 1% of OSD size", "description" : "Size in GiB for block.wal.", "minimum" : 0.5, @@ -30601,8 +30547,8 @@ var pveapi = [ "additionalProperties" : 0, "properties" : { "mon-address" : { - "description" : "Overwrites autodetected monitor IP address. Must be in the public network of ceph.", - "format" : "ip", + "description" : "Overwrites autodetected monitor IP address(es). Must be in the public network(s) of Ceph.", + "format" : "ip-list", "optional" : 1, "type" : "string", "typetext" : "" @@ -31439,89 +31385,6 @@ var pveapi = [ "path" : "/nodes/{node}/ceph/pools", "text" : "pools" }, - { - "info" : { - "GET" : { - "allowtoken" : 1, - "description" : "List local disks.", - "method" : "GET", - "name" : "disks", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "type" : { - "description" : "Only list specific types of disks.", - "enum" : [ - "unused", - "journal_disks" - ], - "optional" : 1, - "type" : "string" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit", - "Datastore.Audit" - ], - "any", - 1 - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : { - "dev" : { - "type" : "string" - }, - "gpt" : { - "type" : "boolean" - }, - "model" : { - "optional" : 1, - "type" : "string" - }, - "osdid" : { - "type" : "integer" - }, - "serial" : { - "optional" : 1, - "type" : "string" - }, - "size" : { - "type" : "integer" - }, - "used" : { - "optional" : 1, - "type" : "string" - }, - "vendor" : { - "optional" : 1, - "type" : "string" - } - }, - "type" : "object" - }, - "type" : "array" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/ceph/disks", - "text" : "disks" - }, { "info" : { "GET" : { @@ -31891,149 +31754,6 @@ var pveapi = [ "path" : "/nodes/{node}/ceph/status", "text" : "status" }, - { - "children" : [ - { - "info" : { - "DELETE" : { - "allowtoken" : 1, - "description" : "Unset a ceph flag", - "method" : "DELETE", - "name" : "unset_flag", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "flag" : { - "description" : "The ceph flag to unset", - "enum" : [ - "nobackfill", - "nodeep-scrub", - "nodown", - "noin", - "noout", - "norebalance", - "norecover", - "noscrub", - "notieragent", - "noup", - "pause" - ], - "type" : "string" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "null" - } - }, - "POST" : { - "allowtoken" : 1, - "description" : "Set a specific ceph flag", - "method" : "POST", - "name" : "set_flag", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "flag" : { - "description" : "The ceph flag to set", - "enum" : [ - "nobackfill", - "nodeep-scrub", - "nodown", - "noin", - "noout", - "norebalance", - "norecover", - "noscrub", - "notieragent", - "noup", - "pause" - ], - "type" : "string" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "null" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/ceph/flags/{flag}", - "text" : "{flag}" - } - ], - "info" : { - "GET" : { - "allowtoken" : 1, - "description" : "get all set ceph flags", - "method" : "GET", - "name" : "get_flags", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/ceph/flags", - "text" : "flags" - }, { "info" : { "GET" : { @@ -32348,8 +32068,7 @@ var pveapi = [ "type" : "string" }, "maxfiles" : { - "default" : 1, - "description" : "Maximal number of backup files per guest system.", + "description" : "Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system.", "minimum" : 1, "optional" : 1, "type" : "integer" @@ -32383,6 +32102,7 @@ var pveapi = [ "type" : "string" }, "prune-backups" : { + "default" : "keep-all=1", "description" : "Use these retention options instead of those from the storage configuration.", "format" : "prune-backups", "optional" : 1, @@ -32396,7 +32116,7 @@ var pveapi = [ }, "remove" : { "default" : 1, - "description" : "Remove old backup files if there are more than 'maxfiles' backup files.", + "description" : "Prune older backups according to 'prune-backups'.", "optional" : 1, "type" : "boolean" }, @@ -32405,13 +32125,6 @@ var pveapi = [ "optional" : 1, "type" : "string" }, - "size" : { - "default" : 1024, - "description" : "Unused, will be removed in a future release.", - "minimum" : 500, - "optional" : 1, - "type" : "integer" - }, "stdexcludes" : { "default" : 1, "description" : "Exclude temporary files and logs.", @@ -32594,8 +32307,7 @@ var pveapi = [ "typetext" : "" }, "maxfiles" : { - "default" : 1, - "description" : "Maximal number of backup files per guest system.", + "description" : "Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system.", "minimum" : 1, "optional" : 1, "type" : "integer", @@ -32633,6 +32345,7 @@ var pveapi = [ "typetext" : "" }, "prune-backups" : { + "default" : "keep-all=1", "description" : "Use these retention options instead of those from the storage configuration.", "format" : "prune-backups", "optional" : 1, @@ -32648,7 +32361,7 @@ var pveapi = [ }, "remove" : { "default" : 1, - "description" : "Remove old backup files if there are more than 'maxfiles' backup files.", + "description" : "Prune older backups according to 'prune-backups'.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -32659,14 +32372,6 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "size" : { - "default" : 1024, - "description" : "Unused, will be removed in a future release.", - "minimum" : 500, - "optional" : 1, - "type" : "integer", - "typetext" : " (500 - N)" - }, "stdexcludes" : { "default" : 1, "description" : "Exclude temporary files and logs.", @@ -35302,6 +35007,60 @@ var pveapi = [ "children" : [ { "children" : [ + { + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "List all custom and default CPU models.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "description" : "Only returns custom models when the current user has Sys.Audit on /nodes.", + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : { + "custom" : { + "description" : "True if this is a custom CPU model.", + "type" : "boolean" + }, + "name" : { + "description" : "Name of the CPU model. Identifies it for subsequent API calls. Prefixed with 'custom-' for custom models.", + "type" : "string" + }, + "vendor" : { + "description" : "CPU vendor visible to the guest when this model is selected. Vendor of 'reported-model' in case of custom models.", + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/capabilities/qemu/cpu", + "text" : "cpu" + }, { "info" : { "GET" : { @@ -37490,6 +37249,40 @@ var pveapi = [ "leaf" : 1, "path" : "/nodes/{node}/disks/initgpt", "text" : "initgpt" + }, + { + "info" : { + "PUT" : { + "allowtoken" : 1, + "description" : "Wipe a disk or partition.", + "method" : "PUT", + "name" : "wipe_disk", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "disk" : { + "description" : "Block device name", + "pattern" : "^/dev/[a-zA-Z0-9\\/]+$", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/disks/wipedisk", + "text" : "wipedisk" } ], "info" : { @@ -37945,6 +37738,7 @@ var pveapi = [ "dest" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -38039,6 +37833,7 @@ var pveapi = [ "source" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -38153,6 +37948,7 @@ var pveapi = [ "dest" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -38240,6 +38036,7 @@ var pveapi = [ "source" : { "description" : "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.", "format" : "pve-fw-addr-spec", + "maxLength" : 512, "optional" : 1, "type" : "string", "typetext" : "" @@ -39582,7 +39379,8 @@ var pveapi = [ "typetext" : "" }, "description" : { - "description" : "Node description/comment.", + "description" : "Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file.", + "maxLength" : 65536, "optional" : 1, "type" : "string", "typetext" : "" @@ -40414,8 +40212,8 @@ var pveapi = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ - "upgrade", "ceph_install", + "upgrade", "login" ], "optional" : 1, @@ -40443,13 +40241,6 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "upgrade" : { - "default" : 0, - "description" : "Deprecated, use the 'cmd' property instead! Run 'apt-get dist-upgrade' instead of normal shell.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, "websocket" : { "description" : "use websocket instead of standard vnc.", "optional" : 1, @@ -40517,8 +40308,8 @@ var pveapi = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ - "upgrade", "ceph_install", + "upgrade", "login" ], "optional" : 1, @@ -40537,13 +40328,6 @@ var pveapi = [ "format" : "pve-node", "type" : "string", "typetext" : "" - }, - "upgrade" : { - "default" : 0, - "description" : "Deprecated, use the 'cmd' property instead! Run 'apt-get dist-upgrade' instead of normal shell.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" } } }, @@ -40585,7 +40369,7 @@ var pveapi = [ "info" : { "GET" : { "allowtoken" : 1, - "description" : "Opens a weksocket for VNC traffic.", + "description" : "Opens a websocket for VNC traffic.", "method" : "GET", "name" : "vncwebsocket", "parameters" : { @@ -40650,8 +40434,8 @@ var pveapi = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ - "upgrade", "ceph_install", + "upgrade", "login" ], "optional" : 1, @@ -40677,13 +40461,6 @@ var pveapi = [ "optional" : 1, "type" : "string", "typetext" : "" - }, - "upgrade" : { - "default" : 0, - "description" : "Deprecated, use the 'cmd' property instead! Run 'apt-get dist-upgrade' instead of normal shell.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" } } }, @@ -41731,15 +41508,6 @@ var pveapi = [ "type" : "string", "typetext" : "[keep-all=<1|0>] [,keep-daily=] [,keep-hourly=] [,keep-last=] [,keep-monthly=] [,keep-weekly=] [,keep-yearly=]" }, - "redundancy" : { - "default" : 2, - "description" : "The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.", - "maximum" : 16, - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - 16)" - }, "saferemove" : { "description" : "Zero-out data when removing LVs.", "optional" : 1, @@ -41862,7 +41630,6 @@ var pveapi = [ "cephfs", "cifs", "dir", - "drbd", "glusterfs", "iscsi", "iscsidirect", @@ -41901,7 +41668,6 @@ var pveapi = [ "cephfs", "cifs", "dir", - "drbd", "glusterfs", "iscsi", "iscsidirect", @@ -42208,15 +41974,6 @@ var pveapi = [ "type" : "string", "typetext" : "[keep-all=<1|0>] [,keep-daily=] [,keep-hourly=] [,keep-last=] [,keep-monthly=] [,keep-weekly=] [,keep-yearly=]" }, - "redundancy" : { - "default" : 2, - "description" : "The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.", - "maximum" : 16, - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - 16)" - }, "saferemove" : { "description" : "Zero-out data when removing LVs.", "optional" : 1, @@ -42320,7 +42077,6 @@ var pveapi = [ "cephfs", "cifs", "dir", - "drbd", "glusterfs", "iscsi", "iscsidirect", @@ -42391,7 +42147,6 @@ var pveapi = [ "cephfs", "cifs", "dir", - "drbd", "glusterfs", "iscsi", "iscsidirect", @@ -43567,6 +43322,10 @@ var pveapi = [ "optional" : 1, "type" : "boolean" }, + "Pool.Audit" : { + "optional" : 1, + "type" : "boolean" + }, "Realm.Allocate" : { "optional" : 1, "type" : "boolean" @@ -45029,7 +44788,7 @@ var pveapi = [ "perm", "/pool/{poolid}", [ - "Pool.Allocate" + "Pool.Audit" ] ] }, @@ -45147,7 +44906,7 @@ var pveapi = [ "additionalProperties" : 0 }, "permissions" : { - "description" : "List all pools where you have Pool.Allocate or VM.Allocate permissions on /pool/.", + "description" : "List all pools where you have Pool.Audit permissions on /pool/.", "user" : "all" }, "returns" : { diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index 9d54557..9514e3e 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -102,7 +102,11 @@ Install ceph related packages. Allow experimental versions. Use with care! -`--version` `` ('default =' `nautilus`):: +`--test-repository` `` ('default =' `0`):: + +Use the test, not the main repository. Use with care! + +`--version` `` ('default =' `pacific`):: Ceph version to install. @@ -152,7 +156,7 @@ Create Ceph Monitor and Manager `--mon-address` `` :: -Overwrites autodetected monitor IP address. Must be in the public network of ceph. +Overwrites autodetected monitor IP address(es). Must be in the public network(s) of Ceph. `--monid` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: @@ -182,7 +186,7 @@ Set the device class of the OSD in crush. Block device name for block.db. -`--db_size` ` (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`):: +`--db_dev_size` ` (1 - N)` ('default =' `bluestore_block_db_size or 10% of OSD size`):: Size in GiB for block.db. + @@ -196,7 +200,7 @@ Enables encryption of the OSD. Block device name for block.wal. -`--wal_size` ` (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`):: +`--wal_dev_size` ` (0.5 - N)` ('default =' `bluestore_block_wal_size or 1% of OSD size`):: Size in GiB for block.wal. + diff --git a/pvenode.1-synopsis.adoc b/pvenode.1-synopsis.adoc index e20b0c1..4d0a277 100644 --- a/pvenode.1-synopsis.adoc +++ b/pvenode.1-synopsis.adoc @@ -219,7 +219,7 @@ A list of settings you want to delete. `--description` `` :: -Node description/comment. +Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file. `--digest` `` :: diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index 986f582..b1809b9 100644 --- a/pvesm.1-synopsis.adoc +++ b/pvesm.1-synopsis.adoc @@ -4,7 +4,7 @@ Create a new storage. -``: `` :: +``: `` :: Storage type. @@ -150,10 +150,6 @@ iSCSI portal (IP or DNS name with optional port). The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups. -`--redundancy` ` (1 - 16)` ('default =' `2`):: - -The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster. - `--saferemove` `` :: Zero-out data when removing LVs. @@ -662,10 +658,6 @@ For non default port. The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups. -`--redundancy` ` (1 - 16)` ('default =' `2`):: - -The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster. - `--saferemove` `` :: Zero-out data when removing LVs. diff --git a/vzdump.1-synopsis.adoc b/vzdump.1-synopsis.adoc index 4e0b14d..369daae 100644 --- a/vzdump.1-synopsis.adoc +++ b/vzdump.1-synopsis.adoc @@ -48,9 +48,9 @@ Specify when to send an email Comma-separated list of email addresses or users that should receive email notifications. -`--maxfiles` ` (1 - N)` ('default =' `1`):: +`--maxfiles` ` (1 - N)` :: -Maximal number of backup files per guest system. +Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system. `--mode` `` ('default =' `snapshot`):: @@ -68,7 +68,7 @@ Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread Backup all known guest systems included in the specified pool. -`--prune-backups` `[keep-all=<1|0>] [,keep-daily=] [,keep-hourly=] [,keep-last=] [,keep-monthly=] [,keep-weekly=] [,keep-yearly=]` :: +`--prune-backups` `[keep-all=<1|0>] [,keep-daily=] [,keep-hourly=] [,keep-last=] [,keep-monthly=] [,keep-weekly=] [,keep-yearly=]` ('default =' `keep-all=1`):: Use these retention options instead of those from the storage configuration. @@ -78,16 +78,12 @@ Be quiet. `--remove` `` ('default =' `1`):: -Remove old backup files if there are more than 'maxfiles' backup files. +Prune older backups according to 'prune-backups'. `--script` `` :: Use specified hook script. -`--size` ` (500 - N)` ('default =' `1024`):: - -Unused, will be removed in a future release. - `--stdexcludes` `` ('default =' `1`):: Exclude temporary files and logs. diff --git a/vzdump.conf.5-opts.adoc b/vzdump.conf.5-opts.adoc index 89e5d89..f7f0578 100644 --- a/vzdump.conf.5-opts.adoc +++ b/vzdump.conf.5-opts.adoc @@ -30,9 +30,9 @@ Specify when to send an email Comma-separated list of email addresses or users that should receive email notifications. -`maxfiles`: ` (1 - N)` ('default =' `1`):: +`maxfiles`: ` (1 - N)` :: -Maximal number of backup files per guest system. +Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system. `mode`: `` ('default =' `snapshot`):: @@ -46,7 +46,7 @@ Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread Backup all known guest systems included in the specified pool. -`prune-backups`: `[keep-all=<1|0>] [,keep-daily=] [,keep-hourly=] [,keep-last=] [,keep-monthly=] [,keep-weekly=] [,keep-yearly=]` :: +`prune-backups`: `[keep-all=<1|0>] [,keep-daily=] [,keep-hourly=] [,keep-last=] [,keep-monthly=] [,keep-weekly=] [,keep-yearly=]` ('default =' `keep-all=1`):: Use these retention options instead of those from the storage configuration. @@ -80,7 +80,7 @@ Keep backups for the last different years. If there is morethan one backup f `remove`: `` ('default =' `1`):: -Remove old backup files if there are more than 'maxfiles' backup files. +Prune older backups according to 'prune-backups'. `script`: `` :: -- 2.39.2