From d26563851c8a12d494cc9051b277665033cb33de Mon Sep 17 00:00:00 2001 From: Thomas Lamprecht Date: Mon, 26 Apr 2021 17:48:36 +0200 Subject: [PATCH] update static and schema information Signed-off-by: Thomas Lamprecht --- api-viewer/apidata.js | 3143 +++++++++++++++++++++++++++++-------- pct-mountpoint-opts.adoc | 2 +- pct.1-synopsis.adoc | 16 +- pct.conf.5-opts.adoc | 4 +- pveceph.1-synopsis.adoc | 42 +- pvecm.1-synopsis.adoc | 2 +- pvenode.1-synopsis.adoc | 4 +- pvesm.1-synopsis.adoc | 50 +- pvesr.1-synopsis.adoc | 4 +- pveum.1-synopsis.adoc | 48 + qm-cloud-init-opts.adoc | 5 +- qm.1-synopsis.adoc | 49 +- qm.conf.5-opts.adoc | 23 +- qmrestore.1-synopsis.adoc | 4 + vzdump.1-synopsis.adoc | 4 +- vzdump.conf.5-opts.adoc | 4 +- 16 files changed, 2717 insertions(+), 687 deletions(-) diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index a8f41de..0b4879e 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -141,7 +141,7 @@ var pveapi = [ "typetext" : "" }, "source" : { - "description" : "Source of the replication.", + "description" : "For internal use, to detect if the guest was stolen.", "format" : "pve-node", "optional" : 1, "type" : "string", @@ -250,7 +250,7 @@ var pveapi = [ "typetext" : "" }, "source" : { - "description" : "Source of the replication.", + "description" : "For internal use, to detect if the guest was stolen.", "format" : "pve-node", "optional" : 1, "type" : "string", @@ -363,6 +363,18 @@ var pveapi = [ "parameters" : { "additionalProperties" : 0, "properties" : { + "api-path-prefix" : { + "description" : "An API path prefix inserted between ':/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "bucket" : { + "description" : "The InfluxDB bucket/db. Only necessary when using the http v2 api.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "disable" : { "description" : "Flag to disable the plugin.", "optional" : 1, @@ -375,6 +387,24 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "influxdbproto" : { + "default" : "udp", + "enum" : [ + "udp", + "http", + "https" + ], + "optional" : 1, + "type" : "string" + }, + "max-body-size" : { + "default" : 25000000, + "description" : "InfluxDB max-body-size in bytes. Requests are batched up to this size.", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, "mtu" : { "default" : 1500, "description" : "MTU for metrics transmission over UDP", @@ -384,6 +414,12 @@ var pveapi = [ "type" : "integer", "typetext" : " (512 - 65536)" }, + "organization" : { + "description" : "The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "path" : { "description" : "root graphite path (ex: proxmox.mycluster.mykey)", "format" : "graphite-path", @@ -393,8 +429,10 @@ var pveapi = [ }, "port" : { "description" : "server network port", + "maximum" : 65536, + "minimum" : 1, "type" : "integer", - "typetext" : "" + "typetext" : " (1 - 65536)" }, "proto" : { "description" : "Protocol to send graphite data. TCP or UDP (default)", @@ -419,6 +457,12 @@ var pveapi = [ "type" : "integer", "typetext" : " (0 - N)" }, + "token" : { + "description" : "The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user:password' instead.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "type" : { "description" : "Plugin type.", "enum" : [ @@ -453,6 +497,18 @@ var pveapi = [ "parameters" : { "additionalProperties" : 0, "properties" : { + "api-path-prefix" : { + "description" : "An API path prefix inserted between ':/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "bucket" : { + "description" : "The InfluxDB bucket/db. Only necessary when using the http v2 api.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "delete" : { "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", @@ -480,6 +536,24 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "influxdbproto" : { + "default" : "udp", + "enum" : [ + "udp", + "http", + "https" + ], + "optional" : 1, + "type" : "string" + }, + "max-body-size" : { + "default" : 25000000, + "description" : "InfluxDB max-body-size in bytes. Requests are batched up to this size.", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, "mtu" : { "default" : 1500, "description" : "MTU for metrics transmission over UDP", @@ -489,6 +563,12 @@ var pveapi = [ "type" : "integer", "typetext" : " (512 - 65536)" }, + "organization" : { + "description" : "The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "path" : { "description" : "root graphite path (ex: proxmox.mycluster.mykey)", "format" : "graphite-path", @@ -498,8 +578,10 @@ var pveapi = [ }, "port" : { "description" : "server network port", + "maximum" : 65536, + "minimum" : 1, "type" : "integer", - "typetext" : "" + "typetext" : " (1 - 65536)" }, "proto" : { "description" : "Protocol to send graphite data. TCP or UDP (default)", @@ -523,6 +605,12 @@ var pveapi = [ "optional" : 1, "type" : "integer", "typetext" : " (0 - N)" + }, + "token" : { + "description" : "The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user:password' instead.", + "optional" : 1, + "type" : "string", + "typetext" : "" } }, "type" : "object" @@ -3503,7 +3591,7 @@ var pveapi = [ "typetext" : "" }, "exclude-path" : { - "description" : "Exclude certain files/directories (shell globs).", + "description" : "Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.", "format" : "string-alist", "optional" : 1, "type" : "string", @@ -3543,8 +3631,8 @@ var pveapi = [ "type" : "string" }, "mailto" : { - "description" : "Comma-separated list of email addresses that should receive email notifications.", - "format" : "string-list", + "description" : "Comma-separated list of email addresses or users that should receive email notifications.", + "format" : "email-or-username-list", "optional" : 1, "type" : "string", "typetext" : "" @@ -3804,7 +3892,7 @@ var pveapi = [ "typetext" : "" }, "exclude-path" : { - "description" : "Exclude certain files/directories (shell globs).", + "description" : "Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.", "format" : "string-alist", "optional" : 1, "type" : "string", @@ -3838,8 +3926,8 @@ var pveapi = [ "type" : "string" }, "mailto" : { - "description" : "Comma-separated list of email addresses that should receive email notifications.", - "format" : "string-list", + "description" : "Comma-separated list of email addresses or users that should receive email notifications.", + "format" : "email-or-username-list", "optional" : 1, "type" : "string", "typetext" : "" @@ -4966,11 +5054,14 @@ var pveapi = [ "api" : { "description" : "API plugin name", "enum" : [ + "1984hosting", "acmedns", "acmeproxy", "active24", "ad", "ali", + "anx", + "arvan", "autodns", "aws", "azure", @@ -5000,6 +5091,7 @@ var pveapi = [ "dynu", "dynv6", "easydns", + "edgedns", "euserv", "exoscale", "freedns", @@ -5008,13 +5100,19 @@ var pveapi = [ "gd", "gdnsdk", "he", + "hetzner", "hexonet", "hostingde", + "huaweicloud", "infoblox", + "infomaniak", "internetbs", "inwx", + "ionos", "ispconfig", "jd", + "joker", + "kappernet", "kas", "kinghost", "knot", @@ -5037,7 +5135,10 @@ var pveapi = [ "nederhost", "neodigit", "netcup", + "netlify", "nic", + "njalla", + "nm", "nsd", "nsone", "nsupdate", @@ -5045,23 +5146,29 @@ var pveapi = [ "one", "online", "openprovider", + "openstack", "opnsense", "ovh", "pdns", "pleskxml", "pointhq", + "rackcorp", "rackspace", "rcode0", "regru", + "scaleway", "schlundtech", "selectel", "servercow", + "simply", "tele3", + "transip", "ultra", "unoeuro", "variomedia", "vscale", "vultr", + "world4you", "yandex", "zilore", "zone", @@ -5203,11 +5310,14 @@ var pveapi = [ "api" : { "description" : "API plugin name", "enum" : [ + "1984hosting", "acmedns", "acmeproxy", "active24", "ad", "ali", + "anx", + "arvan", "autodns", "aws", "azure", @@ -5237,6 +5347,7 @@ var pveapi = [ "dynu", "dynv6", "easydns", + "edgedns", "euserv", "exoscale", "freedns", @@ -5245,13 +5356,19 @@ var pveapi = [ "gd", "gdnsdk", "he", + "hetzner", "hexonet", "hostingde", + "huaweicloud", "infoblox", + "infomaniak", "internetbs", "inwx", + "ionos", "ispconfig", "jd", + "joker", + "kappernet", "kas", "kinghost", "knot", @@ -5274,7 +5391,10 @@ var pveapi = [ "nederhost", "neodigit", "netcup", + "netlify", "nic", + "njalla", + "nm", "nsd", "nsone", "nsupdate", @@ -5282,23 +5402,29 @@ var pveapi = [ "one", "online", "openprovider", + "openstack", "opnsense", "ovh", "pdns", "pleskxml", "pointhq", + "rackcorp", "rackspace", "rcode0", "regru", + "scaleway", "schlundtech", "selectel", "servercow", + "simply", "tele3", + "transip", "ultra", "unoeuro", "variomedia", "vscale", "vultr", + "world4you", "yandex", "zilore", "zone", @@ -6057,6 +6183,288 @@ var pveapi = [ { "children" : [ { + "children" : [ + { + "children" : [ + { + "info" : { + "DELETE" : { + "allowtoken" : 1, + "description" : "Delete sdn subnet object configuration.", + "method" : "DELETE", + "name" : "delete", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "subnet" : { + "description" : "The SDN subnet object identifier.", + "format" : "pve-sdn-subnet-id", + "type" : "string", + "typetext" : "" + }, + "vnet" : { + "description" : "The SDN vnet object identifier.", + "format" : "pve-sdn-vnet-id", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/sdn/vnets/{vnet}/subnets", + [ + "SDN.Allocate" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + }, + "GET" : { + "allowtoken" : 1, + "description" : "Read sdn subnet configuration.", + "method" : "GET", + "name" : "read", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "pending" : { + "description" : "Display pending config.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "running" : { + "description" : "Display running config.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "subnet" : { + "description" : "The SDN subnet object identifier.", + "format" : "pve-sdn-subnet-id", + "type" : "string", + "typetext" : "" + }, + "vnet" : { + "description" : "The SDN vnet object identifier.", + "format" : "pve-sdn-vnet-id", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/sdn/vnets/{vnet}/subnets/{subnet}", + [ + "SDN.Allocate" + ] + ] + }, + "returns" : { + "type" : "object" + } + }, + "PUT" : { + "allowtoken" : 1, + "description" : "Update sdn subnet object configuration.", + "method" : "PUT", + "name" : "update", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", + "maxLength" : 4096, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "digest" : { + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", + "maxLength" : 40, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "dnszoneprefix" : { + "description" : "dns domain zone prefix ex: 'adm' -> .adm.mydomain.com", + "format" : "dns-name", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "gateway" : { + "description" : "Subnet Gateway: Will be assign on vnet for layer3 zones", + "format" : "ip", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "snat" : { + "description" : "enable masquerade for this subnet if pve-firewall", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "subnet" : { + "description" : "The SDN subnet object identifier.", + "format" : "pve-sdn-subnet-id", + "type" : "string", + "typetext" : "" + }, + "vnet" : { + "description" : "associated vnet", + "optional" : 1, + "type" : "string", + "typetext" : "" + } + }, + "type" : "object" + }, + "permissions" : { + "check" : [ + "perm", + "/sdn/vnets/{vnet}/subnets", + [ + "SDN.Allocate" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/cluster/sdn/vnets/{vnet}/subnets/{subnet}", + "text" : "{subnet}" + } + ], + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "SDN subnets index.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "pending" : { + "description" : "Display pending config.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "running" : { + "description" : "Display running config.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "vnet" : { + "description" : "The SDN vnet object identifier.", + "format" : "pve-sdn-vnet-id", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "description" : "Only list entries where you have 'SDN.Audit' or 'SDN.Allocate' permissions on '/sdn/subnets/'", + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{subnet}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "allowtoken" : 1, + "description" : "Create a new sdn subnet object.", + "method" : "POST", + "name" : "create", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "dnszoneprefix" : { + "description" : "dns domain zone prefix ex: 'adm' -> .adm.mydomain.com", + "format" : "dns-name", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "gateway" : { + "description" : "Subnet Gateway: Will be assign on vnet for layer3 zones", + "format" : "ip", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "snat" : { + "description" : "enable masquerade for this subnet if pve-firewall", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "subnet" : { + "description" : "The SDN subnet object identifier.", + "format" : "pve-sdn-subnet-id", + "type" : "string", + "typetext" : "" + }, + "type" : { + "enum" : [ + "subnet" + ], + "type" : "string" + }, + "vnet" : { + "description" : "associated vnet", + "optional" : 0, + "type" : "string", + "typetext" : "" + } + }, + "type" : "object" + }, + "permissions" : { + "check" : [ + "perm", + "/sdn/vnets/{vnet}/subnets", + [ + "SDN.Allocate" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 0, + "path" : "/cluster/sdn/vnets/{vnet}/subnets", + "text" : "subnets" + } + ], "info" : { "DELETE" : { "allowtoken" : 1, @@ -6096,6 +6504,18 @@ var pveapi = [ "parameters" : { "additionalProperties" : 0, "properties" : { + "pending" : { + "description" : "Display pending config.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "running" : { + "description" : "Display running config.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "vnet" : { "description" : "The SDN vnet object identifier.", "format" : "pve-sdn-vnet-id", @@ -6146,27 +6566,6 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "ipv4" : { - "description" : "Anycast router ipv4 address.", - "format" : "CIDRv4", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "ipv6" : { - "description" : "Anycast router ipv6 address.", - "format" : "CIDRv6", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "mac" : { - "description" : "Anycast router mac address", - "format" : "mac-addr", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, "tag" : { "description" : "vlan or vxlan id", "optional" : 1, @@ -6209,7 +6608,7 @@ var pveapi = [ } } }, - "leaf" : 1, + "leaf" : 0, "path" : "/cluster/sdn/vnets/{vnet}", "text" : "{vnet}" } @@ -6221,7 +6620,21 @@ var pveapi = [ "method" : "GET", "name" : "index", "parameters" : { - "additionalProperties" : 0 + "additionalProperties" : 0, + "properties" : { + "pending" : { + "description" : "Display pending config.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "running" : { + "description" : "Display running config.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + } + } }, "permissions" : { "description" : "Only list entries where you have 'SDN.Audit' or 'SDN.Allocate' permissions on '/sdn/vnets/'", @@ -6255,27 +6668,6 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "ipv4" : { - "description" : "Anycast router ipv4 address.", - "format" : "CIDRv4", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "ipv6" : { - "description" : "Anycast router ipv6 address.", - "format" : "CIDRv6", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "mac" : { - "description" : "Anycast router mac address", - "format" : "mac-addr", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, "tag" : { "description" : "vlan or vxlan id", "optional" : 1, @@ -6372,6 +6764,18 @@ var pveapi = [ "parameters" : { "additionalProperties" : 0, "properties" : { + "pending" : { + "description" : "Display pending config.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "running" : { + "description" : "Display running config.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "zone" : { "description" : "The SDN zone object identifier.", "format" : "pve-sdn-zone-id", @@ -6427,12 +6831,44 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "dns" : { + "description" : "dns api server", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "dnszone" : { + "description" : "dns domain zone ex: mydomain.com", + "format" : "dns-name", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "dp-id" : { "description" : "Faucet dataplane id", "optional" : 1, "type" : "integer", "typetext" : "" }, + "exitnodes" : { + "description" : "List of cluster node names.", + "format" : "pve-node-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "ipam" : { + "description" : "use a specific ipam", + "type" : "string", + "typetext" : "" + }, + "mac" : { + "description" : "Anycast logical router mac address", + "format" : "mac-addr", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "mtu" : { "description" : "MTU", "optional" : 1, @@ -6453,6 +6889,12 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "reversedns" : { + "description" : "reverse dns api server", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "tag" : { "description" : "Service-VLAN Tag", "minimum" : 0, @@ -6513,6 +6955,18 @@ var pveapi = [ "parameters" : { "additionalProperties" : 0, "properties" : { + "pending" : { + "description" : "Display pending config.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "running" : { + "description" : "Display running config.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "type" : { "description" : "Only list sdn zones of specific type", "enum" : [ @@ -6535,6 +6989,37 @@ var pveapi = [ "returns" : { "items" : { "properties" : { + "dns" : { + "optional" : 1, + "type" : "string" + }, + "dnszone" : { + "optional" : 1, + "type" : "string" + }, + "ipam" : { + "optional" : 1, + "type" : "string" + }, + "mtu" : { + "optional" : 1, + "type" : "integer" + }, + "nodes" : { + "optional" : 1, + "type" : "string" + }, + "pending" : { + "optional" : 1 + }, + "reversedns" : { + "optional" : 1, + "type" : "string" + }, + "state" : { + "optional" : 1, + "type" : "string" + }, "type" : { "type" : "string" }, @@ -6572,12 +7057,44 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "dns" : { + "description" : "dns api server", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "dnszone" : { + "description" : "dns domain zone ex: mydomain.com", + "format" : "dns-name", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "dp-id" : { "description" : "Faucet dataplane id", "optional" : 1, "type" : "integer", "typetext" : "" }, + "exitnodes" : { + "description" : "List of cluster node names.", + "format" : "pve-node-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "ipam" : { + "description" : "use a specific ipam", + "type" : "string", + "typetext" : "" + }, + "mac" : { + "description" : "Anycast logical router mac address", + "format" : "mac-addr", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "mtu" : { "description" : "MTU", "optional" : 1, @@ -6598,6 +7115,12 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "reversedns" : { + "description" : "reverse dns api server", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "tag" : { "description" : "Service-VLAN Tag", "minimum" : 0, @@ -6708,6 +7231,18 @@ var pveapi = [ "format" : "pve-sdn-controller-id", "type" : "string", "typetext" : "" + }, + "pending" : { + "description" : "Display pending config.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "running" : { + "description" : "Display running config.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" } } }, @@ -6759,16 +7294,26 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "gateway-external-peers" : { - "description" : "upstream bgp peers address list.", - "format" : "ip-list", + "ebgp" : { + "description" : "Enable ebgp. (remote-as external)", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "ebgp-multihop" : { + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "loopback" : { + "description" : "source loopback interface.", "optional" : 1, "type" : "string", "typetext" : "" }, - "gateway-nodes" : { - "description" : "List of cluster node names.", - "format" : "pve-node-list", + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "optional" : 1, "type" : "string", "typetext" : "" @@ -6812,9 +7357,22 @@ var pveapi = [ "parameters" : { "additionalProperties" : 0, "properties" : { + "pending" : { + "description" : "Display pending config.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "running" : { + "description" : "Display running config.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "type" : { "description" : "Only list sdn controllers of specific type", "enum" : [ + "bgp", "evpn", "faucet" ], @@ -6833,6 +7391,13 @@ var pveapi = [ "controller" : { "type" : "string" }, + "pending" : { + "optional" : 1 + }, + "state" : { + "optional" : 1, + "type" : "string" + }, "type" : { "type" : "string" } @@ -6868,16 +7433,26 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "gateway-external-peers" : { - "description" : "upstream bgp peers address list.", - "format" : "ip-list", + "ebgp" : { + "description" : "Enable ebgp. (remote-as external)", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "ebgp-multihop" : { + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "loopback" : { + "description" : "source loopback interface.", "optional" : 1, "type" : "string", "typetext" : "" }, - "gateway-nodes" : { - "description" : "List of cluster node names.", - "format" : "pve-node-list", + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "optional" : 1, "type" : "string", "typetext" : "" @@ -6892,6 +7467,7 @@ var pveapi = [ "type" : { "description" : "Plugin type.", "enum" : [ + "bgp", "evpn", "faucet" ], @@ -6919,142 +7495,627 @@ var pveapi = [ "leaf" : 0, "path" : "/cluster/sdn/controllers", "text" : "controllers" - } - ], - "info" : { - "GET" : { - "allowtoken" : 1, - "description" : "Directory index.", - "method" : "GET", - "name" : "index", - "parameters" : { - "additionalProperties" : 0 - }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "SDN.Audit" - ] - ] - }, - "returns" : { - "items" : { - "properties" : { - "id" : { - "type" : "string" + }, + { + "children" : [ + { + "info" : { + "DELETE" : { + "allowtoken" : 1, + "description" : "Delete sdn ipam object configuration.", + "method" : "DELETE", + "name" : "delete", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "ipam" : { + "description" : "The SDN ipam object identifier.", + "format" : "pve-sdn-ipam-id", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/sdn/ipams", + [ + "SDN.Allocate" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + }, + "GET" : { + "allowtoken" : 1, + "description" : "Read sdn ipam configuration.", + "method" : "GET", + "name" : "read", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "ipam" : { + "description" : "The SDN ipam object identifier.", + "format" : "pve-sdn-ipam-id", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/sdn/ipams/{ipam}", + [ + "SDN.Allocate" + ] + ] + }, + "returns" : { + "type" : "object" + } + }, + "PUT" : { + "allowtoken" : 1, + "description" : "Update sdn ipam object configuration.", + "method" : "PUT", + "name" : "update", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", + "maxLength" : 4096, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "digest" : { + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", + "maxLength" : 40, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "ipam" : { + "description" : "The SDN ipam object identifier.", + "format" : "pve-sdn-ipam-id", + "type" : "string", + "typetext" : "" + }, + "section" : { + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "token" : { + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "url" : { + "optional" : 1, + "type" : "string", + "typetext" : "" + } + }, + "type" : "object" + }, + "permissions" : { + "check" : [ + "perm", + "/sdn/ipams", + [ + "SDN.Allocate" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } } }, - "type" : "object" - }, - "links" : [ - { - "href" : "{id}", - "rel" : "child" - } - ], - "type" : "array" - } - }, - "PUT" : { - "allowtoken" : 1, - "description" : "Apply sdn controller changes && reload.", - "method" : "PUT", - "name" : "reload", - "parameters" : { - "additionalProperties" : 0 - }, - "permissions" : { - "check" : [ - "perm", - "/sdn", - [ - "SDN.Allocate" - ] - ] - }, - "protected" : 1, - "returns" : { - "type" : "string" - } - } - }, - "leaf" : 0, - "path" : "/cluster/sdn", - "text" : "sdn" - }, - { - "info" : { - "GET" : { - "allowtoken" : 1, - "description" : "Read cluster log", - "method" : "GET", - "name" : "log", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "max" : { - "description" : "Maximum number of entries.", - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } + "leaf" : 1, + "path" : "/cluster/sdn/ipams/{ipam}", + "text" : "{ipam}" } - }, - "permissions" : { - "user" : "all" - }, - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "type" : "array" - } - } - }, - "leaf" : 1, - "path" : "/cluster/log", - "text" : "log" - }, - { - "info" : { - "GET" : { - "allowtoken" : 1, - "description" : "Resources index (cluster wide).", - "method" : "GET", - "name" : "resources", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "type" : { - "enum" : [ - "vm", - "storage", - "node", - "sdn" + ], + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "SDN ipams index.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "type" : { + "description" : "Only list sdn ipams of specific type", + "enum" : [ + "netbox", + "phpipam", + "pve" + ], + "optional" : 1, + "type" : "string" + } + } + }, + "permissions" : { + "description" : "Only list entries where you have 'SDN.Audit' or 'SDN.Allocate' permissions on '/sdn/ipams/'", + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : { + "ipam" : { + "type" : "string" + }, + "type" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{ipam}", + "rel" : "child" + } ], - "optional" : 1, - "type" : "string" + "type" : "array" + } + }, + "POST" : { + "allowtoken" : 1, + "description" : "Create a new sdn ipam object.", + "method" : "POST", + "name" : "create", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "ipam" : { + "description" : "The SDN ipam object identifier.", + "format" : "pve-sdn-ipam-id", + "type" : "string", + "typetext" : "" + }, + "section" : { + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "token" : { + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "type" : { + "description" : "Plugin type.", + "enum" : [ + "netbox", + "phpipam", + "pve" + ], + "format" : "pve-configid", + "type" : "string" + }, + "url" : { + "optional" : 1, + "type" : "string", + "typetext" : "" + } + }, + "type" : "object" + }, + "permissions" : { + "check" : [ + "perm", + "/sdn/ipams", + [ + "SDN.Allocate" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" } } }, - "permissions" : { - "user" : "all" - }, - "returns" : { - "items" : { - "properties" : { - "content" : { - "description" : "Allowed storage content types (when type == storage).", - "format" : "pve-storage-content-list", - "optional" : 1, - "type" : "string" - }, - "cpu" : { - "description" : "CPU utilization (when type in node,qemu,lxc).", + "leaf" : 0, + "path" : "/cluster/sdn/ipams", + "text" : "ipams" + }, + { + "children" : [ + { + "info" : { + "DELETE" : { + "allowtoken" : 1, + "description" : "Delete sdn dns object configuration.", + "method" : "DELETE", + "name" : "delete", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "dns" : { + "description" : "The SDN dns object identifier.", + "format" : "pve-sdn-dns-id", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/sdn/dns", + [ + "SDN.Allocate" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + }, + "GET" : { + "allowtoken" : 1, + "description" : "Read sdn dns configuration.", + "method" : "GET", + "name" : "read", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "dns" : { + "description" : "The SDN dns object identifier.", + "format" : "pve-sdn-dns-id", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/sdn/dns/{dns}", + [ + "SDN.Allocate" + ] + ] + }, + "returns" : { + "type" : "object" + } + }, + "PUT" : { + "allowtoken" : 1, + "description" : "Update sdn dns object configuration.", + "method" : "PUT", + "name" : "update", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", + "maxLength" : 4096, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "digest" : { + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", + "maxLength" : 40, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "dns" : { + "description" : "The SDN dns object identifier.", + "format" : "pve-sdn-dns-id", + "type" : "string", + "typetext" : "" + }, + "key" : { + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "reversemaskv6" : { + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "ttl" : { + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "url" : { + "optional" : 1, + "type" : "string", + "typetext" : "" + } + }, + "type" : "object" + }, + "permissions" : { + "check" : [ + "perm", + "/sdn/dns", + [ + "SDN.Allocate" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/cluster/sdn/dns/{dns}", + "text" : "{dns}" + } + ], + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "SDN dns index.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "type" : { + "description" : "Only list sdn dns of specific type", + "enum" : [ + "powerdns" + ], + "optional" : 1, + "type" : "string" + } + } + }, + "permissions" : { + "description" : "Only list entries where you have 'SDN.Audit' or 'SDN.Allocate' permissions on '/sdn/dns/'", + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : { + "dns" : { + "type" : "string" + }, + "type" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{dns}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "allowtoken" : 1, + "description" : "Create a new sdn dns object.", + "method" : "POST", + "name" : "create", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "dns" : { + "description" : "The SDN dns object identifier.", + "format" : "pve-sdn-dns-id", + "type" : "string", + "typetext" : "" + }, + "key" : { + "optional" : 0, + "type" : "string", + "typetext" : "" + }, + "reversemaskv6" : { + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "reversev6mask" : { + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "ttl" : { + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "type" : { + "description" : "Plugin type.", + "enum" : [ + "powerdns" + ], + "format" : "pve-configid", + "type" : "string" + }, + "url" : { + "optional" : 0, + "type" : "string", + "typetext" : "" + } + }, + "type" : "object" + }, + "permissions" : { + "check" : [ + "perm", + "/sdn/dns", + [ + "SDN.Allocate" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 0, + "path" : "/cluster/sdn/dns", + "text" : "dns" + } + ], + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "Directory index.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "SDN.Audit" + ] + ] + }, + "returns" : { + "items" : { + "properties" : { + "id" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{id}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "PUT" : { + "allowtoken" : 1, + "description" : "Apply sdn controller changes && reload.", + "method" : "PUT", + "name" : "reload", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "check" : [ + "perm", + "/sdn", + [ + "SDN.Allocate" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 0, + "path" : "/cluster/sdn", + "text" : "sdn" + }, + { + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "Read cluster log", + "method" : "GET", + "name" : "log", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "max" : { + "description" : "Maximum number of entries.", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/cluster/log", + "text" : "log" + }, + { + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "Resources index (cluster wide).", + "method" : "GET", + "name" : "resources", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "type" : { + "enum" : [ + "vm", + "storage", + "node", + "sdn" + ], + "optional" : 1, + "type" : "string" + } + } + }, + "permissions" : { + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : { + "content" : { + "description" : "Allowed storage content types (when type == storage).", + "format" : "pve-storage-content-list", + "optional" : 1, + "type" : "string" + }, + "cpu" : { + "description" : "CPU utilization (when type in node,qemu,lxc).", "optional" : 1, "renderer" : "fraction_as_percentage", "type" : "number" @@ -7107,6 +8168,11 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "plugintype" : { + "description" : "More specific type, if available.", + "optional" : 1, + "type" : "string" + }, "pool" : { "description" : "The pool name (when type in pool,qemu,lxc).", "optional" : 1, @@ -11037,7 +12103,7 @@ var pveapi = [ }, "fstrim_cloned_disks" : { "default" : 0, - "description" : "Run fstrim after cloning/moving a disk.", + "description" : "Run fstrim after moving a disk or migrating the VM.", "optional" : 1, "type" : "boolean" }, @@ -11086,7 +12152,8 @@ var pveapi = [ "default" : "spice", "description" : "Driver backend for the audio device.", "enum" : [ - "spice" + "spice", + "none" ], "optional" : 1, "type" : "string" @@ -11152,7 +12219,8 @@ var pveapi = [ "description" : "Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.", "enum" : [ "configdrive2", - "nocloud" + "nocloud", + "opennebula" ], "optional" : 1, "type" : "string" @@ -11203,7 +12271,7 @@ var pveapi = [ "type" : "string" }, "efidisk0" : { - "description" : "Configure a Disk for storing EFI vars", + "description" : "Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead.", "format" : { "file" : { "default_key" : 1, @@ -11276,7 +12344,7 @@ var pveapi = [ "type" : "string" }, "ide[n]" : { - "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3).", + "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -11600,7 +12668,7 @@ var pveapi = [ "type" : "string" }, "ipconfig[n]" : { - "description" : "cloud-init: Specify IP addresses and gateways for the corresponding interface.\n\nIP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.\n\nThe special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit\ngateway should be provided.\nFor IPv6 the special string 'auto' can be used to use stateless autoconfiguration.\n\nIf cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using\ndhcp on IPv4.\n", + "description" : "cloud-init: Specify IP addresses and gateways for the corresponding interface.\n\nIP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.\n\nThe special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit\ngateway should be provided.\nFor IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires\ncloud-init 19.4 or newer.\n\nIf cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using\ndhcp on IPv4.\n", "format" : "pve-qm-ipconfig", "optional" : 1, "type" : "string" @@ -11933,7 +13001,7 @@ var pveapi = [ ], "optional" : 1, "type" : "string", - "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 5.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" + "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016/2019\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 5.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" }, "parallel[n]" : { "description" : "Map host parallel devices (n is 0 to 2).", @@ -11984,7 +13052,7 @@ var pveapi = [ "type" : "string" }, "sata[n]" : { - "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).", + "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -12300,7 +13368,7 @@ var pveapi = [ "type" : "string" }, "scsi[n]" : { - "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).", + "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -12839,7 +13907,7 @@ var pveapi = [ "verbose_description" : "Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is 'std' for all OS types besides some Windows versions (XP and older) which use 'cirrus'. The 'qxl' option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays them self.\nYou can also run without any graphic card, using a serial device as terminal." }, "virtio[n]" : { - "description" : "Use volume as VIRTIO hard disk (n is 0 to 15).", + "description" : "Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -13199,7 +14267,7 @@ var pveapi = [ }, "fstrim_cloned_disks" : { "default" : 0, - "description" : "Run fstrim after cloning/moving a disk.", + "description" : "Run fstrim after moving a disk or migrating the VM.", "optional" : 1, "type" : "boolean" }, @@ -13250,7 +14318,8 @@ var pveapi = [ "default" : "spice", "description" : "Driver backend for the audio device.", "enum" : [ - "spice" + "spice", + "none" ], "optional" : 1, "type" : "string" @@ -13258,7 +14327,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "device= [,driver=]" + "typetext" : "device= [,driver=]" }, "autostart" : { "default" : 0, @@ -13330,7 +14399,8 @@ var pveapi = [ "description" : "Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.", "enum" : [ "configdrive2", - "nocloud" + "nocloud", + "opennebula" ], "optional" : 1, "type" : "string" @@ -13397,7 +14467,7 @@ var pveapi = [ "typetext" : "" }, "efidisk0" : { - "description" : "Configure a Disk for storing EFI vars", + "description" : "Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead.", "format" : { "file" : { "default_key" : 1, @@ -13482,7 +14552,7 @@ var pveapi = [ "type" : "string" }, "ide[n]" : { - "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3).", + "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -13807,7 +14877,7 @@ var pveapi = [ "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" }, "ipconfig[n]" : { - "description" : "cloud-init: Specify IP addresses and gateways for the corresponding interface.\n\nIP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.\n\nThe special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit\ngateway should be provided.\nFor IPv6 the special string 'auto' can be used to use stateless autoconfiguration.\n\nIf cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using\ndhcp on IPv4.\n", + "description" : "cloud-init: Specify IP addresses and gateways for the corresponding interface.\n\nIP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.\n\nThe special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit\ngateway should be provided.\nFor IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires\ncloud-init 19.4 or newer.\n\nIf cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using\ndhcp on IPv4.\n", "format" : "pve-qm-ipconfig", "optional" : 1, "type" : "string", @@ -14160,7 +15230,7 @@ var pveapi = [ ], "optional" : 1, "type" : "string", - "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 5.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" + "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016/2019\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 5.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" }, "parallel[n]" : { "description" : "Map host parallel devices (n is 0 to 2).", @@ -14221,7 +15291,7 @@ var pveapi = [ "typetext" : "[source=] [,max_bytes=] [,period=]" }, "sata[n]" : { - "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).", + "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -14538,7 +15608,7 @@ var pveapi = [ "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" }, "scsi[n]" : { - "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).", + "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -15099,7 +16169,7 @@ var pveapi = [ "verbose_description" : "Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is 'std' for all OS types besides some Windows versions (XP and older) which use 'cirrus'. The 'qxl' option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays them self.\nYou can also run without any graphic card, using a serial device as terminal." }, "virtio[n]" : { - "description" : "Use volume as VIRTIO hard disk (n is 0 to 15).", + "description" : "Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -15492,7 +16562,7 @@ var pveapi = [ }, "fstrim_cloned_disks" : { "default" : 0, - "description" : "Run fstrim after cloning/moving a disk.", + "description" : "Run fstrim after moving a disk or migrating the VM.", "optional" : 1, "type" : "boolean" }, @@ -15543,7 +16613,8 @@ var pveapi = [ "default" : "spice", "description" : "Driver backend for the audio device.", "enum" : [ - "spice" + "spice", + "none" ], "optional" : 1, "type" : "string" @@ -15551,7 +16622,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "device= [,driver=]" + "typetext" : "device= [,driver=]" }, "autostart" : { "default" : 0, @@ -15615,7 +16686,8 @@ var pveapi = [ "description" : "Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.", "enum" : [ "configdrive2", - "nocloud" + "nocloud", + "opennebula" ], "optional" : 1, "type" : "string" @@ -15682,7 +16754,7 @@ var pveapi = [ "typetext" : "" }, "efidisk0" : { - "description" : "Configure a Disk for storing EFI vars", + "description" : "Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead.", "format" : { "file" : { "default_key" : 1, @@ -15767,7 +16839,7 @@ var pveapi = [ "type" : "string" }, "ide[n]" : { - "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3).", + "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -16092,7 +17164,7 @@ var pveapi = [ "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" }, "ipconfig[n]" : { - "description" : "cloud-init: Specify IP addresses and gateways for the corresponding interface.\n\nIP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.\n\nThe special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit\ngateway should be provided.\nFor IPv6 the special string 'auto' can be used to use stateless autoconfiguration.\n\nIf cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using\ndhcp on IPv4.\n", + "description" : "cloud-init: Specify IP addresses and gateways for the corresponding interface.\n\nIP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.\n\nThe special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit\ngateway should be provided.\nFor IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires\ncloud-init 19.4 or newer.\n\nIf cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using\ndhcp on IPv4.\n", "format" : "pve-qm-ipconfig", "optional" : 1, "type" : "string", @@ -16445,7 +17517,7 @@ var pveapi = [ ], "optional" : 1, "type" : "string", - "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 5.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" + "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016/2019\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 5.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" }, "parallel[n]" : { "description" : "Map host parallel devices (n is 0 to 2).", @@ -16506,7 +17578,7 @@ var pveapi = [ "typetext" : "[source=] [,max_bytes=] [,period=]" }, "sata[n]" : { - "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).", + "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -16823,7 +17895,7 @@ var pveapi = [ "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" }, "scsi[n]" : { - "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).", + "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -17384,7 +18456,7 @@ var pveapi = [ "verbose_description" : "Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is 'std' for all OS types besides some Windows versions (XP and older) which use 'cirrus'. The 'qxl' option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays them self.\nYou can also run without any graphic card, using a serial device as terminal." }, "virtio[n]" : { - "description" : "Use volume as VIRTIO hard disk (n is 0 to 15).", + "description" : "Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -18248,6 +19320,16 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "running-machine" : { + "description" : "The currently running machine type (if running).", + "optional" : 1, + "type" : "string" + }, + "running-qemu" : { + "description" : "The currently running QEMU version (if running).", + "optional" : 1, + "type" : "string" + }, "spice" : { "description" : "Qemu VGA configuration supports spice.", "optional" : 1, @@ -20179,12 +21261,19 @@ var pveapi = [ "info" : { "DELETE" : { "allowtoken" : 1, - "description" : "Destroy the vm (also delete all used/owned volumes).", + "description" : "Destroy the VM and all used/owned volumes. Removes any VM specific permissions and firewall rules", "method" : "DELETE", "name" : "destroy_vm", "parameters" : { "additionalProperties" : 0, "properties" : { + "destroy-unreferenced-disks" : { + "default" : 1, + "description" : "If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", @@ -20192,7 +21281,7 @@ var pveapi = [ "typetext" : "" }, "purge" : { - "description" : "Remove vmid from backup cron jobs.", + "description" : "Remove VMID from configurations, like backup & replication jobs and HA.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -20347,6 +21436,16 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "running-machine" : { + "description" : "The currently running machine type (if running).", + "optional" : 1, + "type" : "string" + }, + "running-qemu" : { + "description" : "The currently running QEMU version (if running).", + "optional" : 1, + "type" : "string" + }, "status" : { "description" : "Qemu process status.", "enum" : [ @@ -20410,7 +21509,7 @@ var pveapi = [ }, "fstrim_cloned_disks" : { "default" : 0, - "description" : "Run fstrim after cloning/moving a disk.", + "description" : "Run fstrim after moving a disk or migrating the VM.", "optional" : 1, "type" : "boolean" }, @@ -20468,7 +21567,8 @@ var pveapi = [ "default" : "spice", "description" : "Driver backend for the audio device.", "enum" : [ - "spice" + "spice", + "none" ], "optional" : 1, "type" : "string" @@ -20476,7 +21576,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "device= [,driver=]" + "typetext" : "device= [,driver=]" }, "autostart" : { "default" : 0, @@ -20548,7 +21648,8 @@ var pveapi = [ "description" : "Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.", "enum" : [ "configdrive2", - "nocloud" + "nocloud", + "opennebula" ], "optional" : 1, "type" : "string" @@ -20601,7 +21702,7 @@ var pveapi = [ "typetext" : "" }, "efidisk0" : { - "description" : "Configure a Disk for storing EFI vars", + "description" : "Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead.", "format" : { "file" : { "default_key" : 1, @@ -20686,7 +21787,7 @@ var pveapi = [ "type" : "string" }, "ide[n]" : { - "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3).", + "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -21011,7 +22112,7 @@ var pveapi = [ "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" }, "ipconfig[n]" : { - "description" : "cloud-init: Specify IP addresses and gateways for the corresponding interface.\n\nIP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.\n\nThe special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit\ngateway should be provided.\nFor IPv6 the special string 'auto' can be used to use stateless autoconfiguration.\n\nIf cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using\ndhcp on IPv4.\n", + "description" : "cloud-init: Specify IP addresses and gateways for the corresponding interface.\n\nIP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.\n\nThe special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit\ngateway should be provided.\nFor IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires\ncloud-init 19.4 or newer.\n\nIf cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using\ndhcp on IPv4.\n", "format" : "pve-qm-ipconfig", "optional" : 1, "type" : "string", @@ -21084,6 +22185,13 @@ var pveapi = [ "type" : "boolean", "typetext" : "" }, + "live-restore" : { + "description" : "Start the VM immediately from the backup and restore in background. PBS only.", + "optional" : 1, + "requires" : "archive", + "type" : "boolean", + "typetext" : "" + }, "localtime" : { "description" : "Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.", "optional" : 1, @@ -21364,7 +22472,7 @@ var pveapi = [ ], "optional" : 1, "type" : "string", - "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 5.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" + "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016/2019\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 5.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" }, "parallel[n]" : { "description" : "Map host parallel devices (n is 0 to 2).", @@ -21425,7 +22533,7 @@ var pveapi = [ "typetext" : "[source=] [,max_bytes=] [,period=]" }, "sata[n]" : { - "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).", + "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -21742,7 +22850,7 @@ var pveapi = [ "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" }, "scsi[n]" : { - "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).", + "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -22318,7 +23426,7 @@ var pveapi = [ "verbose_description" : "Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is 'std' for all OS types besides some Windows versions (XP and older) which use 'cirrus'. The 'qxl' option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays them self.\nYou can also run without any graphic card, using a serial device as terminal." }, "virtio[n]" : { - "description" : "Use volume as VIRTIO hard disk (n is 0 to 15).", + "description" : "Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -22945,7 +24053,7 @@ var pveapi = [ "type" : "integer" }, "mp[n]" : { - "description" : "Use volume as container mount point.", + "description" : "Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "acl" : { "description" : "Explicitly enable or disable ACL support.", @@ -23015,7 +24123,7 @@ var pveapi = [ }, "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.", - "format" : "address-list", + "format" : "lxc-ip-with-ll-iface-list", "optional" : 1, "type" : "string" }, @@ -23124,6 +24232,7 @@ var pveapi = [ "description" : "OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.", "enum" : [ "debian", + "devuan", "ubuntu", "centos", "fedora", @@ -23445,7 +24554,7 @@ var pveapi = [ "typetext" : " (16 - N)" }, "mp[n]" : { - "description" : "Use volume as container mount point.", + "description" : "Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "acl" : { "description" : "Explicitly enable or disable ACL support.", @@ -23516,7 +24625,7 @@ var pveapi = [ }, "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.", - "format" : "address-list", + "format" : "lxc-ip-with-ll-iface-list", "optional" : 1, "type" : "string", "typetext" : "" @@ -23634,6 +24743,7 @@ var pveapi = [ "description" : "OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.", "enum" : [ "debian", + "devuan", "ubuntu", "centos", "fedora", @@ -28023,6 +29133,12 @@ var pveapi = [ "parameters" : { "additionalProperties" : 0, "properties" : { + "destroy-unreferenced-disks" : { + "description" : "If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "force" : { "default" : 0, "description" : "Force destroy, even if running.", @@ -28397,7 +29513,7 @@ var pveapi = [ "typetext" : " (16 - N)" }, "mp[n]" : { - "description" : "Use volume as container mount point.", + "description" : "Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", "format" : { "acl" : { "description" : "Explicitly enable or disable ACL support.", @@ -28468,7 +29584,7 @@ var pveapi = [ }, "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.", - "format" : "address-list", + "format" : "lxc-ip-with-ll-iface-list", "optional" : 1, "type" : "string", "typetext" : "" @@ -28592,6 +29708,7 @@ var pveapi = [ "description" : "OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.", "enum" : [ "debian", + "devuan", "ubuntu", "centos", "fedora", @@ -29707,6 +30824,613 @@ var pveapi = [ "path" : "/nodes/{node}/ceph/fs", "text" : "fs" }, + { + "children" : [ + { + "info" : { + "DELETE" : { + "allowtoken" : 1, + "description" : "Destroy pool", + "method" : "DELETE", + "name" : "destroypool", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "force" : { + "default" : 0, + "description" : "If true, destroys pool even if in use", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "name" : { + "description" : "The name of the pool. It must be unique.", + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "remove_storages" : { + "default" : 0, + "description" : "Remove all pveceph-managed storages configured for this pool", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + }, + "GET" : { + "allowtoken" : 1, + "description" : "List pool settings.", + "method" : "GET", + "name" : "getpool", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "name" : { + "description" : "The name of the pool. It must be unique.", + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "verbose" : { + "default" : 0, + "description" : "If enabled, will display additional data(eg. statistics).", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit", + "Datastore.Audit" + ], + "any", + 1 + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "properties" : { + "application" : { + "default" : "rbd", + "description" : "The application of the pool.", + "enum" : [ + "rbd", + "cephfs", + "rgw" + ], + "optional" : 1, + "title" : "Application", + "type" : "string" + }, + "application_list" : { + "optional" : 1, + "title" : "Application", + "type" : "array" + }, + "autoscale_status" : { + "optional" : 1, + "title" : "Autoscale Status", + "type" : "object" + }, + "crush_rule" : { + "description" : "The rule to use for mapping object placement in the cluster.", + "optional" : 1, + "title" : "Crush Rule Name", + "type" : "string" + }, + "fast_read" : { + "title" : "Fast Read", + "type" : "boolean" + }, + "hashpspool" : { + "title" : "hashpspool", + "type" : "boolean" + }, + "id" : { + "title" : "ID", + "type" : "integer" + }, + "min_size" : { + "default" : 2, + "description" : "Minimum number of replicas per object", + "maximum" : 7, + "minimum" : 1, + "optional" : 1, + "title" : "Min Size", + "type" : "integer" + }, + "name" : { + "description" : "The name of the pool. It must be unique.", + "title" : "Name", + "type" : "string" + }, + "nodeep-scrub" : { + "title" : "nodeep-scrub", + "type" : "boolean" + }, + "nodelete" : { + "title" : "nodelete", + "type" : "boolean" + }, + "nopgchange" : { + "title" : "nopgchange", + "type" : "boolean" + }, + "noscrub" : { + "title" : "noscrub", + "type" : "boolean" + }, + "nosizechange" : { + "title" : "nosizechange", + "type" : "boolean" + }, + "pg_autoscale_mode" : { + "default" : "warn", + "description" : "The automatic PG scaling mode of the pool.", + "enum" : [ + "on", + "off", + "warn" + ], + "optional" : 1, + "title" : "PG Autoscale Mode", + "type" : "string" + }, + "pg_num" : { + "default" : 128, + "description" : "Number of placement groups.", + "maximum" : 32768, + "minimum" : 1, + "optional" : 1, + "title" : "PG Num", + "type" : "integer" + }, + "pg_num_min" : { + "description" : "Minimal number of placement groups.", + "maximum" : 32768, + "optional" : 1, + "title" : "min. PG Num", + "type" : "integer" + }, + "pgp_num" : { + "title" : "PGP num", + "type" : "integer" + }, + "size" : { + "default" : 3, + "description" : "Number of replicas per object", + "maximum" : 7, + "minimum" : 1, + "optional" : 1, + "title" : "Size", + "type" : "integer" + }, + "statistics" : { + "optional" : 1, + "title" : "Statistics", + "type" : "object" + }, + "target_size" : { + "description" : "The estimated target size of the pool for the PG autoscaler.", + "optional" : 1, + "pattern" : "^(\\d+(\\.\\d+)?)([KMGT])?$", + "title" : "PG Autoscale Target Size", + "type" : "string" + }, + "target_size_ratio" : { + "description" : "The estimated target ratio of the pool for the PG autoscaler.", + "optional" : 1, + "title" : "PG Autoscale Target Ratio", + "type" : "number" + }, + "use_gmt_hitset" : { + "title" : "use_gmt_hitset", + "type" : "boolean" + }, + "write_fadvise_dontneed" : { + "title" : "write_fadvise_dontneed", + "type" : "boolean" + } + }, + "type" : "object" + } + }, + "PUT" : { + "allowtoken" : 1, + "description" : "Change POOL settings", + "method" : "PUT", + "name" : "setpool", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "application" : { + "description" : "The application of the pool.", + "enum" : [ + "rbd", + "cephfs", + "rgw" + ], + "optional" : 1, + "title" : "Application", + "type" : "string" + }, + "crush_rule" : { + "description" : "The rule to use for mapping object placement in the cluster.", + "optional" : 1, + "title" : "Crush Rule Name", + "type" : "string", + "typetext" : "" + }, + "min_size" : { + "description" : "Minimum number of replicas per object", + "maximum" : 7, + "minimum" : 1, + "optional" : 1, + "title" : "Min Size", + "type" : "integer", + "typetext" : " (1 - 7)" + }, + "name" : { + "description" : "The name of the pool. It must be unique.", + "title" : "Name", + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "pg_autoscale_mode" : { + "description" : "The automatic PG scaling mode of the pool.", + "enum" : [ + "on", + "off", + "warn" + ], + "optional" : 1, + "title" : "PG Autoscale Mode", + "type" : "string" + }, + "pg_num" : { + "description" : "Number of placement groups.", + "maximum" : 32768, + "minimum" : 1, + "optional" : 1, + "title" : "PG Num", + "type" : "integer", + "typetext" : " (1 - 32768)" + }, + "pg_num_min" : { + "description" : "Minimal number of placement groups.", + "maximum" : 32768, + "optional" : 1, + "title" : "min. PG Num", + "type" : "integer", + "typetext" : " (-N - 32768)" + }, + "size" : { + "description" : "Number of replicas per object", + "maximum" : 7, + "minimum" : 1, + "optional" : 1, + "title" : "Size", + "type" : "integer", + "typetext" : " (1 - 7)" + }, + "target_size" : { + "description" : "The estimated target size of the pool for the PG autoscaler.", + "optional" : 1, + "pattern" : "^(\\d+(\\.\\d+)?)([KMGT])?$", + "title" : "PG Autoscale Target Size", + "type" : "string" + }, + "target_size_ratio" : { + "description" : "The estimated target ratio of the pool for the PG autoscaler.", + "optional" : 1, + "title" : "PG Autoscale Target Ratio", + "type" : "number", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/ceph/pools/{name}", + "text" : "{name}" + } + ], + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "List all pools.", + "method" : "GET", + "name" : "lspools", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit", + "Datastore.Audit" + ], + "any", + 1 + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "autoscale_status" : { + "optional" : 1, + "title" : "Autoscale Status", + "type" : "object" + }, + "bytes_used" : { + "title" : "Used", + "type" : "integer" + }, + "crush_rule" : { + "title" : "Crush Rule", + "type" : "integer" + }, + "crush_rule_name" : { + "title" : "Crush Rule Name", + "type" : "string" + }, + "min_size" : { + "title" : "Min Size", + "type" : "integer" + }, + "percent_used" : { + "title" : "%-Used", + "type" : "number" + }, + "pg_autoscale_mode" : { + "optional" : 1, + "title" : "PG Autoscale Mode", + "type" : "string" + }, + "pg_num" : { + "title" : "PG Num", + "type" : "integer" + }, + "pg_num_final" : { + "optional" : 1, + "title" : "Optimal PG Num", + "type" : "integer" + }, + "pg_num_min" : { + "optional" : 1, + "title" : "min. PG Num", + "type" : "integer" + }, + "pool" : { + "title" : "ID", + "type" : "integer" + }, + "pool_name" : { + "title" : "Name", + "type" : "string" + }, + "size" : { + "title" : "Size", + "type" : "integer" + }, + "target_size" : { + "optional" : 1, + "title" : "PG Autoscale Target Size", + "type" : "integer" + }, + "target_size_ratio" : { + "optional" : 1, + "title" : "PG Autoscale Target Ratio", + "type" : "number" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{pool_name}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "allowtoken" : 1, + "description" : "Create POOL", + "method" : "POST", + "name" : "createpool", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "add_storages" : { + "description" : "Configure VM and CT storage using the new pool.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "application" : { + "default" : "rbd", + "description" : "The application of the pool.", + "enum" : [ + "rbd", + "cephfs", + "rgw" + ], + "optional" : 1, + "title" : "Application", + "type" : "string" + }, + "crush_rule" : { + "description" : "The rule to use for mapping object placement in the cluster.", + "optional" : 1, + "title" : "Crush Rule Name", + "type" : "string", + "typetext" : "" + }, + "min_size" : { + "default" : 2, + "description" : "Minimum number of replicas per object", + "maximum" : 7, + "minimum" : 1, + "optional" : 1, + "title" : "Min Size", + "type" : "integer", + "typetext" : " (1 - 7)" + }, + "name" : { + "description" : "The name of the pool. It must be unique.", + "title" : "Name", + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "pg_autoscale_mode" : { + "default" : "warn", + "description" : "The automatic PG scaling mode of the pool.", + "enum" : [ + "on", + "off", + "warn" + ], + "optional" : 1, + "title" : "PG Autoscale Mode", + "type" : "string" + }, + "pg_num" : { + "default" : 128, + "description" : "Number of placement groups.", + "maximum" : 32768, + "minimum" : 1, + "optional" : 1, + "title" : "PG Num", + "type" : "integer", + "typetext" : " (1 - 32768)" + }, + "pg_num_min" : { + "description" : "Minimal number of placement groups.", + "maximum" : 32768, + "optional" : 1, + "title" : "min. PG Num", + "type" : "integer", + "typetext" : " (-N - 32768)" + }, + "size" : { + "default" : 3, + "description" : "Number of replicas per object", + "maximum" : 7, + "minimum" : 1, + "optional" : 1, + "title" : "Size", + "type" : "integer", + "typetext" : " (1 - 7)" + }, + "target_size" : { + "description" : "The estimated target size of the pool for the PG autoscaler.", + "optional" : 1, + "pattern" : "^(\\d+(\\.\\d+)?)([KMGT])?$", + "title" : "PG Autoscale Target Size", + "type" : "string" + }, + "target_size_ratio" : { + "description" : "The estimated target ratio of the pool for the PG autoscaler.", + "optional" : 1, + "title" : "PG Autoscale Target Ratio", + "type" : "number", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/ceph/pools", + "text" : "pools" + }, { "info" : { "GET" : { @@ -30151,348 +31875,13 @@ var pveapi = [ "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "object" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/ceph/status", - "text" : "status" - }, - { - "children" : [ - { - "info" : { - "DELETE" : { - "allowtoken" : 1, - "description" : "Destroy pool", - "method" : "DELETE", - "name" : "destroypool", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "force" : { - "default" : 0, - "description" : "If true, destroys pool even if in use", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "name" : { - "description" : "The name of the pool. It must be unique.", - "type" : "string", - "typetext" : "" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "remove_storages" : { - "default" : 0, - "description" : "Remove all pveceph-managed storages configured for this pool", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - }, - "PUT" : { - "allowtoken" : 1, - "description" : "Change POOL settings", - "method" : "PUT", - "name" : "setpool", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "application" : { - "description" : "The application of the pool.", - "enum" : [ - "rbd", - "cephfs", - "rgw" - ], - "optional" : 1, - "type" : "string" - }, - "crush_rule" : { - "description" : "The rule to use for mapping object placement in the cluster.", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "min_size" : { - "description" : "Minimum number of replicas per object", - "maximum" : 7, - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - 7)" - }, - "name" : { - "description" : "The name of the pool. It must be unique.", - "type" : "string", - "typetext" : "" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "pg_autoscale_mode" : { - "description" : "The automatic PG scaling mode of the pool.", - "enum" : [ - "on", - "off", - "warn" - ], - "optional" : 1, - "type" : "string" - }, - "pg_num" : { - "description" : "Number of placement groups.", - "maximum" : 32768, - "minimum" : 8, - "optional" : 1, - "type" : "integer", - "typetext" : " (8 - 32768)" - }, - "size" : { - "description" : "Number of replicas per object", - "maximum" : 7, - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - 7)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/ceph/pools/{name}", - "text" : "{name}" - } - ], - "info" : { - "GET" : { - "allowtoken" : 1, - "description" : "List all pools.", - "method" : "GET", - "name" : "lspools", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit", - "Datastore.Audit" - ], - "any", - 1 - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : { - "bytes_used" : { - "title" : "Used", - "type" : "integer" - }, - "crush_rule" : { - "title" : "Crush Rule", - "type" : "integer" - }, - "crush_rule_name" : { - "title" : "Crush Rule Name", - "type" : "string" - }, - "min_size" : { - "title" : "Min Size", - "type" : "integer" - }, - "percent_used" : { - "title" : "%-Used", - "type" : "number" - }, - "pg_autoscale_mode" : { - "optional" : 1, - "title" : "PG Autoscale Mode", - "type" : "string" - }, - "pg_num" : { - "title" : "PG Num", - "type" : "integer" - }, - "pool" : { - "title" : "ID", - "type" : "integer" - }, - "pool_name" : { - "title" : "Name", - "type" : "string" - }, - "size" : { - "title" : "Size", - "type" : "integer" - } - }, - "type" : "object" - }, - "links" : [ - { - "href" : "{pool_name}", - "rel" : "child" - } - ], - "type" : "array" - } - }, - "POST" : { - "allowtoken" : 1, - "description" : "Create POOL", - "method" : "POST", - "name" : "createpool", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "add_storages" : { - "description" : "Configure VM and CT storage using the new pool.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "application" : { - "default" : "rbd", - "description" : "The application of the pool.", - "enum" : [ - "rbd", - "cephfs", - "rgw" - ], - "optional" : 1, - "type" : "string" - }, - "crush_rule" : { - "description" : "The rule to use for mapping object placement in the cluster.", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "min_size" : { - "default" : 2, - "description" : "Minimum number of replicas per object", - "maximum" : 7, - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - 7)" - }, - "name" : { - "description" : "The name of the pool. It must be unique.", - "type" : "string", - "typetext" : "" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "pg_autoscale_mode" : { - "default" : "warn", - "description" : "The automatic PG scaling mode of the pool.", - "enum" : [ - "on", - "off", - "warn" - ], - "optional" : 1, - "type" : "string" - }, - "pg_num" : { - "default" : 128, - "description" : "Number of placement groups.", - "maximum" : 32768, - "minimum" : 8, - "optional" : 1, - "type" : "integer", - "typetext" : " (8 - 32768)" - }, - "size" : { - "default" : 3, - "description" : "Number of replicas per object", - "maximum" : 7, - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - 7)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" + "type" : "object" } } }, - "leaf" : 0, - "path" : "/nodes/{node}/ceph/pools", - "text" : "pools" + "leaf" : 1, + "path" : "/nodes/{node}/ceph/status", + "text" : "status" }, { "children" : [ @@ -30933,7 +32322,7 @@ var pveapi = [ "typetext" : "" }, "exclude-path" : { - "description" : "Exclude certain files/directories (shell globs).", + "description" : "Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.", "format" : "string-alist", "optional" : 1, "type" : "string", @@ -30967,8 +32356,8 @@ var pveapi = [ "type" : "string" }, "mailto" : { - "description" : "Comma-separated list of email addresses that should receive email notifications.", - "format" : "string-list", + "description" : "Comma-separated list of email addresses or users that should receive email notifications.", + "format" : "email-or-username-list", "optional" : 1, "type" : "string", "typetext" : "" @@ -32729,9 +34118,9 @@ var pveapi = [ "info" : { "GET" : { "allowtoken" : 1, - "description" : "Scan zfs pool list on local node.", + "description" : "Scan remote NFS server.", "method" : "GET", - "name" : "zfsscan", + "name" : "nfsscan", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -32740,6 +34129,12 @@ var pveapi = [ "format" : "pve-node", "type" : "string", "typetext" : "" + }, + "server" : { + "description" : "The server address (name or IP).", + "format" : "pve-storage-server", + "type" : "string", + "typetext" : "" } } }, @@ -32757,8 +34152,12 @@ var pveapi = [ "returns" : { "items" : { "properties" : { - "pool" : { - "description" : "ZFS pool name.", + "options" : { + "description" : "NFS export options.", + "type" : "string" + }, + "path" : { + "description" : "The exported path.", "type" : "string" } }, @@ -32769,30 +34168,48 @@ var pveapi = [ } }, "leaf" : 1, - "path" : "/nodes/{node}/scan/zfs", - "text" : "zfs" + "path" : "/nodes/{node}/scan/nfs", + "text" : "nfs" }, { "info" : { "GET" : { "allowtoken" : 1, - "description" : "Scan remote NFS server.", + "description" : "Scan remote CIFS server.", "method" : "GET", - "name" : "nfsscan", + "name" : "cifsscan", "parameters" : { "additionalProperties" : 0, "properties" : { + "domain" : { + "description" : "SMB domain (Workgroup).", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" }, + "password" : { + "description" : "User password.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "server" : { "description" : "The server address (name or IP).", "format" : "pve-storage-server", "type" : "string", "typetext" : "" + }, + "username" : { + "description" : "User name.", + "optional" : 1, + "type" : "string", + "typetext" : "" } } }, @@ -32810,12 +34227,12 @@ var pveapi = [ "returns" : { "items" : { "properties" : { - "options" : { - "description" : "NFS export options.", + "description" : { + "description" : "Descriptive text from server.", "type" : "string" }, - "path" : { - "description" : "The exported path.", + "share" : { + "description" : "The cifs share name.", "type" : "string" } }, @@ -32826,24 +34243,24 @@ var pveapi = [ } }, "leaf" : 1, - "path" : "/nodes/{node}/scan/nfs", - "text" : "nfs" + "path" : "/nodes/{node}/scan/cifs", + "text" : "cifs" }, { "info" : { "GET" : { "allowtoken" : 1, - "description" : "Scan remote CIFS server.", + "description" : "Scan remote Proxmox Backup Server.", "method" : "GET", - "name" : "cifsscan", + "name" : "pbsscan", "parameters" : { "additionalProperties" : 0, "properties" : { - "domain" : { - "description" : "SMB domain (Workgroup).", + "fingerprint" : { + "description" : "Certificate SHA 256 fingerprint.", "optional" : 1, - "type" : "string", - "typetext" : "" + "pattern" : "([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}", + "type" : "string" }, "node" : { "description" : "The cluster node name.", @@ -32852,11 +34269,19 @@ var pveapi = [ "typetext" : "" }, "password" : { - "description" : "User password.", - "optional" : 1, + "description" : "User password or API token secret.", "type" : "string", "typetext" : "" }, + "port" : { + "default" : 8007, + "description" : "Optional port.", + "maximum" : 65535, + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - 65535)" + }, "server" : { "description" : "The server address (name or IP).", "format" : "pve-storage-server", @@ -32864,8 +34289,7 @@ var pveapi = [ "typetext" : "" }, "username" : { - "description" : "User name.", - "optional" : 1, + "description" : "User-name or API token-ID.", "type" : "string", "typetext" : "" } @@ -32885,12 +34309,13 @@ var pveapi = [ "returns" : { "items" : { "properties" : { - "description" : { - "description" : "Descriptive text from server.", + "comment" : { + "description" : "Comment from server.", + "optional" : 1, "type" : "string" }, - "share" : { - "description" : "The cifs share name.", + "store" : { + "description" : "The datastore name.", "type" : "string" } }, @@ -32901,8 +34326,8 @@ var pveapi = [ } }, "leaf" : 1, - "path" : "/nodes/{node}/scan/cifs", - "text" : "cifs" + "path" : "/nodes/{node}/scan/pbs", + "text" : "pbs" }, { "info" : { @@ -33113,6 +34538,53 @@ var pveapi = [ "path" : "/nodes/{node}/scan/lvmthin", "text" : "lvmthin" }, + { + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "Scan zfs pool list on local node.", + "method" : "GET", + "name" : "zfsscan", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/storage", + [ + "Datastore.Allocate" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "pool" : { + "description" : "ZFS pool name.", + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/scan/zfs", + "text" : "zfs" + }, { "info" : { "GET" : { @@ -33467,6 +34939,89 @@ var pveapi = [ "leaf" : 0, "path" : "/nodes/{node}/hardware/pci", "text" : "pci" + }, + { + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "List local USB devices.", + "method" : "GET", + "name" : "usbscan", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "busnum" : { + "type" : "integer" + }, + "class" : { + "type" : "integer" + }, + "devnum" : { + "type" : "integer" + }, + "level" : { + "type" : "integer" + }, + "manufacturer" : { + "optional" : 1, + "type" : "string" + }, + "port" : { + "type" : "integer" + }, + "prodid" : { + "type" : "string" + }, + "product" : { + "optional" : 1, + "type" : "string" + }, + "serial" : { + "optional" : 1, + "type" : "string" + }, + "speed" : { + "type" : "string" + }, + "usbpath" : { + "optional" : 1, + "type" : "string" + }, + "vendid" : { + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/hardware/usb", + "text" : "usb" } ], "info" : { @@ -33512,6 +35067,143 @@ var pveapi = [ "path" : "/nodes/{node}/hardware", "text" : "hardware" }, + { + "children" : [ + { + "children" : [ + { + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "Get available QEMU/KVM machine types.", + "method" : "GET", + "name" : "types", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "user" : "all" + }, + "proxyto" : "node", + "returns" : { + "items" : { + "additionalProperties" : 1, + "properties" : { + "id" : { + "description" : "Full name of machine type and version.", + "type" : "string" + }, + "type" : { + "description" : "The machine type.", + "enum" : [ + "q35", + "i440fx" + ], + "type" : "string" + }, + "version" : { + "description" : "The machine version.", + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/capabilities/qemu/machines", + "text" : "machines" + } + ], + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "QEMU capabilities index.", + "method" : "GET", + "name" : "qemu_caps_index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/capabilities/qemu", + "text" : "qemu" + } + ], + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "Node capabilities index.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/capabilities", + "text" : "capabilities" + }, { "children" : [ { @@ -33940,6 +35632,11 @@ var pveapi = [ "optional" : 1, "type" : "integer" }, + "encrypted" : { + "description" : "If whole backup is encrypted, value is the fingerprint or '1' if encrypted. Only useful for the Proxmox Backup Server storage type.", + "optional" : 1, + "type" : "string" + }, "format" : { "description" : "Format identifier ('raw', 'qcow2', 'subvol', 'iso', 'tgz' ...)", "type" : "string" @@ -34071,6 +35768,142 @@ var pveapi = [ "path" : "/nodes/{node}/storage/{storage}/content", "text" : "content" }, + { + "children" : [ + { + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "List files and directories for single file restore under the given path.", + "method" : "GET", + "name" : "list", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "filepath" : { + "description" : "base64-path to the directory or file being listed, or \"/\".", + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "storage" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", + "type" : "string", + "typetext" : "" + }, + "volume" : { + "description" : "Backup volume ID or name. Currently only PBS snapshots are supported.", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "description" : "You need read access for the volume.", + "user" : "all" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "filepath" : { + "description" : "base64 path of the current entry", + "type" : "string" + }, + "leaf" : { + "description" : "If this entry is a leaf in the directory graph.", + "type" : "boolean" + }, + "mtime" : { + "description" : "Entry last-modified time (unix timestamp).", + "optional" : 1, + "type" : "integer" + }, + "size" : { + "description" : "Entry file size.", + "optional" : 1, + "type" : "integer" + }, + "text" : { + "description" : "Entry display text.", + "type" : "string" + }, + "type" : { + "description" : "Entry type.", + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/storage/{storage}/file-restore/list", + "text" : "list" + }, + { + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "Extract a file or directory (as zip archive) from a PBS backup.", + "method" : "GET", + "name" : "download", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "filepath" : { + "description" : "base64-path to the directory or file to download.", + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "storage" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", + "type" : "string", + "typetext" : "" + }, + "volume" : { + "description" : "Backup volume ID or name. Currently only PBS snapshots are supported.", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "description" : "You need read access for the volume.", + "user" : "all" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "any" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/storage/{storage}/file-restore/download", + "text" : "download" + } + ], + "leaf" : 0, + "path" : "/nodes/{node}/storage/{storage}/file-restore", + "text" : "file-restore" + }, { "info" : { "GET" : { @@ -34997,6 +36830,7 @@ var pveapi = [ }, "scan" : { "description" : "Information about the last/current scrub.", + "optional" : 1, "type" : "string" }, "state" : { @@ -35193,6 +37027,13 @@ var pveapi = [ "parameters" : { "additionalProperties" : 0, "properties" : { + "include-partitions" : { + "default" : 0, + "description" : "Also include partitions.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", @@ -35219,14 +37060,27 @@ var pveapi = [ }, "permissions" : { "check" : [ - "perm", - "/", + "or", [ - "Sys.Audit", - "Datastore.Audit" + "perm", + "/", + [ + "Sys.Audit", + "Datastore.Audit" + ], + "any", + 1 ], - "any", - 1 + [ + "perm", + "/nodes/{node}", + [ + "Sys.Audit", + "Datastore.Audit" + ], + "any", + 1 + ] ] }, "protected" : 1, @@ -35252,6 +37106,11 @@ var pveapi = [ "osdid" : { "type" : "integer" }, + "parent" : { + "description" : "For partitions only. The device path of the disk the partition resides on.", + "optional" : 1, + "type" : "string" + }, "serial" : { "optional" : 1, "type" : "string" @@ -38324,9 +40183,9 @@ var pveapi = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ - "login", + "ceph_install", "upgrade", - "ceph_install" + "login" ], "optional" : 1, "type" : "string" @@ -38427,9 +40286,9 @@ var pveapi = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ - "login", + "ceph_install", "upgrade", - "ceph_install" + "login" ], "optional" : 1, "type" : "string" @@ -38560,9 +40419,9 @@ var pveapi = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ - "login", + "ceph_install", "upgrade", - "ceph_install" + "login" ], "optional" : 1, "type" : "string" @@ -39552,6 +41411,12 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "master-pubkey" : { + "description" : "Base64-encoded, PEM-formatted public RSA key. Used tp encrypt a copy of the encryption-key which will be added to each encrypted backup.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "maxfiles" : { "description" : "Maximal number of backup files per VM. Use '0' for unlimted.", "minimum" : 0, @@ -39580,6 +41445,12 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "namespace" : { + "description" : "RBD Namespace.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "nodes" : { "description" : "List of cluster node names.", "format" : "pve-node-list", @@ -40003,6 +41874,12 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "master-pubkey" : { + "description" : "Base64-encoded, PEM-formatted public RSA key. Used tp encrypt a copy of the encryption-key which will be added to each encrypted backup.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "maxfiles" : { "description" : "Maximal number of backup files per VM. Use '0' for unlimted.", "minimum" : 0, @@ -40031,6 +41908,12 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "namespace" : { + "description" : "RBD Namespace.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "nodes" : { "description" : "List of cluster node names.", "format" : "pve-node-list", diff --git a/pct-mountpoint-opts.adoc b/pct-mountpoint-opts.adoc index a12ff70..0c3eae6 100644 --- a/pct-mountpoint-opts.adoc +++ b/pct-mountpoint-opts.adoc @@ -4,7 +4,7 @@ Use volume as container root. See below for a detailed description of all option `mp[n]`: `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: -Use volume as container mount point. +Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `acl`=`` ;; diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc index 3c6c51f..e85be64 100644 --- a/pct.1-synopsis.adoc +++ b/pct.1-synopsis.adoc @@ -158,7 +158,7 @@ Amount of RAM for the VM in MB. `--mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: -Use volume as container mount point. +Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `--nameserver` `` :: @@ -172,7 +172,7 @@ Specifies network interfaces for the container. Specifies whether a VM will be started during system bootup. -`--ostype` `` :: +`--ostype` `` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. @@ -274,6 +274,10 @@ Destroy the container (also delete all uses files). The (unique) ID of the VM. +`--destroy-unreferenced-disks` `` :: + +If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config. + `--force` `` ('default =' `0`):: Force destroy, even if running. @@ -623,7 +627,7 @@ Amount of RAM for the VM in MB. `--mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: -Use volume as container mount point. +Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `--nameserver` `` :: @@ -637,7 +641,7 @@ Specifies network interfaces for the container. Specifies whether a VM will be started during system bootup. -`--ostype` `` :: +`--ostype` `` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. @@ -805,7 +809,7 @@ Amount of RAM for the VM in MB. `--mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: -Use volume as container mount point. +Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `--nameserver` `` :: @@ -819,7 +823,7 @@ Specifies network interfaces for the container. Specifies whether a VM will be started during system bootup. -`--ostype` `` :: +`--ostype` `` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. diff --git a/pct.conf.5-opts.adoc b/pct.conf.5-opts.adoc index 5e1c208..9635493 100644 --- a/pct.conf.5-opts.adoc +++ b/pct.conf.5-opts.adoc @@ -80,7 +80,7 @@ Amount of RAM for the VM in MB. `mp[n]`: `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: -Use volume as container mount point. +Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `acl`=`` ;; @@ -190,7 +190,7 @@ Network interface type. Specifies whether a VM will be started during system bootup. -`ostype`: `` :: +`ostype`: `` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index b5eaa87..9d54557 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -242,14 +242,26 @@ Minimum number of replicas per object The automatic PG scaling mode of the pool. -`--pg_num` ` (8 - 32768)` ('default =' `128`):: +`--pg_num` ` (1 - 32768)` ('default =' `128`):: Number of placement groups. +`--pg_num_min` ` (-N - 32768)` :: + +Minimal number of placement groups. + `--size` ` (1 - 7)` ('default =' `3`):: Number of replicas per object +`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` :: + +The estimated target size of the pool for the PG autoscaler. + +`--target_size_ratio` `` :: + +The estimated target ratio of the pool for the PG autoscaler. + *pveceph pool destroy* `` `[OPTIONS]` Destroy pool @@ -266,6 +278,18 @@ If true, destroys pool even if in use Remove all pveceph-managed storages configured for this pool +*pveceph pool get* `` `[OPTIONS]` `[FORMAT_OPTIONS]` + +List pool settings. + +``: `` :: + +The name of the pool. It must be unique. + +`--verbose` `` ('default =' `0`):: + +If enabled, will display additional data(eg. statistics). + *pveceph pool ls* `[FORMAT_OPTIONS]` List all pools. @@ -294,14 +318,26 @@ Minimum number of replicas per object The automatic PG scaling mode of the pool. -`--pg_num` ` (8 - 32768)` :: +`--pg_num` ` (1 - 32768)` :: Number of placement groups. +`--pg_num_min` ` (-N - 32768)` :: + +Minimal number of placement groups. + `--size` ` (1 - 7)` :: Number of replicas per object +`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` :: + +The estimated target size of the pool for the PG autoscaler. + +`--target_size_ratio` `` :: + +The estimated target ratio of the pool for the PG autoscaler. + *pveceph purge* `[OPTIONS]` Destroy ceph related data and configuration files. @@ -324,7 +360,7 @@ Ceph service name. *pveceph status* -Get ceph status. +Get Ceph Status. *pveceph stop* `[OPTIONS]` diff --git a/pvecm.1-synopsis.adoc b/pvecm.1-synopsis.adoc index 1e37c67..e0bdec2 100644 --- a/pvecm.1-synopsis.adoc +++ b/pvecm.1-synopsis.adoc @@ -179,7 +179,7 @@ Update node certificates (and generate all needed files/directories). `--force` `` :: -Force generation of new SSL certifate. +Force generation of new SSL certificate. `--silent` `` :: diff --git a/pvenode.1-synopsis.adoc b/pvenode.1-synopsis.adoc index c66b4af..eeeca67 100644 --- a/pvenode.1-synopsis.adoc +++ b/pvenode.1-synopsis.adoc @@ -81,7 +81,7 @@ ACME challenge type. ACME Plugin ID name -`--api` `` :: +`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | vscale | vultr | world4you | yandex | zilore | zone | zonomi>` :: API plugin name @@ -133,7 +133,7 @@ Update ACME plugin configuration. ACME Plugin ID name -`--api` `` :: +`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | vscale | vultr | world4you | yandex | zilore | zone | zonomi>` :: API plugin name diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index d231c48..986f582 100644 --- a/pvesm.1-synopsis.adoc +++ b/pvesm.1-synopsis.adoc @@ -90,6 +90,10 @@ Always access rbd through krbd kernel module. target portal group for Linux LIO targets +`--master-pubkey` `a file containing a PEM-formatted master public key` :: + +Base64-encoded, PEM-formatted public RSA key. Used tp encrypt a copy of the encryption-key which will be added to each encrypted backup. + `--maxfiles` ` (0 - N)` :: Maximal number of backup files per VM. Use '0' for unlimted. @@ -106,6 +110,10 @@ IP addresses of monitors (for external clusters). mount point +`--namespace` `` :: + +RBD Namespace. + `--nodes` `` :: List of cluster node names. @@ -262,11 +270,11 @@ Export stream format Destination file name -`--base` `(?^:[a-z0-9_\-]{1,40})` :: +`--base` `(?^i:[a-z0-9_\-]{1,40})` :: Snapshot to start an incremental stream from -`--snapshot` `(?^:[a-z0-9_\-]{1,40})` :: +`--snapshot` `(?^i:[a-z0-9_\-]{1,40})` :: Snapshot to export @@ -328,17 +336,17 @@ Import stream format ``: `` :: -Source file name. For '-' stdin is used, the tcp:// format allows to use a TCP connection as input. Else, the file is treated as common file. +Source file name. For '-' stdin is used, the tcp:// format allows to use a TCP connection, the unix://PATH-TO-SOCKET format a UNIX socket as input.Else, the file is treated as common file. `--allow-rename` `` ('default =' `0`):: Choose a new volume ID if the requested volume ID already exists, instead of throwing an error. -`--base` `(?^:[a-z0-9_\-]{1,40})` :: +`--base` `(?^i:[a-z0-9_\-]{1,40})` :: Base snapshot of an incremental stream -`--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` :: +`--delete-snapshot` `(?^i:[a-z0-9_\-]{1,80})` :: A snapshot to delete on success @@ -500,6 +508,30 @@ Scan remote NFS server. The server address (name or IP). +*pvesm scan pbs* ` --password ` `[OPTIONS]` `[FORMAT_OPTIONS]` + +Scan remote Proxmox Backup Server. + +``: `` :: + +The server address (name or IP). + +``: `` :: + +User-name or API token-ID. + +`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` :: + +Certificate SHA 256 fingerprint. + +`--password` `` :: + +User password or API token secret. + +`--port` ` (1 - 65535)` ('default =' `8007`):: + +Optional port. + *pvesm scan zfs* Scan zfs pool list on local node. @@ -578,6 +610,10 @@ Always access rbd through krbd kernel module. target portal group for Linux LIO targets +`--master-pubkey` `a file containing a PEM-formatted master public key` :: + +Base64-encoded, PEM-formatted public RSA key. Used tp encrypt a copy of the encryption-key which will be added to each encrypted backup. + `--maxfiles` ` (0 - N)` :: Maximal number of backup files per VM. Use '0' for unlimted. @@ -594,6 +630,10 @@ IP addresses of monitors (for external clusters). mount point +`--namespace` `` :: + +RBD Namespace. + `--nodes` `` :: List of cluster node names. diff --git a/pvesr.1-synopsis.adoc b/pvesr.1-synopsis.adoc index 08549ae..d5800d5 100644 --- a/pvesr.1-synopsis.adoc +++ b/pvesr.1-synopsis.adoc @@ -34,7 +34,7 @@ Storage replication schedule. The format is a subset of `systemd` calendar event `--source` `` :: -Source of the replication. +For internal use, to detect if the guest was stolen. *pvesr delete* `` `[OPTIONS]` @@ -228,6 +228,6 @@ Storage replication schedule. The format is a subset of `systemd` calendar event `--source` `` :: -Source of the replication. +For internal use, to detect if the guest was stolen. diff --git a/pveum.1-synopsis.adoc b/pveum.1-synopsis.adoc index e00cfdf..8cef833 100644 --- a/pveum.1-synopsis.adoc +++ b/pveum.1-synopsis.adoc @@ -136,6 +136,54 @@ Change user password. User ID +*pveum pool add* `` `[OPTIONS]` + +Create new pool. + +``: `` :: + +no description available + +`--comment` `` :: + +no description available + +*pveum pool delete* `` + +Delete pool. + +``: `` :: + +no description available + +*pveum pool list* `[FORMAT_OPTIONS]` + +Pool index. + +*pveum pool modify* `` `[OPTIONS]` + +Update pool data. + +``: `` :: + +no description available + +`--comment` `` :: + +no description available + +`--delete` `` :: + +Remove vms/storage (instead of adding it). + +`--storage` `` :: + +List of storage IDs. + +`--vms` `` :: + +List of virtual machines. + *pveum realm add* ` --type ` `[OPTIONS]` Add an authentication server. diff --git a/qm-cloud-init-opts.adoc b/qm-cloud-init-opts.adoc index a03f3ac..67be94e 100644 --- a/qm-cloud-init-opts.adoc +++ b/qm-cloud-init-opts.adoc @@ -19,7 +19,7 @@ Specify a custom file containing all user data passed to the VM via cloud-init. Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. -`citype`: `` :: +`citype`: `` :: Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. @@ -35,7 +35,8 @@ IP addresses use CIDR notation, gateways are optional but need an IP of the same + The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. -For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. +For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires +cloud-init 19.4 or newer. + If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index 3f4964b..6431a66 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -127,7 +127,7 @@ The backup archive. Either the file system path to a .tar or .vma file (use '-' Arbitrary arguments passed to kvm. -`--audio0` `device= [,driver=]` :: +`--audio0` `device= [,driver=]` :: Configure a audio device, useful in combination with QXL/Spice. @@ -167,7 +167,7 @@ cloud-init: Specify custom files to replace the automatically generated ones at cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. -`--citype` `` :: +`--citype` `` :: Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. @@ -197,7 +197,7 @@ Description for the VM. Only used on the configuration web interface. This is sa `--efidisk0` `[file=] [,format=] [,size=]` :: -Configure a Disk for storing EFI vars +Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. `--force` `` :: @@ -227,7 +227,7 @@ Enable/disable hugepages memory. `--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as IDE hard disk or CD-ROM (n is 0 to 3). +Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `--ipconfig[n]` `[gw=] [,gw6=] [,ip=] [,ip6=]` :: @@ -237,7 +237,8 @@ IP addresses use CIDR notation, gateways are optional but need an IP of the same + The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. -For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. +For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires +cloud-init 19.4 or newer. + If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. @@ -258,6 +259,12 @@ Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg Enable/disable KVM hardware virtualization. +`--live-restore` `` :: + +Start the VM immediately from the backup and restore in background. PBS only. ++ +NOTE: Requires option(s): `archive` + `--localtime` `` :: Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS. @@ -334,11 +341,11 @@ Configure a VirtIO-based Random Number Generator. `--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SATA hard disk or CD-ROM (n is 0 to 5). +Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). +Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `--scsihw` `` ('default =' `lsi`):: @@ -434,7 +441,7 @@ Configure the VGA hardware. `--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: -Use volume as VIRTIO hard disk (n is 0 to 15). +Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `--vmgenid` `` ('default =' `1 (autogenerated)`):: @@ -466,15 +473,20 @@ For removal from config file, even if removing disk snapshots fails. *qm destroy* `` `[OPTIONS]` -Destroy the vm (also delete all used/owned volumes). +Destroy the VM and all used/owned volumes. Removes any VM specific +permissions and firewall rules ``: ` (1 - N)` :: The (unique) ID of the VM. +`--destroy-unreferenced-disks` `` ('default =' `1`):: + +If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages. + `--purge` `` :: -Remove vmid from backup cron jobs. +Remove VMID from configurations, like backup & replication jobs and HA. `--skiplock` `` :: @@ -848,7 +860,7 @@ Virtual processor architecture. Defaults to the host. Arbitrary arguments passed to kvm. -`--audio0` `device= [,driver=]` :: +`--audio0` `device= [,driver=]` :: Configure a audio device, useful in combination with QXL/Spice. @@ -884,7 +896,7 @@ cloud-init: Specify custom files to replace the automatically generated ones at cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. -`--citype` `` :: +`--citype` `` :: Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. @@ -922,7 +934,7 @@ Prevent changes if current configuration file has different SHA1 digest. This ca `--efidisk0` `[file=] [,format=] [,size=]` :: -Configure a Disk for storing EFI vars +Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. `--force` `` :: @@ -952,7 +964,7 @@ Enable/disable hugepages memory. `--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as IDE hard disk or CD-ROM (n is 0 to 3). +Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `--ipconfig[n]` `[gw=] [,gw6=] [,ip=] [,ip6=]` :: @@ -962,7 +974,8 @@ IP addresses use CIDR notation, gateways are optional but need an IP of the same + The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. -For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. +For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires +cloud-init 19.4 or newer. + If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. @@ -1059,11 +1072,11 @@ Configure a VirtIO-based Random Number Generator. `--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SATA hard disk or CD-ROM (n is 0 to 5). +Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). +Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `--scsihw` `` ('default =' `lsi`):: @@ -1149,7 +1162,7 @@ Configure the VGA hardware. `--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: -Use volume as VIRTIO hard disk (n is 0 to 15). +Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `--vmgenid` `` ('default =' `1 (autogenerated)`):: diff --git a/qm.conf.5-opts.adoc b/qm.conf.5-opts.adoc index 07bd624..ecac889 100644 --- a/qm.conf.5-opts.adoc +++ b/qm.conf.5-opts.adoc @@ -12,7 +12,7 @@ Enable/disable Qemu GuestAgent. `fstrim_cloned_disks`=`` ('default =' `0`);; -Run fstrim after cloning/moving a disk. +Run fstrim after moving a disk or migrating the VM. `type`=`` ('default =' `virtio`);; @@ -30,7 +30,7 @@ args: -no-reboot -no-hpet + NOTE: this option is for experts only. -`audio0`: `device= [,driver=]` :: +`audio0`: `device= [,driver=]` :: Configure a audio device, useful in combination with QXL/Spice. @@ -38,7 +38,7 @@ Configure a audio device, useful in combination with QXL/Spice. Configure an audio device. -`driver`=`` ('default =' `spice`);; +`driver`=`` ('default =' `spice`);; Driver backend for the audio device. @@ -105,7 +105,7 @@ Specify a custom file containing all user data passed to the VM via cloud-init. cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. -`citype`: `` :: +`citype`: `` :: Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. @@ -161,7 +161,7 @@ Description for the VM. Only used on the configuration web interface. This is sa `efidisk0`: `[file=] [,format=] [,size=]` :: -Configure a Disk for storing EFI vars +Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. `file`=`` ;; @@ -237,7 +237,7 @@ Enable/disable hugepages memory. `ide[n]`: `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as IDE hard disk or CD-ROM (n is 0 to 3). +Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `aio`=`` ;; @@ -421,7 +421,8 @@ IP addresses use CIDR notation, gateways are optional but need an IP of the same + The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. -For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. +For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires +cloud-init 19.4 or newer. + If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. @@ -601,7 +602,7 @@ w2k8;; Microsoft Windows 2008 wvista;; Microsoft Windows Vista win7;; Microsoft Windows 7 win8;; Microsoft Windows 8/2012/2012r2 -win10;; Microsoft Windows 10/2016 +win10;; Microsoft Windows 10/2016/2019 l24;; Linux 2.4 Kernel l26;; Linux 2.6 - 5.X Kernel solaris;; Solaris/OpenSolaris/OpenIndiania kernel @@ -641,7 +642,7 @@ The file on the host to gather entropy from. In most cases /dev/urandom should b `sata[n]`: `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SATA hard disk or CD-ROM (n is 0 to 5). +Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `aio`=`` ;; @@ -815,7 +816,7 @@ The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'. `scsi[n]`: `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). +Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `aio`=`` ;; @@ -1160,7 +1161,7 @@ Select the VGA type. `virtio[n]`: `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: -Use volume as VIRTIO hard disk (n is 0 to 15). +Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `aio`=`` ;; diff --git a/qmrestore.1-synopsis.adoc b/qmrestore.1-synopsis.adoc index 73db993..e57e4d2 100644 --- a/qmrestore.1-synopsis.adoc +++ b/qmrestore.1-synopsis.adoc @@ -20,6 +20,10 @@ Override i/o bandwidth limit (in KiB/s). Allow to overwrite existing VM. +`--live-restore` `` :: + +Start the VM immediately from the backup and restore in background. PBS only. + `--pool` `` :: Add the VM to the specified pool. diff --git a/vzdump.1-synopsis.adoc b/vzdump.1-synopsis.adoc index 6036647..4e0b14d 100644 --- a/vzdump.1-synopsis.adoc +++ b/vzdump.1-synopsis.adoc @@ -30,7 +30,7 @@ Exclude specified guest systems (assumes --all) `--exclude-path` `` :: -Exclude certain files/directories (shell globs). +Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. `--ionice` ` (0 - 8)` ('default =' `7`):: @@ -46,7 +46,7 @@ Specify when to send an email `--mailto` `` :: -Comma-separated list of email addresses that should receive email notifications. +Comma-separated list of email addresses or users that should receive email notifications. `--maxfiles` ` (1 - N)` ('default =' `1`):: diff --git a/vzdump.conf.5-opts.adoc b/vzdump.conf.5-opts.adoc index 21b96e8..89e5d89 100644 --- a/vzdump.conf.5-opts.adoc +++ b/vzdump.conf.5-opts.adoc @@ -12,7 +12,7 @@ Store resulting files to specified directory. `exclude-path`: `` :: -Exclude certain files/directories (shell globs). +Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. `ionice`: ` (0 - 8)` ('default =' `7`):: @@ -28,7 +28,7 @@ Specify when to send an email `mailto`: `` :: -Comma-separated list of email addresses that should receive email notifications. +Comma-separated list of email addresses or users that should receive email notifications. `maxfiles`: ` (1 - N)` ('default =' `1`):: -- 2.39.2