X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=api-viewer%2Fapidata.js;h=befa5898df789aa3e9c6ce179e64875985c44623;hb=69055103c00285d279d17e9f54ddc8d1e7854ca4;hp=6c6d9c098b14b4f34893546476ab87e64278bae3;hpb=35a75dd36c05f79e9dda81147867878a55d839c1;p=pve-docs.git diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index 6c6d9c0..befa589 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -136,6 +136,13 @@ var pveapi = [ "optional" : 1, "type" : "string", "typetext" : "" + }, + "source" : { + "description" : "Source of the replication.", + "format" : "pve-node", + "optional" : 1, + "type" : "string", + "typetext" : "" } }, "type" : "object" @@ -237,6 +244,13 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "source" : { + "description" : "Source of the replication.", + "format" : "pve-node", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "target" : { "description" : "Target node.", "format" : "pve-node", @@ -276,6 +290,106 @@ var pveapi = [ { "children" : [ { + "children" : [ + { + "info" : { + "DELETE" : { + "description" : "Removes a node from the cluster configuration.", + "method" : "DELETE", + "name" : "delnode", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + }, + "POST" : { + "description" : "Adds a node to the cluster configuration. This call is for internal use.", + "method" : "POST", + "name" : "addnode", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "force" : { + "description" : "Do not throw error if node already exists.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "link[n]" : { + "description" : "Address and priority information of a single corosync link.", + "format" : { + "address" : { + "default_key" : 1, + "description" : "Hostname (or IP) of this corosync link address.", + "format" : "address", + "format_description" : "IP", + "type" : "string" + }, + "priority" : { + "default" : 0, + "description" : "The priority for the link when knet is used in 'passive' mode. Lower value means higher priority.", + "maximum" : 255, + "minimum" : 0, + "optional" : 1, + "type" : "integer" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[address=] [,priority=]" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "nodeid" : { + "description" : "Node id for this node.", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "votes" : { + "description" : "Number of votes for this node", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + } + } + }, + "protected" : 1, + "returns" : { + "properties" : { + "corosync_authkey" : { + "type" : "string" + }, + "corosync_conf" : { + "type" : "string" + } + }, + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/cluster/config/nodes/{node}", + "text" : "{node}" + } + ], "info" : { "GET" : { "description" : "Corosync node list.", @@ -312,10 +426,190 @@ var pveapi = [ } } }, - "leaf" : 1, + "leaf" : 0, "path" : "/cluster/config/nodes", "text" : "nodes" }, + { + "info" : { + "GET" : { + "description" : "Get information needed to join this cluster over the connected node.", + "method" : "GET", + "name" : "join_info", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "default" : "current connected node", + "description" : "The node for which the joinee gets the nodeinfo. ", + "format" : "pve-node", + "optional" : 1, + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] + ] + }, + "returns" : { + "additionalProperties" : 0, + "properties" : { + "config_digest" : { + "type" : "string" + }, + "nodelist" : { + "items" : { + "additionalProperties" : 1, + "properties" : { + "name" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string" + }, + "nodeid" : { + "description" : "Node id for this node.", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "pve_addr" : { + "format" : "ip", + "type" : "string" + }, + "pve_fp" : { + "description" : "Certificate SHA 256 fingerprint.", + "pattern" : "([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}", + "type" : "string" + }, + "quorum_votes" : { + "minimum" : 0, + "type" : "integer" + }, + "ring0_addr" : { + "description" : "Address and priority information of a single corosync link.", + "format" : { + "address" : { + "default_key" : 1, + "description" : "Hostname (or IP) of this corosync link address.", + "format" : "address", + "format_description" : "IP", + "type" : "string" + }, + "priority" : { + "default" : 0, + "description" : "The priority for the link when knet is used in 'passive' mode. Lower value means higher priority.", + "maximum" : 255, + "minimum" : 0, + "optional" : 1, + "type" : "integer" + } + }, + "optional" : 1, + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + }, + "preferred_node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string" + }, + "totem" : { + "type" : "object" + } + }, + "type" : "object" + } + }, + "POST" : { + "description" : "Joins this node into an existing cluster.", + "method" : "POST", + "name" : "join", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "fingerprint" : { + "description" : "Certificate SHA 256 fingerprint.", + "pattern" : "([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}", + "type" : "string" + }, + "force" : { + "description" : "Do not throw error if node already exists.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "hostname" : { + "description" : "Hostname (or IP) of an existing cluster member.", + "type" : "string", + "typetext" : "" + }, + "link[n]" : { + "default" : "IP resolved by node's hostname", + "description" : "Address and priority information of a single corosync link.", + "format" : { + "address" : { + "default_key" : 1, + "description" : "Hostname (or IP) of this corosync link address.", + "format" : "address", + "format_description" : "IP", + "type" : "string" + }, + "priority" : { + "default" : 0, + "description" : "The priority for the link when knet is used in 'passive' mode. Lower value means higher priority.", + "maximum" : 255, + "minimum" : 0, + "optional" : 1, + "type" : "integer" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[address=] [,priority=]" + }, + "nodeid" : { + "description" : "Node id for this node.", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "password" : { + "description" : "Superuser (root) password of peer node.", + "maxLength" : 128, + "type" : "string", + "typetext" : "" + }, + "votes" : { + "description" : "Number of votes for this node", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + } + } + }, + "protected" : 1, + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/cluster/config/join", + "text" : "join" + }, { "info" : { "GET" : { @@ -335,7 +629,6 @@ var pveapi = [ ] }, "returns" : { - "properties" : {}, "type" : "object" } } @@ -343,6 +636,33 @@ var pveapi = [ "leaf" : 1, "path" : "/cluster/config/totem", "text" : "totem" + }, + { + "info" : { + "GET" : { + "description" : "Get QDevice status", + "method" : "GET", + "name" : "status", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] + ] + }, + "returns" : { + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/cluster/config/qdevice", + "text" : "qdevice" } ], "info" : { @@ -375,26 +695,84 @@ var pveapi = [ ], "type" : "array" } - } - }, - "leaf" : 0, - "path" : "/cluster/config", - "text" : "config" - }, - { - "children" : [ - { - "children" : [ - { - "children" : [ - { - "info" : { - "DELETE" : { - "description" : "Delete rule.", - "method" : "DELETE", - "name" : "delete_rule", - "parameters" : { - "additionalProperties" : 0, + }, + "POST" : { + "description" : "Generate new cluster configuration.", + "method" : "POST", + "name" : "create", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "clustername" : { + "description" : "The name of the cluster.", + "format" : "pve-node", + "maxLength" : 15, + "type" : "string", + "typetext" : "" + }, + "link[n]" : { + "description" : "Address and priority information of a single corosync link.", + "format" : { + "address" : { + "default_key" : 1, + "description" : "Hostname (or IP) of this corosync link address.", + "format" : "address", + "format_description" : "IP", + "type" : "string" + }, + "priority" : { + "default" : 0, + "description" : "The priority for the link when knet is used in 'passive' mode. Lower value means higher priority.", + "maximum" : 255, + "minimum" : 0, + "optional" : 1, + "type" : "integer" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[address=] [,priority=]" + }, + "nodeid" : { + "description" : "Node id for this node.", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "votes" : { + "description" : "Number of votes for this node.", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "protected" : 1, + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 0, + "path" : "/cluster/config", + "text" : "config" + }, + { + "children" : [ + { + "children" : [ + { + "children" : [ + { + "info" : { + "DELETE" : { + "description" : "Delete rule.", + "method" : "DELETE", + "name" : "delete_rule", + "parameters" : { + "additionalProperties" : 0, "properties" : { "digest" : { "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", @@ -469,8 +847,70 @@ var pveapi = [ "proxyto" : null, "returns" : { "properties" : { + "action" : { + "type" : "string" + }, + "comment" : { + "optional" : 1, + "type" : "string" + }, + "dest" : { + "optional" : 1, + "type" : "string" + }, + "dport" : { + "optional" : 1, + "type" : "string" + }, + "enable" : { + "optional" : 1, + "type" : "integer" + }, + "iface" : { + "optional" : 1, + "type" : "string" + }, + "ipversion" : { + "optional" : 1, + "type" : "integer" + }, + "log" : { + "description" : "Log level for firewall rule", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, + "macro" : { + "optional" : 1, + "type" : "string" + }, "pos" : { "type" : "integer" + }, + "proto" : { + "optional" : 1, + "type" : "string" + }, + "source" : { + "optional" : 1, + "type" : "string" + }, + "sport" : { + "optional" : 1, + "type" : "string" + }, + "type" : { + "type" : "string" } }, "type" : "object" @@ -548,6 +988,22 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "log" : { + "description" : "Log level for firewall rule.", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, "macro" : { "description" : "Use predefined standard macro.", "maxLength" : 128, @@ -763,6 +1219,22 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "log" : { + "description" : "Log level for firewall rule.", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, "macro" : { "description" : "Use predefined standard macro.", "maxLength" : 128, @@ -999,8 +1471,70 @@ var pveapi = [ "proxyto" : null, "returns" : { "properties" : { + "action" : { + "type" : "string" + }, + "comment" : { + "optional" : 1, + "type" : "string" + }, + "dest" : { + "optional" : 1, + "type" : "string" + }, + "dport" : { + "optional" : 1, + "type" : "string" + }, + "enable" : { + "optional" : 1, + "type" : "integer" + }, + "iface" : { + "optional" : 1, + "type" : "string" + }, + "ipversion" : { + "optional" : 1, + "type" : "integer" + }, + "log" : { + "description" : "Log level for firewall rule", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, + "macro" : { + "optional" : 1, + "type" : "string" + }, "pos" : { "type" : "integer" + }, + "proto" : { + "optional" : 1, + "type" : "string" + }, + "source" : { + "optional" : 1, + "type" : "string" + }, + "sport" : { + "optional" : 1, + "type" : "string" + }, + "type" : { + "type" : "string" } }, "type" : "object" @@ -1071,6 +1605,22 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "log" : { + "description" : "Log level for firewall rule.", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, "macro" : { "description" : "Use predefined standard macro.", "maxLength" : 128, @@ -1240,6 +1790,22 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "log" : { + "description" : "Log level for firewall rule.", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, "macro" : { "description" : "Use predefined standard macro.", "maxLength" : 128, @@ -1941,12 +2507,46 @@ var pveapi = [ }, "returns" : { "properties" : { + "ebtables" : { + "default" : 1, + "description" : "Enable ebtables rules cluster wide.", + "optional" : 1, + "type" : "boolean" + }, "enable" : { "description" : "Enable or disable the firewall cluster wide.", "minimum" : 0, "optional" : 1, "type" : "integer" }, + "log_ratelimit" : { + "description" : "Log ratelimiting settings", + "format" : { + "burst" : { + "default" : 5, + "description" : "Inital burst of packages which will get logged", + "minimum" : 0, + "optional" : 1, + "type" : "integer" + }, + "enable" : { + "default" : "1", + "default_key" : 1, + "description" : "Enable or disable log rate limiting", + "type" : "boolean" + }, + "rate" : { + "default" : "1/second", + "description" : "Frequency with which the burst bucket gets refilled", + "format_description" : "rate", + "optional" : 1, + "pattern" : "[1-9][0-9]*\\/(second|minute|hour|day)", + "type" : "string" + } + }, + "optional" : 1, + "type" : "string" + }, "policy_in" : { "description" : "Input policy.", "enum" : [ @@ -1992,6 +2592,13 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "ebtables" : { + "default" : 1, + "description" : "Enable ebtables rules cluster wide.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "enable" : { "description" : "Enable or disable the firewall cluster wide.", "minimum" : 0, @@ -1999,6 +2606,35 @@ var pveapi = [ "type" : "integer", "typetext" : " (0 - N)" }, + "log_ratelimit" : { + "description" : "Log ratelimiting settings", + "format" : { + "burst" : { + "default" : 5, + "description" : "Inital burst of packages which will get logged", + "minimum" : 0, + "optional" : 1, + "type" : "integer" + }, + "enable" : { + "default" : "1", + "default_key" : 1, + "description" : "Enable or disable log rate limiting", + "type" : "boolean" + }, + "rate" : { + "default" : "1/second", + "description" : "Frequency with which the burst bucket gets refilled", + "format_description" : "rate", + "optional" : 1, + "pattern" : "[1-9][0-9]*\\/(second|minute|hour|day)", + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[enable=]<1|0> [,burst=] [,rate=]" + }, "policy_in" : { "description" : "Input policy.", "enum" : [ @@ -2374,8 +3010,14 @@ var pveapi = [ "type" : "integer", "typetext" : "" }, - "quiet" : { - "default" : 0, + "pool" : { + "description" : "Backup all known guest systems included in the specified pool.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "quiet" : { + "default" : 0, "description" : "Be quiet.", "optional" : 1, "type" : "boolean", @@ -2417,7 +3059,7 @@ var pveapi = [ }, "stop" : { "default" : 0, - "description" : "Stop runnig backup jobs on this host.", + "description" : "Stop running backup jobs on this host.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -2643,6 +3285,12 @@ var pveapi = [ "type" : "integer", "typetext" : "" }, + "pool" : { + "description" : "Backup all known guest systems included in the specified pool.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "quiet" : { "default" : 0, "description" : "Be quiet.", @@ -2686,7 +3334,7 @@ var pveapi = [ }, "stop" : { "default" : 0, - "description" : "Stop runnig backup jobs on this host.", + "description" : "Stop running backup jobs on this host.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -2757,7 +3405,7 @@ var pveapi = [ "additionalProperties" : 0, "properties" : { "node" : { - "description" : "The cluster node name.", + "description" : "Target node.", "format" : "pve-node", "type" : "string", "typetext" : "" @@ -2799,7 +3447,7 @@ var pveapi = [ "additionalProperties" : 0, "properties" : { "node" : { - "description" : "The cluster node name.", + "description" : "Target node.", "format" : "pve-node", "type" : "string", "typetext" : "" @@ -2886,7 +3534,58 @@ var pveapi = [ ] ] }, - "returns" : {} + "returns" : { + "properties" : { + "comment" : { + "description" : "Description.", + "optional" : 1, + "type" : "string" + }, + "digest" : { + "description" : "Can be used to prevent concurrent modifications.", + "type" : "string" + }, + "group" : { + "description" : "The HA group identifier.", + "format" : "pve-configid", + "optional" : 1, + "type" : "string" + }, + "max_relocate" : { + "description" : "Maximal number of service relocate tries when a service failes to start.", + "optional" : 1, + "type" : "integer" + }, + "max_restart" : { + "description" : "Maximal number of tries to restart the service on a node after its start failed.", + "optional" : 1, + "type" : "integer" + }, + "sid" : { + "description" : "HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).", + "format" : "pve-ha-resource-or-vm-id", + "type" : "string", + "typetext" : ":" + }, + "state" : { + "description" : "Requested resource state.", + "enum" : [ + "started", + "stopped", + "enabled", + "disabled", + "ignored" + ], + "optional" : 1, + "type" : "string" + }, + "type" : { + "description" : "The type of the resources.", + "type" : "string" + } + }, + "type" : "object" + } }, "PUT" : { "description" : "Update resource configuration.", @@ -3494,75 +4193,444 @@ var pveapi = [ "text" : "ha" }, { - "info" : { - "GET" : { - "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)" - } + "children" : [ + { + "children" : [ + { + "info" : { + "DELETE" : { + "description" : "Deactivate existing ACME account at CA.", + "method" : "DELETE", + "name" : "deactivate_account", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "name" : { + "default" : "default", + "description" : "ACME account config file name.", + "format" : "pve-configid", + "format_description" : "name", + "optional" : 1, + "type" : "string", + "typetext" : "" + } + } + }, + "protected" : 1, + "returns" : { + "type" : "string" + } + }, + "GET" : { + "description" : "Return existing ACME account information.", + "method" : "GET", + "name" : "get_account", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "name" : { + "default" : "default", + "description" : "ACME account config file name.", + "format" : "pve-configid", + "format_description" : "name", + "optional" : 1, + "type" : "string", + "typetext" : "" + } + } + }, + "protected" : 1, + "returns" : { + "additionalProperties" : 0, + "properties" : { + "account" : { + "optional" : 1, + "renderer" : "yaml", + "type" : "object" + }, + "directory" : { + "description" : "URL of ACME CA directory endpoint.", + "optional" : 1, + "pattern" : "^https?://.*", + "type" : "string" + }, + "location" : { + "optional" : 1, + "type" : "string" + }, + "tos" : { + "optional" : 1, + "type" : "string" + } + }, + "type" : "object" + } + }, + "PUT" : { + "description" : "Update existing ACME account information with CA. Note: not specifying any new account information triggers a refresh.", + "method" : "PUT", + "name" : "update_account", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "contact" : { + "description" : "Contact email addresses.", + "format" : "email-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "name" : { + "default" : "default", + "description" : "ACME account config file name.", + "format" : "pve-configid", + "format_description" : "name", + "optional" : 1, + "type" : "string", + "typetext" : "" + } + } + }, + "protected" : 1, + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/cluster/acme/account/{name}", + "text" : "{name}" } - }, - "permissions" : { - "user" : "all" - }, - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "type" : "array" - } - } - }, - "leaf" : 1, - "path" : "/cluster/log", - "text" : "log" - }, - { - "info" : { - "GET" : { - "description" : "Resources index (cluster wide).", - "method" : "GET", - "name" : "resources", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "type" : { - "enum" : [ - "vm", - "storage", - "node" + ], + "info" : { + "GET" : { + "description" : "ACMEAccount index.", + "method" : "GET", + "name" : "account_index", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "user" : "all" + }, + "protected" : 1, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } ], - "optional" : 1, + "type" : "array" + } + }, + "POST" : { + "description" : "Register a new ACME account with CA.", + "method" : "POST", + "name" : "register_account", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "contact" : { + "description" : "Contact email addresses.", + "format" : "email-list", + "type" : "string", + "typetext" : "" + }, + "directory" : { + "default" : "https://acme-v02.api.letsencrypt.org/directory", + "description" : "URL of ACME CA directory endpoint.", + "optional" : 1, + "pattern" : "^https?://.*", + "type" : "string" + }, + "name" : { + "default" : "default", + "description" : "ACME account config file name.", + "format" : "pve-configid", + "format_description" : "name", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "tos_url" : { + "description" : "URL of CA TermsOfService - setting this indicates agreement.", + "optional" : 1, + "type" : "string", + "typetext" : "" + } + } + }, + "protected" : 1, + "returns" : { "type" : "string" } } }, - "permissions" : { - "user" : "all" - }, - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "type" : "array" - } - } - }, - "leaf" : 1, - "path" : "/cluster/resources", - "text" : "resources" - }, + "leaf" : 0, + "path" : "/cluster/acme/account", + "text" : "account" + }, + { + "info" : { + "GET" : { + "description" : "Retrieve ACME TermsOfService URL from CA.", + "method" : "GET", + "name" : "get_tos", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "directory" : { + "default" : "https://acme-v02.api.letsencrypt.org/directory", + "description" : "URL of ACME CA directory endpoint.", + "optional" : 1, + "pattern" : "^https?://.*", + "type" : "string" + } + } + }, + "permissions" : { + "user" : "all" + }, + "returns" : { + "description" : "ACME TermsOfService URL.", + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/cluster/acme/tos", + "text" : "tos" + }, + { + "info" : { + "GET" : { + "description" : "Get named known ACME directory endpoints.", + "method" : "GET", + "name" : "get_directories", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "user" : "all" + }, + "returns" : { + "items" : { + "additionalProperties" : 0, + "properties" : { + "name" : { + "type" : "string" + }, + "url" : { + "description" : "URL of ACME CA directory endpoint.", + "pattern" : "^https?://.*", + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/cluster/acme/directories", + "text" : "directories" + } + ], + "info" : { + "GET" : { + "description" : "ACMEAccount index.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/cluster/acme", + "text" : "acme" + }, + { + "info" : { + "GET" : { + "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" : { + "description" : "Resources index (cluster wide).", + "method" : "GET", + "name" : "resources", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "type" : { + "enum" : [ + "vm", + "storage", + "node" + ], + "optional" : 1, + "type" : "string" + } + } + }, + "permissions" : { + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : { + "cpu" : { + "description" : "CPU utilization (when type in node,qemu,lxc).", + "optional" : 1, + "renderer" : "fraction_as_percentage", + "type" : "number" + }, + "disk" : { + "description" : "Used disk space in bytes (when type in storage), used root image spave for VMs (type in qemu,lxc).", + "optional" : 1, + "renderer" : "bytes", + "type" : "string" + }, + "hastate" : { + "description" : "HA service status (for HA managed VMs).", + "optional" : 1, + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "level" : { + "description" : "Support level (when type == node).", + "optional" : 1, + "type" : "string" + }, + "maxcpu" : { + "description" : "Number of available CPUs (when type in node,qemu,lxc).", + "optional" : 1, + "type" : "number" + }, + "maxdisk" : { + "description" : "Storage size in bytes (when type in storage), root image size for VMs (type in qemu,lxc).", + "optional" : 1, + "renderer" : "bytes", + "type" : "integer" + }, + "maxmem" : { + "description" : "Number of available memory in bytes (when type in node,qemu,lxc).", + "optional" : 1, + "renderer" : "bytes", + "type" : "integer" + }, + "mem" : { + "description" : "Used memory in bytes (when type in node,qemu,lxc).", + "optional" : 1, + "renderer" : "bytes", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name (when type in node,storage,qemu,lxc).", + "format" : "pve-node", + "optional" : 1, + "type" : "string" + }, + "pool" : { + "description" : "The pool name (when type in pool,qemu,lxc).", + "optional" : 1, + "type" : "string" + }, + "status" : { + "description" : "Resource type dependent status.", + "optional" : 1, + "type" : "string" + }, + "storage" : { + "description" : "The storage identifier (when type == storage).", + "format" : "pve-storage-id", + "optional" : 1, + "type" : "string" + }, + "type" : { + "description" : "Resource type.", + "enum" : [ + "node", + "storage", + "pool", + "qemu", + "lxc", + "openvz" + ], + "type" : "string" + }, + "uptime" : { + "description" : "Node uptime in seconds (when type in node,qemu,lxc).", + "optional" : 1, + "renderer" : "duration", + "type" : "integer" + } + }, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/cluster/resources", + "text" : "resources" + }, { "info" : { "GET" : { @@ -3611,7 +4679,6 @@ var pveapi = [ ] }, "returns" : { - "properties" : {}, "type" : "object" } }, @@ -3622,12 +4689,56 @@ var pveapi = [ "parameters" : { "additionalProperties" : 0, "properties" : { + "bwlimit" : { + "description" : "Set bandwidth/io limits various operations.", + "format" : { + "clone" : { + "description" : "bandwidth limit in KiB/s for cloning disks", + "format_description" : "LIMIT", + "minimum" : "0", + "optional" : 1, + "type" : "number" + }, + "default" : { + "description" : "default bandwidth limit in KiB/s", + "format_description" : "LIMIT", + "minimum" : "0", + "optional" : 1, + "type" : "number" + }, + "migration" : { + "description" : "bandwidth limit in KiB/s for migrating guests (including moving local disks)", + "format_description" : "LIMIT", + "minimum" : "0", + "optional" : 1, + "type" : "number" + }, + "move" : { + "description" : "bandwidth limit in KiB/s for moving disks", + "format_description" : "LIMIT", + "minimum" : "0", + "optional" : 1, + "type" : "number" + }, + "restore" : { + "description" : "bandwidth limit in KiB/s for restoring guests from backups", + "format_description" : "LIMIT", + "minimum" : "0", + "optional" : 1, + "type" : "number" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[clone=] [,default=] [,migration=] [,move=] [,restore=]" + }, "console" : { - "description" : "Select the default Console viewer. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer comtatible application (SPICE), or an HTML5 based viewer (noVNC).", + "description" : "Select the default Console viewer. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer comtatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC.", "enum" : [ "applet", "vv", - "html5" + "html5", + "xtermjs" ], "optional" : 1, "type" : "string" @@ -3657,6 +4768,25 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "ha" : { + "description" : "Cluster wide HA settings.", + "format" : { + "shutdown_policy" : { + "default" : "conditional", + "description" : "The policy for HA services on node shutdown. 'freeze' disables auto-recovery, 'failover' ensures recovery, 'conditional' recovers on poweroff and freezes on reboot. Running HA Services will always get stopped first on shutdown.", + "enum" : [ + "freeze", + "failover", + "conditional" + ], + "type" : "string", + "verbose_description" : "Describes the policy for handling HA services on poweroff or reboot of a node. Freeze will always freeze services which are still located on the node on shutdown, those services won't be recovered by the HA manager. Failover will not mark the services as frozen and thus the services will get recovered to other nodes, if the shutdown node does not come up again quickly (< 1min). 'conditional' chooses automatically depending on the type of shutdown, i.e., on a reboot the service will be frozen but on a poweroff the service will stay as is, and thus get recovered after about 2 minutes." + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "shutdown_policy=" + }, "http_proxy" : { "description" : "Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')", "optional" : 1, @@ -3698,17 +4828,35 @@ var pveapi = [ "language" : { "description" : "Default GUI language.", "enum" : [ + "zh_CN", + "zh_TW", + "ca", "en", - "de" + "eu", + "fr", + "de", + "it", + "es", + "ja", + "nb", + "nn", + "fa", + "pl", + "pt_BR", + "ru", + "sl", + "sv", + "tr" ], "optional" : 1, "type" : "string" }, "mac_prefix" : { "description" : "Prefix for autogenerated MAC addresses.", + "format" : "mac-prefix", "optional" : 1, - "pattern" : "(?^i:[a-f0-9]{2}(?::[a-f0-9]{2}){0,2}:?)", - "type" : "string" + "type" : "string", + "typetext" : "" }, "max_workers" : { "description" : "Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.", @@ -3747,6 +4895,26 @@ var pveapi = [ "optional" : 1, "type" : "boolean", "typetext" : "" + }, + "u2f" : { + "description" : "u2f", + "format" : { + "appid" : { + "description" : "U2F AppId URL override. Defaults to the origin.", + "format_description" : "APPID", + "optional" : 1, + "type" : "string" + }, + "origin" : { + "description" : "U2F Origin override. Mostly useful for single nodes with a single URL.", + "format_description" : "URL", + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[appid=] [,origin=]" } } }, @@ -3772,7 +4940,7 @@ var pveapi = [ { "info" : { "GET" : { - "description" : "Get cluster status informations.", + "description" : "Get cluster status information.", "method" : "GET", "name" : "get_status", "parameters" : { @@ -3836,20 +5004,115 @@ var pveapi = [ "leaf" : 1, "path" : "/cluster/nextid", "text" : "nextid" - } - ], - "info" : { - "GET" : { - "description" : "Cluster index.", - "method" : "GET", - "name" : "index", - "parameters" : { - "additionalProperties" : 0 - }, - "permissions" : { - "user" : "all" - }, - "returns" : { + }, + { + "children" : [ + { + "info" : { + "GET" : { + "description" : "Get ceph metadata.", + "method" : "GET", + "name" : "ceph_metadata", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit", + "Datastore.Audit" + ], + "any", + 1 + ] + }, + "protected" : 1, + "returns" : { + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/cluster/ceph/metadata", + "text" : "metadata" + }, + { + "info" : { + "GET" : { + "description" : "Get ceph status.", + "method" : "GET", + "name" : "cephstatus", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit", + "Datastore.Audit" + ], + "any", + 1 + ] + }, + "protected" : 1, + "returns" : { + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/cluster/ceph/status", + "text" : "status" + } + ], + "info" : { + "GET" : { + "description" : "Cluster ceph index.", + "method" : "GET", + "name" : "cephindex", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/cluster/ceph", + "text" : "ceph" + } + ], + "info" : { + "GET" : { + "description" : "Cluster index.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "user" : "all" + }, + "returns" : { "items" : { "properties" : {}, "type" : "object" @@ -3974,8 +5237,70 @@ var pveapi = [ "proxyto" : null, "returns" : { "properties" : { + "action" : { + "type" : "string" + }, + "comment" : { + "optional" : 1, + "type" : "string" + }, + "dest" : { + "optional" : 1, + "type" : "string" + }, + "dport" : { + "optional" : 1, + "type" : "string" + }, + "enable" : { + "optional" : 1, + "type" : "integer" + }, + "iface" : { + "optional" : 1, + "type" : "string" + }, + "ipversion" : { + "optional" : 1, + "type" : "integer" + }, + "log" : { + "description" : "Log level for firewall rule", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, + "macro" : { + "optional" : 1, + "type" : "string" + }, "pos" : { "type" : "integer" + }, + "proto" : { + "optional" : 1, + "type" : "string" + }, + "source" : { + "optional" : 1, + "type" : "string" + }, + "sport" : { + "optional" : 1, + "type" : "string" + }, + "type" : { + "type" : "string" } }, "type" : "object" @@ -4046,6 +5371,22 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "log" : { + "description" : "Log level for firewall rule.", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, "macro" : { "description" : "Use predefined standard macro.", "maxLength" : 128, @@ -4243,6 +5584,22 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "log" : { + "description" : "Log level for firewall rule.", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, "macro" : { "description" : "Use predefined standard macro.", "maxLength" : 128, @@ -5562,965 +6919,1496 @@ var pveapi = [ "text" : "firewall" }, { - "info" : { - "GET" : { - "description" : "Read VM RRD statistics (returns PNG)", - "method" : "GET", - "name" : "rrd", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "cf" : { - "description" : "The RRD consolidation function", - "enum" : [ - "AVERAGE", - "MAX" - ], - "optional" : 1, - "type" : "string" - }, - "ds" : { - "description" : "The list of datasources you want to display.", - "format" : "pve-configid-list", - "type" : "string", - "typetext" : "" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "children" : [ + { + "info" : { + "POST" : { + "description" : "Execute fsfreeze-freeze.", + "method" : "POST", + "name" : "fsfreeze-freeze", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } }, - "timeframe" : { - "description" : "Specify the time frame you are interested in.", - "enum" : [ - "hour", - "day", - "week", - "month", - "year" - ], - "type" : "string" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" } } }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "protected" : 1, - "returns" : { - "properties" : { - "filename" : { - "type" : "string" - } - }, - "type" : "object" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/rrd", - "text" : "rrd" - }, - { - "info" : { - "GET" : { - "description" : "Read VM RRD statistics", - "method" : "GET", - "name" : "rrddata", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "cf" : { - "description" : "The RRD consolidation function", - "enum" : [ - "AVERAGE", - "MAX" - ], - "optional" : 1, - "type" : "string" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/fsfreeze-freeze", + "text" : "fsfreeze-freeze" + }, + { + "info" : { + "POST" : { + "description" : "Execute fsfreeze-status.", + "method" : "POST", + "name" : "fsfreeze-status", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } }, - "timeframe" : { - "description" : "Specify the time frame you are interested in.", - "enum" : [ - "hour", - "day", - "week", - "month", - "year" - ], - "type" : "string" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" } } }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "protected" : 1, - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "type" : "array" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/rrddata", - "text" : "rrddata" - }, - { - "info" : { - "GET" : { - "description" : "Get current virtual machine configuration. This does not include pending configuration changes (see 'pending' API).", - "method" : "GET", - "name" : "vm_config", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "current" : { - "default" : 0, - "description" : "Get current values (instead of pending values).", - "optional" : 1, - "type" : "boolean", - "typetext" : "" + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/fsfreeze-status", + "text" : "fsfreeze-status" + }, + { + "info" : { + "POST" : { + "description" : "Execute fsfreeze-thaw.", + "method" : "POST", + "name" : "fsfreeze-thaw", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" } } }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "proxyto" : "node", - "returns" : { - "properties" : { - "digest" : { - "description" : "SHA1 digest of configuration file. This can be used to prevent concurrent modifications.", - "type" : "string" - } - }, - "type" : "object" - } + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/fsfreeze-thaw", + "text" : "fsfreeze-thaw" }, - "POST" : { - "description" : "Set virtual machine options (asynchrounous API).", - "method" : "POST", - "name" : "update_vm_async", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "acpi" : { - "default" : 1, - "description" : "Enable/disable ACPI.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "agent" : { - "default" : 0, - "description" : "Enable/disable Qemu GuestAgent.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "args" : { - "description" : "Arbitrary arguments passed to kvm.", - "optional" : 1, - "type" : "string", - "typetext" : "", - "verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n" - }, - "autostart" : { - "default" : 0, - "description" : "Automatic restart after crash (currently ignored).", - "optional" : 1, - "type" : "boolean", - "typetext" : "" + { + "info" : { + "POST" : { + "description" : "Execute fstrim.", + "method" : "POST", + "name" : "fstrim", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } }, - "background_delay" : { - "description" : "Time to wait for the task to finish. We return 'null' if the task finish within that time.", - "maximum" : 30, - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - 30)" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] }, - "balloon" : { - "description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.", - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/fstrim", + "text" : "fstrim" + }, + { + "info" : { + "GET" : { + "description" : "Execute get-fsinfo.", + "method" : "GET", + "name" : "get-fsinfo", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } }, - "bios" : { - "default" : "seabios", - "description" : "Select BIOS implementation.", - "enum" : [ - "seabios", - "ovmf" - ], - "optional" : 1, - "type" : "string" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] }, - "boot" : { - "default" : "cdn", - "description" : "Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).", - "optional" : 1, - "pattern" : "[acdn]{1,4}", - "type" : "string" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/get-fsinfo", + "text" : "get-fsinfo" + }, + { + "info" : { + "GET" : { + "description" : "Execute get-host-name.", + "method" : "GET", + "name" : "get-host-name", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } }, - "bootdisk" : { - "description" : "Enable booting from specified disk.", - "format" : "pve-qm-bootdisk", - "optional" : 1, - "pattern" : "(ide|sata|scsi|virtio)\\d+", - "type" : "string" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] }, - "cdrom" : { - "description" : "This is an alias for option -ide2", - "format" : "pve-qm-ide", - "optional" : 1, - "type" : "string", - "typetext" : "" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/get-host-name", + "text" : "get-host-name" + }, + { + "info" : { + "GET" : { + "description" : "Execute get-memory-block-info.", + "method" : "GET", + "name" : "get-memory-block-info", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } }, - "cores" : { - "default" : 1, - "description" : "The number of cores per socket.", - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - N)" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] }, - "cpu" : { - "description" : "Emulated CPU type.", - "format" : { - "cputype" : { - "default" : "kvm64", - "default_key" : 1, - "description" : "Emulated CPU type.", - "enum" : [ - "486", - "athlon", - "Broadwell", - "Broadwell-IBRS", - "Broadwell-noTSX", - "Broadwell-noTSX-IBRS", - "Conroe", - "core2duo", - "coreduo", - "Haswell", - "Haswell-IBRS", - "Haswell-noTSX", - "Haswell-noTSX-IBRS", - "host", - "IvyBridge", - "IvyBridge-IBRS", - "kvm32", - "kvm64", - "max", - "Nehalem", - "Nehalem-IBRS", - "Opteron_G1", - "Opteron_G2", - "Opteron_G3", - "Opteron_G4", - "Opteron_G5", - "Penryn", - "pentium", - "pentium2", - "pentium3", - "phenom", - "qemu32", - "qemu64", - "SandyBridge", - "SandyBridge-IBRS", - "Skylake-Client", - "Skylake-Client-IBRS", - "Skylake-Server", - "Skylake-Server-IBRS", - "Westmere", - "Westmere-IBRS" - ], - "type" : "string" - }, - "flags" : { - "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl'.", - "format_description" : "+FLAG[;-FLAG...]", - "optional" : 1, - "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl))(;(?^:[+-](pcid|spec-ctrl)))*)", - "type" : "string" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/get-memory-block-info", + "text" : "get-memory-block-info" + }, + { + "info" : { + "GET" : { + "description" : "Execute get-memory-blocks.", + "method" : "GET", + "name" : "get-memory-blocks", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "hidden" : { - "default" : 0, - "description" : "Do not identify as a KVM virtual machine.", - "optional" : 1, - "type" : "boolean" + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "optional" : 1, - "type" : "string", - "typetext" : "[cputype=] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]" - }, - "cpulimit" : { - "default" : 0, - "description" : "Limit of CPU usage.", - "maximum" : 128, - "minimum" : 0, - "optional" : 1, - "type" : "number", - "typetext" : " (0 - 128)", - "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit." + } }, - "cpuunits" : { - "default" : 1024, - "description" : "CPU weight for a VM.", - "maximum" : 262144, - "minimum" : 2, - "optional" : 1, - "type" : "integer", - "typetext" : " (2 - 262144)", - "verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs." + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] }, - "delete" : { - "description" : "A list of settings you want to delete.", - "format" : "pve-configid-list", - "optional" : 1, - "type" : "string", - "typetext" : "" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/get-memory-blocks", + "text" : "get-memory-blocks" + }, + { + "info" : { + "GET" : { + "description" : "Execute get-osinfo.", + "method" : "GET", + "name" : "get-osinfo", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } }, - "description" : { - "description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.", - "optional" : 1, - "type" : "string", - "typetext" : "" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] }, - "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" : "" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/get-osinfo", + "text" : "get-osinfo" + }, + { + "info" : { + "GET" : { + "description" : "Execute get-time.", + "method" : "GET", + "name" : "get-time", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } }, - "force" : { - "description" : "Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.", - "optional" : 1, - "requires" : "delete", - "type" : "boolean", - "typetext" : "" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] }, - "freeze" : { - "description" : "Freeze CPU at startup (use 'c' monitor command to start execution).", - "optional" : 1, - "type" : "boolean", - "typetext" : "" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/get-time", + "text" : "get-time" + }, + { + "info" : { + "GET" : { + "description" : "Execute get-timezone.", + "method" : "GET", + "name" : "get-timezone", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } }, - "hostpci[n]" : { - "description" : "Map host PCI devices into guest.", - "format" : "pve-qm-hostpci", - "optional" : 1, - "type" : "string", - "typetext" : "[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]", - "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer \npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] }, - "hotplug" : { - "default" : "network,disk,usb", - "description" : "Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.", - "format" : "pve-hotplug-features", - "optional" : 1, - "type" : "string", - "typetext" : "" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/get-timezone", + "text" : "get-timezone" + }, + { + "info" : { + "GET" : { + "description" : "Execute get-users.", + "method" : "GET", + "name" : "get-users", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } }, - "hugepages" : { - "description" : "Enable/disable hugepages memory.", - "enum" : [ - "any", - "2", - "1024" - ], - "optional" : 1, - "type" : "string" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] }, - "ide[n]" : { - "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3).", - "format" : { - "aio" : { - "description" : "AIO type to use.", - "enum" : [ - "native", - "threads" - ], - "optional" : 1, - "type" : "string" - }, - "backup" : { - "description" : "Whether the drive should be included when making backups.", - "optional" : 1, - "type" : "boolean" - }, - "bps" : { - "description" : "Maximum r/w speed in bytes per second.", - "format_description" : "bps", - "optional" : 1, - "type" : "integer" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/get-users", + "text" : "get-users" + }, + { + "info" : { + "GET" : { + "description" : "Execute get-vcpus.", + "method" : "GET", + "name" : "get-vcpus", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "bps_max_length" : { - "description" : "Maximum length of I/O bursts in seconds.", - "format_description" : "seconds", + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", "minimum" : 1, - "optional" : 1, - "type" : "integer" - }, - "bps_rd" : { - "description" : "Maximum read speed in bytes per second.", - "format_description" : "bps", - "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/get-vcpus", + "text" : "get-vcpus" + }, + { + "info" : { + "GET" : { + "description" : "Execute info.", + "method" : "GET", + "name" : "info", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "bps_rd_length" : { - "alias" : "bps_rd_max_length" + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/info", + "text" : "info" + }, + { + "info" : { + "GET" : { + "description" : "Execute network-get-interfaces.", + "method" : "GET", + "name" : "network-get-interfaces", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "bps_rd_max_length" : { - "description" : "Maximum length of read I/O bursts in seconds.", - "format_description" : "seconds", + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", "minimum" : 1, - "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/network-get-interfaces", + "text" : "network-get-interfaces" + }, + { + "info" : { + "POST" : { + "description" : "Execute ping.", + "method" : "POST", + "name" : "ping", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "bps_wr" : { - "description" : "Maximum write speed in bytes per second.", - "format_description" : "bps", - "optional" : 1, - "type" : "integer" + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/ping", + "text" : "ping" + }, + { + "info" : { + "POST" : { + "description" : "Execute shutdown.", + "method" : "POST", + "name" : "shutdown", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "bps_wr_length" : { - "alias" : "bps_wr_max_length" + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/shutdown", + "text" : "shutdown" + }, + { + "info" : { + "POST" : { + "description" : "Execute suspend-disk.", + "method" : "POST", + "name" : "suspend-disk", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "bps_wr_max_length" : { - "description" : "Maximum length of write I/O bursts in seconds.", - "format_description" : "seconds", + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", "minimum" : 1, - "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/suspend-disk", + "text" : "suspend-disk" + }, + { + "info" : { + "POST" : { + "description" : "Execute suspend-hybrid.", + "method" : "POST", + "name" : "suspend-hybrid", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "cache" : { - "description" : "The drive's cache mode", - "enum" : [ - "none", - "writethrough", - "writeback", - "unsafe", - "directsync" - ], - "optional" : 1, - "type" : "string" + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/suspend-hybrid", + "text" : "suspend-hybrid" + }, + { + "info" : { + "POST" : { + "description" : "Execute suspend-ram.", + "method" : "POST", + "name" : "suspend-ram", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "cyls" : { - "description" : "Force the drive's physical geometry to have a specific cylinder count.", + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/suspend-ram", + "text" : "suspend-ram" + }, + { + "info" : { + "POST" : { + "description" : "Sets the password for the given user to the given password", + "method" : "POST", + "name" : "set-user-password", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "crypted" : { + "default" : 0, + "description" : "set to 1 if the password has already been passed through crypt()", "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "password" : { + "description" : "The new password.", + "maxLength" : 64, + "minLength" : 5, + "type" : "string", + "typetext" : "" + }, + "username" : { + "description" : "The user to set the password for.", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/set-user-password", + "text" : "set-user-password" + }, + { + "info" : { + "POST" : { + "description" : "Executes the given command in the vm via the guest-agent and returns an object with the pid.", + "method" : "POST", + "name" : "exec", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "command" : { + "description" : "The command as a list of program + arguments", + "format" : "string-alist", + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "properties" : { + "pid" : { + "description" : "The PID of the process started by the guest-agent.", "type" : "integer" + } + }, + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/exec", + "text" : "exec" + }, + { + "info" : { + "GET" : { + "description" : "Gets the status of the given pid started by the guest-agent", + "method" : "GET", + "name" : "exec-status", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "detect_zeroes" : { - "description" : "Controls whether to detect and try to optimize writes of zeroes.", - "optional" : 1, - "type" : "boolean" + "pid" : { + "description" : "The PID to query", + "type" : "integer", + "typetext" : "" }, - "discard" : { - "description" : "Controls whether to pass discard/trim requests to the underlying storage.", - "enum" : [ - "ignore", - "on" - ], + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "properties" : { + "err-data" : { + "description" : "stderr of the process", "optional" : 1, "type" : "string" }, - "file" : { - "default_key" : 1, - "description" : "The drive's backing volume.", - "format" : "pve-volume-id-or-qm-path", - "format_description" : "volume", - "type" : "string" - }, - "format" : { - "description" : "The drive's backing file's data format.", - "enum" : [ - "raw", - "cow", - "qcow", - "qed", - "qcow2", - "vmdk", - "cloop" - ], + "err-truncated" : { + "description" : "true if stderr was not fully captured", "optional" : 1, - "type" : "string" + "type" : "boolean" }, - "heads" : { - "description" : "Force the drive's physical geometry to have a specific head count.", + "exitcode" : { + "description" : "process exit code if it was normally terminated.", "optional" : 1, "type" : "integer" }, - "iops" : { - "description" : "Maximum r/w I/O in operations per second.", - "format_description" : "iops", + "exited" : { + "description" : "Tells if the given command has exited yet.", + "type" : "boolean" + }, + "out-data" : { + "description" : "stdout of the process", "optional" : 1, - "type" : "integer" + "type" : "string" }, - "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool in operations per second.", - "format_description" : "iops", + "out-truncated" : { + "description" : "true if stdout was not fully captured", "optional" : 1, - "type" : "integer" + "type" : "boolean" }, - "iops_max_length" : { - "description" : "Maximum length of I/O bursts in seconds.", - "format_description" : "seconds", - "minimum" : 1, + "signal" : { + "description" : "signal number or exception code if the process was abnormally terminated.", "optional" : 1, "type" : "integer" + } + }, + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/exec-status", + "text" : "exec-status" + }, + { + "info" : { + "GET" : { + "description" : "Reads the given file via guest agent. Is limited to 16777216 bytes.", + "method" : "GET", + "name" : "file-read", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "file" : { + "description" : "The path to the file", + "type" : "string", + "typetext" : "" }, - "iops_rd" : { - "description" : "Maximum read I/O in operations per second.", - "format_description" : "iops", - "optional" : 1, - "type" : "integer" - }, - "iops_rd_length" : { - "alias" : "iops_rd_max_length" - }, - "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool in operations per second.", - "format_description" : "iops", - "optional" : 1, - "type" : "integer" - }, - "iops_rd_max_length" : { - "description" : "Maximum length of read I/O bursts in seconds.", - "format_description" : "seconds", - "minimum" : 1, - "optional" : 1, - "type" : "integer" - }, - "iops_wr" : { - "description" : "Maximum write I/O in operations per second.", - "format_description" : "iops", - "optional" : 1, - "type" : "integer" - }, - "iops_wr_length" : { - "alias" : "iops_wr_max_length" - }, - "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool in operations per second.", - "format_description" : "iops", - "optional" : 1, - "type" : "integer" + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "iops_wr_max_length" : { - "description" : "Maximum length of write I/O bursts in seconds.", - "format_description" : "seconds", + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", "minimum" : 1, - "optional" : 1, - "type" : "integer" - }, - "mbps" : { - "description" : "Maximum r/w speed in megabytes per second.", - "format_description" : "mbps", - "optional" : 1, - "type" : "number" - }, - "mbps_max" : { - "description" : "Maximum unthrottled r/w pool in megabytes per second.", - "format_description" : "mbps", - "optional" : 1, - "type" : "number" - }, - "mbps_rd" : { - "description" : "Maximum read speed in megabytes per second.", - "format_description" : "mbps", - "optional" : 1, - "type" : "number" - }, - "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool in megabytes per second.", - "format_description" : "mbps", - "optional" : 1, - "type" : "number" - }, - "mbps_wr" : { - "description" : "Maximum write speed in megabytes per second.", - "format_description" : "mbps", - "optional" : 1, - "type" : "number" - }, - "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool in megabytes per second.", - "format_description" : "mbps", - "optional" : 1, - "type" : "number" - }, - "media" : { - "default" : "disk", - "description" : "The drive's media type.", - "enum" : [ - "cdrom", - "disk" - ], - "optional" : 1, - "type" : "string" - }, - "model" : { - "description" : "The drive's reported model name, url-encoded, up to 40 bytes long.", - "format" : "urlencoded", - "format_description" : "model", - "maxLength" : 120, - "optional" : 1, - "type" : "string" - }, - "replicate" : { - "default" : 1, - "description" : "Whether the drive should considered for replication jobs.", - "optional" : 1, - "type" : "boolean" - }, - "rerror" : { - "description" : "Read error action.", - "enum" : [ - "ignore", - "report", - "stop" - ], - "optional" : 1, - "type" : "string" - }, - "secs" : { - "description" : "Force the drive's physical geometry to have a specific sector count.", - "optional" : 1, - "type" : "integer" - }, - "serial" : { - "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", - "format" : "urlencoded", - "format_description" : "serial", - "maxLength" : 60, - "optional" : 1, - "type" : "string" - }, - "size" : { - "description" : "Disk size. This is purely informational and has no effect.", - "format" : "disk-size", - "format_description" : "DiskSize", - "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a `content` property.", + "properties" : { + "content" : { + "description" : "The content of the file, maximum 16777216", "type" : "string" }, - "snapshot" : { - "description" : "Whether the drive should be included when making snapshots.", + "truncated" : { + "description" : "If set to 1, the output is truncated and not complete", "optional" : 1, "type" : "boolean" + } + }, + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/file-read", + "text" : "file-read" + }, + { + "info" : { + "POST" : { + "description" : "Writes the given file via guest agent.", + "method" : "POST", + "name" : "file-write", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "content" : { + "description" : "The content to write into the file.", + "maxLength" : 61440, + "type" : "string", + "typetext" : "" }, - "trans" : { - "description" : "Force disk geometry bios translation mode.", - "enum" : [ - "none", - "lba", - "auto" - ], - "optional" : 1, - "type" : "string" + "file" : { + "description" : "The path to the file.", + "type" : "string", + "typetext" : "" }, - "volume" : { - "alias" : "file" + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "werror" : { - "description" : "Write error action.", - "enum" : [ - "enospc", - "ignore", - "report", - "stop" - ], - "optional" : 1, - "type" : "string" + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "optional" : 1, + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/agent/file-write", + "text" : "file-write" + } + ], + "info" : { + "GET" : { + "description" : "Qemu Agent command index.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 1, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "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=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "" }, - "keyboard" : { - "default" : null, - "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.", + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "user" : "all" + }, + "proxyto" : "node", + "returns" : { + "description" : "Returns the list of Qemu Agent commands", + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "description" : "Execute Qemu Guest Agent commands.", + "method" : "POST", + "name" : "agent", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "command" : { + "description" : "The QGA command.", "enum" : [ - "de", - "de-ch", - "da", - "en-gb", - "en-us", - "es", - "fi", - "fr", - "fr-be", - "fr-ca", - "fr-ch", - "hu", - "is", - "it", - "ja", - "lt", - "mk", - "nl", - "no", - "pl", - "pt", - "pt-br", - "sv", - "sl", - "tr" + "fsfreeze-freeze", + "fsfreeze-status", + "fsfreeze-thaw", + "fstrim", + "get-fsinfo", + "get-host-name", + "get-memory-block-info", + "get-memory-blocks", + "get-osinfo", + "get-time", + "get-timezone", + "get-users", + "get-vcpus", + "info", + "network-get-interfaces", + "ping", + "shutdown", + "suspend-disk", + "suspend-hybrid", + "suspend-ram" ], - "optional" : 1, "type" : "string" }, - "kvm" : { - "default" : 1, - "description" : "Enable/disable KVM hardware virtualization.", - "optional" : 1, - "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, - "type" : "boolean", - "typetext" : "" + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "lock" : { - "description" : "Lock/unlock the VM.", + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Returns an object with a single `result` property.", + "type" : "object" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/qemu/{vmid}/agent", + "text" : "agent" + }, + { + "info" : { + "GET" : { + "description" : "Read VM RRD statistics (returns PNG)", + "method" : "GET", + "name" : "rrd", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "cf" : { + "description" : "The RRD consolidation function", "enum" : [ - "migrate", - "backup", - "snapshot", - "rollback" + "AVERAGE", + "MAX" ], "optional" : 1, "type" : "string" }, - "machine" : { - "description" : "Specific the Qemu machine type.", - "maxLength" : 40, - "optional" : 1, - "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?)", - "type" : "string" + "ds" : { + "description" : "The list of datasources you want to display.", + "format" : "pve-configid-list", + "type" : "string", + "typetext" : "" }, - "memory" : { - "default" : 512, - "description" : "Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.", - "minimum" : 16, - "optional" : 1, - "type" : "integer", - "typetext" : " (16 - N)" + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "migrate_downtime" : { - "default" : 0.1, - "description" : "Set maximum tolerated downtime (in seconds) for migrations.", - "minimum" : 0, - "optional" : 1, - "type" : "number", - "typetext" : " (0 - N)" + "timeframe" : { + "description" : "Specify the time frame you are interested in.", + "enum" : [ + "hour", + "day", + "week", + "month", + "year" + ], + "type" : "string" }, - "migrate_speed" : { - "default" : 0, - "description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit.", - "minimum" : 0, - "optional" : 1, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, "type" : "integer", - "typetext" : " (0 - N)" - }, - "name" : { - "description" : "Set a name for the VM. Only used on the configuration web interface.", - "format" : "dns-name", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "protected" : 1, + "returns" : { + "properties" : { + "filename" : { + "type" : "string" + } + }, + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/rrd", + "text" : "rrd" + }, + { + "info" : { + "GET" : { + "description" : "Read VM RRD statistics", + "method" : "GET", + "name" : "rrddata", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "cf" : { + "description" : "The RRD consolidation function", + "enum" : [ + "AVERAGE", + "MAX" + ], "optional" : 1, + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", "typetext" : "" }, - "net[n]" : { - "description" : "Specify network devices.", - "format" : { - "bridge" : { - "description" : "Bridge to attach the network device to. The Proxmox VE standard bridge\nis called 'vmbr0'.\n\nIf you do not specify a bridge, we create a kvm user (NATed) network\ndevice, which provides DHCP and DNS services. The following addresses\nare used:\n\n 10.0.2.2 Gateway\n 10.0.2.3 DNS Server\n 10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n", - "format_description" : "bridge", - "optional" : 1, - "type" : "string" - }, - "e1000" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "e1000-82540em" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "e1000-82544gc" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "e1000-82545em" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "firewall" : { - "description" : "Whether this interface should be protected by the firewall.", - "optional" : 1, - "type" : "boolean" - }, - "i82551" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "i82557b" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "i82559er" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "link_down" : { - "description" : "Whether this interface should be disconnected (like pulling the plug).", - "optional" : 1, - "type" : "boolean" - }, - "macaddr" : { - "description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.", - "format_description" : "XX:XX:XX:XX:XX:XX", - "optional" : 1, - "pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})", - "type" : "string" - }, - "model" : { - "default_key" : 1, - "description" : "Network Card Model. The 'virtio' model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use 'e1000'.", - "enum" : [ - "rtl8139", - "ne2k_pci", - "e1000", - "pcnet", - "virtio", - "ne2k_isa", - "i82551", - "i82557b", - "i82559er", - "vmxnet3", - "e1000-82540em", - "e1000-82544gc", - "e1000-82545em" - ], - "type" : "string" - }, - "ne2k_isa" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "ne2k_pci" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "pcnet" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "queues" : { - "description" : "Number of packet queues to be used on the device.", - "maximum" : 16, - "minimum" : 0, - "optional" : 1, - "type" : "integer" - }, - "rate" : { - "description" : "Rate limit in mbps (megabytes per second) as floating point number.", - "minimum" : 0, - "optional" : 1, - "type" : "number" - }, - "rtl8139" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "tag" : { - "description" : "VLAN tag to apply to packets on this interface.", - "maximum" : 4094, - "minimum" : 1, - "optional" : 1, - "type" : "integer" - }, - "trunks" : { - "description" : "VLAN trunks to pass through this interface.", - "format_description" : "vlanid[;vlanid...]", - "optional" : 1, - "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", - "type" : "string" - }, - "virtio" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "vmxnet3" : { - "alias" : "macaddr", - "keyAlias" : "model" - } - }, + "timeframe" : { + "description" : "Specify the time frame you are interested in.", + "enum" : [ + "hour", + "day", + "week", + "month", + "year" + ], + "type" : "string" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "protected" : 1, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/rrddata", + "text" : "rrddata" + }, + { + "info" : { + "GET" : { + "description" : "Get current virtual machine configuration. This does not include pending configuration changes (see 'pending' API).", + "method" : "GET", + "name" : "vm_config", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "current" : { + "default" : 0, + "description" : "Get current values (instead of pending values).", "optional" : 1, - "type" : "string", - "typetext" : "[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]" + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", @@ -6528,106 +8416,331 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "numa" : { - "default" : 0, - "description" : "Enable/disable NUMA.", + "snapshot" : { + "description" : "Fetch config values from given snapshot.", + "format" : "pve-configid", + "maxLength" : 40, "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "string", + "typetext" : "" }, - "numa[n]" : { - "description" : "NUMA topology.", + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "proxyto" : "node", + "returns" : { + "description" : "The current VM configuration.", + "properties" : { + "acpi" : { + "default" : 1, + "description" : "Enable/disable ACPI.", + "optional" : 1, + "type" : "boolean" + }, + "agent" : { + "description" : "Enable/disable Qemu GuestAgent and its properties.", "format" : { - "cpus" : { - "description" : "CPUs accessing this NUMA node.", - "format_description" : "id[-id];...", - "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", - "type" : "string" - }, - "hostnodes" : { - "description" : "Host NUMA nodes to use.", - "format_description" : "id[-id];...", - "optional" : 1, - "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", - "type" : "string" - }, - "memory" : { - "description" : "Amount of memory this NUMA node provides.", - "optional" : 1, - "type" : "number" + "enabled" : { + "default" : 0, + "default_key" : 1, + "description" : "Enable/disable Qemu GuestAgent.", + "type" : "boolean" }, - "policy" : { - "description" : "NUMA allocation policy.", - "enum" : [ - "preferred", - "bind", - "interleave" - ], + "fstrim_cloned_disks" : { + "default" : 0, + "description" : "Run fstrim after cloning/moving a disk.", "optional" : 1, - "type" : "string" + "type" : "boolean" } }, "optional" : 1, + "type" : "string" + }, + "arch" : { + "description" : "Virtual processor architecture. Defaults to the host.", + "enum" : [ + "x86_64", + "aarch64" + ], + "optional" : 1, + "type" : "string" + }, + "args" : { + "description" : "Arbitrary arguments passed to kvm.", + "optional" : 1, "type" : "string", - "typetext" : "cpus= [,hostnodes=] [,memory=] [,policy=]" + "verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n" }, - "onboot" : { + "autostart" : { "default" : 0, - "description" : "Specifies whether a VM will be started during system bootup.", + "description" : "Automatic restart after crash (currently ignored).", "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "boolean" }, - "ostype" : { - "description" : "Specify guest operating system.", + "balloon" : { + "description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.", + "minimum" : 0, + "optional" : 1, + "type" : "integer" + }, + "bios" : { + "default" : "seabios", + "description" : "Select BIOS implementation.", "enum" : [ - "other", - "wxp", - "w2k", - "w2k3", - "w2k8", - "wvista", - "win7", - "win8", - "win10", - "l24", - "l26", - "solaris" + "seabios", + "ovmf" ], "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/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" + "type" : "string" }, - "parallel[n]" : { - "description" : "Map host parallel devices (n is 0 to 2).", + "boot" : { + "default" : "cdn", + "description" : "Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).", + "optional" : 1, + "pattern" : "[acdn]{1,4}", + "type" : "string" + }, + "bootdisk" : { + "description" : "Enable booting from specified disk.", + "format" : "pve-qm-bootdisk", + "optional" : 1, + "pattern" : "(ide|sata|scsi|virtio)\\d+", + "type" : "string" + }, + "cdrom" : { + "description" : "This is an alias for option -ide2", + "format" : "pve-qm-ide", "optional" : 1, - "pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+", "type" : "string", - "verbose_description" : "Map host parallel devices (n is 0 to 2).\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" + "typetext" : "" }, - "protection" : { - "default" : 0, - "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.", + "cicustom" : { + "description" : "cloud-init: Specify custom files to replace the automatically generated ones at start.", + "format" : "pve-qm-cicustom", "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "string" }, - "reboot" : { + "cipassword" : { + "description" : "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.", + "optional" : 1, + "type" : "string" + }, + "citype" : { + "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" + ], + "optional" : 1, + "type" : "string" + }, + "ciuser" : { + "description" : "cloud-init: User name to change ssh keys and password for instead of the image's configured default user.", + "optional" : 1, + "type" : "string" + }, + "cores" : { "default" : 1, - "description" : "Allow reboot. If set to '0' the VM exit on reboot.", + "description" : "The number of cores per socket.", + "minimum" : 1, "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "integer" }, - "revert" : { - "description" : "Revert a pending change.", - "format" : "pve-configid-list", + "cpu" : { + "description" : "Emulated CPU type.", + "format" : { + "cputype" : { + "default" : "kvm64", + "default_key" : 1, + "description" : "Emulated CPU type.", + "enum" : [ + "486", + "athlon", + "Broadwell", + "Broadwell-IBRS", + "Broadwell-noTSX", + "Broadwell-noTSX-IBRS", + "Conroe", + "core2duo", + "coreduo", + "EPYC", + "EPYC-IBPB", + "Haswell", + "Haswell-IBRS", + "Haswell-noTSX", + "Haswell-noTSX-IBRS", + "host", + "IvyBridge", + "IvyBridge-IBRS", + "kvm32", + "kvm64", + "max", + "Nehalem", + "Nehalem-IBRS", + "Opteron_G1", + "Opteron_G2", + "Opteron_G3", + "Opteron_G4", + "Opteron_G5", + "Penryn", + "pentium", + "pentium2", + "pentium3", + "phenom", + "qemu32", + "qemu64", + "SandyBridge", + "SandyBridge-IBRS", + "Skylake-Client", + "Skylake-Client-IBRS", + "Skylake-Server", + "Skylake-Server-IBRS", + "Westmere", + "Westmere-IBRS" + ], + "type" : "string" + }, + "flags" : { + "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'.", + "format_description" : "+FLAG[;-FLAG...]", + "optional" : 1, + "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear)))*)", + "type" : "string" + }, + "hidden" : { + "default" : 0, + "description" : "Do not identify as a KVM virtual machine.", + "optional" : 1, + "type" : "boolean" + }, + "hv-vendor-id" : { + "description" : "The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.", + "format_description" : "vendor-id", + "optional" : 1, + "pattern" : "(?^:[a-zA-Z0-9]{1,12})", + "type" : "string" + } + }, + "optional" : 1, + "type" : "string" + }, + "cpulimit" : { + "default" : 0, + "description" : "Limit of CPU usage.", + "maximum" : 128, + "minimum" : 0, + "optional" : 1, + "type" : "number", + "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit." + }, + "cpuunits" : { + "default" : 1024, + "description" : "CPU weight for a VM.", + "maximum" : 262144, + "minimum" : 2, + "optional" : 1, + "type" : "integer", + "verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs." + }, + "description" : { + "description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.", + "optional" : 1, + "type" : "string" + }, + "digest" : { + "description" : "SHA1 digest of configuration file. This can be used to prevent concurrent modifications.", + "type" : "string" + }, + "efidisk0" : { + "description" : "Configure a Disk for storing EFI vars", + "format" : { + "file" : { + "default_key" : 1, + "description" : "The drive's backing volume.", + "format" : "pve-volume-id-or-qm-path", + "format_description" : "volume", + "type" : "string" + }, + "format" : { + "description" : "The drive's backing file's data format.", + "enum" : [ + "raw", + "cow", + "qcow", + "qed", + "qcow2", + "vmdk", + "cloop" + ], + "optional" : 1, + "type" : "string" + }, + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", + "optional" : 1, + "type" : "string" + }, + "volume" : { + "alias" : "file" + } + }, + "optional" : 1, + "type" : "string" + }, + "freeze" : { + "description" : "Freeze CPU at startup (use 'c' monitor command to start execution).", + "optional" : 1, + "type" : "boolean" + }, + "hookscript" : { + "description" : "Script that will be executed during various steps in the vms lifetime.", + "format" : "pve-volume-id", + "optional" : 1, + "type" : "string" + }, + "hostpci[n]" : { + "description" : "Map host PCI devices into guest.", + "format" : "pve-qm-hostpci", "optional" : 1, "type" : "string", - "typetext" : "" + "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer\npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" }, - "sata[n]" : { - "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).", + "hotplug" : { + "default" : "network,disk,usb", + "description" : "Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.", + "format" : "pve-hotplug-features", + "optional" : 1, + "type" : "string" + }, + "hugepages" : { + "description" : "Enable/disable hugepages memory.", + "enum" : [ + "any", + "2", + "1024" + ], + "optional" : 1, + "type" : "string" + }, + "ide[n]" : { + "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3).", "format" : { "aio" : { "description" : "AIO type to use.", @@ -6854,6 +8967,14 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "model" : { + "description" : "The drive's reported model name, url-encoded, up to 40 bytes long.", + "format" : "urlencoded", + "format_description" : "model", + "maxLength" : 120, + "optional" : 1, + "type" : "string" + }, "replicate" : { "default" : 1, "description" : "Whether the drive should considered for replication jobs.", @@ -6883,6 +9004,13 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "shared" : { + "default" : 0, + "description" : "Mark this locally-managed volume as available on all nodes", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!" + }, "size" : { "description" : "Disk size. This is purely informational and has no effect.", "format" : "disk-size", @@ -6891,7 +9019,12 @@ var pveapi = [ "type" : "string" }, "snapshot" : { - "description" : "Whether the drive should be included when making snapshots.", + "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.", + "optional" : 1, + "type" : "boolean" + }, + "ssd" : { + "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.", "optional" : 1, "type" : "boolean" }, @@ -6918,127 +9051,474 @@ var pveapi = [ ], "optional" : 1, "type" : "string" + }, + "wwn" : { + "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.", + "format_description" : "wwn", + "optional" : 1, + "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})", + "type" : "string" } }, "optional" : 1, - "type" : "string", - "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=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "type" : "string" }, - "scsi[n]" : { - "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).", + "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 gateway 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 dhcp on IPv4.\n", + "format" : "pve-qm-ipconfig", + "optional" : 1, + "type" : "string" + }, + "ivshmem" : { + "description" : "Inter-VM shared memory. Useful for direct communication between VMs, or to the host.", "format" : { - "aio" : { - "description" : "AIO type to use.", - "enum" : [ - "native", - "threads" - ], + "name" : { + "description" : "The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.", + "format_description" : "string", "optional" : 1, + "pattern" : "[a-zA-Z0-9\\-]+", "type" : "string" }, - "backup" : { - "description" : "Whether the drive should be included when making backups.", - "optional" : 1, - "type" : "boolean" - }, - "bps" : { - "description" : "Maximum r/w speed in bytes per second.", - "format_description" : "bps", - "optional" : 1, - "type" : "integer" - }, - "bps_max_length" : { - "description" : "Maximum length of I/O bursts in seconds.", - "format_description" : "seconds", + "size" : { + "description" : "The size of the file in MB.", "minimum" : 1, - "optional" : 1, "type" : "integer" - }, - "bps_rd" : { - "description" : "Maximum read speed in bytes per second.", - "format_description" : "bps", + } + }, + "optional" : 1, + "type" : "string" + }, + "keyboard" : { + "default" : null, + "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.", + "enum" : [ + "de", + "de-ch", + "da", + "en-gb", + "en-us", + "es", + "fi", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "hu", + "is", + "it", + "ja", + "lt", + "mk", + "nl", + "no", + "pl", + "pt", + "pt-br", + "sv", + "sl", + "tr" + ], + "optional" : 1, + "type" : "string" + }, + "kvm" : { + "default" : 1, + "description" : "Enable/disable KVM hardware virtualization.", + "optional" : 1, + "type" : "boolean" + }, + "localtime" : { + "description" : "Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.", + "optional" : 1, + "type" : "boolean" + }, + "lock" : { + "description" : "Lock/unlock the VM.", + "enum" : [ + "backup", + "clone", + "create", + "migrate", + "rollback", + "snapshot", + "snapshot-delete", + "suspending", + "suspended" + ], + "optional" : 1, + "type" : "string" + }, + "machine" : { + "description" : "Specifies the Qemu machine type.", + "maxLength" : 40, + "optional" : 1, + "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)", + "type" : "string" + }, + "memory" : { + "default" : 512, + "description" : "Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.", + "minimum" : 16, + "optional" : 1, + "type" : "integer" + }, + "migrate_downtime" : { + "default" : 0.1, + "description" : "Set maximum tolerated downtime (in seconds) for migrations.", + "minimum" : 0, + "optional" : 1, + "type" : "number" + }, + "migrate_speed" : { + "default" : 0, + "description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit.", + "minimum" : 0, + "optional" : 1, + "type" : "integer" + }, + "name" : { + "description" : "Set a name for the VM. Only used on the configuration web interface.", + "format" : "dns-name", + "optional" : 1, + "type" : "string" + }, + "nameserver" : { + "description" : "cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.", + "format" : "address-list", + "optional" : 1, + "type" : "string" + }, + "net[n]" : { + "description" : "Specify network devices.", + "format" : { + "bridge" : { + "description" : "Bridge to attach the network device to. The Proxmox VE standard bridge\nis called 'vmbr0'.\n\nIf you do not specify a bridge, we create a kvm user (NATed) network\ndevice, which provides DHCP and DNS services. The following addresses\nare used:\n\n 10.0.2.2 Gateway\n 10.0.2.3 DNS Server\n 10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n", + "format_description" : "bridge", "optional" : 1, - "type" : "integer" + "type" : "string" }, - "bps_rd_length" : { - "alias" : "bps_rd_max_length" + "e1000" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "bps_rd_max_length" : { - "description" : "Maximum length of read I/O bursts in seconds.", - "format_description" : "seconds", - "minimum" : 1, - "optional" : 1, - "type" : "integer" + "e1000-82540em" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "bps_wr" : { - "description" : "Maximum write speed in bytes per second.", - "format_description" : "bps", - "optional" : 1, - "type" : "integer" + "e1000-82544gc" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "bps_wr_length" : { - "alias" : "bps_wr_max_length" + "e1000-82545em" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "bps_wr_max_length" : { - "description" : "Maximum length of write I/O bursts in seconds.", - "format_description" : "seconds", - "minimum" : 1, + "firewall" : { + "description" : "Whether this interface should be protected by the firewall.", "optional" : 1, - "type" : "integer" + "type" : "boolean" }, - "cache" : { - "description" : "The drive's cache mode", - "enum" : [ - "none", - "writethrough", - "writeback", - "unsafe", - "directsync" - ], - "optional" : 1, - "type" : "string" + "i82551" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "cyls" : { - "description" : "Force the drive's physical geometry to have a specific cylinder count.", - "optional" : 1, - "type" : "integer" + "i82557b" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "detect_zeroes" : { - "description" : "Controls whether to detect and try to optimize writes of zeroes.", + "i82559er" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "link_down" : { + "description" : "Whether this interface should be disconnected (like pulling the plug).", "optional" : 1, "type" : "boolean" }, - "discard" : { - "description" : "Controls whether to pass discard/trim requests to the underlying storage.", - "enum" : [ - "ignore", - "on" - ], + "macaddr" : { + "description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.", + "format" : "mac-addr", + "format_description" : "XX:XX:XX:XX:XX:XX", "optional" : 1, - "type" : "string" + "type" : "string", + "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set." }, - "file" : { + "model" : { "default_key" : 1, - "description" : "The drive's backing volume.", - "format" : "pve-volume-id-or-qm-path", - "format_description" : "volume", - "type" : "string" - }, - "format" : { - "description" : "The drive's backing file's data format.", + "description" : "Network Card Model. The 'virtio' model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use 'e1000'.", "enum" : [ - "raw", - "cow", - "qcow", - "qed", - "qcow2", - "vmdk", - "cloop" + "rtl8139", + "ne2k_pci", + "e1000", + "pcnet", + "virtio", + "ne2k_isa", + "i82551", + "i82557b", + "i82559er", + "vmxnet3", + "e1000-82540em", + "e1000-82544gc", + "e1000-82545em" ], - "optional" : 1, "type" : "string" }, - "heads" : { + "ne2k_isa" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "ne2k_pci" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "pcnet" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "queues" : { + "description" : "Number of packet queues to be used on the device.", + "maximum" : 16, + "minimum" : 0, + "optional" : 1, + "type" : "integer" + }, + "rate" : { + "description" : "Rate limit in mbps (megabytes per second) as floating point number.", + "minimum" : 0, + "optional" : 1, + "type" : "number" + }, + "rtl8139" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "tag" : { + "description" : "VLAN tag to apply to packets on this interface.", + "maximum" : 4094, + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "trunks" : { + "description" : "VLAN trunks to pass through this interface.", + "format_description" : "vlanid[;vlanid...]", + "optional" : 1, + "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", + "type" : "string" + }, + "virtio" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "vmxnet3" : { + "alias" : "macaddr", + "keyAlias" : "model" + } + }, + "optional" : 1, + "type" : "string" + }, + "numa" : { + "default" : 0, + "description" : "Enable/disable NUMA.", + "optional" : 1, + "type" : "boolean" + }, + "numa[n]" : { + "description" : "NUMA topology.", + "format" : { + "cpus" : { + "description" : "CPUs accessing this NUMA node.", + "format_description" : "id[-id];...", + "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", + "type" : "string" + }, + "hostnodes" : { + "description" : "Host NUMA nodes to use.", + "format_description" : "id[-id];...", + "optional" : 1, + "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", + "type" : "string" + }, + "memory" : { + "description" : "Amount of memory this NUMA node provides.", + "optional" : 1, + "type" : "number" + }, + "policy" : { + "description" : "NUMA allocation policy.", + "enum" : [ + "preferred", + "bind", + "interleave" + ], + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string" + }, + "onboot" : { + "default" : 0, + "description" : "Specifies whether a VM will be started during system bootup.", + "optional" : 1, + "type" : "boolean" + }, + "ostype" : { + "description" : "Specify guest operating system.", + "enum" : [ + "other", + "wxp", + "w2k", + "w2k3", + "w2k8", + "wvista", + "win7", + "win8", + "win10", + "l24", + "l26", + "solaris" + ], + "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/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" + }, + "parallel[n]" : { + "description" : "Map host parallel devices (n is 0 to 2).", + "optional" : 1, + "pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+", + "type" : "string", + "verbose_description" : "Map host parallel devices (n is 0 to 2).\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" + }, + "protection" : { + "default" : 0, + "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.", + "optional" : 1, + "type" : "boolean" + }, + "reboot" : { + "default" : 1, + "description" : "Allow reboot. If set to '0' the VM exit on reboot.", + "optional" : 1, + "type" : "boolean" + }, + "sata[n]" : { + "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).", + "format" : { + "aio" : { + "description" : "AIO type to use.", + "enum" : [ + "native", + "threads" + ], + "optional" : 1, + "type" : "string" + }, + "backup" : { + "description" : "Whether the drive should be included when making backups.", + "optional" : 1, + "type" : "boolean" + }, + "bps" : { + "description" : "Maximum r/w speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "bps_rd" : { + "description" : "Maximum read speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_rd_length" : { + "alias" : "bps_rd_max_length" + }, + "bps_rd_max_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_wr_length" : { + "alias" : "bps_wr_max_length" + }, + "bps_wr_max_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "cache" : { + "description" : "The drive's cache mode", + "enum" : [ + "none", + "writethrough", + "writeback", + "unsafe", + "directsync" + ], + "optional" : 1, + "type" : "string" + }, + "cyls" : { + "description" : "Force the drive's physical geometry to have a specific cylinder count.", + "optional" : 1, + "type" : "integer" + }, + "detect_zeroes" : { + "description" : "Controls whether to detect and try to optimize writes of zeroes.", + "optional" : 1, + "type" : "boolean" + }, + "discard" : { + "description" : "Controls whether to pass discard/trim requests to the underlying storage.", + "enum" : [ + "ignore", + "on" + ], + "optional" : 1, + "type" : "string" + }, + "file" : { + "default_key" : 1, + "description" : "The drive's backing volume.", + "format" : "pve-volume-id-or-qm-path", + "format_description" : "volume", + "type" : "string" + }, + "format" : { + "description" : "The drive's backing file's data format.", + "enum" : [ + "raw", + "cow", + "qcow", + "qed", + "qcow2", + "vmdk", + "cloop" + ], + "optional" : 1, + "type" : "string" + }, + "heads" : { "description" : "Force the drive's physical geometry to have a specific head count.", "optional" : 1, "type" : "integer" @@ -7106,11 +9586,6 @@ var pveapi = [ "optional" : 1, "type" : "integer" }, - "iothread" : { - "description" : "Whether to use iothreads for this drive", - "optional" : 1, - "type" : "boolean" - }, "mbps" : { "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", @@ -7157,12 +9632,6 @@ var pveapi = [ "optional" : 1, "type" : "string" }, - "queues" : { - "description" : "Number of queues.", - "minimum" : 2, - "optional" : 1, - "type" : "integer" - }, "replicate" : { "default" : 1, "description" : "Whether the drive should considered for replication jobs.", @@ -7179,12 +9648,6 @@ var pveapi = [ "optional" : 1, "type" : "string" }, - "scsiblock" : { - "default" : 0, - "description" : "whether to use scsi-block for full passthrough of host block device\n\nWARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host", - "optional" : 1, - "type" : "boolean" - }, "secs" : { "description" : "Force the drive's physical geometry to have a specific sector count.", "optional" : 1, @@ -7198,6 +9661,13 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "shared" : { + "default" : 0, + "description" : "Mark this locally-managed volume as available on all nodes", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!" + }, "size" : { "description" : "Disk size. This is purely informational and has no effect.", "format" : "disk-size", @@ -7206,7 +9676,12 @@ var pveapi = [ "type" : "string" }, "snapshot" : { - "description" : "Whether the drive should be included when making snapshots.", + "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.", + "optional" : 1, + "type" : "boolean" + }, + "ssd" : { + "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.", "optional" : 1, "type" : "boolean" }, @@ -7233,166 +9708,20 @@ var pveapi = [ ], "optional" : 1, "type" : "string" - } - }, - "optional" : 1, - "type" : "string", - "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=] [,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=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" - }, - "scsihw" : { - "default" : "lsi", - "description" : "SCSI controller model", - "enum" : [ - "lsi", - "lsi53c810", - "virtio-scsi-pci", - "virtio-scsi-single", - "megasas", - "pvscsi" - ], - "optional" : 1, - "type" : "string" - }, - "serial[n]" : { - "description" : "Create a serial device inside the VM (n is 0 to 3)", - "optional" : 1, - "pattern" : "(/dev/.+|socket)", - "type" : "string", - "verbose_description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a\nhost serial device (i.e. /dev/ttyS0), or create a unix socket on the\nhost side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" - }, - "shares" : { - "default" : 1000, - "description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning", - "maximum" : 50000, - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - 50000)" - }, - "skiplock" : { - "description" : "Ignore locks - only root is allowed to use this option.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "smbios1" : { - "description" : "Specify SMBIOS type 1 fields.", - "format" : "pve-qm-smbios1", - "maxLength" : 256, - "optional" : 1, - "type" : "string", - "typetext" : "[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]" - }, - "smp" : { - "default" : 1, - "description" : "The number of CPUs. Please use option -sockets instead.", - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - }, - "sockets" : { - "default" : 1, - "description" : "The number of CPU sockets.", - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - }, - "startdate" : { - "default" : "now", - "description" : "Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.", - "optional" : 1, - "pattern" : "(now|\\d{4}-\\d{1,2}-\\d{1,2}(T\\d{1,2}:\\d{1,2}:\\d{1,2})?)", - "type" : "string", - "typetext" : "(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)" - }, - "startup" : { - "description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.", - "format" : "pve-startup-order", - "optional" : 1, - "type" : "string", - "typetext" : "[[order=]\\d+] [,up=\\d+] [,down=\\d+] " - }, - "tablet" : { - "default" : 1, - "description" : "Enable/disable the USB tablet device.", - "optional" : 1, - "type" : "boolean", - "typetext" : "", - "verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl)." - }, - "tdf" : { - "default" : 0, - "description" : "Enable/disable time drift fix.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "template" : { - "default" : 0, - "description" : "Enable/disable Template.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "unused[n]" : { - "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.", - "format" : "pve-volume-id", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "usb[n]" : { - "description" : "Configure an USB device (n is 0 to 4).", - "format" : { - "host" : { - "default_key" : 1, - "description" : "The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:\n\n 'bus-port(.port)*' (decimal numbers) or\n 'vendor_id:product_id' (hexadeciaml numbers) or\n 'spice'\n\nYou can use the 'lsusb -t' command to list existing usb devices.\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nThe value 'spice' can be used to add a usb redirection devices for spice.\n", - "format" : "pve-qm-usb-device", - "format_description" : "HOSTUSBDEVICE|spice", - "type" : "string" }, - "usb3" : { - "default" : 0, - "description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).", + "wwn" : { + "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.", + "format_description" : "wwn", "optional" : 1, - "type" : "boolean" + "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})", + "type" : "string" } }, "optional" : 1, - "type" : "string", - "typetext" : "[host=] [,usb3=<1|0>]" - }, - "vcpus" : { - "default" : 0, - "description" : "Number of hotplugged vcpus.", - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - }, - "vga" : { - "description" : "Select the VGA type.", - "enum" : [ - "std", - "cirrus", - "vmware", - "qxl", - "serial0", - "serial1", - "serial2", - "serial3", - "qxl2", - "qxl3", - "qxl4" - ], - "optional" : 1, - "type" : "string", - "verbose_description" : "Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal." + "type" : "string" }, - "virtio[n]" : { - "description" : "Use volume as VIRTIO hard disk (n is 0 to 15).", + "scsi[n]" : { + "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).", "format" : { "aio" : { "description" : "AIO type to use.", @@ -7624,6 +9953,12 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "queues" : { + "description" : "Number of queues.", + "minimum" : 2, + "optional" : 1, + "type" : "integer" + }, "replicate" : { "default" : 1, "description" : "Whether the drive should considered for replication jobs.", @@ -7640,6 +9975,12 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "scsiblock" : { + "default" : 0, + "description" : "whether to use scsi-block for full passthrough of host block device\n\nWARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host", + "optional" : 1, + "type" : "boolean" + }, "secs" : { "description" : "Force the drive's physical geometry to have a specific sector count.", "optional" : 1, @@ -7653,6 +9994,13 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "shared" : { + "default" : 0, + "description" : "Mark this locally-managed volume as available on all nodes", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!" + }, "size" : { "description" : "Disk size. This is purely informational and has no effect.", "format" : "disk-size", @@ -7661,7 +10009,12 @@ var pveapi = [ "type" : "string" }, "snapshot" : { - "description" : "Whether the drive should be included when making snapshots.", + "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.", + "optional" : 1, + "type" : "boolean" + }, + "ssd" : { + "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.", "optional" : 1, "type" : "boolean" }, @@ -7688,292 +10041,185 @@ var pveapi = [ ], "optional" : 1, "type" : "string" + }, + "wwn" : { + "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.", + "format_description" : "wwn", + "optional" : 1, + "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})", + "type" : "string" } }, "optional" : 1, + "type" : "string" + }, + "scsihw" : { + "default" : "lsi", + "description" : "SCSI controller model", + "enum" : [ + "lsi", + "lsi53c810", + "virtio-scsi-pci", + "virtio-scsi-single", + "megasas", + "pvscsi" + ], + "optional" : 1, + "type" : "string" + }, + "searchdomain" : { + "description" : "cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.", + "optional" : 1, + "type" : "string" + }, + "serial[n]" : { + "description" : "Create a serial device inside the VM (n is 0 to 3)", + "optional" : 1, + "pattern" : "(/dev/.+|socket)", "type" : "string", - "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=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "verbose_description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a\nhost serial device (i.e. /dev/ttyS0), or create a unix socket on the\nhost side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", + "shares" : { + "default" : 1000, + "description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.", + "maximum" : 50000, + "minimum" : 0, + "optional" : 1, + "type" : "integer" + }, + "smbios1" : { + "description" : "Specify SMBIOS type 1 fields.", + "format" : "pve-qm-smbios1", + "maxLength" : 512, + "optional" : 1, + "type" : "string" + }, + "smp" : { + "default" : 1, + "description" : "The number of CPUs. Please use option -sockets instead.", "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" + "optional" : 1, + "type" : "integer" }, - "vmstatestorage" : { - "description" : "Default storage for VM state volumes/files.", - "format" : "pve-storage-id", + "sockets" : { + "default" : 1, + "description" : "The number of CPU sockets.", + "minimum" : 1, "optional" : 1, - "type" : "string", - "typetext" : "" + "type" : "integer" }, - "watchdog" : { - "description" : "Create a virtual hardware watchdog device.", - "format" : "pve-qm-watchdog", + "sshkeys" : { + "description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).", + "format" : "urlencoded", "optional" : 1, - "type" : "string", - "typetext" : "[[model=]] [,action=]", - "verbose_description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Disk", - "VM.Config.CDROM", - "VM.Config.CPU", - "VM.Config.Memory", - "VM.Config.Network", - "VM.Config.HWType", - "VM.Config.Options" - ], - "any", - 1 - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "optional" : 1, - "type" : "string" - } - }, - "PUT" : { - "description" : "Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation.", - "method" : "PUT", - "name" : "update_vm", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "acpi" : { - "default" : 1, - "description" : "Enable/disable ACPI.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "string" }, - "agent" : { - "default" : 0, - "description" : "Enable/disable Qemu GuestAgent.", + "startdate" : { + "default" : "now", + "description" : "Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.", "optional" : 1, - "type" : "boolean", - "typetext" : "" + "pattern" : "(now|\\d{4}-\\d{1,2}-\\d{1,2}(T\\d{1,2}:\\d{1,2}:\\d{1,2})?)", + "type" : "string", + "typetext" : "(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)" }, - "args" : { - "description" : "Arbitrary arguments passed to kvm.", + "startup" : { + "description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.", + "format" : "pve-startup-order", "optional" : 1, "type" : "string", - "typetext" : "", - "verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n" + "typetext" : "[[order=]\\d+] [,up=\\d+] [,down=\\d+] " }, - "autostart" : { - "default" : 0, - "description" : "Automatic restart after crash (currently ignored).", + "tablet" : { + "default" : 1, + "description" : "Enable/disable the USB tablet device.", "optional" : 1, "type" : "boolean", - "typetext" : "" - }, - "balloon" : { - "description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.", - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" + "verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl)." }, - "bios" : { - "default" : "seabios", - "description" : "Select BIOS implementation.", - "enum" : [ - "seabios", - "ovmf" - ], + "tdf" : { + "default" : 0, + "description" : "Enable/disable time drift fix.", "optional" : 1, - "type" : "string" + "type" : "boolean" }, - "boot" : { - "default" : "cdn", - "description" : "Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).", + "template" : { + "default" : 0, + "description" : "Enable/disable Template.", "optional" : 1, - "pattern" : "[acdn]{1,4}", - "type" : "string" + "type" : "boolean" }, - "bootdisk" : { - "description" : "Enable booting from specified disk.", - "format" : "pve-qm-bootdisk", + "unused[n]" : { + "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.", + "format" : "pve-volume-id", "optional" : 1, - "pattern" : "(ide|sata|scsi|virtio)\\d+", "type" : "string" }, - "cdrom" : { - "description" : "This is an alias for option -ide2", - "format" : "pve-qm-ide", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "cores" : { - "default" : 1, - "description" : "The number of cores per socket.", - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - }, - "cpu" : { - "description" : "Emulated CPU type.", + "usb[n]" : { + "description" : "Configure an USB device (n is 0 to 4).", "format" : { - "cputype" : { - "default" : "kvm64", + "host" : { "default_key" : 1, - "description" : "Emulated CPU type.", - "enum" : [ - "486", - "athlon", - "Broadwell", - "Broadwell-IBRS", - "Broadwell-noTSX", - "Broadwell-noTSX-IBRS", - "Conroe", - "core2duo", - "coreduo", - "Haswell", - "Haswell-IBRS", - "Haswell-noTSX", - "Haswell-noTSX-IBRS", - "host", - "IvyBridge", - "IvyBridge-IBRS", - "kvm32", - "kvm64", - "max", - "Nehalem", - "Nehalem-IBRS", - "Opteron_G1", - "Opteron_G2", - "Opteron_G3", - "Opteron_G4", - "Opteron_G5", - "Penryn", - "pentium", - "pentium2", - "pentium3", - "phenom", - "qemu32", - "qemu64", - "SandyBridge", - "SandyBridge-IBRS", - "Skylake-Client", - "Skylake-Client-IBRS", - "Skylake-Server", - "Skylake-Server-IBRS", - "Westmere", - "Westmere-IBRS" - ], - "type" : "string" - }, - "flags" : { - "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl'.", - "format_description" : "+FLAG[;-FLAG...]", - "optional" : 1, - "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl))(;(?^:[+-](pcid|spec-ctrl)))*)", + "description" : "The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:\n\n 'bus-port(.port)*' (decimal numbers) or\n 'vendor_id:product_id' (hexadeciaml numbers) or\n 'spice'\n\nYou can use the 'lsusb -t' command to list existing usb devices.\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nThe value 'spice' can be used to add a usb redirection devices for spice.\n", + "format" : "pve-qm-usb-device", + "format_description" : "HOSTUSBDEVICE|spice", "type" : "string" }, - "hidden" : { + "usb3" : { "default" : 0, - "description" : "Do not identify as a KVM virtual machine.", + "description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).", "optional" : 1, "type" : "boolean" } }, "optional" : 1, - "type" : "string", - "typetext" : "[cputype=] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]" + "type" : "string" }, - "cpulimit" : { + "vcpus" : { "default" : 0, - "description" : "Limit of CPU usage.", - "maximum" : 128, - "minimum" : 0, - "optional" : 1, - "type" : "number", - "typetext" : " (0 - 128)", - "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit." - }, - "cpuunits" : { - "default" : 1024, - "description" : "CPU weight for a VM.", - "maximum" : 262144, - "minimum" : 2, - "optional" : 1, - "type" : "integer", - "typetext" : " (2 - 262144)", - "verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs." - }, - "delete" : { - "description" : "A list of settings you want to delete.", - "format" : "pve-configid-list", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "description" : { - "description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.", - "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" : "" - }, - "force" : { - "description" : "Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.", - "optional" : 1, - "requires" : "delete", - "type" : "boolean", - "typetext" : "" - }, - "freeze" : { - "description" : "Freeze CPU at startup (use 'c' monitor command to start execution).", + "description" : "Number of hotplugged vcpus.", + "minimum" : 1, "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "integer" }, - "hostpci[n]" : { - "description" : "Map host PCI devices into guest.", - "format" : "pve-qm-hostpci", + "vga" : { + "description" : "Configure the VGA hardware.", + "format" : { + "memory" : { + "description" : "Sets the VGA memory (in MiB). Has no effect with serial display.", + "maximum" : 512, + "minimum" : 4, + "optional" : 1, + "type" : "integer" + }, + "type" : { + "default" : "std", + "default_key" : 1, + "description" : "Select the VGA type.", + "enum" : [ + "cirrus", + "qxl", + "qxl2", + "qxl3", + "qxl4", + "none", + "serial0", + "serial1", + "serial2", + "serial3", + "std", + "virtio", + "vmware" + ], + "optional" : 1, + "type" : "string" + } + }, "optional" : 1, "type" : "string", - "typetext" : "[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]", - "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer \npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" + "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." }, - "hotplug" : { - "default" : "network,disk,usb", - "description" : "Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.", - "format" : "pve-hotplug-features", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "hugepages" : { - "description" : "Enable/disable hugepages memory.", - "enum" : [ - "any", - "2", - "1024" - ], - "optional" : 1, - "type" : "string" - }, - "ide[n]" : { - "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3).", + "virtio[n]" : { + "description" : "Use volume as VIRTIO hard disk (n is 0 to 15).", "format" : { "aio" : { "description" : "AIO type to use.", @@ -8154,6 +10400,11 @@ var pveapi = [ "optional" : 1, "type" : "integer" }, + "iothread" : { + "description" : "Whether to use iothreads for this drive", + "optional" : 1, + "type" : "boolean" + }, "mbps" : { "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", @@ -8200,14 +10451,6 @@ var pveapi = [ "optional" : 1, "type" : "string" }, - "model" : { - "description" : "The drive's reported model name, url-encoded, up to 40 bytes long.", - "format" : "urlencoded", - "format_description" : "model", - "maxLength" : 120, - "optional" : 1, - "type" : "string" - }, "replicate" : { "default" : 1, "description" : "Whether the drive should considered for replication jobs.", @@ -8237,6 +10480,13 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "shared" : { + "default" : 0, + "description" : "Mark this locally-managed volume as available on all nodes", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!" + }, "size" : { "description" : "Disk size. This is purely informational and has no effect.", "format" : "disk-size", @@ -8245,7 +10495,7 @@ var pveapi = [ "type" : "string" }, "snapshot" : { - "description" : "Whether the drive should be included when making snapshots.", + "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.", "optional" : 1, "type" : "boolean" }, @@ -8275,340 +10525,379 @@ var pveapi = [ } }, "optional" : 1, + "type" : "string" + }, + "vmgenid" : { + "default" : "1 (autogenerated)", + "description" : "Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.", + "format_description" : "UUID", + "optional" : 1, + "pattern" : "(?:[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}|[01])", "type" : "string", - "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=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "verbose_description" : "The VM generation ID (vmgenid) device exposes a 128-bit integer value identifier to the guest OS. This allows to notify the guest operating system when the virtual machine is executed with a different configuration (e.g. snapshot execution or creation from a template). The guest operating system notices the change, and is then able to react as appropriate by marking its copies of distributed databases as dirty, re-initializing its random number generator, etc.\nNote that auto-creation only works when done throug API/CLI create or update methods, but not when manually editing the config file." }, - "keyboard" : { - "default" : null, - "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.", - "enum" : [ - "de", - "de-ch", - "da", - "en-gb", - "en-us", - "es", - "fi", - "fr", - "fr-be", - "fr-ca", - "fr-ch", - "hu", - "is", - "it", - "ja", - "lt", - "mk", - "nl", - "no", - "pl", - "pt", - "pt-br", - "sv", - "sl", - "tr" - ], + "vmstatestorage" : { + "description" : "Default storage for VM state volumes/files.", + "format" : "pve-storage-id", "optional" : 1, "type" : "string" }, - "kvm" : { + "watchdog" : { + "description" : "Create a virtual hardware watchdog device.", + "format" : "pve-qm-watchdog", + "optional" : 1, + "type" : "string", + "verbose_description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)" + } + }, + "type" : "object" + } + }, + "POST" : { + "description" : "Set virtual machine options (asynchrounous API).", + "method" : "POST", + "name" : "update_vm_async", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "acpi" : { "default" : 1, - "description" : "Enable/disable KVM hardware virtualization.", + "description" : "Enable/disable ACPI.", "optional" : 1, "type" : "boolean", "typetext" : "" }, - "localtime" : { - "description" : "Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.", + "agent" : { + "description" : "Enable/disable Qemu GuestAgent and its properties.", + "format" : { + "enabled" : { + "default" : 0, + "default_key" : 1, + "description" : "Enable/disable Qemu GuestAgent.", + "type" : "boolean" + }, + "fstrim_cloned_disks" : { + "default" : 0, + "description" : "Run fstrim after cloning/moving a disk.", + "optional" : 1, + "type" : "boolean" + } + }, "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "string", + "typetext" : "[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]" }, - "lock" : { - "description" : "Lock/unlock the VM.", + "arch" : { + "description" : "Virtual processor architecture. Defaults to the host.", "enum" : [ - "migrate", - "backup", - "snapshot", - "rollback" + "x86_64", + "aarch64" ], "optional" : 1, "type" : "string" }, - "machine" : { - "description" : "Specific the Qemu machine type.", - "maxLength" : 40, + "args" : { + "description" : "Arbitrary arguments passed to kvm.", "optional" : 1, - "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?)", - "type" : "string" + "type" : "string", + "typetext" : "", + "verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n" }, - "memory" : { - "default" : 512, - "description" : "Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.", - "minimum" : 16, + "autostart" : { + "default" : 0, + "description" : "Automatic restart after crash (currently ignored).", "optional" : 1, - "type" : "integer", - "typetext" : " (16 - N)" + "type" : "boolean", + "typetext" : "" }, - "migrate_downtime" : { - "default" : 0.1, - "description" : "Set maximum tolerated downtime (in seconds) for migrations.", - "minimum" : 0, + "background_delay" : { + "description" : "Time to wait for the task to finish. We return 'null' if the task finish within that time.", + "maximum" : 30, + "minimum" : 1, "optional" : 1, - "type" : "number", - "typetext" : " (0 - N)" + "type" : "integer", + "typetext" : " (1 - 30)" }, - "migrate_speed" : { - "default" : 0, - "description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit.", + "balloon" : { + "description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.", "minimum" : 0, "optional" : 1, "type" : "integer", "typetext" : " (0 - N)" }, - "name" : { - "description" : "Set a name for the VM. Only used on the configuration web interface.", - "format" : "dns-name", + "bios" : { + "default" : "seabios", + "description" : "Select BIOS implementation.", + "enum" : [ + "seabios", + "ovmf" + ], + "optional" : 1, + "type" : "string" + }, + "boot" : { + "default" : "cdn", + "description" : "Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).", + "optional" : 1, + "pattern" : "[acdn]{1,4}", + "type" : "string" + }, + "bootdisk" : { + "description" : "Enable booting from specified disk.", + "format" : "pve-qm-bootdisk", + "optional" : 1, + "pattern" : "(ide|sata|scsi|virtio)\\d+", + "type" : "string" + }, + "cdrom" : { + "description" : "This is an alias for option -ide2", + "format" : "pve-qm-ide", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "cicustom" : { + "description" : "cloud-init: Specify custom files to replace the automatically generated ones at start.", + "format" : "pve-qm-cicustom", + "optional" : 1, + "type" : "string", + "typetext" : "[meta=] [,network=] [,user=]" + }, + "cipassword" : { + "description" : "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.", "optional" : 1, "type" : "string", "typetext" : "" }, - "net[n]" : { - "description" : "Specify network devices.", + "citype" : { + "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" + ], + "optional" : 1, + "type" : "string" + }, + "ciuser" : { + "description" : "cloud-init: User name to change ssh keys and password for instead of the image's configured default user.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "cores" : { + "default" : 1, + "description" : "The number of cores per socket.", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "cpu" : { + "description" : "Emulated CPU type.", "format" : { - "bridge" : { - "description" : "Bridge to attach the network device to. The Proxmox VE standard bridge\nis called 'vmbr0'.\n\nIf you do not specify a bridge, we create a kvm user (NATed) network\ndevice, which provides DHCP and DNS services. The following addresses\nare used:\n\n 10.0.2.2 Gateway\n 10.0.2.3 DNS Server\n 10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n", - "format_description" : "bridge", - "optional" : 1, - "type" : "string" - }, - "e1000" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "e1000-82540em" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "e1000-82544gc" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "e1000-82545em" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "firewall" : { - "description" : "Whether this interface should be protected by the firewall.", - "optional" : 1, - "type" : "boolean" - }, - "i82551" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "i82557b" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "i82559er" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "link_down" : { - "description" : "Whether this interface should be disconnected (like pulling the plug).", - "optional" : 1, - "type" : "boolean" - }, - "macaddr" : { - "description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.", - "format_description" : "XX:XX:XX:XX:XX:XX", - "optional" : 1, - "pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})", - "type" : "string" - }, - "model" : { + "cputype" : { + "default" : "kvm64", "default_key" : 1, - "description" : "Network Card Model. The 'virtio' model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use 'e1000'.", + "description" : "Emulated CPU type.", "enum" : [ - "rtl8139", - "ne2k_pci", - "e1000", - "pcnet", - "virtio", - "ne2k_isa", - "i82551", - "i82557b", - "i82559er", - "vmxnet3", - "e1000-82540em", - "e1000-82544gc", - "e1000-82545em" + "486", + "athlon", + "Broadwell", + "Broadwell-IBRS", + "Broadwell-noTSX", + "Broadwell-noTSX-IBRS", + "Conroe", + "core2duo", + "coreduo", + "EPYC", + "EPYC-IBPB", + "Haswell", + "Haswell-IBRS", + "Haswell-noTSX", + "Haswell-noTSX-IBRS", + "host", + "IvyBridge", + "IvyBridge-IBRS", + "kvm32", + "kvm64", + "max", + "Nehalem", + "Nehalem-IBRS", + "Opteron_G1", + "Opteron_G2", + "Opteron_G3", + "Opteron_G4", + "Opteron_G5", + "Penryn", + "pentium", + "pentium2", + "pentium3", + "phenom", + "qemu32", + "qemu64", + "SandyBridge", + "SandyBridge-IBRS", + "Skylake-Client", + "Skylake-Client-IBRS", + "Skylake-Server", + "Skylake-Server-IBRS", + "Westmere", + "Westmere-IBRS" ], "type" : "string" }, - "ne2k_isa" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "ne2k_pci" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "pcnet" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "queues" : { - "description" : "Number of packet queues to be used on the device.", - "maximum" : 16, - "minimum" : 0, - "optional" : 1, - "type" : "integer" - }, - "rate" : { - "description" : "Rate limit in mbps (megabytes per second) as floating point number.", - "minimum" : 0, + "flags" : { + "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'.", + "format_description" : "+FLAG[;-FLAG...]", "optional" : 1, - "type" : "number" - }, - "rtl8139" : { - "alias" : "macaddr", - "keyAlias" : "model" + "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear)))*)", + "type" : "string" }, - "tag" : { - "description" : "VLAN tag to apply to packets on this interface.", - "maximum" : 4094, - "minimum" : 1, + "hidden" : { + "default" : 0, + "description" : "Do not identify as a KVM virtual machine.", "optional" : 1, - "type" : "integer" + "type" : "boolean" }, - "trunks" : { - "description" : "VLAN trunks to pass through this interface.", - "format_description" : "vlanid[;vlanid...]", + "hv-vendor-id" : { + "description" : "The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.", + "format_description" : "vendor-id", "optional" : 1, - "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", + "pattern" : "(?^:[a-zA-Z0-9]{1,12})", "type" : "string" - }, - "virtio" : { - "alias" : "macaddr", - "keyAlias" : "model" - }, - "vmxnet3" : { - "alias" : "macaddr", - "keyAlias" : "model" } }, "optional" : 1, "type" : "string", - "typetext" : "[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]" + "typetext" : "[cputype=] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=]" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "cpulimit" : { + "default" : 0, + "description" : "Limit of CPU usage.", + "maximum" : 128, + "minimum" : 0, + "optional" : 1, + "type" : "number", + "typetext" : " (0 - 128)", + "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit." + }, + "cpuunits" : { + "default" : 1024, + "description" : "CPU weight for a VM.", + "maximum" : 262144, + "minimum" : 2, + "optional" : 1, + "type" : "integer", + "typetext" : " (2 - 262144)", + "verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs." + }, + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", + "optional" : 1, "type" : "string", "typetext" : "" }, - "numa" : { - "default" : 0, - "description" : "Enable/disable NUMA.", + "description" : { + "description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.", "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "string", + "typetext" : "" }, - "numa[n]" : { - "description" : "NUMA topology.", + "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" : "" + }, + "efidisk0" : { + "description" : "Configure a Disk for storing EFI vars", "format" : { - "cpus" : { - "description" : "CPUs accessing this NUMA node.", - "format_description" : "id[-id];...", - "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", + "file" : { + "default_key" : 1, + "description" : "The drive's backing volume.", + "format" : "pve-volume-id-or-qm-path", + "format_description" : "volume", "type" : "string" }, - "hostnodes" : { - "description" : "Host NUMA nodes to use.", - "format_description" : "id[-id];...", + "format" : { + "description" : "The drive's backing file's data format.", + "enum" : [ + "raw", + "cow", + "qcow", + "qed", + "qcow2", + "vmdk", + "cloop" + ], "optional" : 1, - "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", "type" : "string" }, - "memory" : { - "description" : "Amount of memory this NUMA node provides.", - "optional" : 1, - "type" : "number" - }, - "policy" : { - "description" : "NUMA allocation policy.", - "enum" : [ - "preferred", - "bind", - "interleave" - ], + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", "optional" : 1, "type" : "string" + }, + "volume" : { + "alias" : "file" } }, "optional" : 1, "type" : "string", - "typetext" : "cpus= [,hostnodes=] [,memory=] [,policy=]" - }, - "onboot" : { - "default" : 0, - "description" : "Specifies whether a VM will be started during system bootup.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "ostype" : { - "description" : "Specify guest operating system.", - "enum" : [ - "other", - "wxp", - "w2k", - "w2k3", - "w2k8", - "wvista", - "win7", - "win8", - "win10", - "l24", - "l26", - "solaris" - ], - "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/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" - }, - "parallel[n]" : { - "description" : "Map host parallel devices (n is 0 to 2).", - "optional" : 1, - "pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+", - "type" : "string", - "verbose_description" : "Map host parallel devices (n is 0 to 2).\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" + "typetext" : "[file=] [,format=] [,size=]" }, - "protection" : { - "default" : 0, - "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.", + "force" : { + "description" : "Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.", "optional" : 1, + "requires" : "delete", "type" : "boolean", "typetext" : "" }, - "reboot" : { - "default" : 1, - "description" : "Allow reboot. If set to '0' the VM exit on reboot.", + "freeze" : { + "description" : "Freeze CPU at startup (use 'c' monitor command to start execution).", "optional" : 1, "type" : "boolean", "typetext" : "" }, - "revert" : { - "description" : "Revert a pending change.", - "format" : "pve-configid-list", + "hookscript" : { + "description" : "Script that will be executed during various steps in the vms lifetime.", + "format" : "pve-volume-id", "optional" : 1, "type" : "string", "typetext" : "" }, - "sata[n]" : { - "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).", + "hostpci[n]" : { + "description" : "Map host PCI devices into guest.", + "format" : "pve-qm-hostpci", + "optional" : 1, + "type" : "string", + "typetext" : "[host=] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]", + "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer\npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" + }, + "hotplug" : { + "default" : "network,disk,usb", + "description" : "Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.", + "format" : "pve-hotplug-features", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "hugepages" : { + "description" : "Enable/disable hugepages memory.", + "enum" : [ + "any", + "2", + "1024" + ], + "optional" : 1, + "type" : "string" + }, + "ide[n]" : { + "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3).", "format" : { "aio" : { "description" : "AIO type to use.", @@ -8835,6 +11124,14 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "model" : { + "description" : "The drive's reported model name, url-encoded, up to 40 bytes long.", + "format" : "urlencoded", + "format_description" : "model", + "maxLength" : 120, + "optional" : 1, + "type" : "string" + }, "replicate" : { "default" : 1, "description" : "Whether the drive should considered for replication jobs.", @@ -8864,6 +11161,13 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "shared" : { + "default" : 0, + "description" : "Mark this locally-managed volume as available on all nodes", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!" + }, "size" : { "description" : "Disk size. This is purely informational and has no effect.", "format" : "disk-size", @@ -8872,7 +11176,12 @@ var pveapi = [ "type" : "string" }, "snapshot" : { - "description" : "Whether the drive should be included when making snapshots.", + "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.", + "optional" : 1, + "type" : "boolean" + }, + "ssd" : { + "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.", "optional" : 1, "type" : "boolean" }, @@ -8899,198 +11208,569 @@ var pveapi = [ ], "optional" : 1, "type" : "string" + }, + "wwn" : { + "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.", + "format_description" : "wwn", + "optional" : 1, + "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})", + "type" : "string" } }, "optional" : 1, "type" : "string", - "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=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "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=]" }, - "scsi[n]" : { - "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).", + "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 gateway 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 dhcp on IPv4.\n", + "format" : "pve-qm-ipconfig", + "optional" : 1, + "type" : "string", + "typetext" : "[gw=] [,gw6=] [,ip=] [,ip6=]" + }, + "ivshmem" : { + "description" : "Inter-VM shared memory. Useful for direct communication between VMs, or to the host.", "format" : { - "aio" : { - "description" : "AIO type to use.", - "enum" : [ - "native", - "threads" - ], + "name" : { + "description" : "The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.", + "format_description" : "string", "optional" : 1, + "pattern" : "[a-zA-Z0-9\\-]+", "type" : "string" }, - "backup" : { - "description" : "Whether the drive should be included when making backups.", - "optional" : 1, - "type" : "boolean" - }, - "bps" : { - "description" : "Maximum r/w speed in bytes per second.", - "format_description" : "bps", - "optional" : 1, - "type" : "integer" - }, - "bps_max_length" : { - "description" : "Maximum length of I/O bursts in seconds.", - "format_description" : "seconds", + "size" : { + "description" : "The size of the file in MB.", "minimum" : 1, - "optional" : 1, "type" : "integer" - }, - "bps_rd" : { - "description" : "Maximum read speed in bytes per second.", - "format_description" : "bps", + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "size= [,name=]" + }, + "keyboard" : { + "default" : null, + "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.", + "enum" : [ + "de", + "de-ch", + "da", + "en-gb", + "en-us", + "es", + "fi", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "hu", + "is", + "it", + "ja", + "lt", + "mk", + "nl", + "no", + "pl", + "pt", + "pt-br", + "sv", + "sl", + "tr" + ], + "optional" : 1, + "type" : "string" + }, + "kvm" : { + "default" : 1, + "description" : "Enable/disable KVM hardware virtualization.", + "optional" : 1, + "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, + "type" : "boolean", + "typetext" : "" + }, + "lock" : { + "description" : "Lock/unlock the VM.", + "enum" : [ + "backup", + "clone", + "create", + "migrate", + "rollback", + "snapshot", + "snapshot-delete", + "suspending", + "suspended" + ], + "optional" : 1, + "type" : "string" + }, + "machine" : { + "description" : "Specifies the Qemu machine type.", + "maxLength" : 40, + "optional" : 1, + "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)", + "type" : "string" + }, + "memory" : { + "default" : 512, + "description" : "Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.", + "minimum" : 16, + "optional" : 1, + "type" : "integer", + "typetext" : " (16 - N)" + }, + "migrate_downtime" : { + "default" : 0.1, + "description" : "Set maximum tolerated downtime (in seconds) for migrations.", + "minimum" : 0, + "optional" : 1, + "type" : "number", + "typetext" : " (0 - N)" + }, + "migrate_speed" : { + "default" : 0, + "description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit.", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "name" : { + "description" : "Set a name for the VM. Only used on the configuration web interface.", + "format" : "dns-name", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "nameserver" : { + "description" : "cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.", + "format" : "address-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "net[n]" : { + "description" : "Specify network devices.", + "format" : { + "bridge" : { + "description" : "Bridge to attach the network device to. The Proxmox VE standard bridge\nis called 'vmbr0'.\n\nIf you do not specify a bridge, we create a kvm user (NATed) network\ndevice, which provides DHCP and DNS services. The following addresses\nare used:\n\n 10.0.2.2 Gateway\n 10.0.2.3 DNS Server\n 10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n", + "format_description" : "bridge", "optional" : 1, - "type" : "integer" + "type" : "string" }, - "bps_rd_length" : { - "alias" : "bps_rd_max_length" + "e1000" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "bps_rd_max_length" : { - "description" : "Maximum length of read I/O bursts in seconds.", - "format_description" : "seconds", - "minimum" : 1, - "optional" : 1, - "type" : "integer" + "e1000-82540em" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "bps_wr" : { - "description" : "Maximum write speed in bytes per second.", - "format_description" : "bps", - "optional" : 1, - "type" : "integer" + "e1000-82544gc" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "bps_wr_length" : { - "alias" : "bps_wr_max_length" + "e1000-82545em" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "bps_wr_max_length" : { - "description" : "Maximum length of write I/O bursts in seconds.", - "format_description" : "seconds", - "minimum" : 1, + "firewall" : { + "description" : "Whether this interface should be protected by the firewall.", "optional" : 1, - "type" : "integer" + "type" : "boolean" }, - "cache" : { - "description" : "The drive's cache mode", - "enum" : [ - "none", - "writethrough", - "writeback", - "unsafe", - "directsync" - ], - "optional" : 1, - "type" : "string" + "i82551" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "cyls" : { - "description" : "Force the drive's physical geometry to have a specific cylinder count.", - "optional" : 1, - "type" : "integer" + "i82557b" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "detect_zeroes" : { - "description" : "Controls whether to detect and try to optimize writes of zeroes.", + "i82559er" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "link_down" : { + "description" : "Whether this interface should be disconnected (like pulling the plug).", "optional" : 1, "type" : "boolean" }, - "discard" : { - "description" : "Controls whether to pass discard/trim requests to the underlying storage.", + "macaddr" : { + "description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.", + "format" : "mac-addr", + "format_description" : "XX:XX:XX:XX:XX:XX", + "optional" : 1, + "type" : "string", + "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set." + }, + "model" : { + "default_key" : 1, + "description" : "Network Card Model. The 'virtio' model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use 'e1000'.", "enum" : [ - "ignore", - "on" + "rtl8139", + "ne2k_pci", + "e1000", + "pcnet", + "virtio", + "ne2k_isa", + "i82551", + "i82557b", + "i82559er", + "vmxnet3", + "e1000-82540em", + "e1000-82544gc", + "e1000-82545em" ], + "type" : "string" + }, + "ne2k_isa" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "ne2k_pci" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "pcnet" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "queues" : { + "description" : "Number of packet queues to be used on the device.", + "maximum" : 16, + "minimum" : 0, + "optional" : 1, + "type" : "integer" + }, + "rate" : { + "description" : "Rate limit in mbps (megabytes per second) as floating point number.", + "minimum" : 0, + "optional" : 1, + "type" : "number" + }, + "rtl8139" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "tag" : { + "description" : "VLAN tag to apply to packets on this interface.", + "maximum" : 4094, + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "trunks" : { + "description" : "VLAN trunks to pass through this interface.", + "format_description" : "vlanid[;vlanid...]", "optional" : 1, + "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", "type" : "string" }, - "file" : { - "default_key" : 1, - "description" : "The drive's backing volume.", - "format" : "pve-volume-id-or-qm-path", - "format_description" : "volume", + "virtio" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "vmxnet3" : { + "alias" : "macaddr", + "keyAlias" : "model" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "numa" : { + "default" : 0, + "description" : "Enable/disable NUMA.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "numa[n]" : { + "description" : "NUMA topology.", + "format" : { + "cpus" : { + "description" : "CPUs accessing this NUMA node.", + "format_description" : "id[-id];...", + "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", "type" : "string" }, - "format" : { - "description" : "The drive's backing file's data format.", + "hostnodes" : { + "description" : "Host NUMA nodes to use.", + "format_description" : "id[-id];...", + "optional" : 1, + "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", + "type" : "string" + }, + "memory" : { + "description" : "Amount of memory this NUMA node provides.", + "optional" : 1, + "type" : "number" + }, + "policy" : { + "description" : "NUMA allocation policy.", "enum" : [ - "raw", - "cow", - "qcow", - "qed", - "qcow2", - "vmdk", - "cloop" + "preferred", + "bind", + "interleave" ], "optional" : 1, "type" : "string" - }, - "heads" : { - "description" : "Force the drive's physical geometry to have a specific head count.", + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "cpus= [,hostnodes=] [,memory=] [,policy=]" + }, + "onboot" : { + "default" : 0, + "description" : "Specifies whether a VM will be started during system bootup.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "ostype" : { + "description" : "Specify guest operating system.", + "enum" : [ + "other", + "wxp", + "w2k", + "w2k3", + "w2k8", + "wvista", + "win7", + "win8", + "win10", + "l24", + "l26", + "solaris" + ], + "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/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" + }, + "parallel[n]" : { + "description" : "Map host parallel devices (n is 0 to 2).", + "optional" : 1, + "pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+", + "type" : "string", + "verbose_description" : "Map host parallel devices (n is 0 to 2).\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" + }, + "protection" : { + "default" : 0, + "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "reboot" : { + "default" : 1, + "description" : "Allow reboot. If set to '0' the VM exit on reboot.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "revert" : { + "description" : "Revert a pending change.", + "format" : "pve-configid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "sata[n]" : { + "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).", + "format" : { + "aio" : { + "description" : "AIO type to use.", + "enum" : [ + "native", + "threads" + ], "optional" : 1, - "type" : "integer" + "type" : "string" }, - "iops" : { - "description" : "Maximum r/w I/O in operations per second.", - "format_description" : "iops", + "backup" : { + "description" : "Whether the drive should be included when making backups.", "optional" : 1, - "type" : "integer" + "type" : "boolean" }, - "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool in operations per second.", - "format_description" : "iops", + "bps" : { + "description" : "Maximum r/w speed in bytes per second.", + "format_description" : "bps", "optional" : 1, "type" : "integer" }, - "iops_max_length" : { + "bps_max_length" : { "description" : "Maximum length of I/O bursts in seconds.", "format_description" : "seconds", "minimum" : 1, "optional" : 1, "type" : "integer" }, - "iops_rd" : { - "description" : "Maximum read I/O in operations per second.", - "format_description" : "iops", + "bps_rd" : { + "description" : "Maximum read speed in bytes per second.", + "format_description" : "bps", "optional" : 1, "type" : "integer" }, - "iops_rd_length" : { - "alias" : "iops_rd_max_length" - }, - "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool in operations per second.", - "format_description" : "iops", - "optional" : 1, - "type" : "integer" + "bps_rd_length" : { + "alias" : "bps_rd_max_length" }, - "iops_rd_max_length" : { + "bps_rd_max_length" : { "description" : "Maximum length of read I/O bursts in seconds.", "format_description" : "seconds", "minimum" : 1, "optional" : 1, "type" : "integer" }, - "iops_wr" : { - "description" : "Maximum write I/O in operations per second.", - "format_description" : "iops", + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", + "format_description" : "bps", "optional" : 1, "type" : "integer" }, - "iops_wr_length" : { - "alias" : "iops_wr_max_length" + "bps_wr_length" : { + "alias" : "bps_wr_max_length" }, - "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool in operations per second.", - "format_description" : "iops", + "bps_wr_max_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, "type" : "integer" }, - "iops_wr_max_length" : { - "description" : "Maximum length of write I/O bursts in seconds.", + "cache" : { + "description" : "The drive's cache mode", + "enum" : [ + "none", + "writethrough", + "writeback", + "unsafe", + "directsync" + ], + "optional" : 1, + "type" : "string" + }, + "cyls" : { + "description" : "Force the drive's physical geometry to have a specific cylinder count.", + "optional" : 1, + "type" : "integer" + }, + "detect_zeroes" : { + "description" : "Controls whether to detect and try to optimize writes of zeroes.", + "optional" : 1, + "type" : "boolean" + }, + "discard" : { + "description" : "Controls whether to pass discard/trim requests to the underlying storage.", + "enum" : [ + "ignore", + "on" + ], + "optional" : 1, + "type" : "string" + }, + "file" : { + "default_key" : 1, + "description" : "The drive's backing volume.", + "format" : "pve-volume-id-or-qm-path", + "format_description" : "volume", + "type" : "string" + }, + "format" : { + "description" : "The drive's backing file's data format.", + "enum" : [ + "raw", + "cow", + "qcow", + "qed", + "qcow2", + "vmdk", + "cloop" + ], + "optional" : 1, + "type" : "string" + }, + "heads" : { + "description" : "Force the drive's physical geometry to have a specific head count.", + "optional" : 1, + "type" : "integer" + }, + "iops" : { + "description" : "Maximum r/w I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_max" : { + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", "format_description" : "seconds", "minimum" : 1, "optional" : 1, "type" : "integer" }, - "iothread" : { - "description" : "Whether to use iothreads for this drive", + "iops_rd" : { + "description" : "Maximum read I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "type" : "boolean" + "type" : "integer" + }, + "iops_rd_length" : { + "alias" : "iops_rd_max_length" + }, + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_rd_max_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "iops_wr" : { + "description" : "Maximum write I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_wr_length" : { + "alias" : "iops_wr_max_length" + }, + "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_wr_max_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" }, "mbps" : { "description" : "Maximum r/w speed in megabytes per second.", @@ -9138,12 +11818,6 @@ var pveapi = [ "optional" : 1, "type" : "string" }, - "queues" : { - "description" : "Number of queues.", - "minimum" : 2, - "optional" : 1, - "type" : "integer" - }, "replicate" : { "default" : 1, "description" : "Whether the drive should considered for replication jobs.", @@ -9160,12 +11834,6 @@ var pveapi = [ "optional" : 1, "type" : "string" }, - "scsiblock" : { - "default" : 0, - "description" : "whether to use scsi-block for full passthrough of host block device\n\nWARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host", - "optional" : 1, - "type" : "boolean" - }, "secs" : { "description" : "Force the drive's physical geometry to have a specific sector count.", "optional" : 1, @@ -9179,6 +11847,13 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "shared" : { + "default" : 0, + "description" : "Mark this locally-managed volume as available on all nodes", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!" + }, "size" : { "description" : "Disk size. This is purely informational and has no effect.", "format" : "disk-size", @@ -9187,7 +11862,12 @@ var pveapi = [ "type" : "string" }, "snapshot" : { - "description" : "Whether the drive should be included when making snapshots.", + "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.", + "optional" : 1, + "type" : "boolean" + }, + "ssd" : { + "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.", "optional" : 1, "type" : "boolean" }, @@ -9214,166 +11894,21 @@ var pveapi = [ ], "optional" : 1, "type" : "string" + }, + "wwn" : { + "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.", + "format_description" : "wwn", + "optional" : 1, + "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})", + "type" : "string" } }, "optional" : 1, "type" : "string", - "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=] [,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=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" - }, - "scsihw" : { - "default" : "lsi", - "description" : "SCSI controller model", - "enum" : [ - "lsi", - "lsi53c810", - "virtio-scsi-pci", - "virtio-scsi-single", - "megasas", - "pvscsi" - ], - "optional" : 1, - "type" : "string" - }, - "serial[n]" : { - "description" : "Create a serial device inside the VM (n is 0 to 3)", - "optional" : 1, - "pattern" : "(/dev/.+|socket)", - "type" : "string", - "verbose_description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a\nhost serial device (i.e. /dev/ttyS0), or create a unix socket on the\nhost side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" - }, - "shares" : { - "default" : 1000, - "description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning", - "maximum" : 50000, - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - 50000)" - }, - "skiplock" : { - "description" : "Ignore locks - only root is allowed to use this option.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "smbios1" : { - "description" : "Specify SMBIOS type 1 fields.", - "format" : "pve-qm-smbios1", - "maxLength" : 256, - "optional" : 1, - "type" : "string", - "typetext" : "[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]" - }, - "smp" : { - "default" : 1, - "description" : "The number of CPUs. Please use option -sockets instead.", - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - }, - "sockets" : { - "default" : 1, - "description" : "The number of CPU sockets.", - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - }, - "startdate" : { - "default" : "now", - "description" : "Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.", - "optional" : 1, - "pattern" : "(now|\\d{4}-\\d{1,2}-\\d{1,2}(T\\d{1,2}:\\d{1,2}:\\d{1,2})?)", - "type" : "string", - "typetext" : "(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)" - }, - "startup" : { - "description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.", - "format" : "pve-startup-order", - "optional" : 1, - "type" : "string", - "typetext" : "[[order=]\\d+] [,up=\\d+] [,down=\\d+] " - }, - "tablet" : { - "default" : 1, - "description" : "Enable/disable the USB tablet device.", - "optional" : 1, - "type" : "boolean", - "typetext" : "", - "verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl)." - }, - "tdf" : { - "default" : 0, - "description" : "Enable/disable time drift fix.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "template" : { - "default" : 0, - "description" : "Enable/disable Template.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "unused[n]" : { - "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.", - "format" : "pve-volume-id", - "optional" : 1, - "type" : "string", - "typetext" : "" + "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=]" }, - "usb[n]" : { - "description" : "Configure an USB device (n is 0 to 4).", - "format" : { - "host" : { - "default_key" : 1, - "description" : "The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:\n\n 'bus-port(.port)*' (decimal numbers) or\n 'vendor_id:product_id' (hexadeciaml numbers) or\n 'spice'\n\nYou can use the 'lsusb -t' command to list existing usb devices.\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nThe value 'spice' can be used to add a usb redirection devices for spice.\n", - "format" : "pve-qm-usb-device", - "format_description" : "HOSTUSBDEVICE|spice", - "type" : "string" - }, - "usb3" : { - "default" : 0, - "description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).", - "optional" : 1, - "type" : "boolean" - } - }, - "optional" : 1, - "type" : "string", - "typetext" : "[host=] [,usb3=<1|0>]" - }, - "vcpus" : { - "default" : 0, - "description" : "Number of hotplugged vcpus.", - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - }, - "vga" : { - "description" : "Select the VGA type.", - "enum" : [ - "std", - "cirrus", - "vmware", - "qxl", - "serial0", - "serial1", - "serial2", - "serial3", - "qxl2", - "qxl3", - "qxl4" - ], - "optional" : 1, - "type" : "string", - "verbose_description" : "Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal." - }, - "virtio[n]" : { - "description" : "Use volume as VIRTIO hard disk (n is 0 to 15).", + "scsi[n]" : { + "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).", "format" : { "aio" : { "description" : "AIO type to use.", @@ -9605,6 +12140,12 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "queues" : { + "description" : "Number of queues.", + "minimum" : 2, + "optional" : 1, + "type" : "integer" + }, "replicate" : { "default" : 1, "description" : "Whether the drive should considered for replication jobs.", @@ -9621,6 +12162,12 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "scsiblock" : { + "default" : 0, + "description" : "whether to use scsi-block for full passthrough of host block device\n\nWARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host", + "optional" : 1, + "type" : "boolean" + }, "secs" : { "description" : "Force the drive's physical geometry to have a specific sector count.", "optional" : 1, @@ -9634,6 +12181,13 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "shared" : { + "default" : 0, + "description" : "Mark this locally-managed volume as available on all nodes", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!" + }, "size" : { "description" : "Disk size. This is purely informational and has no effect.", "format" : "disk-size", @@ -9642,7 +12196,12 @@ var pveapi = [ "type" : "string" }, "snapshot" : { - "description" : "Whether the drive should be included when making snapshots.", + "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.", + "optional" : 1, + "type" : "boolean" + }, + "ssd" : { + "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.", "optional" : 1, "type" : "boolean" }, @@ -9669,903 +12228,521 @@ var pveapi = [ ], "optional" : 1, "type" : "string" + }, + "wwn" : { + "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.", + "format_description" : "wwn", + "optional" : 1, + "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})", + "type" : "string" } }, "optional" : 1, "type" : "string", - "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=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "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=] [,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=]" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" + "scsihw" : { + "default" : "lsi", + "description" : "SCSI controller model", + "enum" : [ + "lsi", + "lsi53c810", + "virtio-scsi-pci", + "virtio-scsi-single", + "megasas", + "pvscsi" + ], + "optional" : 1, + "type" : "string" }, - "vmstatestorage" : { - "description" : "Default storage for VM state volumes/files.", - "format" : "pve-storage-id", + "searchdomain" : { + "description" : "cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.", "optional" : 1, "type" : "string", "typetext" : "" }, - "watchdog" : { - "description" : "Create a virtual hardware watchdog device.", - "format" : "pve-qm-watchdog", + "serial[n]" : { + "description" : "Create a serial device inside the VM (n is 0 to 3)", "optional" : 1, + "pattern" : "(/dev/.+|socket)", "type" : "string", - "typetext" : "[[model=]] [,action=]", - "verbose_description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Disk", - "VM.Config.CDROM", - "VM.Config.CPU", - "VM.Config.Memory", - "VM.Config.Network", - "VM.Config.HWType", - "VM.Config.Options" - ], - "any", - 1 - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "null" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/config", - "text" : "config" - }, - { - "info" : { - "GET" : { - "description" : "Get virtual machine configuration, including pending changes.", - "method" : "GET", - "name" : "vm_pending", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "verbose_description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a\nhost serial device (i.e. /dev/ttyS0), or create a unix socket on the\nhost side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, + "shares" : { + "default" : 1000, + "description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.", + "maximum" : 50000, + "minimum" : 0, + "optional" : 1, "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : { - "delete" : { - "description" : "Indicates a pending delete request if present and not 0. The value 2 indicates a force-delete request.", - "maximum" : 2, - "minimum" : 0, - "optional" : 1, - "type" : "integer" - }, - "key" : { - "description" : "Configuration option name.", - "type" : "string" - }, - "pending" : { - "description" : "Pending value.", - "optional" : 1, - "type" : "string" - }, - "value" : { - "description" : "Current value.", - "optional" : 1, - "type" : "string" - } + "typetext" : " (0 - 50000)" }, - "type" : "object" - }, - "type" : "array" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/pending", - "text" : "pending" - }, - { - "info" : { - "PUT" : { - "description" : "Unlink/delete disk images.", - "method" : "PUT", - "name" : "unlink", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "force" : { - "description" : "Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.", + "skiplock" : { + "description" : "Ignore locks - only root is allowed to use this option.", "optional" : 1, "type" : "boolean", "typetext" : "" }, - "idlist" : { - "description" : "A list of disk IDs you want to delete.", - "format" : "pve-configid-list", + "smbios1" : { + "description" : "Specify SMBIOS type 1 fields.", + "format" : "pve-qm-smbios1", + "maxLength" : 512, + "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "[base64=<1|0>] [,family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "smp" : { + "default" : 1, + "description" : "The number of CPUs. Please use option -sockets instead.", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", + "sockets" : { + "default" : 1, + "description" : "The number of CPU sockets.", "minimum" : 1, + "optional" : 1, "type" : "integer", "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Disk" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "null" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/unlink", - "text" : "unlink" - }, - { - "info" : { - "POST" : { - "description" : "Creates a TCP VNC proxy connections.", - "method" : "POST", - "name" : "vncproxy", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - }, - "websocket" : { - "description" : "starts websockify instead of vncproxy", + "sshkeys" : { + "description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).", + "format" : "urlencoded", "optional" : 1, - "type" : "boolean", - "typetext" : "" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Console" - ] - ] - }, - "protected" : 1, - "returns" : { - "additionalProperties" : 0, - "properties" : { - "cert" : { - "type" : "string" - }, - "port" : { - "type" : "integer" - }, - "ticket" : { - "type" : "string" - }, - "upid" : { - "type" : "string" - }, - "user" : { - "type" : "string" - } - } - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/vncproxy", - "text" : "vncproxy" - }, - { - "info" : { - "POST" : { - "description" : "Creates a TCP proxy connections.", - "method" : "POST", - "name" : "termproxy", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", "type" : "string", "typetext" : "" }, - "serial" : { - "description" : "opens a serial terminal (defaults to display)", - "enum" : [ - "serial0", - "serial1", - "serial2", - "serial3" - ], + "startdate" : { + "default" : "now", + "description" : "Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.", "optional" : 1, - "type" : "string" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Console" - ] - ] - }, - "protected" : 1, - "returns" : { - "additionalProperties" : 0, - "properties" : { - "port" : { - "type" : "integer" - }, - "ticket" : { - "type" : "string" - }, - "upid" : { - "type" : "string" + "pattern" : "(now|\\d{4}-\\d{1,2}-\\d{1,2}(T\\d{1,2}:\\d{1,2}:\\d{1,2})?)", + "type" : "string", + "typetext" : "(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)" }, - "user" : { - "type" : "string" - } - } - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/termproxy", - "text" : "termproxy" - }, - { - "info" : { - "GET" : { - "description" : "Opens a weksocket for VNC traffic.", - "method" : "GET", - "name" : "vncwebsocket", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "startup" : { + "description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.", + "format" : "pve-startup-order", + "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "[[order=]\\d+] [,up=\\d+] [,down=\\d+] " }, - "port" : { - "description" : "Port number returned by previous vncproxy call.", - "maximum" : 5999, - "minimum" : 5900, - "type" : "integer", - "typetext" : " (5900 - 5999)" + "tablet" : { + "default" : 1, + "description" : "Enable/disable the USB tablet device.", + "optional" : 1, + "type" : "boolean", + "typetext" : "", + "verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl)." }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" + "tdf" : { + "default" : 0, + "description" : "Enable/disable time drift fix.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, - "vncticket" : { - "description" : "Ticket from previous call to vncproxy.", - "maxLength" : 512, - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Console" - ] - ], - "description" : "You also need to pass a valid ticket (vncticket)." - }, - "returns" : { - "properties" : { - "port" : { - "type" : "string" - } - }, - "type" : "object" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/vncwebsocket", - "text" : "vncwebsocket" - }, - { - "info" : { - "POST" : { - "description" : "Returns a SPICE configuration to connect to the VM.", - "method" : "POST", - "name" : "spiceproxy", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "template" : { + "default" : 0, + "description" : "Enable/disable Template.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "unused[n]" : { + "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.", + "format" : "pve-volume-id", + "optional" : 1, "type" : "string", "typetext" : "" }, - "proxy" : { - "description" : "SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As resonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).", - "format" : "address", + "usb[n]" : { + "description" : "Configure an USB device (n is 0 to 4).", + "format" : { + "host" : { + "default_key" : 1, + "description" : "The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:\n\n 'bus-port(.port)*' (decimal numbers) or\n 'vendor_id:product_id' (hexadeciaml numbers) or\n 'spice'\n\nYou can use the 'lsusb -t' command to list existing usb devices.\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nThe value 'spice' can be used to add a usb redirection devices for spice.\n", + "format" : "pve-qm-usb-device", + "format_description" : "HOSTUSBDEVICE|spice", + "type" : "string" + }, + "usb3" : { + "default" : 0, + "description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).", + "optional" : 1, + "type" : "boolean" + } + }, "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "[host=] [,usb3=<1|0>]" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", + "vcpus" : { + "default" : 0, + "description" : "Number of hotplugged vcpus.", "minimum" : 1, + "optional" : 1, "type" : "integer", "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Console" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "additionalProperties" : 1, - "description" : "Returned values can be directly passed to the 'remote-viewer' application.", - "properties" : { - "host" : { - "type" : "string" - }, - "password" : { - "type" : "string" - }, - "proxy" : { - "type" : "string" - }, - "tls-port" : { - "type" : "integer" - }, - "type" : { - "type" : "string" - } - } - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/spiceproxy", - "text" : "spiceproxy" - }, - { - "children" : [ - { - "info" : { - "GET" : { - "description" : "Get virtual machine status.", - "method" : "GET", - "name" : "vm_status", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "object" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/status/current", - "text" : "current" - }, - { - "info" : { - "POST" : { - "description" : "Start virtual machine.", - "method" : "POST", - "name" : "vm_start", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "machine" : { - "description" : "Specific the Qemu machine type.", - "maxLength" : 40, - "optional" : 1, - "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?)", - "type" : "string" - }, - "migratedfrom" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "vga" : { + "description" : "Configure the VGA hardware.", + "format" : { + "memory" : { + "description" : "Sets the VGA memory (in MiB). Has no effect with serial display.", + "maximum" : 512, + "minimum" : 4, "optional" : 1, - "type" : "string", - "typetext" : "" + "type" : "integer" }, - "migration_network" : { - "description" : "CIDR of the (sub) network that is used for migration.", - "format" : "CIDR", + "type" : { + "default" : "std", + "default_key" : 1, + "description" : "Select the VGA type.", + "enum" : [ + "cirrus", + "qxl", + "qxl2", + "qxl3", + "qxl4", + "none", + "serial0", + "serial1", + "serial2", + "serial3", + "std", + "virtio", + "vmware" + ], "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "migration_type" : { - "description" : "Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.", + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[[type=]] [,memory=]", + "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).", + "format" : { + "aio" : { + "description" : "AIO type to use.", "enum" : [ - "secure", - "insecure" + "native", + "threads" ], "optional" : 1, "type" : "string" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "backup" : { + "description" : "Whether the drive should be included when making backups.", + "optional" : 1, + "type" : "boolean" }, - "skiplock" : { - "description" : "Ignore locks - only root is allowed to use this option.", + "bps" : { + "description" : "Maximum r/w speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "integer" }, - "stateuri" : { - "description" : "Some command save/restore state from this location.", - "maxLength" : 128, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "type" : "string", - "typetext" : "" + "type" : "integer" }, - "targetstorage" : { - "description" : "Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)", + "bps_rd" : { + "description" : "Maximum read speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "type" : "string", - "typetext" : "" + "type" : "integer" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", + "bps_rd_length" : { + "alias" : "bps_rd_max_length" + }, + "bps_rd_max_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.PowerMgmt" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/status/start", - "text" : "start" - }, - { - "info" : { - "POST" : { - "description" : "Stop virtual machine. The qemu process will exit immediately. Thisis akin to pulling the power plug of a running computer and may damage the VM data", - "method" : "POST", - "name" : "vm_stop", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "keepActive" : { - "default" : 0, - "description" : "Do not deactivate storage volumes.", "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "integer" }, - "migratedfrom" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "type" : "string", - "typetext" : "" + "type" : "integer" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "bps_wr_length" : { + "alias" : "bps_wr_max_length" }, - "skiplock" : { - "description" : "Ignore locks - only root is allowed to use this option.", + "bps_wr_max_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "integer" }, - "timeout" : { - "description" : "Wait maximal timeout seconds.", - "minimum" : 0, + "cache" : { + "description" : "The drive's cache mode", + "enum" : [ + "none", + "writethrough", + "writeback", + "unsafe", + "directsync" + ], "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.PowerMgmt" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/status/stop", - "text" : "stop" - }, - { - "info" : { - "POST" : { - "description" : "Reset virtual machine.", - "method" : "POST", - "name" : "vm_reset", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "type" : "string" }, - "skiplock" : { - "description" : "Ignore locks - only root is allowed to use this option.", + "cyls" : { + "description" : "Force the drive's physical geometry to have a specific cylinder count.", "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "integer" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.PowerMgmt" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/status/reset", - "text" : "reset" - }, - { - "info" : { - "POST" : { - "description" : "Shutdown virtual machine. This is similar to pressing the power button on a physical machine.This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown.", - "method" : "POST", - "name" : "vm_shutdown", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "forceStop" : { - "default" : 0, - "description" : "Make sure the VM stops.", + "detect_zeroes" : { + "description" : "Controls whether to detect and try to optimize writes of zeroes.", "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "boolean" }, - "keepActive" : { - "default" : 0, - "description" : "Do not deactivate storage volumes.", + "discard" : { + "description" : "Controls whether to pass discard/trim requests to the underlying storage.", + "enum" : [ + "ignore", + "on" + ], "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "string" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "file" : { + "default_key" : 1, + "description" : "The drive's backing volume.", + "format" : "pve-volume-id-or-qm-path", + "format_description" : "volume", + "type" : "string" }, - "skiplock" : { - "description" : "Ignore locks - only root is allowed to use this option.", + "format" : { + "description" : "The drive's backing file's data format.", + "enum" : [ + "raw", + "cow", + "qcow", + "qed", + "qcow2", + "vmdk", + "cloop" + ], "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "string" }, - "timeout" : { - "description" : "Wait maximal timeout seconds.", - "minimum" : 0, + "heads" : { + "description" : "Force the drive's physical geometry to have a specific head count.", "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" + "type" : "integer" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.PowerMgmt" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/status/shutdown", - "text" : "shutdown" - }, - { - "info" : { - "POST" : { - "description" : "Suspend virtual machine.", - "method" : "POST", - "name" : "vm_suspend", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "iops" : { + "description" : "Maximum r/w I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" }, - "skiplock" : { - "description" : "Ignore locks - only root is allowed to use this option.", + "iops_max" : { + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", + "format_description" : "iops", "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "integer" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.PowerMgmt" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/status/suspend", - "text" : "suspend" - }, - { - "info" : { - "POST" : { - "description" : "Resume virtual machine.", - "method" : "POST", - "name" : "vm_resume", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "nocheck" : { "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "type" : "integer" }, - "skiplock" : { - "description" : "Ignore locks - only root is allowed to use this option.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" + "iops_rd" : { + "description" : "Maximum read I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", + "iops_rd_length" : { + "alias" : "iops_rd_max_length" + }, + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_rd_max_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" + "optional" : 1, + "type" : "integer" + }, + "iops_wr" : { + "description" : "Maximum write I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_wr_length" : { + "alias" : "iops_wr_max_length" + }, + "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_wr_max_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "iothread" : { + "description" : "Whether to use iothreads for this drive", + "optional" : 1, + "type" : "boolean" + }, + "mbps" : { + "description" : "Maximum r/w speed in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_max" : { + "description" : "Maximum unthrottled r/w pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_rd" : { + "description" : "Maximum read speed in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_rd_max" : { + "description" : "Maximum unthrottled read pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_wr" : { + "description" : "Maximum write speed in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_wr_max" : { + "description" : "Maximum unthrottled write pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "media" : { + "default" : "disk", + "description" : "The drive's media type.", + "enum" : [ + "cdrom", + "disk" + ], + "optional" : 1, + "type" : "string" + }, + "replicate" : { + "default" : 1, + "description" : "Whether the drive should considered for replication jobs.", + "optional" : 1, + "type" : "boolean" + }, + "rerror" : { + "description" : "Read error action.", + "enum" : [ + "ignore", + "report", + "stop" + ], + "optional" : 1, + "type" : "string" + }, + "secs" : { + "description" : "Force the drive's physical geometry to have a specific sector count.", + "optional" : 1, + "type" : "integer" + }, + "serial" : { + "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", + "format" : "urlencoded", + "format_description" : "serial", + "maxLength" : 60, + "optional" : 1, + "type" : "string" + }, + "shared" : { + "default" : 0, + "description" : "Mark this locally-managed volume as available on all nodes", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!" + }, + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", + "optional" : 1, + "type" : "string" + }, + "snapshot" : { + "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.", + "optional" : 1, + "type" : "boolean" + }, + "trans" : { + "description" : "Force disk geometry bios translation mode.", + "enum" : [ + "none", + "lba", + "auto" + ], + "optional" : 1, + "type" : "string" + }, + "volume" : { + "alias" : "file" + }, + "werror" : { + "description" : "Write error action.", + "enum" : [ + "enospc", + "ignore", + "report", + "stop" + ], + "optional" : 1, + "type" : "string" } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.PowerMgmt" - ] - ] + }, + "optional" : 1, + "type" : "string", + "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=] [,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=]" }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/status/resume", - "text" : "resume" - } - ], - "info" : { - "GET" : { - "description" : "Directory index", - "method" : "GET", - "name" : "vmcmdidx", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "vmgenid" : { + "default" : "1 (autogenerated)", + "description" : "Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.", + "format_description" : "UUID", + "optional" : 1, + "pattern" : "(?:[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}|[01])", "type" : "string", - "typetext" : "" + "verbose_description" : "The VM generation ID (vmgenid) device exposes a 128-bit integer value identifier to the guest OS. This allows to notify the guest operating system when the virtual machine is executed with a different configuration (e.g. snapshot execution or creation from a template). The guest operating system notices the change, and is then able to react as appropriate by marking its copies of distributed databases as dirty, re-initializing its random number generator, etc.\nNote that auto-creation only works when done throug API/CLI create or update methods, but not when manually editing the config file." }, "vmid" : { "description" : "The (unique) ID of the VM.", @@ -10573,313 +12750,290 @@ var pveapi = [ "minimum" : 1, "type" : "integer", "typetext" : " (1 - N)" + }, + "vmstatestorage" : { + "description" : "Default storage for VM state volumes/files.", + "format" : "pve-storage-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "watchdog" : { + "description" : "Create a virtual hardware watchdog device.", + "format" : "pve-qm-watchdog", + "optional" : 1, + "type" : "string", + "typetext" : "[[model=]] [,action=]", + "verbose_description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)" } } }, "permissions" : { - "user" : "all" + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Config.Disk", + "VM.Config.CDROM", + "VM.Config.CPU", + "VM.Config.Memory", + "VM.Config.Network", + "VM.Config.HWType", + "VM.Config.Options" + ], + "any", + 1 + ] }, + "protected" : 1, "proxyto" : "node", "returns" : { - "items" : { - "properties" : { - "subdir" : { - "type" : "string" - } - }, - "type" : "object" - }, - "links" : [ - { - "href" : "{subdir}", - "rel" : "child" - } - ], - "type" : "array" + "optional" : 1, + "type" : "string" } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/qemu/{vmid}/status", - "text" : "status" - }, - { - "info" : { + }, "PUT" : { - "description" : "Send key event to virtual machine.", + "description" : "Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation.", "method" : "PUT", - "name" : "vm_sendkey", + "name" : "update_vm", "parameters" : { "additionalProperties" : 0, "properties" : { - "key" : { - "description" : "The key (qemu monitor encoding).", - "type" : "string", - "typetext" : "" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "skiplock" : { - "description" : "Ignore locks - only root is allowed to use this option.", + "acpi" : { + "default" : 1, + "description" : "Enable/disable ACPI.", "optional" : 1, "type" : "boolean", "typetext" : "" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Console" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "null" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/sendkey", - "text" : "sendkey" - }, - { - "info" : { - "GET" : { - "description" : "Check if feature for virtual machine is available.", - "method" : "GET", - "name" : "vm_feature", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "feature" : { - "description" : "Feature to check.", + "agent" : { + "description" : "Enable/disable Qemu GuestAgent and its properties.", + "format" : { + "enabled" : { + "default" : 0, + "default_key" : 1, + "description" : "Enable/disable Qemu GuestAgent.", + "type" : "boolean" + }, + "fstrim_cloned_disks" : { + "default" : 0, + "description" : "Run fstrim after cloning/moving a disk.", + "optional" : 1, + "type" : "boolean" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]" + }, + "arch" : { + "description" : "Virtual processor architecture. Defaults to the host.", "enum" : [ - "snapshot", - "clone", - "copy" + "x86_64", + "aarch64" ], + "optional" : 1, "type" : "string" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "snapname" : { - "description" : "The name of the snapshot.", - "format" : "pve-configid", - "maxLength" : 40, + "args" : { + "description" : "Arbitrary arguments passed to kvm.", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "", + "verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "properties" : { - "hasFeature" : { - "type" : "boolean" + "autostart" : { + "default" : 0, + "description" : "Automatic restart after crash (currently ignored).", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, - "nodes" : { - "items" : { - "type" : "string" - }, - "type" : "array" - } - }, - "type" : "object" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/feature", - "text" : "feature" - }, - { - "info" : { - "POST" : { - "description" : "Create a copy of virtual machine/template.", - "method" : "POST", - "name" : "clone_vm", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "description" : { - "description" : "Description for the new VM.", + "balloon" : { + "description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.", + "minimum" : 0, "optional" : 1, - "type" : "string", - "typetext" : "" + "type" : "integer", + "typetext" : " (0 - N)" }, - "format" : { - "description" : "Target format for file storage.", + "bios" : { + "default" : "seabios", + "description" : "Select BIOS implementation.", "enum" : [ - "raw", - "qcow2", - "vmdk" + "seabios", + "ovmf" ], "optional" : 1, - "requires" : "full", "type" : "string" }, - "full" : { - "default" : 0, - "description" : "Create a full copy of all disk. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default.", + "boot" : { + "default" : "cdn", + "description" : "Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).", "optional" : 1, - "type" : "boolean", - "typetext" : "" + "pattern" : "[acdn]{1,4}", + "type" : "string" }, - "name" : { - "description" : "Set a name for the new VM.", - "format" : "dns-name", + "bootdisk" : { + "description" : "Enable booting from specified disk.", + "format" : "pve-qm-bootdisk", "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "newid" : { - "description" : "VMID for the clone.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" + "pattern" : "(ide|sata|scsi|virtio)\\d+", + "type" : "string" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "cdrom" : { + "description" : "This is an alias for option -ide2", + "format" : "pve-qm-ide", + "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, - "pool" : { - "description" : "Add the new VM to the specified pool.", - "format" : "pve-poolid", + "cicustom" : { + "description" : "cloud-init: Specify custom files to replace the automatically generated ones at start.", + "format" : "pve-qm-cicustom", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "[meta=] [,network=] [,user=]" }, - "snapname" : { - "description" : "The name of the snapshot.", - "format" : "pve-configid", - "maxLength" : 40, + "cipassword" : { + "description" : "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.", "optional" : 1, "type" : "string", "typetext" : "" }, - "storage" : { - "description" : "Target storage for full clone.", - "format" : "pve-storage-id", + "citype" : { + "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" + ], "optional" : 1, - "requires" : "full", - "type" : "string", - "typetext" : "" + "type" : "string" }, - "target" : { - "description" : "Target node. Only allowed if the original VM is on shared storage.", - "format" : "pve-node", + "ciuser" : { + "description" : "cloud-init: User name to change ssh keys and password for instead of the image's configured default user.", "optional" : 1, "type" : "string", "typetext" : "" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", + "cores" : { + "default" : 1, + "description" : "The number of cores per socket.", "minimum" : 1, + "optional" : 1, "type" : "integer", "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "and", - [ - "perm", - "/vms/{vmid}", - [ - "VM.Clone" - ] - ], - [ - "or", - [ - "perm", - "/vms/{newid}", - [ - "VM.Allocate" - ] - ], - [ - "perm", - "/pool/{pool}", - [ - "VM.Allocate" - ], - "require_param", - "pool" - ] - ] - ], - "description" : "You need 'VM.Clone' permissions on /vms/{vmid}, and 'VM.Allocate' permissions on /vms/{newid} (or on the VM pool /pool/{pool}). You also need 'Datastore.AllocateSpace' on any used storage." - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/clone", - "text" : "clone" - }, - { - "info" : { - "POST" : { - "description" : "Move volume to different storage.", - "method" : "POST", - "name" : "move_vm_disk", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "delete" : { + }, + "cpu" : { + "description" : "Emulated CPU type.", + "format" : { + "cputype" : { + "default" : "kvm64", + "default_key" : 1, + "description" : "Emulated CPU type.", + "enum" : [ + "486", + "athlon", + "Broadwell", + "Broadwell-IBRS", + "Broadwell-noTSX", + "Broadwell-noTSX-IBRS", + "Conroe", + "core2duo", + "coreduo", + "EPYC", + "EPYC-IBPB", + "Haswell", + "Haswell-IBRS", + "Haswell-noTSX", + "Haswell-noTSX-IBRS", + "host", + "IvyBridge", + "IvyBridge-IBRS", + "kvm32", + "kvm64", + "max", + "Nehalem", + "Nehalem-IBRS", + "Opteron_G1", + "Opteron_G2", + "Opteron_G3", + "Opteron_G4", + "Opteron_G5", + "Penryn", + "pentium", + "pentium2", + "pentium3", + "phenom", + "qemu32", + "qemu64", + "SandyBridge", + "SandyBridge-IBRS", + "Skylake-Client", + "Skylake-Client-IBRS", + "Skylake-Server", + "Skylake-Server-IBRS", + "Westmere", + "Westmere-IBRS" + ], + "type" : "string" + }, + "flags" : { + "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'.", + "format_description" : "+FLAG[;-FLAG...]", + "optional" : 1, + "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear)))*)", + "type" : "string" + }, + "hidden" : { + "default" : 0, + "description" : "Do not identify as a KVM virtual machine.", + "optional" : 1, + "type" : "boolean" + }, + "hv-vendor-id" : { + "description" : "The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.", + "format_description" : "vendor-id", + "optional" : 1, + "pattern" : "(?^:[a-zA-Z0-9]{1,12})", + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[cputype=] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=]" + }, + "cpulimit" : { "default" : 0, - "description" : "Delete the original disk after successful copy. By default the original disk is kept as unused disk.", + "description" : "Limit of CPU usage.", + "maximum" : 128, + "minimum" : 0, "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "number", + "typetext" : " (0 - 128)", + "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit." + }, + "cpuunits" : { + "default" : 1024, + "description" : "CPU weight for a VM.", + "maximum" : 262144, + "minimum" : 2, + "optional" : 1, + "type" : "integer", + "typetext" : " (2 - 262144)", + "verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs." + }, + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "description" : { + "description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.", + "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.", @@ -10888,998 +13042,4337 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "disk" : { - "description" : "The disk you want to move.", - "enum" : [ - "ide0", - "ide1", - "ide2", - "ide3", - "scsi0", - "scsi1", - "scsi2", - "scsi3", - "scsi4", - "scsi5", - "scsi6", - "scsi7", - "scsi8", - "scsi9", - "scsi10", - "scsi11", - "scsi12", - "scsi13", - "virtio0", - "virtio1", - "virtio2", - "virtio3", - "virtio4", - "virtio5", - "virtio6", - "virtio7", - "virtio8", - "virtio9", - "virtio10", - "virtio11", - "virtio12", - "virtio13", - "virtio14", - "virtio15", - "sata0", - "sata1", - "sata2", - "sata3", - "sata4", - "sata5", - "efidisk0" - ], - "type" : "string" + "efidisk0" : { + "description" : "Configure a Disk for storing EFI vars", + "format" : { + "file" : { + "default_key" : 1, + "description" : "The drive's backing volume.", + "format" : "pve-volume-id-or-qm-path", + "format_description" : "volume", + "type" : "string" + }, + "format" : { + "description" : "The drive's backing file's data format.", + "enum" : [ + "raw", + "cow", + "qcow", + "qed", + "qcow2", + "vmdk", + "cloop" + ], + "optional" : 1, + "type" : "string" + }, + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", + "optional" : 1, + "type" : "string" + }, + "volume" : { + "alias" : "file" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[file=] [,format=] [,size=]" }, - "format" : { - "description" : "Target Format.", - "enum" : [ - "raw", - "qcow2", - "vmdk" - ], + "force" : { + "description" : "Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.", "optional" : 1, - "type" : "string" + "requires" : "delete", + "type" : "boolean", + "typetext" : "" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "freeze" : { + "description" : "Freeze CPU at startup (use 'c' monitor command to start execution).", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "hookscript" : { + "description" : "Script that will be executed during various steps in the vms lifetime.", + "format" : "pve-volume-id", + "optional" : 1, "type" : "string", "typetext" : "" }, - "storage" : { - "description" : "Target storage.", - "format" : "pve-storage-id", + "hostpci[n]" : { + "description" : "Map host PCI devices into guest.", + "format" : "pve-qm-hostpci", + "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "[host=] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]", + "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer\npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "and", - [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Disk" - ] - ], - [ - "perm", - "/storage/{storage}", - [ - "Datastore.AllocateSpace" - ] - ] - ], - "description" : "You need 'VM.Config.Disk' permissions on /vms/{vmid}, and 'Datastore.AllocateSpace' permissions on the storage." - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "description" : "the task ID.", - "type" : "string" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/move_disk", - "text" : "move_disk" - }, - { - "info" : { - "POST" : { - "description" : "Migrate virtual machine. Creates a new migration task.", - "method" : "POST", - "name" : "migrate_vm", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "force" : { - "description" : "Allow to migrate VMs which use local devices. Only root may use this option.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "migration_network" : { - "description" : "CIDR of the (sub) network that is used for migration.", - "format" : "CIDR", + "hotplug" : { + "default" : "network,disk,usb", + "description" : "Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.", + "format" : "pve-hotplug-features", "optional" : 1, "type" : "string", "typetext" : "" }, - "migration_type" : { - "description" : "Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.", + "hugepages" : { + "description" : "Enable/disable hugepages memory.", "enum" : [ - "secure", - "insecure" + "any", + "2", + "1024" ], "optional" : 1, "type" : "string" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "online" : { - "description" : "Use online/live migration.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "target" : { - "description" : "Target node.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "targetstorage" : { - "description" : "Default target storage.", - "format" : "pve-storage-id", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - }, - "with-local-disks" : { - "description" : "Enable live storage migration for local disk", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Migrate" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "description" : "the task ID.", - "type" : "string" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/migrate", - "text" : "migrate" - }, - { - "info" : { - "POST" : { - "description" : "Execute Qemu monitor commands.", - "method" : "POST", - "name" : "monitor", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "command" : { - "description" : "The monitor command.", - "type" : "string", - "typetext" : "" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Monitor" - ] - ], - "description" : "Sys.Modify is required for (sub)commands which are not read-only ('info *' and 'help')" - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/monitor", - "text" : "monitor" - }, - { - "info" : { - "POST" : { - "description" : "Execute Qemu Guest Agent commands.", - "method" : "POST", - "name" : "agent", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "command" : { - "description" : "The QGA command.", - "enum" : [ - "ping", - "get-time", - "info", - "fsfreeze-status", - "fsfreeze-freeze", - "fsfreeze-thaw", - "fstrim", - "network-get-interfaces", - "get-vcpus", - "get-fsinfo", - "get-memory-blocks", - "get-memory-block-info", - "suspend-hybrid", - "suspend-ram", - "suspend-disk", - "shutdown" - ], - "type" : "string" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Monitor" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "description" : "Returns an object with a single `result` property. The type of that\nproperty depends on the executed command.", - "type" : "object" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/agent", - "text" : "agent" - }, - { - "info" : { - "PUT" : { - "description" : "Extend volume size.", - "method" : "PUT", - "name" : "resize_vm", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "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" : "" - }, - "disk" : { - "description" : "The disk you want to resize.", - "enum" : [ - "ide0", - "ide1", - "ide2", - "ide3", - "scsi0", - "scsi1", - "scsi2", - "scsi3", - "scsi4", - "scsi5", - "scsi6", - "scsi7", - "scsi8", - "scsi9", - "scsi10", - "scsi11", - "scsi12", - "scsi13", - "virtio0", - "virtio1", - "virtio2", - "virtio3", - "virtio4", - "virtio5", - "virtio6", - "virtio7", - "virtio8", - "virtio9", - "virtio10", - "virtio11", - "virtio12", - "virtio13", - "virtio14", - "virtio15", - "sata0", - "sata1", - "sata2", - "sata3", - "sata4", - "sata5", - "efidisk0" - ], - "type" : "string" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "size" : { - "description" : "The new size. With the `+` sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.", - "pattern" : "\\+?\\d+(\\.\\d+)?[KMGT]?", - "type" : "string" - }, - "skiplock" : { - "description" : "Ignore locks - only root is allowed to use this option.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Disk" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "null" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/resize", - "text" : "resize" - }, - { - "children" : [ - { - "children" : [ - { - "info" : { - "GET" : { - "description" : "Get snapshot configuration", - "method" : "GET", - "name" : "get_snapshot_config", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "snapname" : { - "description" : "The name of the snapshot.", - "format" : "pve-configid", - "maxLength" : 40, - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Snapshot", - "VM.Snapshot.Rollback" - ], - "any", - 1 - ] + "ide[n]" : { + "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3).", + "format" : { + "aio" : { + "description" : "AIO type to use.", + "enum" : [ + "native", + "threads" + ], + "optional" : 1, + "type" : "string" }, - "proxyto" : "node", - "returns" : { - "type" : "object" - } - }, - "PUT" : { - "description" : "Update snapshot metadata.", - "method" : "PUT", - "name" : "update_snapshot_config", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "description" : { - "description" : "A textual description or comment.", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "snapname" : { - "description" : "The name of the snapshot.", - "format" : "pve-configid", - "maxLength" : 40, - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } + "backup" : { + "description" : "Whether the drive should be included when making backups.", + "optional" : 1, + "type" : "boolean" }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Snapshot" - ] - ] + "bps" : { + "description" : "Maximum r/w speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "null" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config", - "text" : "config" - }, - { - "info" : { - "POST" : { - "description" : "Rollback VM state to specified snapshot.", - "method" : "POST", - "name" : "rollback", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "snapname" : { - "description" : "The name of the snapshot.", - "format" : "pve-configid", - "maxLength" : 40, - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Snapshot", - "VM.Snapshot.Rollback" - ], - "any", - 1 - ] + "bps_rd" : { + "description" : "Maximum read speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "description" : "the task ID.", + "bps_rd_length" : { + "alias" : "bps_rd_max_length" + }, + "bps_rd_max_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_wr_length" : { + "alias" : "bps_wr_max_length" + }, + "bps_wr_max_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "cache" : { + "description" : "The drive's cache mode", + "enum" : [ + "none", + "writethrough", + "writeback", + "unsafe", + "directsync" + ], + "optional" : 1, "type" : "string" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}/rollback", - "text" : "rollback" - } - ], - "info" : { - "DELETE" : { - "description" : "Delete a VM snapshot.", - "method" : "DELETE", - "name" : "delsnapshot", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "force" : { - "description" : "For removal from config file, even if removing disk snapshots fails.", + }, + "cyls" : { + "description" : "Force the drive's physical geometry to have a specific cylinder count.", "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "integer" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "detect_zeroes" : { + "description" : "Controls whether to detect and try to optimize writes of zeroes.", + "optional" : 1, + "type" : "boolean" }, - "snapname" : { - "description" : "The name of the snapshot.", - "format" : "pve-configid", - "maxLength" : 40, - "type" : "string", - "typetext" : "" + "discard" : { + "description" : "Controls whether to pass discard/trim requests to the underlying storage.", + "enum" : [ + "ignore", + "on" + ], + "optional" : 1, + "type" : "string" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", + "file" : { + "default_key" : 1, + "description" : "The drive's backing volume.", + "format" : "pve-volume-id-or-qm-path", + "format_description" : "volume", + "type" : "string" + }, + "format" : { + "description" : "The drive's backing file's data format.", + "enum" : [ + "raw", + "cow", + "qcow", + "qed", + "qcow2", + "vmdk", + "cloop" + ], + "optional" : 1, + "type" : "string" + }, + "heads" : { + "description" : "Force the drive's physical geometry to have a specific head count.", + "optional" : 1, + "type" : "integer" + }, + "iops" : { + "description" : "Maximum r/w I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_max" : { + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Snapshot" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "description" : "the task ID.", - "type" : "string" - } - }, - "GET" : { - "description" : "", - "method" : "GET", - "name" : "snapshot_cmd_idx", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "optional" : 1, + "type" : "integer" }, - "snapname" : { - "description" : "The name of the snapshot.", - "format" : "pve-configid", - "maxLength" : 40, - "type" : "string", - "typetext" : "" + "iops_rd" : { + "description" : "Maximum read I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", + "iops_rd_length" : { + "alias" : "iops_rd_max_length" + }, + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_rd_max_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "user" : "all" - }, - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "links" : [ - { - "href" : "{cmd}", - "rel" : "child" - } - ], - "type" : "array" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}", - "text" : "{snapname}" - } - ], - "info" : { - "GET" : { - "description" : "List all snapshots.", - "method" : "GET", - "name" : "snapshot_list", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "links" : [ - { - "href" : "{name}", - "rel" : "child" - } - ], - "type" : "array" - } - }, - "POST" : { - "description" : "Snapshot a VM.", - "method" : "POST", - "name" : "snapshot", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "description" : { - "description" : "A textual description or comment.", + "optional" : 1, + "type" : "integer" + }, + "iops_wr" : { + "description" : "Maximum write I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_wr_length" : { + "alias" : "iops_wr_max_length" + }, + "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_wr_max_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "mbps" : { + "description" : "Maximum r/w speed in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_max" : { + "description" : "Maximum unthrottled r/w pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_rd" : { + "description" : "Maximum read speed in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_rd_max" : { + "description" : "Maximum unthrottled read pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_wr" : { + "description" : "Maximum write speed in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_wr_max" : { + "description" : "Maximum unthrottled write pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "media" : { + "default" : "disk", + "description" : "The drive's media type.", + "enum" : [ + "cdrom", + "disk" + ], + "optional" : 1, + "type" : "string" + }, + "model" : { + "description" : "The drive's reported model name, url-encoded, up to 40 bytes long.", + "format" : "urlencoded", + "format_description" : "model", + "maxLength" : 120, + "optional" : 1, + "type" : "string" + }, + "replicate" : { + "default" : 1, + "description" : "Whether the drive should considered for replication jobs.", + "optional" : 1, + "type" : "boolean" + }, + "rerror" : { + "description" : "Read error action.", + "enum" : [ + "ignore", + "report", + "stop" + ], + "optional" : 1, + "type" : "string" + }, + "secs" : { + "description" : "Force the drive's physical geometry to have a specific sector count.", + "optional" : 1, + "type" : "integer" + }, + "serial" : { + "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", + "format" : "urlencoded", + "format_description" : "serial", + "maxLength" : 60, + "optional" : 1, + "type" : "string" + }, + "shared" : { + "default" : 0, + "description" : "Mark this locally-managed volume as available on all nodes", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!" + }, + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", + "optional" : 1, + "type" : "string" + }, + "snapshot" : { + "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.", + "optional" : 1, + "type" : "boolean" + }, + "ssd" : { + "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.", + "optional" : 1, + "type" : "boolean" + }, + "trans" : { + "description" : "Force disk geometry bios translation mode.", + "enum" : [ + "none", + "lba", + "auto" + ], + "optional" : 1, + "type" : "string" + }, + "volume" : { + "alias" : "file" + }, + "werror" : { + "description" : "Write error action.", + "enum" : [ + "enospc", + "ignore", + "report", + "stop" + ], + "optional" : 1, + "type" : "string" + }, + "wwn" : { + "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.", + "format_description" : "wwn", + "optional" : 1, + "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})", + "type" : "string" + } + }, "optional" : 1, "type" : "string", - "typetext" : "" + "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=]" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "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 gateway 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 dhcp on IPv4.\n", + "format" : "pve-qm-ipconfig", + "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "[gw=] [,gw6=] [,ip=] [,ip6=]" }, - "snapname" : { - "description" : "The name of the snapshot.", - "format" : "pve-configid", - "maxLength" : 40, + "ivshmem" : { + "description" : "Inter-VM shared memory. Useful for direct communication between VMs, or to the host.", + "format" : { + "name" : { + "description" : "The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.", + "format_description" : "string", + "optional" : 1, + "pattern" : "[a-zA-Z0-9\\-]+", + "type" : "string" + }, + "size" : { + "description" : "The size of the file in MB.", + "minimum" : 1, + "type" : "integer" + } + }, + "optional" : 1, "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" + "typetext" : "size= [,name=]" }, - "vmstate" : { - "description" : "Save the vmstate", + "keyboard" : { + "default" : null, + "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.", + "enum" : [ + "de", + "de-ch", + "da", + "en-gb", + "en-us", + "es", + "fi", + "fr", + "fr-be", + "fr-ca", + "fr-ch", + "hu", + "is", + "it", + "ja", + "lt", + "mk", + "nl", + "no", + "pl", + "pt", + "pt-br", + "sv", + "sl", + "tr" + ], "optional" : 1, - "type" : "boolean", - "typetext" : "" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Snapshot" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "description" : "the task ID.", - "type" : "string" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/qemu/{vmid}/snapshot", - "text" : "snapshot" - }, - { - "info" : { - "POST" : { - "description" : "Create a Template.", - "method" : "POST", - "name" : "template", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "disk" : { - "description" : "If you want to convert only 1 disk to base image.", + "type" : "string" + }, + "kvm" : { + "default" : 1, + "description" : "Enable/disable KVM hardware virtualization.", + "optional" : 1, + "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, + "type" : "boolean", + "typetext" : "" + }, + "lock" : { + "description" : "Lock/unlock the VM.", "enum" : [ - "ide0", - "ide1", - "ide2", - "ide3", - "scsi0", - "scsi1", - "scsi2", - "scsi3", - "scsi4", - "scsi5", - "scsi6", - "scsi7", - "scsi8", - "scsi9", - "scsi10", - "scsi11", - "scsi12", - "scsi13", - "virtio0", - "virtio1", - "virtio2", - "virtio3", - "virtio4", - "virtio5", - "virtio6", - "virtio7", - "virtio8", - "virtio9", - "virtio10", - "virtio11", - "virtio12", - "virtio13", - "virtio14", - "virtio15", - "sata0", - "sata1", - "sata2", - "sata3", - "sata4", - "sata5", - "efidisk0" + "backup", + "clone", + "create", + "migrate", + "rollback", + "snapshot", + "snapshot-delete", + "suspending", + "suspended" ], "optional" : 1, "type" : "string" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "machine" : { + "description" : "Specifies the Qemu machine type.", + "maxLength" : 40, + "optional" : 1, + "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)", + "type" : "string" + }, + "memory" : { + "default" : 512, + "description" : "Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.", + "minimum" : 16, + "optional" : 1, + "type" : "integer", + "typetext" : " (16 - N)" + }, + "migrate_downtime" : { + "default" : 0.1, + "description" : "Set maximum tolerated downtime (in seconds) for migrations.", + "minimum" : 0, + "optional" : 1, + "type" : "number", + "typetext" : " (0 - N)" + }, + "migrate_speed" : { + "default" : 0, + "description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit.", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "name" : { + "description" : "Set a name for the VM. Only used on the configuration web interface.", + "format" : "dns-name", + "optional" : 1, "type" : "string", "typetext" : "" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Allocate" - ] - ], - "description" : "You need 'VM.Allocate' permissions on /vms/{vmid}" - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "null" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/template", - "text" : "template" - } - ], - "info" : { - "DELETE" : { - "description" : "Destroy the vm (also delete all used/owned volumes).", - "method" : "DELETE", - "name" : "destroy_vm", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "skiplock" : { - "description" : "Ignore locks - only root is allowed to use this option.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Allocate" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - }, - "GET" : { - "description" : "Directory index", - "method" : "GET", - "name" : "vmdiridx", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "user" : "all" - }, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : { - "subdir" : { - "type" : "string" - } - }, - "type" : "object" - }, - "links" : [ - { - "href" : "{subdir}", - "rel" : "child" - } - ], - "type" : "array" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/qemu/{vmid}", - "text" : "{vmid}" - } + "nameserver" : { + "description" : "cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.", + "format" : "address-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "net[n]" : { + "description" : "Specify network devices.", + "format" : { + "bridge" : { + "description" : "Bridge to attach the network device to. The Proxmox VE standard bridge\nis called 'vmbr0'.\n\nIf you do not specify a bridge, we create a kvm user (NATed) network\ndevice, which provides DHCP and DNS services. The following addresses\nare used:\n\n 10.0.2.2 Gateway\n 10.0.2.3 DNS Server\n 10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n", + "format_description" : "bridge", + "optional" : 1, + "type" : "string" + }, + "e1000" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "e1000-82540em" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "e1000-82544gc" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "e1000-82545em" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "firewall" : { + "description" : "Whether this interface should be protected by the firewall.", + "optional" : 1, + "type" : "boolean" + }, + "i82551" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "i82557b" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "i82559er" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "link_down" : { + "description" : "Whether this interface should be disconnected (like pulling the plug).", + "optional" : 1, + "type" : "boolean" + }, + "macaddr" : { + "description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.", + "format" : "mac-addr", + "format_description" : "XX:XX:XX:XX:XX:XX", + "optional" : 1, + "type" : "string", + "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set." + }, + "model" : { + "default_key" : 1, + "description" : "Network Card Model. The 'virtio' model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use 'e1000'.", + "enum" : [ + "rtl8139", + "ne2k_pci", + "e1000", + "pcnet", + "virtio", + "ne2k_isa", + "i82551", + "i82557b", + "i82559er", + "vmxnet3", + "e1000-82540em", + "e1000-82544gc", + "e1000-82545em" + ], + "type" : "string" + }, + "ne2k_isa" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "ne2k_pci" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "pcnet" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "queues" : { + "description" : "Number of packet queues to be used on the device.", + "maximum" : 16, + "minimum" : 0, + "optional" : 1, + "type" : "integer" + }, + "rate" : { + "description" : "Rate limit in mbps (megabytes per second) as floating point number.", + "minimum" : 0, + "optional" : 1, + "type" : "number" + }, + "rtl8139" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "tag" : { + "description" : "VLAN tag to apply to packets on this interface.", + "maximum" : 4094, + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "trunks" : { + "description" : "VLAN trunks to pass through this interface.", + "format_description" : "vlanid[;vlanid...]", + "optional" : 1, + "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", + "type" : "string" + }, + "virtio" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "vmxnet3" : { + "alias" : "macaddr", + "keyAlias" : "model" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "numa" : { + "default" : 0, + "description" : "Enable/disable NUMA.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "numa[n]" : { + "description" : "NUMA topology.", + "format" : { + "cpus" : { + "description" : "CPUs accessing this NUMA node.", + "format_description" : "id[-id];...", + "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", + "type" : "string" + }, + "hostnodes" : { + "description" : "Host NUMA nodes to use.", + "format_description" : "id[-id];...", + "optional" : 1, + "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", + "type" : "string" + }, + "memory" : { + "description" : "Amount of memory this NUMA node provides.", + "optional" : 1, + "type" : "number" + }, + "policy" : { + "description" : "NUMA allocation policy.", + "enum" : [ + "preferred", + "bind", + "interleave" + ], + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "cpus= [,hostnodes=] [,memory=] [,policy=]" + }, + "onboot" : { + "default" : 0, + "description" : "Specifies whether a VM will be started during system bootup.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "ostype" : { + "description" : "Specify guest operating system.", + "enum" : [ + "other", + "wxp", + "w2k", + "w2k3", + "w2k8", + "wvista", + "win7", + "win8", + "win10", + "l24", + "l26", + "solaris" + ], + "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/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" + }, + "parallel[n]" : { + "description" : "Map host parallel devices (n is 0 to 2).", + "optional" : 1, + "pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+", + "type" : "string", + "verbose_description" : "Map host parallel devices (n is 0 to 2).\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" + }, + "protection" : { + "default" : 0, + "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "reboot" : { + "default" : 1, + "description" : "Allow reboot. If set to '0' the VM exit on reboot.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "revert" : { + "description" : "Revert a pending change.", + "format" : "pve-configid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "sata[n]" : { + "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).", + "format" : { + "aio" : { + "description" : "AIO type to use.", + "enum" : [ + "native", + "threads" + ], + "optional" : 1, + "type" : "string" + }, + "backup" : { + "description" : "Whether the drive should be included when making backups.", + "optional" : 1, + "type" : "boolean" + }, + "bps" : { + "description" : "Maximum r/w speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "bps_rd" : { + "description" : "Maximum read speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_rd_length" : { + "alias" : "bps_rd_max_length" + }, + "bps_rd_max_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_wr_length" : { + "alias" : "bps_wr_max_length" + }, + "bps_wr_max_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "cache" : { + "description" : "The drive's cache mode", + "enum" : [ + "none", + "writethrough", + "writeback", + "unsafe", + "directsync" + ], + "optional" : 1, + "type" : "string" + }, + "cyls" : { + "description" : "Force the drive's physical geometry to have a specific cylinder count.", + "optional" : 1, + "type" : "integer" + }, + "detect_zeroes" : { + "description" : "Controls whether to detect and try to optimize writes of zeroes.", + "optional" : 1, + "type" : "boolean" + }, + "discard" : { + "description" : "Controls whether to pass discard/trim requests to the underlying storage.", + "enum" : [ + "ignore", + "on" + ], + "optional" : 1, + "type" : "string" + }, + "file" : { + "default_key" : 1, + "description" : "The drive's backing volume.", + "format" : "pve-volume-id-or-qm-path", + "format_description" : "volume", + "type" : "string" + }, + "format" : { + "description" : "The drive's backing file's data format.", + "enum" : [ + "raw", + "cow", + "qcow", + "qed", + "qcow2", + "vmdk", + "cloop" + ], + "optional" : 1, + "type" : "string" + }, + "heads" : { + "description" : "Force the drive's physical geometry to have a specific head count.", + "optional" : 1, + "type" : "integer" + }, + "iops" : { + "description" : "Maximum r/w I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_max" : { + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "iops_rd" : { + "description" : "Maximum read I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_rd_length" : { + "alias" : "iops_rd_max_length" + }, + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_rd_max_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "iops_wr" : { + "description" : "Maximum write I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_wr_length" : { + "alias" : "iops_wr_max_length" + }, + "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_wr_max_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "mbps" : { + "description" : "Maximum r/w speed in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_max" : { + "description" : "Maximum unthrottled r/w pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_rd" : { + "description" : "Maximum read speed in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_rd_max" : { + "description" : "Maximum unthrottled read pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_wr" : { + "description" : "Maximum write speed in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_wr_max" : { + "description" : "Maximum unthrottled write pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "media" : { + "default" : "disk", + "description" : "The drive's media type.", + "enum" : [ + "cdrom", + "disk" + ], + "optional" : 1, + "type" : "string" + }, + "replicate" : { + "default" : 1, + "description" : "Whether the drive should considered for replication jobs.", + "optional" : 1, + "type" : "boolean" + }, + "rerror" : { + "description" : "Read error action.", + "enum" : [ + "ignore", + "report", + "stop" + ], + "optional" : 1, + "type" : "string" + }, + "secs" : { + "description" : "Force the drive's physical geometry to have a specific sector count.", + "optional" : 1, + "type" : "integer" + }, + "serial" : { + "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", + "format" : "urlencoded", + "format_description" : "serial", + "maxLength" : 60, + "optional" : 1, + "type" : "string" + }, + "shared" : { + "default" : 0, + "description" : "Mark this locally-managed volume as available on all nodes", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!" + }, + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", + "optional" : 1, + "type" : "string" + }, + "snapshot" : { + "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.", + "optional" : 1, + "type" : "boolean" + }, + "ssd" : { + "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.", + "optional" : 1, + "type" : "boolean" + }, + "trans" : { + "description" : "Force disk geometry bios translation mode.", + "enum" : [ + "none", + "lba", + "auto" + ], + "optional" : 1, + "type" : "string" + }, + "volume" : { + "alias" : "file" + }, + "werror" : { + "description" : "Write error action.", + "enum" : [ + "enospc", + "ignore", + "report", + "stop" + ], + "optional" : 1, + "type" : "string" + }, + "wwn" : { + "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.", + "format_description" : "wwn", + "optional" : 1, + "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})", + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "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 13).", + "format" : { + "aio" : { + "description" : "AIO type to use.", + "enum" : [ + "native", + "threads" + ], + "optional" : 1, + "type" : "string" + }, + "backup" : { + "description" : "Whether the drive should be included when making backups.", + "optional" : 1, + "type" : "boolean" + }, + "bps" : { + "description" : "Maximum r/w speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "bps_rd" : { + "description" : "Maximum read speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_rd_length" : { + "alias" : "bps_rd_max_length" + }, + "bps_rd_max_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_wr_length" : { + "alias" : "bps_wr_max_length" + }, + "bps_wr_max_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "cache" : { + "description" : "The drive's cache mode", + "enum" : [ + "none", + "writethrough", + "writeback", + "unsafe", + "directsync" + ], + "optional" : 1, + "type" : "string" + }, + "cyls" : { + "description" : "Force the drive's physical geometry to have a specific cylinder count.", + "optional" : 1, + "type" : "integer" + }, + "detect_zeroes" : { + "description" : "Controls whether to detect and try to optimize writes of zeroes.", + "optional" : 1, + "type" : "boolean" + }, + "discard" : { + "description" : "Controls whether to pass discard/trim requests to the underlying storage.", + "enum" : [ + "ignore", + "on" + ], + "optional" : 1, + "type" : "string" + }, + "file" : { + "default_key" : 1, + "description" : "The drive's backing volume.", + "format" : "pve-volume-id-or-qm-path", + "format_description" : "volume", + "type" : "string" + }, + "format" : { + "description" : "The drive's backing file's data format.", + "enum" : [ + "raw", + "cow", + "qcow", + "qed", + "qcow2", + "vmdk", + "cloop" + ], + "optional" : 1, + "type" : "string" + }, + "heads" : { + "description" : "Force the drive's physical geometry to have a specific head count.", + "optional" : 1, + "type" : "integer" + }, + "iops" : { + "description" : "Maximum r/w I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_max" : { + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "iops_rd" : { + "description" : "Maximum read I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_rd_length" : { + "alias" : "iops_rd_max_length" + }, + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_rd_max_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "iops_wr" : { + "description" : "Maximum write I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_wr_length" : { + "alias" : "iops_wr_max_length" + }, + "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_wr_max_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "iothread" : { + "description" : "Whether to use iothreads for this drive", + "optional" : 1, + "type" : "boolean" + }, + "mbps" : { + "description" : "Maximum r/w speed in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_max" : { + "description" : "Maximum unthrottled r/w pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_rd" : { + "description" : "Maximum read speed in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_rd_max" : { + "description" : "Maximum unthrottled read pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_wr" : { + "description" : "Maximum write speed in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_wr_max" : { + "description" : "Maximum unthrottled write pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "media" : { + "default" : "disk", + "description" : "The drive's media type.", + "enum" : [ + "cdrom", + "disk" + ], + "optional" : 1, + "type" : "string" + }, + "queues" : { + "description" : "Number of queues.", + "minimum" : 2, + "optional" : 1, + "type" : "integer" + }, + "replicate" : { + "default" : 1, + "description" : "Whether the drive should considered for replication jobs.", + "optional" : 1, + "type" : "boolean" + }, + "rerror" : { + "description" : "Read error action.", + "enum" : [ + "ignore", + "report", + "stop" + ], + "optional" : 1, + "type" : "string" + }, + "scsiblock" : { + "default" : 0, + "description" : "whether to use scsi-block for full passthrough of host block device\n\nWARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host", + "optional" : 1, + "type" : "boolean" + }, + "secs" : { + "description" : "Force the drive's physical geometry to have a specific sector count.", + "optional" : 1, + "type" : "integer" + }, + "serial" : { + "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", + "format" : "urlencoded", + "format_description" : "serial", + "maxLength" : 60, + "optional" : 1, + "type" : "string" + }, + "shared" : { + "default" : 0, + "description" : "Mark this locally-managed volume as available on all nodes", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!" + }, + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", + "optional" : 1, + "type" : "string" + }, + "snapshot" : { + "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.", + "optional" : 1, + "type" : "boolean" + }, + "ssd" : { + "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.", + "optional" : 1, + "type" : "boolean" + }, + "trans" : { + "description" : "Force disk geometry bios translation mode.", + "enum" : [ + "none", + "lba", + "auto" + ], + "optional" : 1, + "type" : "string" + }, + "volume" : { + "alias" : "file" + }, + "werror" : { + "description" : "Write error action.", + "enum" : [ + "enospc", + "ignore", + "report", + "stop" + ], + "optional" : 1, + "type" : "string" + }, + "wwn" : { + "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.", + "format_description" : "wwn", + "optional" : 1, + "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})", + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "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=] [,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=]" + }, + "scsihw" : { + "default" : "lsi", + "description" : "SCSI controller model", + "enum" : [ + "lsi", + "lsi53c810", + "virtio-scsi-pci", + "virtio-scsi-single", + "megasas", + "pvscsi" + ], + "optional" : 1, + "type" : "string" + }, + "searchdomain" : { + "description" : "cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "serial[n]" : { + "description" : "Create a serial device inside the VM (n is 0 to 3)", + "optional" : 1, + "pattern" : "(/dev/.+|socket)", + "type" : "string", + "verbose_description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a\nhost serial device (i.e. /dev/ttyS0), or create a unix socket on the\nhost side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" + }, + "shares" : { + "default" : 1000, + "description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.", + "maximum" : 50000, + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - 50000)" + }, + "skiplock" : { + "description" : "Ignore locks - only root is allowed to use this option.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "smbios1" : { + "description" : "Specify SMBIOS type 1 fields.", + "format" : "pve-qm-smbios1", + "maxLength" : 512, + "optional" : 1, + "type" : "string", + "typetext" : "[base64=<1|0>] [,family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]" + }, + "smp" : { + "default" : 1, + "description" : "The number of CPUs. Please use option -sockets instead.", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "sockets" : { + "default" : 1, + "description" : "The number of CPU sockets.", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "sshkeys" : { + "description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).", + "format" : "urlencoded", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "startdate" : { + "default" : "now", + "description" : "Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.", + "optional" : 1, + "pattern" : "(now|\\d{4}-\\d{1,2}-\\d{1,2}(T\\d{1,2}:\\d{1,2}:\\d{1,2})?)", + "type" : "string", + "typetext" : "(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)" + }, + "startup" : { + "description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.", + "format" : "pve-startup-order", + "optional" : 1, + "type" : "string", + "typetext" : "[[order=]\\d+] [,up=\\d+] [,down=\\d+] " + }, + "tablet" : { + "default" : 1, + "description" : "Enable/disable the USB tablet device.", + "optional" : 1, + "type" : "boolean", + "typetext" : "", + "verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl)." + }, + "tdf" : { + "default" : 0, + "description" : "Enable/disable time drift fix.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "template" : { + "default" : 0, + "description" : "Enable/disable Template.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "unused[n]" : { + "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.", + "format" : "pve-volume-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "usb[n]" : { + "description" : "Configure an USB device (n is 0 to 4).", + "format" : { + "host" : { + "default_key" : 1, + "description" : "The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:\n\n 'bus-port(.port)*' (decimal numbers) or\n 'vendor_id:product_id' (hexadeciaml numbers) or\n 'spice'\n\nYou can use the 'lsusb -t' command to list existing usb devices.\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nThe value 'spice' can be used to add a usb redirection devices for spice.\n", + "format" : "pve-qm-usb-device", + "format_description" : "HOSTUSBDEVICE|spice", + "type" : "string" + }, + "usb3" : { + "default" : 0, + "description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).", + "optional" : 1, + "type" : "boolean" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[host=] [,usb3=<1|0>]" + }, + "vcpus" : { + "default" : 0, + "description" : "Number of hotplugged vcpus.", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "vga" : { + "description" : "Configure the VGA hardware.", + "format" : { + "memory" : { + "description" : "Sets the VGA memory (in MiB). Has no effect with serial display.", + "maximum" : 512, + "minimum" : 4, + "optional" : 1, + "type" : "integer" + }, + "type" : { + "default" : "std", + "default_key" : 1, + "description" : "Select the VGA type.", + "enum" : [ + "cirrus", + "qxl", + "qxl2", + "qxl3", + "qxl4", + "none", + "serial0", + "serial1", + "serial2", + "serial3", + "std", + "virtio", + "vmware" + ], + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[[type=]] [,memory=]", + "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).", + "format" : { + "aio" : { + "description" : "AIO type to use.", + "enum" : [ + "native", + "threads" + ], + "optional" : 1, + "type" : "string" + }, + "backup" : { + "description" : "Whether the drive should be included when making backups.", + "optional" : 1, + "type" : "boolean" + }, + "bps" : { + "description" : "Maximum r/w speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "bps_rd" : { + "description" : "Maximum read speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_rd_length" : { + "alias" : "bps_rd_max_length" + }, + "bps_rd_max_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_wr_length" : { + "alias" : "bps_wr_max_length" + }, + "bps_wr_max_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "cache" : { + "description" : "The drive's cache mode", + "enum" : [ + "none", + "writethrough", + "writeback", + "unsafe", + "directsync" + ], + "optional" : 1, + "type" : "string" + }, + "cyls" : { + "description" : "Force the drive's physical geometry to have a specific cylinder count.", + "optional" : 1, + "type" : "integer" + }, + "detect_zeroes" : { + "description" : "Controls whether to detect and try to optimize writes of zeroes.", + "optional" : 1, + "type" : "boolean" + }, + "discard" : { + "description" : "Controls whether to pass discard/trim requests to the underlying storage.", + "enum" : [ + "ignore", + "on" + ], + "optional" : 1, + "type" : "string" + }, + "file" : { + "default_key" : 1, + "description" : "The drive's backing volume.", + "format" : "pve-volume-id-or-qm-path", + "format_description" : "volume", + "type" : "string" + }, + "format" : { + "description" : "The drive's backing file's data format.", + "enum" : [ + "raw", + "cow", + "qcow", + "qed", + "qcow2", + "vmdk", + "cloop" + ], + "optional" : 1, + "type" : "string" + }, + "heads" : { + "description" : "Force the drive's physical geometry to have a specific head count.", + "optional" : 1, + "type" : "integer" + }, + "iops" : { + "description" : "Maximum r/w I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_max" : { + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "iops_rd" : { + "description" : "Maximum read I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_rd_length" : { + "alias" : "iops_rd_max_length" + }, + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_rd_max_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "iops_wr" : { + "description" : "Maximum write I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_wr_length" : { + "alias" : "iops_wr_max_length" + }, + "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "iops_wr_max_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "iothread" : { + "description" : "Whether to use iothreads for this drive", + "optional" : 1, + "type" : "boolean" + }, + "mbps" : { + "description" : "Maximum r/w speed in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_max" : { + "description" : "Maximum unthrottled r/w pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_rd" : { + "description" : "Maximum read speed in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_rd_max" : { + "description" : "Maximum unthrottled read pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_wr" : { + "description" : "Maximum write speed in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "mbps_wr_max" : { + "description" : "Maximum unthrottled write pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "media" : { + "default" : "disk", + "description" : "The drive's media type.", + "enum" : [ + "cdrom", + "disk" + ], + "optional" : 1, + "type" : "string" + }, + "replicate" : { + "default" : 1, + "description" : "Whether the drive should considered for replication jobs.", + "optional" : 1, + "type" : "boolean" + }, + "rerror" : { + "description" : "Read error action.", + "enum" : [ + "ignore", + "report", + "stop" + ], + "optional" : 1, + "type" : "string" + }, + "secs" : { + "description" : "Force the drive's physical geometry to have a specific sector count.", + "optional" : 1, + "type" : "integer" + }, + "serial" : { + "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", + "format" : "urlencoded", + "format_description" : "serial", + "maxLength" : 60, + "optional" : 1, + "type" : "string" + }, + "shared" : { + "default" : 0, + "description" : "Mark this locally-managed volume as available on all nodes", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!" + }, + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", + "optional" : 1, + "type" : "string" + }, + "snapshot" : { + "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.", + "optional" : 1, + "type" : "boolean" + }, + "trans" : { + "description" : "Force disk geometry bios translation mode.", + "enum" : [ + "none", + "lba", + "auto" + ], + "optional" : 1, + "type" : "string" + }, + "volume" : { + "alias" : "file" + }, + "werror" : { + "description" : "Write error action.", + "enum" : [ + "enospc", + "ignore", + "report", + "stop" + ], + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "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=] [,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=]" + }, + "vmgenid" : { + "default" : "1 (autogenerated)", + "description" : "Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.", + "format_description" : "UUID", + "optional" : 1, + "pattern" : "(?:[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}|[01])", + "type" : "string", + "verbose_description" : "The VM generation ID (vmgenid) device exposes a 128-bit integer value identifier to the guest OS. This allows to notify the guest operating system when the virtual machine is executed with a different configuration (e.g. snapshot execution or creation from a template). The guest operating system notices the change, and is then able to react as appropriate by marking its copies of distributed databases as dirty, re-initializing its random number generator, etc.\nNote that auto-creation only works when done throug API/CLI create or update methods, but not when manually editing the config file." + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "vmstatestorage" : { + "description" : "Default storage for VM state volumes/files.", + "format" : "pve-storage-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "watchdog" : { + "description" : "Create a virtual hardware watchdog device.", + "format" : "pve-qm-watchdog", + "optional" : 1, + "type" : "string", + "typetext" : "[[model=]] [,action=]", + "verbose_description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Config.Disk", + "VM.Config.CDROM", + "VM.Config.CPU", + "VM.Config.Memory", + "VM.Config.Network", + "VM.Config.HWType", + "VM.Config.Options" + ], + "any", + 1 + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/config", + "text" : "config" + }, + { + "info" : { + "GET" : { + "description" : "Get virtual machine configuration, including pending changes.", + "method" : "GET", + "name" : "vm_pending", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "delete" : { + "description" : "Indicates a pending delete request if present and not 0. The value 2 indicates a force-delete request.", + "maximum" : 2, + "minimum" : 0, + "optional" : 1, + "type" : "integer" + }, + "key" : { + "description" : "Configuration option name.", + "type" : "string" + }, + "pending" : { + "description" : "Pending value.", + "optional" : 1, + "type" : "string" + }, + "value" : { + "description" : "Current value.", + "optional" : 1, + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/pending", + "text" : "pending" + }, + { + "info" : { + "PUT" : { + "description" : "Unlink/delete disk images.", + "method" : "PUT", + "name" : "unlink", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "force" : { + "description" : "Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "idlist" : { + "description" : "A list of disk IDs you want to delete.", + "format" : "pve-configid-list", + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Config.Disk" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/unlink", + "text" : "unlink" + }, + { + "info" : { + "POST" : { + "description" : "Creates a TCP VNC proxy connections.", + "method" : "POST", + "name" : "vncproxy", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "websocket" : { + "description" : "starts websockify instead of vncproxy", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Console" + ] + ] + }, + "protected" : 1, + "returns" : { + "additionalProperties" : 0, + "properties" : { + "cert" : { + "type" : "string" + }, + "port" : { + "type" : "integer" + }, + "ticket" : { + "type" : "string" + }, + "upid" : { + "type" : "string" + }, + "user" : { + "type" : "string" + } + } + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/vncproxy", + "text" : "vncproxy" + }, + { + "info" : { + "POST" : { + "description" : "Creates a TCP proxy connections.", + "method" : "POST", + "name" : "termproxy", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "serial" : { + "description" : "opens a serial terminal (defaults to display)", + "enum" : [ + "serial0", + "serial1", + "serial2", + "serial3" + ], + "optional" : 1, + "type" : "string" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Console" + ] + ] + }, + "protected" : 1, + "returns" : { + "additionalProperties" : 0, + "properties" : { + "port" : { + "type" : "integer" + }, + "ticket" : { + "type" : "string" + }, + "upid" : { + "type" : "string" + }, + "user" : { + "type" : "string" + } + } + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/termproxy", + "text" : "termproxy" + }, + { + "info" : { + "GET" : { + "description" : "Opens a weksocket for VNC traffic.", + "method" : "GET", + "name" : "vncwebsocket", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "port" : { + "description" : "Port number returned by previous vncproxy call.", + "maximum" : 5999, + "minimum" : 5900, + "type" : "integer", + "typetext" : " (5900 - 5999)" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "vncticket" : { + "description" : "Ticket from previous call to vncproxy.", + "maxLength" : 512, + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Console" + ] + ], + "description" : "You also need to pass a valid ticket (vncticket)." + }, + "returns" : { + "properties" : { + "port" : { + "type" : "string" + } + }, + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/vncwebsocket", + "text" : "vncwebsocket" + }, + { + "info" : { + "POST" : { + "description" : "Returns a SPICE configuration to connect to the VM.", + "method" : "POST", + "name" : "spiceproxy", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "proxy" : { + "description" : "SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).", + "format" : "address", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Console" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "additionalProperties" : 1, + "description" : "Returned values can be directly passed to the 'remote-viewer' application.", + "properties" : { + "host" : { + "type" : "string" + }, + "password" : { + "type" : "string" + }, + "proxy" : { + "type" : "string" + }, + "tls-port" : { + "type" : "integer" + }, + "type" : { + "type" : "string" + } + } + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/spiceproxy", + "text" : "spiceproxy" + }, + { + "children" : [ + { + "info" : { + "GET" : { + "description" : "Get virtual machine status.", + "method" : "GET", + "name" : "vm_status", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "properties" : { + "agent" : { + "description" : "Qemu GuestAgent enabled in config.", + "optional" : 1, + "type" : "boolean" + }, + "cpus" : { + "description" : "Maximum usable CPUs.", + "optional" : 1, + "type" : "number" + }, + "ha" : { + "description" : "HA manager service status.", + "type" : "object" + }, + "lock" : { + "description" : "The current config lock, if any.", + "optional" : 1, + "type" : "string" + }, + "maxdisk" : { + "description" : "Root disk size in bytes.", + "optional" : 1, + "renderer" : "bytes", + "type" : "integer" + }, + "maxmem" : { + "description" : "Maximum memory in bytes.", + "optional" : 1, + "renderer" : "bytes", + "type" : "integer" + }, + "name" : { + "description" : "VM name.", + "optional" : 1, + "type" : "string" + }, + "pid" : { + "description" : "PID of running qemu process.", + "optional" : 1, + "type" : "integer" + }, + "qmpstatus" : { + "description" : "Qemu QMP agent status.", + "optional" : 1, + "type" : "string" + }, + "spice" : { + "description" : "Qemu VGA configuration supports spice.", + "optional" : 1, + "type" : "boolean" + }, + "status" : { + "description" : "Qemu process status.", + "enum" : [ + "stopped", + "running" + ], + "type" : "string" + }, + "uptime" : { + "description" : "Uptime.", + "optional" : 1, + "renderer" : "duration", + "type" : "integer" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer" + } + }, + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/status/current", + "text" : "current" + }, + { + "info" : { + "POST" : { + "description" : "Start virtual machine.", + "method" : "POST", + "name" : "vm_start", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "machine" : { + "description" : "Specifies the Qemu machine type.", + "maxLength" : 40, + "optional" : 1, + "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)", + "type" : "string" + }, + "migratedfrom" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "migration_network" : { + "description" : "CIDR of the (sub) network that is used for migration.", + "format" : "CIDR", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "migration_type" : { + "description" : "Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.", + "enum" : [ + "secure", + "insecure" + ], + "optional" : 1, + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "skiplock" : { + "description" : "Ignore locks - only root is allowed to use this option.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "stateuri" : { + "description" : "Some command save/restore state from this location.", + "maxLength" : 128, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "targetstorage" : { + "description" : "Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.PowerMgmt" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/status/start", + "text" : "start" + }, + { + "info" : { + "POST" : { + "description" : "Stop virtual machine. The qemu process will exit immediately. Thisis akin to pulling the power plug of a running computer and may damage the VM data", + "method" : "POST", + "name" : "vm_stop", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "keepActive" : { + "default" : 0, + "description" : "Do not deactivate storage volumes.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "migratedfrom" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "skiplock" : { + "description" : "Ignore locks - only root is allowed to use this option.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "timeout" : { + "description" : "Wait maximal timeout seconds.", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.PowerMgmt" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/status/stop", + "text" : "stop" + }, + { + "info" : { + "POST" : { + "description" : "Reset virtual machine.", + "method" : "POST", + "name" : "vm_reset", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "skiplock" : { + "description" : "Ignore locks - only root is allowed to use this option.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.PowerMgmt" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/status/reset", + "text" : "reset" + }, + { + "info" : { + "POST" : { + "description" : "Shutdown virtual machine. This is similar to pressing the power button on a physical machine.This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown.", + "method" : "POST", + "name" : "vm_shutdown", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "forceStop" : { + "default" : 0, + "description" : "Make sure the VM stops.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "keepActive" : { + "default" : 0, + "description" : "Do not deactivate storage volumes.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "skiplock" : { + "description" : "Ignore locks - only root is allowed to use this option.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "timeout" : { + "description" : "Wait maximal timeout seconds.", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.PowerMgmt" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/status/shutdown", + "text" : "shutdown" + }, + { + "info" : { + "POST" : { + "description" : "Suspend virtual machine.", + "method" : "POST", + "name" : "vm_suspend", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "skiplock" : { + "description" : "Ignore locks - only root is allowed to use this option.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "statestorage" : { + "description" : "The storage for the VM state", + "format" : "pve-storage-id", + "optional" : 1, + "requires" : "todisk", + "type" : "string", + "typetext" : "" + }, + "todisk" : { + "default" : 0, + "description" : "If set, suspends the VM to disk. Will be resumed on next VM start.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.PowerMgmt" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/status/suspend", + "text" : "suspend" + }, + { + "info" : { + "POST" : { + "description" : "Resume virtual machine.", + "method" : "POST", + "name" : "vm_resume", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "nocheck" : { + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "skiplock" : { + "description" : "Ignore locks - only root is allowed to use this option.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.PowerMgmt" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/status/resume", + "text" : "resume" + } + ], + "info" : { + "GET" : { + "description" : "Directory index", + "method" : "GET", + "name" : "vmcmdidx", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "user" : "all" + }, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "subdir" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{subdir}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/qemu/{vmid}/status", + "text" : "status" + }, + { + "info" : { + "PUT" : { + "description" : "Send key event to virtual machine.", + "method" : "PUT", + "name" : "vm_sendkey", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "key" : { + "description" : "The key (qemu monitor encoding).", + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "skiplock" : { + "description" : "Ignore locks - only root is allowed to use this option.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Console" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/sendkey", + "text" : "sendkey" + }, + { + "info" : { + "GET" : { + "description" : "Check if feature for virtual machine is available.", + "method" : "GET", + "name" : "vm_feature", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "feature" : { + "description" : "Feature to check.", + "enum" : [ + "snapshot", + "clone", + "copy" + ], + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "properties" : { + "hasFeature" : { + "type" : "boolean" + }, + "nodes" : { + "items" : { + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/feature", + "text" : "feature" + }, + { + "info" : { + "POST" : { + "description" : "Create a copy of virtual machine/template.", + "method" : "POST", + "name" : "clone_vm", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "bwlimit" : { + "default" : "clone limit from datacenter or storage config", + "description" : "Override I/O bandwidth limit (in KiB/s).", + "minimum" : "0", + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "description" : { + "description" : "Description for the new VM.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "format" : { + "description" : "Target format for file storage. Only valid for full clone.", + "enum" : [ + "raw", + "qcow2", + "vmdk" + ], + "optional" : 1, + "type" : "string" + }, + "full" : { + "description" : "Create a full copy of all disks. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "name" : { + "description" : "Set a name for the new VM.", + "format" : "dns-name", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "newid" : { + "description" : "VMID for the clone.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "pool" : { + "description" : "Add the new VM to the specified pool.", + "format" : "pve-poolid", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "storage" : { + "description" : "Target storage for full clone.", + "format" : "pve-storage-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "target" : { + "description" : "Target node. Only allowed if the original VM is on shared storage.", + "format" : "pve-node", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "and", + [ + "perm", + "/vms/{vmid}", + [ + "VM.Clone" + ] + ], + [ + "or", + [ + "perm", + "/vms/{newid}", + [ + "VM.Allocate" + ] + ], + [ + "perm", + "/pool/{pool}", + [ + "VM.Allocate" + ], + "require_param", + "pool" + ] + ] + ], + "description" : "You need 'VM.Clone' permissions on /vms/{vmid}, and 'VM.Allocate' permissions on /vms/{newid} (or on the VM pool /pool/{pool}). You also need 'Datastore.AllocateSpace' on any used storage." + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/clone", + "text" : "clone" + }, + { + "info" : { + "POST" : { + "description" : "Move volume to different storage.", + "method" : "POST", + "name" : "move_vm_disk", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "bwlimit" : { + "default" : "move limit from datacenter or storage config", + "description" : "Override I/O bandwidth limit (in KiB/s).", + "minimum" : "0", + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "delete" : { + "default" : 0, + "description" : "Delete the original disk after successful copy. By default the original disk is kept as unused disk.", + "optional" : 1, + "type" : "boolean", + "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" : "" + }, + "disk" : { + "description" : "The disk you want to move.", + "enum" : [ + "ide0", + "ide1", + "ide2", + "ide3", + "scsi0", + "scsi1", + "scsi2", + "scsi3", + "scsi4", + "scsi5", + "scsi6", + "scsi7", + "scsi8", + "scsi9", + "scsi10", + "scsi11", + "scsi12", + "scsi13", + "virtio0", + "virtio1", + "virtio2", + "virtio3", + "virtio4", + "virtio5", + "virtio6", + "virtio7", + "virtio8", + "virtio9", + "virtio10", + "virtio11", + "virtio12", + "virtio13", + "virtio14", + "virtio15", + "sata0", + "sata1", + "sata2", + "sata3", + "sata4", + "sata5", + "efidisk0" + ], + "type" : "string" + }, + "format" : { + "description" : "Target Format.", + "enum" : [ + "raw", + "qcow2", + "vmdk" + ], + "optional" : 1, + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "storage" : { + "description" : "Target storage.", + "format" : "pve-storage-id", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "and", + [ + "perm", + "/vms/{vmid}", + [ + "VM.Config.Disk" + ] + ], + [ + "perm", + "/storage/{storage}", + [ + "Datastore.AllocateSpace" + ] + ] + ], + "description" : "You need 'VM.Config.Disk' permissions on /vms/{vmid}, and 'Datastore.AllocateSpace' permissions on the storage." + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "the task ID.", + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/move_disk", + "text" : "move_disk" + }, + { + "info" : { + "GET" : { + "description" : "Get preconditions for migration.", + "method" : "GET", + "name" : "migrate_vm_precondition", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "target" : { + "description" : "Target node.", + "format" : "pve-node", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Migrate" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "properties" : { + "allowed_nodes" : { + "description" : "List nodes allowed for offline migration, only passed if VM is offline", + "optional" : 1, + "type" : "array" + }, + "local_disks" : { + "description" : "List local disks including CD-Rom, unsused and not referenced disks", + "type" : "array" + }, + "local_resources" : { + "description" : "List local resources e.g. pci, usb", + "type" : "array" + }, + "not_allowed_nodes" : { + "description" : "List not allowed nodes with additional informations, only passed if VM is offline", + "optional" : 1, + "type" : "object" + }, + "running" : { + "type" : "boolean" + } + }, + "type" : "object" + } + }, + "POST" : { + "description" : "Migrate virtual machine. Creates a new migration task.", + "method" : "POST", + "name" : "migrate_vm", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "bwlimit" : { + "default" : "migrate limit from datacenter or storage config", + "description" : "Override I/O bandwidth limit (in KiB/s).", + "minimum" : "0", + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "force" : { + "description" : "Allow to migrate VMs which use local devices. Only root may use this option.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "migration_network" : { + "description" : "CIDR of the (sub) network that is used for migration.", + "format" : "CIDR", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "migration_type" : { + "description" : "Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.", + "enum" : [ + "secure", + "insecure" + ], + "optional" : 1, + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "online" : { + "description" : "Use online/live migration.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "target" : { + "description" : "Target node.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "targetstorage" : { + "description" : "Default target storage.", + "format" : "pve-storage-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "with-local-disks" : { + "description" : "Enable live storage migration for local disk", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Migrate" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "the task ID.", + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/migrate", + "text" : "migrate" + }, + { + "info" : { + "POST" : { + "description" : "Execute Qemu monitor commands.", + "method" : "POST", + "name" : "monitor", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "command" : { + "description" : "The monitor command.", + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Monitor" + ] + ], + "description" : "Sys.Modify is required for (sub)commands which are not read-only ('info *' and 'help')" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/monitor", + "text" : "monitor" + }, + { + "info" : { + "PUT" : { + "description" : "Extend volume size.", + "method" : "PUT", + "name" : "resize_vm", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "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" : "" + }, + "disk" : { + "description" : "The disk you want to resize.", + "enum" : [ + "ide0", + "ide1", + "ide2", + "ide3", + "scsi0", + "scsi1", + "scsi2", + "scsi3", + "scsi4", + "scsi5", + "scsi6", + "scsi7", + "scsi8", + "scsi9", + "scsi10", + "scsi11", + "scsi12", + "scsi13", + "virtio0", + "virtio1", + "virtio2", + "virtio3", + "virtio4", + "virtio5", + "virtio6", + "virtio7", + "virtio8", + "virtio9", + "virtio10", + "virtio11", + "virtio12", + "virtio13", + "virtio14", + "virtio15", + "sata0", + "sata1", + "sata2", + "sata3", + "sata4", + "sata5", + "efidisk0" + ], + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "size" : { + "description" : "The new size. With the `+` sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.", + "pattern" : "\\+?\\d+(\\.\\d+)?[KMGT]?", + "type" : "string" + }, + "skiplock" : { + "description" : "Ignore locks - only root is allowed to use this option.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Config.Disk" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/resize", + "text" : "resize" + }, + { + "children" : [ + { + "children" : [ + { + "info" : { + "GET" : { + "description" : "Get snapshot configuration", + "method" : "GET", + "name" : "get_snapshot_config", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Snapshot", + "VM.Snapshot.Rollback" + ], + "any", + 1 + ] + }, + "proxyto" : "node", + "returns" : { + "type" : "object" + } + }, + "PUT" : { + "description" : "Update snapshot metadata.", + "method" : "PUT", + "name" : "update_snapshot_config", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "description" : { + "description" : "A textual description or comment.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Snapshot" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config", + "text" : "config" + }, + { + "info" : { + "POST" : { + "description" : "Rollback VM state to specified snapshot.", + "method" : "POST", + "name" : "rollback", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Snapshot", + "VM.Snapshot.Rollback" + ], + "any", + 1 + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "the task ID.", + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}/rollback", + "text" : "rollback" + } + ], + "info" : { + "DELETE" : { + "description" : "Delete a VM snapshot.", + "method" : "DELETE", + "name" : "delsnapshot", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "force" : { + "description" : "For removal from config file, even if removing disk snapshots fails.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Snapshot" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "the task ID.", + "type" : "string" + } + }, + "GET" : { + "description" : "", + "method" : "GET", + "name" : "snapshot_cmd_idx", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{cmd}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}", + "text" : "{snapname}" + } + ], + "info" : { + "GET" : { + "description" : "List all snapshots.", + "method" : "GET", + "name" : "snapshot_list", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "description" : { + "description" : "Snapshot description.", + "type" : "string" + }, + "name" : { + "description" : "Snapshot identifier. Value 'current' identifies the current VM.", + "type" : "string" + }, + "parent" : { + "description" : "Parent snapshot identifier.", + "optional" : 1, + "type" : "string" + }, + "snaptime" : { + "description" : "Snapshot creation time", + "optional" : 1, + "renderer" : "timestamp", + "type" : "integer" + }, + "vmstate" : { + "description" : "Snapshot includes RAM.", + "optional" : 1, + "type" : "boolean" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "description" : "Snapshot a VM.", + "method" : "POST", + "name" : "snapshot", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "description" : { + "description" : "A textual description or comment.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "vmstate" : { + "description" : "Save the vmstate", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Snapshot" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "the task ID.", + "type" : "string" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/qemu/{vmid}/snapshot", + "text" : "snapshot" + }, + { + "info" : { + "POST" : { + "description" : "Create a Template.", + "method" : "POST", + "name" : "template", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "disk" : { + "description" : "If you want to convert only 1 disk to base image.", + "enum" : [ + "ide0", + "ide1", + "ide2", + "ide3", + "scsi0", + "scsi1", + "scsi2", + "scsi3", + "scsi4", + "scsi5", + "scsi6", + "scsi7", + "scsi8", + "scsi9", + "scsi10", + "scsi11", + "scsi12", + "scsi13", + "virtio0", + "virtio1", + "virtio2", + "virtio3", + "virtio4", + "virtio5", + "virtio6", + "virtio7", + "virtio8", + "virtio9", + "virtio10", + "virtio11", + "virtio12", + "virtio13", + "virtio14", + "virtio15", + "sata0", + "sata1", + "sata2", + "sata3", + "sata4", + "sata5", + "efidisk0" + ], + "optional" : 1, + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Allocate" + ] + ], + "description" : "You need 'VM.Allocate' permissions on /vms/{vmid}" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/template", + "text" : "template" + }, + { + "children" : [ + { + "info" : { + "GET" : { + "description" : "Get automatically generated cloudinit config.", + "method" : "GET", + "name" : "cloudinit_generated_config_dump", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "type" : { + "description" : "Config type.", + "enum" : [ + "user", + "network", + "meta" + ], + "type" : "string" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/cloudinit/dump", + "text" : "dump" + } + ], + "leaf" : 0, + "path" : "/nodes/{node}/qemu/{vmid}/cloudinit", + "text" : "cloudinit" + } + ], + "info" : { + "DELETE" : { + "description" : "Destroy the vm (also delete all used/owned volumes).", + "method" : "DELETE", + "name" : "destroy_vm", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "skiplock" : { + "description" : "Ignore locks - only root is allowed to use this option.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Allocate" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + }, + "GET" : { + "description" : "Directory index", + "method" : "GET", + "name" : "vmdiridx", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "user" : "all" + }, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "subdir" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{subdir}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/qemu/{vmid}", + "text" : "{vmid}" + } ], "info" : { "GET" : { @@ -11911,7 +17404,65 @@ var pveapi = [ "proxyto" : "node", "returns" : { "items" : { - "properties" : {}, + "properties" : { + "cpus" : { + "description" : "Maximum usable CPUs.", + "optional" : 1, + "type" : "number" + }, + "lock" : { + "description" : "The current config lock, if any.", + "optional" : 1, + "type" : "string" + }, + "maxdisk" : { + "description" : "Root disk size in bytes.", + "optional" : 1, + "renderer" : "bytes", + "type" : "integer" + }, + "maxmem" : { + "description" : "Maximum memory in bytes.", + "optional" : 1, + "renderer" : "bytes", + "type" : "integer" + }, + "name" : { + "description" : "VM name.", + "optional" : 1, + "type" : "string" + }, + "pid" : { + "description" : "PID of running qemu process.", + "optional" : 1, + "type" : "integer" + }, + "qmpstatus" : { + "description" : "Qemu QMP agent status.", + "optional" : 1, + "type" : "string" + }, + "status" : { + "description" : "Qemu process status.", + "enum" : [ + "stopped", + "running" + ], + "type" : "string" + }, + "uptime" : { + "description" : "Uptime.", + "optional" : 1, + "renderer" : "duration", + "type" : "integer" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer" + } + }, "type" : "object" }, "links" : [ @@ -11938,11 +17489,33 @@ var pveapi = [ "typetext" : "" }, "agent" : { - "default" : 0, - "description" : "Enable/disable Qemu GuestAgent.", + "description" : "Enable/disable Qemu GuestAgent and its properties.", + "format" : { + "enabled" : { + "default" : 0, + "default_key" : 1, + "description" : "Enable/disable Qemu GuestAgent.", + "type" : "boolean" + }, + "fstrim_cloned_disks" : { + "default" : 0, + "description" : "Run fstrim after cloning/moving a disk.", + "optional" : 1, + "type" : "boolean" + } + }, "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "string", + "typetext" : "[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]" + }, + "arch" : { + "description" : "Virtual processor architecture. Defaults to the host.", + "enum" : [ + "x86_64", + "aarch64" + ], + "optional" : 1, + "type" : "string" }, "archive" : { "description" : "The backup file.", @@ -11996,6 +17569,14 @@ var pveapi = [ "pattern" : "(ide|sata|scsi|virtio)\\d+", "type" : "string" }, + "bwlimit" : { + "default" : "restore limit from datacenter or storage config", + "description" : "Override I/O bandwidth limit (in KiB/s).", + "minimum" : "0", + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, "cdrom" : { "description" : "This is an alias for option -ide2", "format" : "pve-qm-ide", @@ -12003,6 +17584,34 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "cicustom" : { + "description" : "cloud-init: Specify custom files to replace the automatically generated ones at start.", + "format" : "pve-qm-cicustom", + "optional" : 1, + "type" : "string", + "typetext" : "[meta=] [,network=] [,user=]" + }, + "cipassword" : { + "description" : "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.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "citype" : { + "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" + ], + "optional" : 1, + "type" : "string" + }, + "ciuser" : { + "description" : "cloud-init: User name to change ssh keys and password for instead of the image's configured default user.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "cores" : { "default" : 1, "description" : "The number of cores per socket.", @@ -12028,6 +17637,8 @@ var pveapi = [ "Conroe", "core2duo", "coreduo", + "EPYC", + "EPYC-IBPB", "Haswell", "Haswell-IBRS", "Haswell-noTSX", @@ -12064,10 +17675,10 @@ var pveapi = [ "type" : "string" }, "flags" : { - "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl'.", + "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'.", "format_description" : "+FLAG[;-FLAG...]", "optional" : 1, - "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl))(;(?^:[+-](pcid|spec-ctrl)))*)", + "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear)))*)", "type" : "string" }, "hidden" : { @@ -12075,11 +17686,18 @@ var pveapi = [ "description" : "Do not identify as a KVM virtual machine.", "optional" : 1, "type" : "boolean" + }, + "hv-vendor-id" : { + "description" : "The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.", + "format_description" : "vendor-id", + "optional" : 1, + "pattern" : "(?^:[a-zA-Z0-9]{1,12})", + "type" : "string" } }, "optional" : 1, "type" : "string", - "typetext" : "[cputype=] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]" + "typetext" : "[cputype=] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=]" }, "cpulimit" : { "default" : 0, @@ -12105,7 +17723,46 @@ var pveapi = [ "description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" + }, + "efidisk0" : { + "description" : "Configure a Disk for storing EFI vars", + "format" : { + "file" : { + "default_key" : 1, + "description" : "The drive's backing volume.", + "format" : "pve-volume-id-or-qm-path", + "format_description" : "volume", + "type" : "string" + }, + "format" : { + "description" : "The drive's backing file's data format.", + "enum" : [ + "raw", + "cow", + "qcow", + "qed", + "qcow2", + "vmdk", + "cloop" + ], + "optional" : 1, + "type" : "string" + }, + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", + "optional" : 1, + "type" : "string" + }, + "volume" : { + "alias" : "file" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[file=] [,format=] [,size=]" }, "force" : { "description" : "Allow to overwrite existing VM.", @@ -12120,13 +17777,20 @@ var pveapi = [ "type" : "boolean", "typetext" : "" }, + "hookscript" : { + "description" : "Script that will be executed during various steps in the vms lifetime.", + "format" : "pve-volume-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "hostpci[n]" : { "description" : "Map host PCI devices into guest.", "format" : "pve-qm-hostpci", "optional" : 1, "type" : "string", - "typetext" : "[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]", - "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer \npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" + "typetext" : "[host=] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]", + "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer\npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" }, "hotplug" : { "default" : "network,disk,usb", @@ -12411,6 +18075,13 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "shared" : { + "default" : 0, + "description" : "Mark this locally-managed volume as available on all nodes", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!" + }, "size" : { "description" : "Disk size. This is purely informational and has no effect.", "format" : "disk-size", @@ -12419,7 +18090,12 @@ var pveapi = [ "type" : "string" }, "snapshot" : { - "description" : "Whether the drive should be included when making snapshots.", + "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.", + "optional" : 1, + "type" : "boolean" + }, + "ssd" : { + "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.", "optional" : 1, "type" : "boolean" }, @@ -12446,15 +18122,49 @@ var pveapi = [ ], "optional" : 1, "type" : "string" + }, + "wwn" : { + "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.", + "format_description" : "wwn", + "optional" : 1, + "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})", + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "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 gateway 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 dhcp on IPv4.\n", + "format" : "pve-qm-ipconfig", + "optional" : 1, + "type" : "string", + "typetext" : "[gw=] [,gw6=] [,ip=] [,ip6=]" + }, + "ivshmem" : { + "description" : "Inter-VM shared memory. Useful for direct communication between VMs, or to the host.", + "format" : { + "name" : { + "description" : "The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.", + "format_description" : "string", + "optional" : 1, + "pattern" : "[a-zA-Z0-9\\-]+", + "type" : "string" + }, + "size" : { + "description" : "The size of the file in MB.", + "minimum" : 1, + "type" : "integer" } }, "optional" : 1, "type" : "string", - "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=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "size= [,name=]" }, "keyboard" : { "default" : null, - "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.", + "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.", "enum" : [ "de", "de-ch", @@ -12501,19 +18211,24 @@ var pveapi = [ "lock" : { "description" : "Lock/unlock the VM.", "enum" : [ - "migrate", "backup", + "clone", + "create", + "migrate", + "rollback", "snapshot", - "rollback" + "snapshot-delete", + "suspending", + "suspended" ], "optional" : 1, "type" : "string" }, "machine" : { - "description" : "Specific the Qemu machine type.", + "description" : "Specifies the Qemu machine type.", "maxLength" : 40, "optional" : 1, - "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?)", + "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)", "type" : "string" }, "memory" : { @@ -12547,6 +18262,13 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "nameserver" : { + "description" : "cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.", + "format" : "address-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "net[n]" : { "description" : "Specify network devices.", "format" : { @@ -12596,10 +18318,11 @@ var pveapi = [ }, "macaddr" : { "description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.", + "format" : "mac-addr", "format_description" : "XX:XX:XX:XX:XX:XX", "optional" : 1, - "pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})", - "type" : "string" + "type" : "string", + "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set." }, "model" : { "default_key" : 1, @@ -13038,6 +18761,13 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "shared" : { + "default" : 0, + "description" : "Mark this locally-managed volume as available on all nodes", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!" + }, "size" : { "description" : "Disk size. This is purely informational and has no effect.", "format" : "disk-size", @@ -13046,7 +18776,12 @@ var pveapi = [ "type" : "string" }, "snapshot" : { - "description" : "Whether the drive should be included when making snapshots.", + "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.", + "optional" : 1, + "type" : "boolean" + }, + "ssd" : { + "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.", "optional" : 1, "type" : "boolean" }, @@ -13073,11 +18808,18 @@ var pveapi = [ ], "optional" : 1, "type" : "string" + }, + "wwn" : { + "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.", + "format_description" : "wwn", + "optional" : 1, + "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})", + "type" : "string" } }, "optional" : 1, "type" : "string", - "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=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "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 13).", @@ -13353,6 +19095,13 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "shared" : { + "default" : 0, + "description" : "Mark this locally-managed volume as available on all nodes", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!" + }, "size" : { "description" : "Disk size. This is purely informational and has no effect.", "format" : "disk-size", @@ -13361,7 +19110,12 @@ var pveapi = [ "type" : "string" }, "snapshot" : { - "description" : "Whether the drive should be included when making snapshots.", + "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.", + "optional" : 1, + "type" : "boolean" + }, + "ssd" : { + "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.", "optional" : 1, "type" : "boolean" }, @@ -13388,11 +19142,18 @@ var pveapi = [ ], "optional" : 1, "type" : "string" + }, + "wwn" : { + "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.", + "format_description" : "wwn", + "optional" : 1, + "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})", + "type" : "string" } }, "optional" : 1, "type" : "string", - "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=] [,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=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "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=] [,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=]" }, "scsihw" : { "default" : "lsi", @@ -13408,6 +19169,12 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "searchdomain" : { + "description" : "cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "serial[n]" : { "description" : "Create a serial device inside the VM (n is 0 to 3)", "optional" : 1, @@ -13417,7 +19184,7 @@ var pveapi = [ }, "shares" : { "default" : 1000, - "description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning", + "description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.", "maximum" : 50000, "minimum" : 0, "optional" : 1, @@ -13427,10 +19194,10 @@ var pveapi = [ "smbios1" : { "description" : "Specify SMBIOS type 1 fields.", "format" : "pve-qm-smbios1", - "maxLength" : 256, + "maxLength" : 512, "optional" : 1, "type" : "string", - "typetext" : "[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]" + "typetext" : "[base64=<1|0>] [,family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]" }, "smp" : { "default" : 1, @@ -13448,6 +19215,20 @@ var pveapi = [ "type" : "integer", "typetext" : " (1 - N)" }, + "sshkeys" : { + "description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).", + "format" : "urlencoded", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "start" : { + "default" : 0, + "description" : "Start VM after it was created successfully.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "startdate" : { "default" : "now", "description" : "Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.", @@ -13536,23 +19317,42 @@ var pveapi = [ "typetext" : " (1 - N)" }, "vga" : { - "description" : "Select the VGA type.", - "enum" : [ - "std", - "cirrus", - "vmware", - "qxl", - "serial0", - "serial1", - "serial2", - "serial3", - "qxl2", - "qxl3", - "qxl4" - ], + "description" : "Configure the VGA hardware.", + "format" : { + "memory" : { + "description" : "Sets the VGA memory (in MiB). Has no effect with serial display.", + "maximum" : 512, + "minimum" : 4, + "optional" : 1, + "type" : "integer" + }, + "type" : { + "default" : "std", + "default_key" : 1, + "description" : "Select the VGA type.", + "enum" : [ + "cirrus", + "qxl", + "qxl2", + "qxl3", + "qxl4", + "none", + "serial0", + "serial1", + "serial2", + "serial3", + "std", + "virtio", + "vmware" + ], + "optional" : 1, + "type" : "string" + } + }, "optional" : 1, "type" : "string", - "verbose_description" : "Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal." + "typetext" : "[[type=]] [,memory=]", + "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).", @@ -13816,6 +19616,13 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "shared" : { + "default" : 0, + "description" : "Mark this locally-managed volume as available on all nodes", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!" + }, "size" : { "description" : "Disk size. This is purely informational and has no effect.", "format" : "disk-size", @@ -13824,7 +19631,7 @@ var pveapi = [ "type" : "string" }, "snapshot" : { - "description" : "Whether the drive should be included when making snapshots.", + "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.", "optional" : 1, "type" : "boolean" }, @@ -13855,7 +19662,16 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "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=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "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=] [,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=]" + }, + "vmgenid" : { + "default" : "1 (autogenerated)", + "description" : "Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.", + "format_description" : "UUID", + "optional" : 1, + "pattern" : "(?:[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}|[01])", + "type" : "string", + "verbose_description" : "The VM generation ID (vmgenid) device exposes a 128-bit integer value identifier to the guest OS. This allows to notify the guest operating system when the virtual machine is executed with a different configuration (e.g. snapshot execution or creation from a template). The guest operating system notices the change, and is then able to react as appropriate by marking its copies of distributed databases as dirty, re-initializing its random number generator, etc.\nNote that auto-creation only works when done throug API/CLI create or update methods, but not when manually editing the config file." }, "vmid" : { "description" : "The (unique) ID of the VM.", @@ -13913,31 +19729,461 @@ var pveapi = [ "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", - "typetext" : "" + "typetext" : "" + }, + "snapshot" : { + "description" : "Fetch config values from given snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "proxyto" : "node", + "returns" : { + "properties" : { + "arch" : { + "default" : "amd64", + "description" : "OS architecture type.", + "enum" : [ + "amd64", + "i386", + "arm64", + "armhf" + ], + "optional" : 1, + "type" : "string" + }, + "cmode" : { + "default" : "tty", + "description" : "Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).", + "enum" : [ + "shell", + "console", + "tty" + ], + "optional" : 1, + "type" : "string" + }, + "console" : { + "default" : 1, + "description" : "Attach a console device (/dev/console) to the container.", + "optional" : 1, + "type" : "boolean" + }, + "cores" : { + "description" : "The number of cores assigned to the container. A container can use all available cores by default.", + "maximum" : 128, + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "cpulimit" : { + "default" : 0, + "description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.", + "maximum" : 128, + "minimum" : 0, + "optional" : 1, + "type" : "number" + }, + "cpuunits" : { + "default" : 1024, + "description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0.", + "maximum" : 500000, + "minimum" : 0, + "optional" : 1, + "type" : "integer" + }, + "description" : { + "description" : "Container description. Only used on the configuration web interface.", + "optional" : 1, + "type" : "string" + }, + "digest" : { + "description" : "SHA1 digest of configuration file. This can be used to prevent concurrent modifications.", + "type" : "string" + }, + "features" : { + "description" : "Allow containers access to advanced features.", + "format" : { + "fuse" : { + "default" : 0, + "description" : "Allow using 'fuse' file systems in a container. Note that interactions between fuse and the freezer cgroup can potentially cause I/O deadlocks.", + "optional" : 1, + "type" : "boolean" + }, + "keyctl" : { + "default" : 0, + "description" : "For unprivileged containers only: Allow the use of the keyctl() system call. This is required to use docker inside a container. By default unprivileged containers will see this system call as non-existent. This is mostly a workaround for systemd-networkd, as it will treat it as a fatal error when some keyctl() operations are denied by the kernel due to lacking permissions. Essentially, you can choose between running systemd-networkd or docker.", + "optional" : 1, + "type" : "boolean" + }, + "mount" : { + "description" : "Allow mounting file systems of specific types. This should be a list of file system types as used with the mount command. Note that this can have negative effects on the container's security. With access to a loop device, mounting a file can circumvent the mknod permission of the devices cgroup, mounting an NFS file system can block the host's I/O completely and prevent it from rebooting, etc.", + "format_description" : "fstype;fstype;...", + "optional" : 1, + "pattern" : "(?^:[a-zA-Z0-9_; ]+)", + "type" : "string" + }, + "nesting" : { + "default" : 0, + "description" : "Allow nesting. Best used with unprivileged containers with additional id mapping. Note that this will expose procfs and sysfs contents of the host to the guest.", + "optional" : 1, + "type" : "boolean" + } + }, + "optional" : 1, + "type" : "string" + }, + "hookscript" : { + "description" : "Script that will be exectued during various steps in the containers lifetime.", + "format" : "pve-volume-id", + "optional" : 1, + "type" : "string" + }, + "hostname" : { + "description" : "Set a host name for the container.", + "format" : "dns-name", + "maxLength" : 255, + "optional" : 1, + "type" : "string" + }, + "lock" : { + "description" : "Lock/unlock the VM.", + "enum" : [ + "backup", + "create", + "disk", + "fstrim", + "migrate", + "mounted", + "rollback", + "snapshot", + "snapshot-delete" + ], + "optional" : 1, + "type" : "string" + }, + "lxc" : { + "description" : "Array of lxc low-level configurations ([[key1, value1], [key2, value2] ...]).", + "items" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "optional" : 1, + "type" : "array" + }, + "memory" : { + "default" : 512, + "description" : "Amount of RAM for the VM in MB.", + "minimum" : 16, + "optional" : 1, + "type" : "integer" + }, + "mp[n]" : { + "description" : "Use volume as container mount point.", + "format" : { + "acl" : { + "description" : "Explicitly enable or disable ACL support.", + "optional" : 1, + "type" : "boolean" + }, + "backup" : { + "description" : "Whether to include the mount point in backups.", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Whether to include the mount point in backups (only used for volume mount points)." + }, + "mp" : { + "description" : "Path to the mount point as seen from inside the container (must not contain symlinks).", + "format" : "pve-lxc-mp-string", + "format_description" : "Path", + "type" : "string", + "verbose_description" : "Path to the mount point as seen from inside the container.\n\nNOTE: Must not contain any symlinks for security reasons." + }, + "quota" : { + "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)", + "optional" : 1, + "type" : "boolean" + }, + "replicate" : { + "default" : 1, + "description" : "Will include this volume to a storage replica job.", + "optional" : 1, + "type" : "boolean" + }, + "ro" : { + "description" : "Read-only mount point", + "optional" : 1, + "type" : "boolean" + }, + "shared" : { + "default" : 0, + "description" : "Mark this non-volume mount point as available on multiple nodes (see 'nodes')", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this non-volume mount point as available on all nodes.\n\nWARNING: This option does not share the mount point automatically, it assumes it is shared already!" + }, + "size" : { + "description" : "Volume size (read only value).", + "format" : "disk-size", + "format_description" : "DiskSize", + "optional" : 1, + "type" : "string" + }, + "volume" : { + "default_key" : 1, + "description" : "Volume, device or directory to mount into the container.", + "format" : "pve-lxc-mp-string", + "format_description" : "volume", + "type" : "string" + } + }, + "optional" : 1, + "type" : "string" + }, + "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", + "optional" : 1, + "type" : "string" + }, + "net[n]" : { + "description" : "Specifies network interfaces for the container.", + "format" : { + "bridge" : { + "description" : "Bridge to attach the network device to.", + "format_description" : "bridge", + "optional" : 1, + "pattern" : "[-_.\\w\\d]+", + "type" : "string" + }, + "firewall" : { + "description" : "Controls whether this interface's firewall rules should be used.", + "optional" : 1, + "type" : "boolean" + }, + "gw" : { + "description" : "Default gateway for IPv4 traffic.", + "format" : "ipv4", + "format_description" : "GatewayIPv4", + "optional" : 1, + "type" : "string" + }, + "gw6" : { + "description" : "Default gateway for IPv6 traffic.", + "format" : "ipv6", + "format_description" : "GatewayIPv6", + "optional" : 1, + "type" : "string" + }, + "hwaddr" : { + "description" : "The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)", + "format" : "mac-addr", + "format_description" : "XX:XX:XX:XX:XX:XX", + "optional" : 1, + "type" : "string", + "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set." + }, + "ip" : { + "description" : "IPv4 address in CIDR format.", + "format" : "pve-ipv4-config", + "format_description" : "(IPv4/CIDR|dhcp|manual)", + "optional" : 1, + "type" : "string" + }, + "ip6" : { + "description" : "IPv6 address in CIDR format.", + "format" : "pve-ipv6-config", + "format_description" : "(IPv6/CIDR|auto|dhcp|manual)", + "optional" : 1, + "type" : "string" + }, + "mtu" : { + "description" : "Maximum transfer unit of the interface. (lxc.network.mtu)", + "minimum" : 64, + "optional" : 1, + "type" : "integer" + }, + "name" : { + "description" : "Name of the network device as seen from inside the container. (lxc.network.name)", + "format_description" : "string", + "pattern" : "[-_.\\w\\d]+", + "type" : "string" + }, + "rate" : { + "description" : "Apply rate limiting to the interface", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "tag" : { + "description" : "VLAN tag for this interface.", + "maximum" : 4094, + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "trunks" : { + "description" : "VLAN ids to pass through the interface", + "format_description" : "vlanid[;vlanid...]", + "optional" : 1, + "pattern" : "(?^:\\d+(?:;\\d+)*)", + "type" : "string" + }, + "type" : { + "description" : "Network interface type.", + "enum" : [ + "veth" + ], + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string" + }, + "onboot" : { + "default" : 0, + "description" : "Specifies whether a VM will be started during system bootup.", + "optional" : 1, + "type" : "boolean" + }, + "ostype" : { + "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", + "ubuntu", + "centos", + "fedora", + "opensuse", + "archlinux", + "alpine", + "gentoo", + "unmanaged" + ], + "optional" : 1, + "type" : "string" + }, + "protection" : { + "default" : 0, + "description" : "Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.", + "optional" : 1, + "type" : "boolean" + }, + "rootfs" : { + "description" : "Use volume as container root.", + "format" : { + "acl" : { + "description" : "Explicitly enable or disable ACL support.", + "optional" : 1, + "type" : "boolean" + }, + "quota" : { + "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)", + "optional" : 1, + "type" : "boolean" + }, + "replicate" : { + "default" : 1, + "description" : "Will include this volume to a storage replica job.", + "optional" : 1, + "type" : "boolean" + }, + "ro" : { + "description" : "Read-only mount point", + "optional" : 1, + "type" : "boolean" + }, + "shared" : { + "default" : 0, + "description" : "Mark this non-volume mount point as available on multiple nodes (see 'nodes')", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this non-volume mount point as available on all nodes.\n\nWARNING: This option does not share the mount point automatically, it assumes it is shared already!" + }, + "size" : { + "description" : "Volume size (read only value).", + "format" : "disk-size", + "format_description" : "DiskSize", + "optional" : 1, + "type" : "string" + }, + "volume" : { + "default_key" : 1, + "description" : "Volume, device or directory to mount into the container.", + "format" : "pve-lxc-mp-string", + "format_description" : "volume", + "type" : "string" + } + }, + "optional" : 1, + "type" : "string" + }, + "searchdomain" : { + "description" : "Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.", + "format" : "dns-name-list", + "optional" : 1, + "type" : "string" + }, + "startup" : { + "description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.", + "format" : "pve-startup-order", + "optional" : 1, + "type" : "string", + "typetext" : "[[order=]\\d+] [,up=\\d+] [,down=\\d+] " + }, + "swap" : { + "default" : 512, + "description" : "Amount of SWAP for the VM in MB.", + "minimum" : 0, + "optional" : 1, + "type" : "integer" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "proxyto" : "node", - "returns" : { - "properties" : { - "digest" : { - "description" : "SHA1 digest of configuration file. This can be used to prevent concurrent modifications.", + "template" : { + "default" : 0, + "description" : "Enable/disable Template.", + "optional" : 1, + "type" : "boolean" + }, + "tty" : { + "default" : 2, + "description" : "Specify the number of tty available to the container", + "maximum" : 6, + "minimum" : 0, + "optional" : 1, + "type" : "integer" + }, + "unprivileged" : { + "default" : 0, + "description" : "Makes the container run as unprivileged user. (Should not be modified manually.)", + "optional" : 1, + "type" : "boolean" + }, + "unused[n]" : { + "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.", + "format" : "pve-volume-id", + "optional" : 1, "type" : "string" } }, @@ -13956,7 +20202,9 @@ var pveapi = [ "description" : "OS architecture type.", "enum" : [ "amd64", - "i386" + "i386", + "arm64", + "armhf" ], "optional" : 1, "type" : "string" @@ -14025,6 +20273,46 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "features" : { + "description" : "Allow containers access to advanced features.", + "format" : { + "fuse" : { + "default" : 0, + "description" : "Allow using 'fuse' file systems in a container. Note that interactions between fuse and the freezer cgroup can potentially cause I/O deadlocks.", + "optional" : 1, + "type" : "boolean" + }, + "keyctl" : { + "default" : 0, + "description" : "For unprivileged containers only: Allow the use of the keyctl() system call. This is required to use docker inside a container. By default unprivileged containers will see this system call as non-existent. This is mostly a workaround for systemd-networkd, as it will treat it as a fatal error when some keyctl() operations are denied by the kernel due to lacking permissions. Essentially, you can choose between running systemd-networkd or docker.", + "optional" : 1, + "type" : "boolean" + }, + "mount" : { + "description" : "Allow mounting file systems of specific types. This should be a list of file system types as used with the mount command. Note that this can have negative effects on the container's security. With access to a loop device, mounting a file can circumvent the mknod permission of the devices cgroup, mounting an NFS file system can block the host's I/O completely and prevent it from rebooting, etc.", + "format_description" : "fstype;fstype;...", + "optional" : 1, + "pattern" : "(?^:[a-zA-Z0-9_; ]+)", + "type" : "string" + }, + "nesting" : { + "default" : 0, + "description" : "Allow nesting. Best used with unprivileged containers with additional id mapping. Note that this will expose procfs and sysfs contents of the host to the guest.", + "optional" : 1, + "type" : "boolean" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[fuse=<1|0>] [,keyctl=<1|0>] [,mount=] [,nesting=<1|0>]" + }, + "hookscript" : { + "description" : "Script that will be exectued during various steps in the containers lifetime.", + "format" : "pve-volume-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "hostname" : { "description" : "Set a host name for the container.", "format" : "dns-name", @@ -14036,10 +20324,15 @@ var pveapi = [ "lock" : { "description" : "Lock/unlock the VM.", "enum" : [ - "migrate", "backup", + "create", + "disk", + "fstrim", + "migrate", + "mounted", + "rollback", "snapshot", - "rollback" + "snapshot-delete" ], "optional" : 1, "type" : "string" @@ -14153,10 +20446,11 @@ var pveapi = [ }, "hwaddr" : { "description" : "The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)", + "format" : "mac-addr", "format_description" : "XX:XX:XX:XX:XX:XX", "optional" : 1, - "pattern" : "(?^i:(?:[a-f0-9]{2}:){5}[a-f0-9]{2})", - "type" : "string" + "type" : "string", + "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set." }, "ip" : { "description" : "IPv4 address in CIDR format.", @@ -14395,19 +20689,237 @@ var pveapi = [ "children" : [ { "info" : { - "GET" : { - "description" : "Get virtual machine status.", - "method" : "GET", - "name" : "vm_status", + "GET" : { + "description" : "Get virtual machine status.", + "method" : "GET", + "name" : "vm_status", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "properties" : { + "cpus" : { + "description" : "Maximum usable CPUs.", + "optional" : 1, + "type" : "number" + }, + "ha" : { + "description" : "HA manager service status.", + "type" : "object" + }, + "lock" : { + "description" : "The current config lock, if any.", + "optional" : 1, + "type" : "string" + }, + "maxdisk" : { + "description" : "Root disk size in bytes.", + "optional" : 1, + "renderer" : "bytes", + "type" : "integer" + }, + "maxmem" : { + "description" : "Maximum memory in bytes.", + "optional" : 1, + "renderer" : "bytes", + "type" : "integer" + }, + "maxswap" : { + "description" : "Maximum SWAP memory in bytes.", + "optional" : 1, + "renderer" : "bytes", + "type" : "integer" + }, + "name" : { + "description" : "Container name.", + "optional" : 1, + "type" : "string" + }, + "status" : { + "description" : "LXC Container status.", + "enum" : [ + "stopped", + "running" + ], + "type" : "string" + }, + "uptime" : { + "description" : "Uptime.", + "optional" : 1, + "renderer" : "duration", + "type" : "integer" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer" + } + }, + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/status/current", + "text" : "current" + }, + { + "info" : { + "POST" : { + "description" : "Start the container.", + "method" : "POST", + "name" : "vm_start", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "skiplock" : { + "description" : "Ignore locks - only root is allowed to use this option.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.PowerMgmt" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/status/start", + "text" : "start" + }, + { + "info" : { + "POST" : { + "description" : "Stop the container. This will abruptly stop all processes running in the container.", + "method" : "POST", + "name" : "vm_stop", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "skiplock" : { + "description" : "Ignore locks - only root is allowed to use this option.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.PowerMgmt" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/status/stop", + "text" : "stop" + }, + { + "info" : { + "POST" : { + "description" : "Shutdown the container. This will trigger a clean shutdown of the container, see lxc-stop(1) for details.", + "method" : "POST", + "name" : "vm_shutdown", "parameters" : { "additionalProperties" : 0, "properties" : { + "forceStop" : { + "default" : 0, + "description" : "Make sure the Container stops.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" }, + "timeout" : { + "default" : 60, + "description" : "Wait maximal timeout seconds.", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", @@ -14422,27 +20934,27 @@ var pveapi = [ "perm", "/vms/{vmid}", [ - "VM.Audit" + "VM.PowerMgmt" ] ] }, "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "object" + "type" : "string" } } }, "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/status/current", - "text" : "current" + "path" : "/nodes/{node}/lxc/{vmid}/status/shutdown", + "text" : "shutdown" }, { "info" : { "POST" : { - "description" : "Start the container.", + "description" : "Suspend the container.", "method" : "POST", - "name" : "vm_start", + "name" : "vm_suspend", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -14452,12 +20964,6 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "skiplock" : { - "description" : "Ignore locks - only root is allowed to use this option.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", @@ -14484,15 +20990,15 @@ var pveapi = [ } }, "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/status/start", - "text" : "start" + "path" : "/nodes/{node}/lxc/{vmid}/status/suspend", + "text" : "suspend" }, { "info" : { "POST" : { - "description" : "Stop the container. This will abruptly stop all processes running in the container.", + "description" : "Resume the container.", "method" : "POST", - "name" : "vm_stop", + "name" : "vm_resume", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -14502,53 +21008,259 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "skiplock" : { - "description" : "Ignore locks - only root is allowed to use this option.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.PowerMgmt" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/status/resume", + "text" : "resume" + } + ], + "info" : { + "GET" : { + "description" : "Directory index", + "method" : "GET", + "name" : "vmcmdidx", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "user" : "all" + }, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "subdir" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{subdir}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/lxc/{vmid}/status", + "text" : "status" + }, + { + "children" : [ + { + "children" : [ + { + "info" : { + "POST" : { + "description" : "Rollback LXC state to specified snapshot.", + "method" : "POST", + "name" : "rollback", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Snapshot", + "VM.Snapshot.Rollback" + ], + "any", + 1 + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "the task ID.", + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/snapshot/{snapname}/rollback", + "text" : "rollback" + }, + { + "info" : { + "GET" : { + "description" : "Get snapshot configuration", + "method" : "GET", + "name" : "get_snapshot_config", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Snapshot", + "VM.Snapshot.Rollback" + ], + "any", + 1 + ] + }, + "proxyto" : "node", + "returns" : { + "type" : "object" + } + }, + "PUT" : { + "description" : "Update snapshot metadata.", + "method" : "PUT", + "name" : "update_snapshot_config", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "description" : { + "description" : "A textual description or comment.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Snapshot" + ] + ] }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" } } }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.PowerMgmt" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config", + "text" : "config" } - }, - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/status/stop", - "text" : "stop" - }, - { + ], "info" : { - "POST" : { - "description" : "Shutdown the container. This will trigger a clean shutdown of the container, see lxc-stop(1) for details.", - "method" : "POST", - "name" : "vm_shutdown", + "DELETE" : { + "description" : "Delete a LXC snapshot.", + "method" : "DELETE", + "name" : "delsnapshot", "parameters" : { "additionalProperties" : 0, "properties" : { - "forceStop" : { - "default" : 0, - "description" : "Make sure the Container stops.", + "force" : { + "description" : "For removal from config file, even if removing disk snapshots fails.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -14559,13 +21271,12 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "timeout" : { - "default" : 60, - "description" : "Wait maximal timeout seconds.", - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", @@ -14581,27 +21292,21 @@ var pveapi = [ "perm", "/vms/{vmid}", [ - "VM.PowerMgmt" + "VM.Snapshot" ] ] }, "protected" : 1, "proxyto" : "node", "returns" : { + "description" : "the task ID.", "type" : "string" } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/status/shutdown", - "text" : "shutdown" - }, - { - "info" : { - "POST" : { - "description" : "Suspend the container.", - "method" : "POST", - "name" : "vm_suspend", + }, + "GET" : { + "description" : "", + "method" : "GET", + "name" : "snapshot_cmd_idx", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -14611,47 +21316,10 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.PowerMgmt" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/status/suspend", - "text" : "suspend" - }, - { - "info" : { - "POST" : { - "description" : "Resume the container.", - "method" : "POST", - "name" : "vm_resume", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, "type" : "string", "typetext" : "" }, @@ -14665,40 +21333,122 @@ var pveapi = [ } }, "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.PowerMgmt" - ] - ] + "user" : "all" }, - "protected" : 1, - "proxyto" : "node", "returns" : { - "type" : "string" + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{cmd}", + "rel" : "child" + } + ], + "type" : "array" } } }, - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/status/resume", - "text" : "resume" + "leaf" : 0, + "path" : "/nodes/{node}/lxc/{vmid}/snapshot/{snapname}", + "text" : "{snapname}" } ], "info" : { "GET" : { - "description" : "Directory index", + "description" : "List all snapshots.", "method" : "GET", - "name" : "vmcmdidx", + "name" : "list", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "description" : { + "description" : "Snapshot description.", + "type" : "string" + }, + "name" : { + "description" : "Snapshot identifier. Value 'current' identifies the current VM.", + "type" : "string" + }, + "parent" : { + "description" : "Parent snapshot identifier.", + "optional" : 1, + "type" : "string" + }, + "snaptime" : { + "description" : "Snapshot creation time", + "optional" : 1, + "renderer" : "timestamp", + "type" : "integer" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "description" : "Snapshot a container.", + "method" : "POST", + "name" : "snapshot", "parameters" : { "additionalProperties" : 0, "properties" : { + "description" : { + "description" : "A textual description or comment.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" }, + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "type" : "string", + "typetext" : "" + }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", @@ -14709,31 +21459,25 @@ var pveapi = [ } }, "permissions" : { - "user" : "all" + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Snapshot" + ] + ] }, + "protected" : 1, "proxyto" : "node", "returns" : { - "items" : { - "properties" : { - "subdir" : { - "type" : "string" - } - }, - "type" : "object" - }, - "links" : [ - { - "href" : "{subdir}", - "rel" : "child" - } - ], - "type" : "array" + "description" : "the task ID.", + "type" : "string" } } }, "leaf" : 0, - "path" : "/nodes/{node}/lxc/{vmid}/status", - "text" : "status" + "path" : "/nodes/{node}/lxc/{vmid}/snapshot", + "text" : "snapshot" }, { "children" : [ @@ -14741,25 +21485,32 @@ var pveapi = [ "children" : [ { "info" : { - "POST" : { - "description" : "Rollback LXC state to specified snapshot.", - "method" : "POST", - "name" : "rollback", + "DELETE" : { + "description" : "Delete rule.", + "method" : "DELETE", + "name" : "delete_rule", "parameters" : { "additionalProperties" : 0, "properties" : { + "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" : "" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" }, - "snapname" : { - "description" : "The name of the snapshot.", - "format" : "pve-configid", - "maxLength" : 40, - "type" : "string", - "typetext" : "" + "pos" : { + "description" : "Update rule at position .", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" }, "vmid" : { "description" : "The (unique) ID of the VM.", @@ -14775,31 +21526,20 @@ var pveapi = [ "perm", "/vms/{vmid}", [ - "VM.Snapshot", - "VM.Snapshot.Rollback" - ], - "any", - 1 + "VM.Config.Network" + ] ] }, "protected" : 1, - "proxyto" : "node", + "proxyto" : null, "returns" : { - "description" : "the task ID.", - "type" : "string" + "type" : "null" } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/snapshot/{snapname}/rollback", - "text" : "rollback" - }, - { - "info" : { + }, "GET" : { - "description" : "Get snapshot configuration", + "description" : "Get single rule data.", "method" : "GET", - "name" : "get_snapshot_config", + "name" : "get_rule", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -14809,12 +21549,12 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "snapname" : { - "description" : "The name of the snapshot.", - "format" : "pve-configid", - "maxLength" : 40, - "type" : "string", - "typetext" : "" + "pos" : { + "description" : "Update rule at position .", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" }, "vmid" : { "description" : "The (unique) ID of the VM.", @@ -14830,44 +21570,221 @@ var pveapi = [ "perm", "/vms/{vmid}", [ - "VM.Snapshot", - "VM.Snapshot.Rollback" - ], - "any", - 1 + "VM.Audit" + ] ] }, - "proxyto" : "node", + "proxyto" : null, "returns" : { + "properties" : { + "action" : { + "type" : "string" + }, + "comment" : { + "optional" : 1, + "type" : "string" + }, + "dest" : { + "optional" : 1, + "type" : "string" + }, + "dport" : { + "optional" : 1, + "type" : "string" + }, + "enable" : { + "optional" : 1, + "type" : "integer" + }, + "iface" : { + "optional" : 1, + "type" : "string" + }, + "ipversion" : { + "optional" : 1, + "type" : "integer" + }, + "log" : { + "description" : "Log level for firewall rule", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, + "macro" : { + "optional" : 1, + "type" : "string" + }, + "pos" : { + "type" : "integer" + }, + "proto" : { + "optional" : 1, + "type" : "string" + }, + "source" : { + "optional" : 1, + "type" : "string" + }, + "sport" : { + "optional" : 1, + "type" : "string" + }, + "type" : { + "type" : "string" + } + }, "type" : "object" } }, "PUT" : { - "description" : "Update snapshot metadata.", + "description" : "Modify rule data.", "method" : "PUT", - "name" : "update_snapshot_config", + "name" : "update_rule", "parameters" : { "additionalProperties" : 0, "properties" : { - "description" : { - "description" : "A textual description or comment.", + "action" : { + "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", + "maxLength" : 20, + "minLength" : 2, + "optional" : 1, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" + }, + "comment" : { + "description" : "Descriptive comment.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "dest" : { + "description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.", + "format" : "pve-fw-addr-spec", + "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" : "" + }, + "dport" : { + "description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.", + "format" : "pve-fw-dport-spec", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "enable" : { + "description" : "Flag to enable/disable a rule.", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "iface" : { + "description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.", + "format" : "pve-iface", + "maxLength" : 20, + "minLength" : 2, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "log" : { + "description" : "Log level for firewall rule.", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, + "macro" : { + "description" : "Use predefined standard macro.", + "maxLength" : 128, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "moveto" : { + "description" : "Move rule to new position . Other arguments are ignored.", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "pos" : { + "description" : "Update rule at position .", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "proto" : { + "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.", + "format" : "pve-fw-protocol-spec", "optional" : 1, "type" : "string", "typetext" : "" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "source" : { + "description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.", + "format" : "pve-fw-addr-spec", + "optional" : 1, "type" : "string", "typetext" : "" }, - "snapname" : { - "description" : "The name of the snapshot.", - "format" : "pve-configid", - "maxLength" : 40, + "sport" : { + "description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.", + "format" : "pve-fw-sport-spec", + "optional" : 1, "type" : "string", "typetext" : "" }, + "type" : { + "description" : "Rule type.", + "enum" : [ + "in", + "out", + "group" + ], + "optional" : 1, + "type" : "string" + }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", @@ -14882,49 +21799,36 @@ var pveapi = [ "perm", "/vms/{vmid}", [ - "VM.Snapshot" + "VM.Config.Network" ] ] }, "protected" : 1, - "proxyto" : "node", + "proxyto" : null, "returns" : { "type" : "null" } } }, "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config", - "text" : "config" + "path" : "/nodes/{node}/lxc/{vmid}/firewall/rules/{pos}", + "text" : "{pos}" } ], "info" : { - "DELETE" : { - "description" : "Delete a LXC snapshot.", - "method" : "DELETE", - "name" : "delsnapshot", + "GET" : { + "description" : "List rules.", + "method" : "GET", + "name" : "get_rules", "parameters" : { "additionalProperties" : 0, "properties" : { - "force" : { - "description" : "For removal from config file, even if removing disk snapshots fails.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" }, - "snapname" : { - "description" : "The name of the snapshot.", - "format" : "pve-configid", - "maxLength" : 40, - "type" : "string", - "typetext" : "" - }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", @@ -14939,183 +21843,191 @@ var pveapi = [ "perm", "/vms/{vmid}", [ - "VM.Snapshot" + "VM.Audit" ] ] }, - "protected" : 1, - "proxyto" : "node", + "proxyto" : null, "returns" : { - "description" : "the task ID.", - "type" : "string" + "items" : { + "properties" : { + "pos" : { + "type" : "integer" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{pos}", + "rel" : "child" + } + ], + "type" : "array" } }, - "GET" : { - "description" : "", - "method" : "GET", - "name" : "snapshot_cmd_idx", + "POST" : { + "description" : "Create new rule.", + "method" : "POST", + "name" : "create_rule", "parameters" : { "additionalProperties" : 0, "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "action" : { + "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", + "maxLength" : 20, + "minLength" : 2, + "optional" : 0, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" + }, + "comment" : { + "description" : "Descriptive comment.", + "optional" : 1, "type" : "string", "typetext" : "" }, - "snapname" : { - "description" : "The name of the snapshot.", - "format" : "pve-configid", + "dest" : { + "description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.", + "format" : "pve-fw-addr-spec", + "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" : "" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, + "dport" : { + "description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.", + "format" : "pve-fw-dport-spec", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "enable" : { + "description" : "Flag to enable/disable a rule.", + "minimum" : 0, + "optional" : 1, "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "user" : "all" - }, - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "links" : [ - { - "href" : "{cmd}", - "rel" : "child" - } - ], - "type" : "array" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/lxc/{vmid}/snapshot/{snapname}", - "text" : "{snapname}" - } - ], - "info" : { - "GET" : { - "description" : "List all snapshots.", - "method" : "GET", - "name" : "list", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "links" : [ - { - "href" : "{name}", - "rel" : "child" - } - ], - "type" : "array" - } - }, - "POST" : { - "description" : "Snapshot a container.", - "method" : "POST", - "name" : "snapshot", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "description" : { - "description" : "A textual description or comment.", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "typetext" : " (0 - N)" + }, + "iface" : { + "description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.", + "format" : "pve-iface", + "maxLength" : 20, + "minLength" : 2, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "log" : { + "description" : "Log level for firewall rule.", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, + "macro" : { + "description" : "Use predefined standard macro.", + "maxLength" : 128, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "pos" : { + "description" : "Update rule at position .", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "proto" : { + "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.", + "format" : "pve-fw-protocol-spec", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "source" : { + "description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.", + "format" : "pve-fw-addr-spec", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "sport" : { + "description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.", + "format" : "pve-fw-sport-spec", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "type" : { + "description" : "Rule type.", + "enum" : [ + "in", + "out", + "group" + ], + "optional" : 0, + "type" : "string" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } }, - "snapname" : { - "description" : "The name of the snapshot.", - "format" : "pve-configid", - "maxLength" : 40, - "type" : "string", - "typetext" : "" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Config.Network" + ] + ] }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" + "protected" : 1, + "proxyto" : null, + "returns" : { + "type" : "null" } } }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Snapshot" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "description" : "the task ID.", - "type" : "string" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/lxc/{vmid}/snapshot", - "text" : "snapshot" - }, - { - "children" : [ + "leaf" : 0, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/rules", + "text" : "rules" + }, { "children" : [ { "info" : { "DELETE" : { - "description" : "Delete rule.", + "description" : "Remove IP or Network alias.", "method" : "DELETE", - "name" : "delete_rule", + "name" : "remove_alias", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -15126,19 +22038,19 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "name" : { + "description" : "Alias name.", + "maxLength" : 64, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" }, - "pos" : { - "description" : "Update rule at position .", - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" - }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", @@ -15158,31 +22070,30 @@ var pveapi = [ ] }, "protected" : 1, - "proxyto" : null, "returns" : { "type" : "null" } }, "GET" : { - "description" : "Get single rule data.", + "description" : "Read alias.", "method" : "GET", - "name" : "get_rule", + "name" : "read_alias", "parameters" : { "additionalProperties" : 0, "properties" : { + "name" : { + "description" : "Alias name.", + "maxLength" : 64, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" }, - "pos" : { - "description" : "Update rule at position .", - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" - }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", @@ -15201,47 +22112,24 @@ var pveapi = [ ] ] }, - "proxyto" : null, "returns" : { - "properties" : { - "pos" : { - "type" : "integer" - } - }, "type" : "object" } }, "PUT" : { - "description" : "Modify rule data.", + "description" : "Update IP or Network alias.", "method" : "PUT", - "name" : "update_rule", + "name" : "update_alias", "parameters" : { "additionalProperties" : 0, "properties" : { - "action" : { - "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", - "maxLength" : 20, - "minLength" : 2, - "optional" : 1, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "type" : "string" - }, - "comment" : { - "description" : "Descriptive comment.", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "delete" : { - "description" : "A list of settings you want to delete.", - "format" : "pve-configid-list", - "optional" : 1, + "cidr" : { + "description" : "Network/IP specification in CIDR format.", + "format" : "IPorCIDR", "type" : "string", "typetext" : "" }, - "dest" : { - "description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.", - "format" : "pve-fw-addr-spec", + "comment" : { "optional" : 1, "type" : "string", "typetext" : "" @@ -15253,42 +22141,12 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "dport" : { - "description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.", - "format" : "pve-fw-dport-spec", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "enable" : { - "description" : "Flag to enable/disable a rule.", - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" - }, - "iface" : { - "description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.", - "format" : "pve-iface", - "maxLength" : 20, + "name" : { + "description" : "Alias name.", + "maxLength" : 64, "minLength" : 2, - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "macro" : { - "description" : "Use predefined standard macro.", - "maxLength" : 128, - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "moveto" : { - "description" : "Move rule to new position . Other arguments are ignored.", - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" }, "node" : { "description" : "The cluster node name.", @@ -15296,42 +22154,12 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "pos" : { - "description" : "Update rule at position .", - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" - }, - "proto" : { - "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.", - "format" : "pve-fw-protocol-spec", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "source" : { - "description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.", - "format" : "pve-fw-addr-spec", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "sport" : { - "description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.", - "format" : "pve-fw-sport-spec", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "type" : { - "description" : "Rule type.", - "enum" : [ - "in", - "out", - "group" - ], + "rename" : { + "description" : "Rename an existing alias.", + "maxLength" : 64, + "minLength" : 2, "optional" : 1, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" }, "vmid" : { @@ -15353,22 +22181,21 @@ var pveapi = [ ] }, "protected" : 1, - "proxyto" : null, "returns" : { "type" : "null" } } }, "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/firewall/rules/{pos}", - "text" : "{pos}" + "path" : "/nodes/{node}/lxc/{vmid}/firewall/aliases/{name}", + "text" : "{name}" } ], "info" : { "GET" : { - "description" : "List rules.", + "description" : "List aliases", "method" : "GET", - "name" : "get_rules", + "name" : "get_aliases", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -15396,183 +22223,289 @@ var pveapi = [ ] ] }, - "proxyto" : null, "returns" : { "items" : { "properties" : { - "pos" : { - "type" : "integer" + "cidr" : { + "type" : "string" + }, + "comment" : { + "optional" : 1, + "type" : "string" + }, + "digest" : { + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", + "maxLength" : 40, + "optional" : 0, + "type" : "string" + }, + "name" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "description" : "Create IP or Network Alias.", + "method" : "POST", + "name" : "create_alias", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "cidr" : { + "description" : "Network/IP specification in CIDR format.", + "format" : "IPorCIDR", + "type" : "string", + "typetext" : "" + }, + "comment" : { + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "name" : { + "description" : "Alias name.", + "maxLength" : 64, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Config.Network" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/aliases", + "text" : "aliases" + }, + { + "children" : [ + { + "children" : [ + { + "info" : { + "DELETE" : { + "description" : "Remove IP or Network from IPSet.", + "method" : "DELETE", + "name" : "remove_ip", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "cidr" : { + "description" : "Network/IP specification in CIDR format.", + "format" : "IPorCIDRorAlias", + "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" : "" + }, + "name" : { + "description" : "IP set name.", + "maxLength" : 64, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Config.Network" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + }, + "GET" : { + "description" : "Read IP or Network settings from IPSet.", + "method" : "GET", + "name" : "read_ip", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "cidr" : { + "description" : "Network/IP specification in CIDR format.", + "format" : "IPorCIDRorAlias", + "type" : "string", + "typetext" : "" + }, + "name" : { + "description" : "IP set name.", + "maxLength" : 64, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "object" + } + }, + "PUT" : { + "description" : "Update IP or Network settings", + "method" : "PUT", + "name" : "update_ip", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "cidr" : { + "description" : "Network/IP specification in CIDR format.", + "format" : "IPorCIDRorAlias", + "type" : "string", + "typetext" : "" + }, + "comment" : { + "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" : "" + }, + "name" : { + "description" : "IP set name.", + "maxLength" : 64, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "nomatch" : { + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Config.Network" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } } }, - "type" : "object" - }, - "links" : [ - { - "href" : "{pos}", - "rel" : "child" - } - ], - "type" : "array" - } - }, - "POST" : { - "description" : "Create new rule.", - "method" : "POST", - "name" : "create_rule", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "action" : { - "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", - "maxLength" : 20, - "minLength" : 2, - "optional" : 0, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "type" : "string" - }, - "comment" : { - "description" : "Descriptive comment.", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "dest" : { - "description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.", - "format" : "pve-fw-addr-spec", - "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" : "" - }, - "dport" : { - "description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.", - "format" : "pve-fw-dport-spec", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "enable" : { - "description" : "Flag to enable/disable a rule.", - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" - }, - "iface" : { - "description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.", - "format" : "pve-iface", - "maxLength" : 20, - "minLength" : 2, - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "macro" : { - "description" : "Use predefined standard macro.", - "maxLength" : 128, - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "pos" : { - "description" : "Update rule at position .", - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" - }, - "proto" : { - "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.", - "format" : "pve-fw-protocol-spec", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "source" : { - "description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.", - "format" : "pve-fw-addr-spec", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "sport" : { - "description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.", - "format" : "pve-fw-sport-spec", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "type" : { - "description" : "Rule type.", - "enum" : [ - "in", - "out", - "group" - ], - "optional" : 0, - "type" : "string" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr}", + "text" : "{cidr}" } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Network" - ] - ] - }, - "protected" : 1, - "proxyto" : null, - "returns" : { - "type" : "null" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/lxc/{vmid}/firewall/rules", - "text" : "rules" - }, - { - "children" : [ - { + ], "info" : { "DELETE" : { - "description" : "Remove IP or Network alias.", + "description" : "Delete IPSet", "method" : "DELETE", - "name" : "remove_alias", + "name" : "delete_ipset", "parameters" : { "additionalProperties" : 0, "properties" : { - "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" : "" - }, "name" : { - "description" : "Alias name.", + "description" : "IP set name.", "maxLength" : 64, "minLength" : 2, "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", @@ -15608,14 +22541,14 @@ var pveapi = [ } }, "GET" : { - "description" : "Read alias.", + "description" : "List IPSet content", "method" : "GET", - "name" : "read_alias", + "name" : "get_ipset", "parameters" : { "additionalProperties" : 0, "properties" : { "name" : { - "description" : "Alias name.", + "description" : "IP set name.", "maxLength" : 64, "minLength" : 2, "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", @@ -15646,19 +22579,47 @@ var pveapi = [ ] }, "returns" : { - "type" : "object" + "items" : { + "properties" : { + "cidr" : { + "type" : "string" + }, + "comment" : { + "optional" : 1, + "type" : "string" + }, + "digest" : { + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", + "maxLength" : 40, + "optional" : 0, + "type" : "string" + }, + "nomatch" : { + "optional" : 1, + "type" : "boolean" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{cidr}", + "rel" : "child" + } + ], + "type" : "array" } }, - "PUT" : { - "description" : "Update IP or Network alias.", - "method" : "PUT", - "name" : "update_alias", + "POST" : { + "description" : "Add IP or Network to IPSet.", + "method" : "POST", + "name" : "create_ip", "parameters" : { "additionalProperties" : 0, "properties" : { "cidr" : { "description" : "Network/IP specification in CIDR format.", - "format" : "IPorCIDR", + "format" : "IPorCIDRorAlias", "type" : "string", "typetext" : "" }, @@ -15667,15 +22628,8 @@ var pveapi = [ "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" : "" - }, "name" : { - "description" : "Alias name.", + "description" : "IP set name.", "maxLength" : 64, "minLength" : 2, "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", @@ -15687,13 +22641,10 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "rename" : { - "description" : "Rename an existing alias.", - "maxLength" : 64, - "minLength" : 2, + "nomatch" : { "optional" : 1, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "type" : "string" + "type" : "boolean", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", @@ -15719,16 +22670,16 @@ var pveapi = [ } } }, - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/firewall/aliases/{name}", + "leaf" : 0, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}", "text" : "{name}" } ], "info" : { "GET" : { - "description" : "List aliases", + "description" : "List IPSets", "method" : "GET", - "name" : "get_aliases", + "name" : "ipset_index", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -15759,9 +22710,6 @@ var pveapi = [ "returns" : { "items" : { "properties" : { - "cidr" : { - "type" : "string" - }, "comment" : { "optional" : 1, "type" : "string" @@ -15773,6 +22721,10 @@ var pveapi = [ "type" : "string" }, "name" : { + "description" : "IP set name.", + "maxLength" : 64, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" } }, @@ -15788,29 +22740,277 @@ var pveapi = [ } }, "POST" : { - "description" : "Create IP or Network Alias.", + "description" : "Create new IPSet", "method" : "POST", - "name" : "create_alias", + "name" : "create_ipset", "parameters" : { "additionalProperties" : 0, "properties" : { - "cidr" : { - "description" : "Network/IP specification in CIDR format.", - "format" : "IPorCIDR", + "comment" : { + "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" : "" + }, + "name" : { + "description" : "IP set name.", + "maxLength" : 64, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "rename" : { + "description" : "Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet.", + "maxLength" : 64, + "minLength" : 2, + "optional" : 1, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Config.Network" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/ipset", + "text" : "ipset" + }, + { + "info" : { + "GET" : { + "description" : "Get VM firewall options.", + "method" : "GET", + "name" : "get_options", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "proxyto" : "node", + "returns" : { + "properties" : { + "dhcp" : { + "description" : "Enable DHCP.", + "optional" : 1, + "type" : "boolean" + }, + "enable" : { + "description" : "Enable/disable firewall rules.", + "optional" : 1, + "type" : "boolean" + }, + "ipfilter" : { + "description" : "Enable default IP filters. This is equivalent to adding an empty ipfilter-net ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added.", + "optional" : 1, + "type" : "boolean" + }, + "log_level_in" : { + "description" : "Log level for incoming traffic.", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, + "log_level_out" : { + "description" : "Log level for outgoing traffic.", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, + "macfilter" : { + "description" : "Enable/disable MAC address filter.", + "optional" : 1, + "type" : "boolean" + }, + "ndp" : { + "description" : "Enable NDP.", + "optional" : 1, + "type" : "boolean" + }, + "policy_in" : { + "description" : "Input policy.", + "enum" : [ + "ACCEPT", + "REJECT", + "DROP" + ], + "optional" : 1, + "type" : "string" + }, + "policy_out" : { + "description" : "Output policy.", + "enum" : [ + "ACCEPT", + "REJECT", + "DROP" + ], + "optional" : 1, + "type" : "string" + }, + "radv" : { + "description" : "Allow sending Router Advertisement.", + "optional" : 1, + "type" : "boolean" + } + }, + "type" : "object" + } + }, + "PUT" : { + "description" : "Set Firewall options.", + "method" : "PUT", + "name" : "set_options", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "dhcp" : { + "description" : "Enable DHCP.", + "optional" : 1, + "type" : "boolean", + "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" : "" }, - "comment" : { + "enable" : { + "description" : "Enable/disable firewall rules.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "ipfilter" : { + "description" : "Enable default IP filters. This is equivalent to adding an empty ipfilter-net ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "log_level_in" : { + "description" : "Log level for incoming traffic.", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, + "log_level_out" : { + "description" : "Log level for outgoing traffic.", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, + "macfilter" : { + "description" : "Enable/disable MAC address filter.", "optional" : 1, - "type" : "string", - "typetext" : "" + "type" : "boolean", + "typetext" : "" }, - "name" : { - "description" : "Alias name.", - "maxLength" : 64, - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "type" : "string" + "ndp" : { + "description" : "Enable NDP.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", @@ -15818,1136 +23018,2476 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Network" - ] - ] - }, - "protected" : 1, - "returns" : { - "type" : "null" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/lxc/{vmid}/firewall/aliases", - "text" : "aliases" - }, - { - "children" : [ - { - "children" : [ - { - "info" : { - "DELETE" : { - "description" : "Remove IP or Network from IPSet.", - "method" : "DELETE", - "name" : "remove_ip", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "cidr" : { - "description" : "Network/IP specification in CIDR format.", - "format" : "IPorCIDRorAlias", - "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" : "" - }, - "name" : { - "description" : "IP set name.", - "maxLength" : 64, - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "type" : "string" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Network" - ] - ] - }, - "protected" : 1, - "returns" : { - "type" : "null" - } - }, - "GET" : { - "description" : "Read IP or Network settings from IPSet.", - "method" : "GET", - "name" : "read_ip", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "cidr" : { - "description" : "Network/IP specification in CIDR format.", - "format" : "IPorCIDRorAlias", - "type" : "string", - "typetext" : "" - }, - "name" : { - "description" : "IP set name.", - "maxLength" : 64, - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "type" : "string" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "protected" : 1, - "returns" : { - "type" : "object" - } - }, - "PUT" : { - "description" : "Update IP or Network settings", - "method" : "PUT", - "name" : "update_ip", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "cidr" : { - "description" : "Network/IP specification in CIDR format.", - "format" : "IPorCIDRorAlias", - "type" : "string", - "typetext" : "" - }, - "comment" : { - "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" : "" - }, - "name" : { - "description" : "IP set name.", - "maxLength" : 64, - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "type" : "string" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "nomatch" : { - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Network" - ] - ] - }, - "protected" : 1, - "returns" : { - "type" : "null" - } - } + "policy_in" : { + "description" : "Input policy.", + "enum" : [ + "ACCEPT", + "REJECT", + "DROP" + ], + "optional" : 1, + "type" : "string" + }, + "policy_out" : { + "description" : "Output policy.", + "enum" : [ + "ACCEPT", + "REJECT", + "DROP" + ], + "optional" : 1, + "type" : "string" }, - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr}", - "text" : "{cidr}" + "radv" : { + "description" : "Allow sending Router Advertisement.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } } - ], - "info" : { - "DELETE" : { - "description" : "Delete IPSet", - "method" : "DELETE", - "name" : "delete_ipset", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "name" : { - "description" : "IP set name.", - "maxLength" : 64, - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "type" : "string" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Config.Network" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/options", + "text" : "options" + }, + { + "info" : { + "GET" : { + "description" : "Read firewall log", + "method" : "GET", + "name" : "log", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "limit" : { + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Network" - ] - ] + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "protected" : 1, - "returns" : { - "type" : "null" + "start" : { + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "GET" : { - "description" : "List IPSet content", - "method" : "GET", - "name" : "get_ipset", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "name" : { - "description" : "IP set name.", - "maxLength" : 64, - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "type" : "string" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Console" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "n" : { + "description" : "Line number", + "type" : "integer" + }, + "t" : { + "description" : "Line text", + "type" : "string" } }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "returns" : { - "items" : { - "properties" : { - "cidr" : { - "type" : "string" - }, - "comment" : { - "optional" : 1, - "type" : "string" - }, - "digest" : { - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "maxLength" : 40, - "optional" : 0, - "type" : "string" - }, - "nomatch" : { - "optional" : 1, - "type" : "boolean" - } - }, - "type" : "object" - }, - "links" : [ - { - "href" : "{cidr}", - "rel" : "child" - } - ], - "type" : "array" - } + "type" : "object" }, - "POST" : { - "description" : "Add IP or Network to IPSet.", - "method" : "POST", - "name" : "create_ip", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "cidr" : { - "description" : "Network/IP specification in CIDR format.", - "format" : "IPorCIDRorAlias", - "type" : "string", - "typetext" : "" - }, - "comment" : { - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "name" : { - "description" : "IP set name.", - "maxLength" : 64, - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "type" : "string" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "nomatch" : { - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/log", + "text" : "log" + }, + { + "info" : { + "GET" : { + "description" : "Lists possible IPSet/Alias reference which are allowed in source/dest properties.", + "method" : "GET", + "name" : "refs", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Network" - ] - ] + "type" : { + "description" : "Only list references of specified type.", + "enum" : [ + "alias", + "ipset" + ], + "optional" : 1, + "type" : "string" }, - "protected" : 1, - "returns" : { - "type" : "null" + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } } }, - "leaf" : 0, - "path" : "/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}", - "text" : "{name}" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "returns" : { + "items" : { + "properties" : { + "comment" : { + "optional" : 1, + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "type" : { + "enum" : [ + "alias", + "ipset" + ], + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/refs", + "text" : "refs" + } + ], + "info" : { + "GET" : { + "description" : "Directory index.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/lxc/{vmid}/firewall", + "text" : "firewall" + }, + { + "info" : { + "GET" : { + "description" : "Read VM RRD statistics (returns PNG)", + "method" : "GET", + "name" : "rrd", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "cf" : { + "description" : "The RRD consolidation function", + "enum" : [ + "AVERAGE", + "MAX" + ], + "optional" : 1, + "type" : "string" + }, + "ds" : { + "description" : "The list of datasources you want to display.", + "format" : "pve-configid-list", + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "timeframe" : { + "description" : "Specify the time frame you are interested in.", + "enum" : [ + "hour", + "day", + "week", + "month", + "year" + ], + "type" : "string" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "protected" : 1, + "returns" : { + "properties" : { + "filename" : { + "type" : "string" + } + }, + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/rrd", + "text" : "rrd" + }, + { + "info" : { + "GET" : { + "description" : "Read VM RRD statistics", + "method" : "GET", + "name" : "rrddata", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "cf" : { + "description" : "The RRD consolidation function", + "enum" : [ + "AVERAGE", + "MAX" + ], + "optional" : 1, + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "timeframe" : { + "description" : "Specify the time frame you are interested in.", + "enum" : [ + "hour", + "day", + "week", + "month", + "year" + ], + "type" : "string" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "protected" : 1, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/rrddata", + "text" : "rrddata" + }, + { + "info" : { + "POST" : { + "description" : "Creates a TCP VNC proxy connections.", + "method" : "POST", + "name" : "vncproxy", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "height" : { + "description" : "sets the height of the console in pixels.", + "maximum" : 2160, + "minimum" : 16, + "optional" : 1, + "type" : "integer", + "typetext" : " (16 - 2160)" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "websocket" : { + "description" : "use websocket instead of standard VNC.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "width" : { + "description" : "sets the width of the console in pixels.", + "maximum" : 4096, + "minimum" : 16, + "optional" : 1, + "type" : "integer", + "typetext" : " (16 - 4096)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Console" + ] + ] + }, + "protected" : 1, + "returns" : { + "additionalProperties" : 0, + "properties" : { + "cert" : { + "type" : "string" + }, + "port" : { + "type" : "integer" + }, + "ticket" : { + "type" : "string" + }, + "upid" : { + "type" : "string" + }, + "user" : { + "type" : "string" + } + } + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/vncproxy", + "text" : "vncproxy" + }, + { + "info" : { + "POST" : { + "description" : "Creates a TCP proxy connection.", + "method" : "POST", + "name" : "termproxy", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Console" + ] + ] + }, + "protected" : 1, + "returns" : { + "additionalProperties" : 0, + "properties" : { + "port" : { + "type" : "integer" + }, + "ticket" : { + "type" : "string" + }, + "upid" : { + "type" : "string" + }, + "user" : { + "type" : "string" + } + } + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/termproxy", + "text" : "termproxy" + }, + { + "info" : { + "GET" : { + "description" : "Opens a weksocket for VNC traffic.", + "method" : "GET", + "name" : "vncwebsocket", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "port" : { + "description" : "Port number returned by previous vncproxy call.", + "maximum" : 5999, + "minimum" : 5900, + "type" : "integer", + "typetext" : " (5900 - 5999)" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "vncticket" : { + "description" : "Ticket from previous call to vncproxy.", + "maxLength" : 512, + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Console" + ] + ], + "description" : "You also need to pass a valid ticket (vncticket)." + }, + "returns" : { + "properties" : { + "port" : { + "type" : "string" + } + }, + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/vncwebsocket", + "text" : "vncwebsocket" + }, + { + "info" : { + "POST" : { + "description" : "Returns a SPICE configuration to connect to the CT.", + "method" : "POST", + "name" : "spiceproxy", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "proxy" : { + "description" : "SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).", + "format" : "address", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Console" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "additionalProperties" : 1, + "description" : "Returned values can be directly passed to the 'remote-viewer' application.", + "properties" : { + "host" : { + "type" : "string" + }, + "password" : { + "type" : "string" + }, + "proxy" : { + "type" : "string" + }, + "tls-port" : { + "type" : "integer" + }, + "type" : { + "type" : "string" + } } - ], - "info" : { - "GET" : { - "description" : "List IPSets", - "method" : "GET", - "name" : "ipset_index", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/spiceproxy", + "text" : "spiceproxy" + }, + { + "info" : { + "POST" : { + "description" : "Migrate the container to another node. Creates a new migration task.", + "method" : "POST", + "name" : "migrate_vm", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "bwlimit" : { + "default" : "migrate limit from datacenter or storage config", + "description" : "Override I/O bandwidth limit (in KiB/s).", + "minimum" : "0", + "optional" : 1, + "type" : "number", + "typetext" : " (0 - N)" + }, + "force" : { + "description" : "Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "online" : { + "description" : "Use online/live migration.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "restart" : { + "description" : "Use restart migration", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "target" : { + "description" : "Target node.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "timeout" : { + "default" : 180, + "description" : "Timeout in seconds for shutdown for restart migration", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Migrate" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "the task ID.", + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/migrate", + "text" : "migrate" + }, + { + "info" : { + "GET" : { + "description" : "Check if feature for virtual machine is available.", + "method" : "GET", + "name" : "vm_feature", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "feature" : { + "description" : "Feature to check.", + "enum" : [ + "snapshot", + "clone", + "copy" + ], + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "properties" : { + "hasFeature" : { + "type" : "boolean" + } + }, + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/feature", + "text" : "feature" + }, + { + "info" : { + "POST" : { + "description" : "Create a Template.", + "method" : "POST", + "name" : "template", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Allocate" + ] + ], + "description" : "You need 'VM.Allocate' permissions on /vms/{vmid}" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/template", + "text" : "template" + }, + { + "info" : { + "POST" : { + "description" : "Create a container clone/copy", + "method" : "POST", + "name" : "clone_vm", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "bwlimit" : { + "default" : "clone limit from datacenter or storage config", + "description" : "Override I/O bandwidth limit (in KiB/s).", + "minimum" : "0", + "optional" : 1, + "type" : "number", + "typetext" : " (0 - N)" + }, + "description" : { + "description" : "Description for the new CT.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "full" : { + "description" : "Create a full copy of all disks. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] + "hostname" : { + "description" : "Set a hostname for the new CT.", + "format" : "dns-name", + "optional" : 1, + "type" : "string", + "typetext" : "" }, - "returns" : { - "items" : { - "properties" : { - "comment" : { - "optional" : 1, - "type" : "string" - }, - "digest" : { - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "maxLength" : 40, - "optional" : 0, - "type" : "string" - }, - "name" : { - "description" : "IP set name.", - "maxLength" : 64, - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "type" : "string" - } - }, - "type" : "object" - }, - "links" : [ - { - "href" : "{name}", - "rel" : "child" - } - ], - "type" : "array" - } - }, - "POST" : { - "description" : "Create new IPSet", - "method" : "POST", - "name" : "create_ipset", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "comment" : { - "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" : "" - }, - "name" : { - "description" : "IP set name.", - "maxLength" : 64, - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "type" : "string" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "rename" : { - "description" : "Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet.", - "maxLength" : 64, - "minLength" : 2, - "optional" : 1, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "type" : "string" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } + "newid" : { + "description" : "VMID for the clone.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Network" - ] - ] + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "protected" : 1, - "returns" : { - "type" : "null" + "pool" : { + "description" : "Add the new CT to the specified pool.", + "format" : "pve-poolid", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "storage" : { + "description" : "Target storage for full clone.", + "format" : "pve-storage-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "target" : { + "description" : "Target node. Only allowed if the original VM is on shared storage.", + "format" : "pve-node", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } } }, - "leaf" : 0, - "path" : "/nodes/{node}/lxc/{vmid}/firewall/ipset", - "text" : "ipset" - }, - { - "info" : { - "GET" : { - "description" : "Get VM firewall options.", - "method" : "GET", - "name" : "get_options", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ + "permissions" : { + "check" : [ + "and", + [ + "perm", + "/vms/{vmid}", + [ + "VM.Clone" + ] + ], + [ + "or", + [ "perm", - "/vms/{vmid}", + "/vms/{newid}", [ - "VM.Audit" + "VM.Allocate" ] + ], + [ + "perm", + "/pool/{pool}", + [ + "VM.Allocate" + ], + "require_param", + "pool" ] + ] + ], + "description" : "You need 'VM.Clone' permissions on /vms/{vmid}, and 'VM.Allocate' permissions on /vms/{newid} (or on the VM pool /pool/{pool}). You also need 'Datastore.AllocateSpace' on any used storage." + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/clone", + "text" : "clone" + }, + { + "info" : { + "PUT" : { + "description" : "Resize a container mount point.", + "method" : "PUT", + "name" : "resize_vm", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "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" : "" + }, + "disk" : { + "description" : "The disk you want to resize.", + "enum" : [ + "rootfs", + "mp0", + "mp1", + "mp2", + "mp3", + "mp4", + "mp5", + "mp6", + "mp7", + "mp8", + "mp9", + "mp10", + "mp11", + "mp12", + "mp13", + "mp14", + "mp15", + "mp16", + "mp17", + "mp18", + "mp19", + "mp20", + "mp21", + "mp22", + "mp23", + "mp24", + "mp25", + "mp26", + "mp27", + "mp28", + "mp29", + "mp30", + "mp31", + "mp32", + "mp33", + "mp34", + "mp35", + "mp36", + "mp37", + "mp38", + "mp39", + "mp40", + "mp41", + "mp42", + "mp43", + "mp44", + "mp45", + "mp46", + "mp47", + "mp48", + "mp49", + "mp50", + "mp51", + "mp52", + "mp53", + "mp54", + "mp55", + "mp56", + "mp57", + "mp58", + "mp59", + "mp60", + "mp61", + "mp62", + "mp63", + "mp64", + "mp65", + "mp66", + "mp67", + "mp68", + "mp69", + "mp70", + "mp71", + "mp72", + "mp73", + "mp74", + "mp75", + "mp76", + "mp77", + "mp78", + "mp79", + "mp80", + "mp81", + "mp82", + "mp83", + "mp84", + "mp85", + "mp86", + "mp87", + "mp88", + "mp89", + "mp90", + "mp91", + "mp92", + "mp93", + "mp94", + "mp95", + "mp96", + "mp97", + "mp98", + "mp99", + "mp100", + "mp101", + "mp102", + "mp103", + "mp104", + "mp105", + "mp106", + "mp107", + "mp108", + "mp109", + "mp110", + "mp111", + "mp112", + "mp113", + "mp114", + "mp115", + "mp116", + "mp117", + "mp118", + "mp119", + "mp120", + "mp121", + "mp122", + "mp123", + "mp124", + "mp125", + "mp126", + "mp127", + "mp128", + "mp129", + "mp130", + "mp131", + "mp132", + "mp133", + "mp134", + "mp135", + "mp136", + "mp137", + "mp138", + "mp139", + "mp140", + "mp141", + "mp142", + "mp143", + "mp144", + "mp145", + "mp146", + "mp147", + "mp148", + "mp149", + "mp150", + "mp151", + "mp152", + "mp153", + "mp154", + "mp155", + "mp156", + "mp157", + "mp158", + "mp159", + "mp160", + "mp161", + "mp162", + "mp163", + "mp164", + "mp165", + "mp166", + "mp167", + "mp168", + "mp169", + "mp170", + "mp171", + "mp172", + "mp173", + "mp174", + "mp175", + "mp176", + "mp177", + "mp178", + "mp179", + "mp180", + "mp181", + "mp182", + "mp183", + "mp184", + "mp185", + "mp186", + "mp187", + "mp188", + "mp189", + "mp190", + "mp191", + "mp192", + "mp193", + "mp194", + "mp195", + "mp196", + "mp197", + "mp198", + "mp199", + "mp200", + "mp201", + "mp202", + "mp203", + "mp204", + "mp205", + "mp206", + "mp207", + "mp208", + "mp209", + "mp210", + "mp211", + "mp212", + "mp213", + "mp214", + "mp215", + "mp216", + "mp217", + "mp218", + "mp219", + "mp220", + "mp221", + "mp222", + "mp223", + "mp224", + "mp225", + "mp226", + "mp227", + "mp228", + "mp229", + "mp230", + "mp231", + "mp232", + "mp233", + "mp234", + "mp235", + "mp236", + "mp237", + "mp238", + "mp239", + "mp240", + "mp241", + "mp242", + "mp243", + "mp244", + "mp245", + "mp246", + "mp247", + "mp248", + "mp249", + "mp250", + "mp251", + "mp252", + "mp253", + "mp254", + "mp255" + ], + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "proxyto" : "node", - "returns" : { - "properties" : { - "dhcp" : { - "description" : "Enable DHCP.", - "optional" : 1, - "type" : "boolean" - }, - "enable" : { - "description" : "Enable/disable firewall rules.", - "optional" : 1, - "type" : "boolean" - }, - "ipfilter" : { - "description" : "Enable default IP filters. This is equivalent to adding an empty ipfilter-net ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added.", - "optional" : 1, - "type" : "boolean" - }, - "log_level_in" : { - "description" : "Log level for incoming traffic.", - "enum" : [ - "emerg", - "alert", - "crit", - "err", - "warning", - "notice", - "info", - "debug", - "nolog" - ], - "optional" : 1, - "type" : "string" - }, - "log_level_out" : { - "description" : "Log level for outgoing traffic.", - "enum" : [ - "emerg", - "alert", - "crit", - "err", - "warning", - "notice", - "info", - "debug", - "nolog" - ], - "optional" : 1, - "type" : "string" - }, - "macfilter" : { - "description" : "Enable/disable MAC address filter.", - "optional" : 1, - "type" : "boolean" - }, - "ndp" : { - "description" : "Enable NDP.", - "optional" : 1, - "type" : "boolean" - }, - "policy_in" : { - "description" : "Input policy.", - "enum" : [ - "ACCEPT", - "REJECT", - "DROP" - ], - "optional" : 1, - "type" : "string" - }, - "policy_out" : { - "description" : "Output policy.", - "enum" : [ - "ACCEPT", - "REJECT", - "DROP" - ], - "optional" : 1, - "type" : "string" - }, - "radv" : { - "description" : "Allow sending Router Advertisement.", - "optional" : 1, - "type" : "boolean" - } - }, - "type" : "object" + "size" : { + "description" : "The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.", + "pattern" : "\\+?\\d+(\\.\\d+)?[KMGT]?", + "type" : "string" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "PUT" : { - "description" : "Set Firewall options.", - "method" : "PUT", - "name" : "set_options", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "delete" : { - "description" : "A list of settings you want to delete.", - "format" : "pve-configid-list", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "dhcp" : { - "description" : "Enable DHCP.", - "optional" : 1, - "type" : "boolean", - "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" : "" - }, - "enable" : { - "description" : "Enable/disable firewall rules.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "ipfilter" : { - "description" : "Enable default IP filters. This is equivalent to adding an empty ipfilter-net ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "log_level_in" : { - "description" : "Log level for incoming traffic.", - "enum" : [ - "emerg", - "alert", - "crit", - "err", - "warning", - "notice", - "info", - "debug", - "nolog" - ], - "optional" : 1, - "type" : "string" - }, - "log_level_out" : { - "description" : "Log level for outgoing traffic.", - "enum" : [ - "emerg", - "alert", - "crit", - "err", - "warning", - "notice", - "info", - "debug", - "nolog" - ], - "optional" : 1, - "type" : "string" - }, - "macfilter" : { - "description" : "Enable/disable MAC address filter.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "ndp" : { - "description" : "Enable NDP.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "policy_in" : { - "description" : "Input policy.", - "enum" : [ - "ACCEPT", - "REJECT", - "DROP" - ], - "optional" : 1, - "type" : "string" - }, - "policy_out" : { - "description" : "Output policy.", - "enum" : [ - "ACCEPT", - "REJECT", - "DROP" - ], - "optional" : 1, - "type" : "string" - }, - "radv" : { - "description" : "Allow sending Router Advertisement.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Config.Disk" + ], + "any", + 1 + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "the task ID.", + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/resize", + "text" : "resize" + }, + { + "info" : { + "POST" : { + "description" : "Move a rootfs-/mp-volume to a different storage", + "method" : "POST", + "name" : "move_volume", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "bwlimit" : { + "default" : "clone limit from datacenter or storage config", + "description" : "Override I/O bandwidth limit (in KiB/s).", + "minimum" : "0", + "optional" : 1, + "type" : "number", + "typetext" : " (0 - N)" }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Network" - ] - ] + "delete" : { + "default" : 0, + "description" : "Delete the original volume after successful copy. By default the original is kept as an unused volume entry.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "null" + "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" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "storage" : { + "description" : "Target Storage.", + "format" : "pve-storage-id", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "volume" : { + "description" : "Volume which will be moved.", + "enum" : [ + "rootfs", + "mp0", + "mp1", + "mp2", + "mp3", + "mp4", + "mp5", + "mp6", + "mp7", + "mp8", + "mp9", + "mp10", + "mp11", + "mp12", + "mp13", + "mp14", + "mp15", + "mp16", + "mp17", + "mp18", + "mp19", + "mp20", + "mp21", + "mp22", + "mp23", + "mp24", + "mp25", + "mp26", + "mp27", + "mp28", + "mp29", + "mp30", + "mp31", + "mp32", + "mp33", + "mp34", + "mp35", + "mp36", + "mp37", + "mp38", + "mp39", + "mp40", + "mp41", + "mp42", + "mp43", + "mp44", + "mp45", + "mp46", + "mp47", + "mp48", + "mp49", + "mp50", + "mp51", + "mp52", + "mp53", + "mp54", + "mp55", + "mp56", + "mp57", + "mp58", + "mp59", + "mp60", + "mp61", + "mp62", + "mp63", + "mp64", + "mp65", + "mp66", + "mp67", + "mp68", + "mp69", + "mp70", + "mp71", + "mp72", + "mp73", + "mp74", + "mp75", + "mp76", + "mp77", + "mp78", + "mp79", + "mp80", + "mp81", + "mp82", + "mp83", + "mp84", + "mp85", + "mp86", + "mp87", + "mp88", + "mp89", + "mp90", + "mp91", + "mp92", + "mp93", + "mp94", + "mp95", + "mp96", + "mp97", + "mp98", + "mp99", + "mp100", + "mp101", + "mp102", + "mp103", + "mp104", + "mp105", + "mp106", + "mp107", + "mp108", + "mp109", + "mp110", + "mp111", + "mp112", + "mp113", + "mp114", + "mp115", + "mp116", + "mp117", + "mp118", + "mp119", + "mp120", + "mp121", + "mp122", + "mp123", + "mp124", + "mp125", + "mp126", + "mp127", + "mp128", + "mp129", + "mp130", + "mp131", + "mp132", + "mp133", + "mp134", + "mp135", + "mp136", + "mp137", + "mp138", + "mp139", + "mp140", + "mp141", + "mp142", + "mp143", + "mp144", + "mp145", + "mp146", + "mp147", + "mp148", + "mp149", + "mp150", + "mp151", + "mp152", + "mp153", + "mp154", + "mp155", + "mp156", + "mp157", + "mp158", + "mp159", + "mp160", + "mp161", + "mp162", + "mp163", + "mp164", + "mp165", + "mp166", + "mp167", + "mp168", + "mp169", + "mp170", + "mp171", + "mp172", + "mp173", + "mp174", + "mp175", + "mp176", + "mp177", + "mp178", + "mp179", + "mp180", + "mp181", + "mp182", + "mp183", + "mp184", + "mp185", + "mp186", + "mp187", + "mp188", + "mp189", + "mp190", + "mp191", + "mp192", + "mp193", + "mp194", + "mp195", + "mp196", + "mp197", + "mp198", + "mp199", + "mp200", + "mp201", + "mp202", + "mp203", + "mp204", + "mp205", + "mp206", + "mp207", + "mp208", + "mp209", + "mp210", + "mp211", + "mp212", + "mp213", + "mp214", + "mp215", + "mp216", + "mp217", + "mp218", + "mp219", + "mp220", + "mp221", + "mp222", + "mp223", + "mp224", + "mp225", + "mp226", + "mp227", + "mp228", + "mp229", + "mp230", + "mp231", + "mp232", + "mp233", + "mp234", + "mp235", + "mp236", + "mp237", + "mp238", + "mp239", + "mp240", + "mp241", + "mp242", + "mp243", + "mp244", + "mp245", + "mp246", + "mp247", + "mp248", + "mp249", + "mp250", + "mp251", + "mp252", + "mp253", + "mp254", + "mp255" + ], + "type" : "string" } } }, - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/firewall/options", - "text" : "options" + "permissions" : { + "check" : [ + "and", + [ + "perm", + "/vms/{vmid}", + [ + "VM.Config.Disk" + ] + ], + [ + "perm", + "/storage/{storage}", + [ + "Datastore.AllocateSpace" + ] + ] + ], + "description" : "You need 'VM.Config.Disk' permissions on /vms/{vmid}, and 'Datastore.AllocateSpace' permissions on the storage." + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/move_volume", + "text" : "move_volume" + } + ], + "info" : { + "DELETE" : { + "description" : "Destroy the container (also delete all uses files).", + "method" : "DELETE", + "name" : "destroy_vm", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Allocate" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + }, + "GET" : { + "description" : "Directory index", + "method" : "GET", + "name" : "vmdiridx", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "user" : "all" + }, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "subdir" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{subdir}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/lxc/{vmid}", + "text" : "{vmid}" + } + ], + "info" : { + "GET" : { + "description" : "LXC container index (per node).", + "method" : "GET", + "name" : "vmlist", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "description" : "Only list CTs where you have VM.Audit permissons on /vms/.", + "user" : "all" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "cpus" : { + "description" : "Maximum usable CPUs.", + "optional" : 1, + "type" : "number" + }, + "lock" : { + "description" : "The current config lock, if any.", + "optional" : 1, + "type" : "string" + }, + "maxdisk" : { + "description" : "Root disk size in bytes.", + "optional" : 1, + "renderer" : "bytes", + "type" : "integer" + }, + "maxmem" : { + "description" : "Maximum memory in bytes.", + "optional" : 1, + "renderer" : "bytes", + "type" : "integer" + }, + "maxswap" : { + "description" : "Maximum SWAP memory in bytes.", + "optional" : 1, + "renderer" : "bytes", + "type" : "integer" + }, + "name" : { + "description" : "Container name.", + "optional" : 1, + "type" : "string" + }, + "status" : { + "description" : "LXC Container status.", + "enum" : [ + "stopped", + "running" + ], + "type" : "string" + }, + "uptime" : { + "description" : "Uptime.", + "optional" : 1, + "renderer" : "duration", + "type" : "integer" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{vmid}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "description" : "Create or restore a container.", + "method" : "POST", + "name" : "create_vm", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "arch" : { + "default" : "amd64", + "description" : "OS architecture type.", + "enum" : [ + "amd64", + "i386", + "arm64", + "armhf" + ], + "optional" : 1, + "type" : "string" + }, + "bwlimit" : { + "default" : "restore limit from datacenter or storage config", + "description" : "Override I/O bandwidth limit (in KiB/s).", + "minimum" : "0", + "optional" : 1, + "type" : "number", + "typetext" : " (0 - N)" + }, + "cmode" : { + "default" : "tty", + "description" : "Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).", + "enum" : [ + "shell", + "console", + "tty" + ], + "optional" : 1, + "type" : "string" + }, + "console" : { + "default" : 1, + "description" : "Attach a console device (/dev/console) to the container.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "cores" : { + "description" : "The number of cores assigned to the container. A container can use all available cores by default.", + "maximum" : 128, + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - 128)" + }, + "cpulimit" : { + "default" : 0, + "description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.", + "maximum" : 128, + "minimum" : 0, + "optional" : 1, + "type" : "number", + "typetext" : " (0 - 128)" + }, + "cpuunits" : { + "default" : 1024, + "description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0.", + "maximum" : 500000, + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - 500000)" + }, + "description" : { + "description" : "Container description. Only used on the configuration web interface.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "features" : { + "description" : "Allow containers access to advanced features.", + "format" : { + "fuse" : { + "default" : 0, + "description" : "Allow using 'fuse' file systems in a container. Note that interactions between fuse and the freezer cgroup can potentially cause I/O deadlocks.", + "optional" : 1, + "type" : "boolean" + }, + "keyctl" : { + "default" : 0, + "description" : "For unprivileged containers only: Allow the use of the keyctl() system call. This is required to use docker inside a container. By default unprivileged containers will see this system call as non-existent. This is mostly a workaround for systemd-networkd, as it will treat it as a fatal error when some keyctl() operations are denied by the kernel due to lacking permissions. Essentially, you can choose between running systemd-networkd or docker.", + "optional" : 1, + "type" : "boolean" + }, + "mount" : { + "description" : "Allow mounting file systems of specific types. This should be a list of file system types as used with the mount command. Note that this can have negative effects on the container's security. With access to a loop device, mounting a file can circumvent the mknod permission of the devices cgroup, mounting an NFS file system can block the host's I/O completely and prevent it from rebooting, etc.", + "format_description" : "fstype;fstype;...", + "optional" : 1, + "pattern" : "(?^:[a-zA-Z0-9_; ]+)", + "type" : "string" + }, + "nesting" : { + "default" : 0, + "description" : "Allow nesting. Best used with unprivileged containers with additional id mapping. Note that this will expose procfs and sysfs contents of the host to the guest.", + "optional" : 1, + "type" : "boolean" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[fuse=<1|0>] [,keyctl=<1|0>] [,mount=] [,nesting=<1|0>]" + }, + "force" : { + "description" : "Allow to overwrite existing container.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "hookscript" : { + "description" : "Script that will be exectued during various steps in the containers lifetime.", + "format" : "pve-volume-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "hostname" : { + "description" : "Set a host name for the container.", + "format" : "dns-name", + "maxLength" : 255, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "ignore-unpack-errors" : { + "description" : "Ignore errors when extracting the template.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "lock" : { + "description" : "Lock/unlock the VM.", + "enum" : [ + "backup", + "create", + "disk", + "fstrim", + "migrate", + "mounted", + "rollback", + "snapshot", + "snapshot-delete" + ], + "optional" : 1, + "type" : "string" + }, + "memory" : { + "default" : 512, + "description" : "Amount of RAM for the VM in MB.", + "minimum" : 16, + "optional" : 1, + "type" : "integer", + "typetext" : " (16 - N)" + }, + "mp[n]" : { + "description" : "Use volume as container mount point.", + "format" : { + "acl" : { + "description" : "Explicitly enable or disable ACL support.", + "optional" : 1, + "type" : "boolean" + }, + "backup" : { + "description" : "Whether to include the mount point in backups.", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Whether to include the mount point in backups (only used for volume mount points)." + }, + "mp" : { + "description" : "Path to the mount point as seen from inside the container (must not contain symlinks).", + "format" : "pve-lxc-mp-string", + "format_description" : "Path", + "type" : "string", + "verbose_description" : "Path to the mount point as seen from inside the container.\n\nNOTE: Must not contain any symlinks for security reasons." + }, + "quota" : { + "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)", + "optional" : 1, + "type" : "boolean" + }, + "replicate" : { + "default" : 1, + "description" : "Will include this volume to a storage replica job.", + "optional" : 1, + "type" : "boolean" + }, + "ro" : { + "description" : "Read-only mount point", + "optional" : 1, + "type" : "boolean" + }, + "shared" : { + "default" : 0, + "description" : "Mark this non-volume mount point as available on multiple nodes (see 'nodes')", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this non-volume mount point as available on all nodes.\n\nWARNING: This option does not share the mount point automatically, it assumes it is shared already!" + }, + "size" : { + "description" : "Volume size (read only value).", + "format" : "disk-size", + "format_description" : "DiskSize", + "optional" : 1, + "type" : "string" + }, + "volume" : { + "default_key" : 1, + "description" : "Volume, device or directory to mount into the container.", + "format" : "pve-lxc-mp-string", + "format_description" : "volume", + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]" + }, + "nameserver" : { + "description" : "Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.", + "format" : "address-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "net[n]" : { + "description" : "Specifies network interfaces for the container.", + "format" : { + "bridge" : { + "description" : "Bridge to attach the network device to.", + "format_description" : "bridge", + "optional" : 1, + "pattern" : "[-_.\\w\\d]+", + "type" : "string" + }, + "firewall" : { + "description" : "Controls whether this interface's firewall rules should be used.", + "optional" : 1, + "type" : "boolean" + }, + "gw" : { + "description" : "Default gateway for IPv4 traffic.", + "format" : "ipv4", + "format_description" : "GatewayIPv4", + "optional" : 1, + "type" : "string" + }, + "gw6" : { + "description" : "Default gateway for IPv6 traffic.", + "format" : "ipv6", + "format_description" : "GatewayIPv6", + "optional" : 1, + "type" : "string" + }, + "hwaddr" : { + "description" : "The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)", + "format" : "mac-addr", + "format_description" : "XX:XX:XX:XX:XX:XX", + "optional" : 1, + "type" : "string", + "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set." + }, + "ip" : { + "description" : "IPv4 address in CIDR format.", + "format" : "pve-ipv4-config", + "format_description" : "(IPv4/CIDR|dhcp|manual)", + "optional" : 1, + "type" : "string" + }, + "ip6" : { + "description" : "IPv6 address in CIDR format.", + "format" : "pve-ipv6-config", + "format_description" : "(IPv6/CIDR|auto|dhcp|manual)", + "optional" : 1, + "type" : "string" + }, + "mtu" : { + "description" : "Maximum transfer unit of the interface. (lxc.network.mtu)", + "minimum" : 64, + "optional" : 1, + "type" : "integer" + }, + "name" : { + "description" : "Name of the network device as seen from inside the container. (lxc.network.name)", + "format_description" : "string", + "pattern" : "[-_.\\w\\d]+", + "type" : "string" + }, + "rate" : { + "description" : "Apply rate limiting to the interface", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" + }, + "tag" : { + "description" : "VLAN tag for this interface.", + "maximum" : 4094, + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "trunks" : { + "description" : "VLAN ids to pass through the interface", + "format_description" : "vlanid[;vlanid...]", + "optional" : 1, + "pattern" : "(?^:\\d+(?:;\\d+)*)", + "type" : "string" + }, + "type" : { + "description" : "Network interface type.", + "enum" : [ + "veth" + ], + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "onboot" : { + "default" : 0, + "description" : "Specifies whether a VM will be started during system bootup.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "ostemplate" : { + "description" : "The OS template or backup file.", + "maxLength" : 255, + "type" : "string", + "typetext" : "" + }, + "ostype" : { + "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", + "ubuntu", + "centos", + "fedora", + "opensuse", + "archlinux", + "alpine", + "gentoo", + "unmanaged" + ], + "optional" : 1, + "type" : "string" + }, + "password" : { + "description" : "Sets root password inside container.", + "minLength" : 5, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "pool" : { + "description" : "Add the VM to the specified pool.", + "format" : "pve-poolid", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "protection" : { + "default" : 0, + "description" : "Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "restore" : { + "description" : "Mark this as restore task.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "rootfs" : { + "description" : "Use volume as container root.", + "format" : { + "acl" : { + "description" : "Explicitly enable or disable ACL support.", + "optional" : 1, + "type" : "boolean" + }, + "quota" : { + "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)", + "optional" : 1, + "type" : "boolean" + }, + "replicate" : { + "default" : 1, + "description" : "Will include this volume to a storage replica job.", + "optional" : 1, + "type" : "boolean" + }, + "ro" : { + "description" : "Read-only mount point", + "optional" : 1, + "type" : "boolean" + }, + "shared" : { + "default" : 0, + "description" : "Mark this non-volume mount point as available on multiple nodes (see 'nodes')", + "optional" : 1, + "type" : "boolean", + "verbose_description" : "Mark this non-volume mount point as available on all nodes.\n\nWARNING: This option does not share the mount point automatically, it assumes it is shared already!" + }, + "size" : { + "description" : "Volume size (read only value).", + "format" : "disk-size", + "format_description" : "DiskSize", + "optional" : 1, + "type" : "string" + }, + "volume" : { + "default_key" : 1, + "description" : "Volume, device or directory to mount into the container.", + "format" : "pve-lxc-mp-string", + "format_description" : "volume", + "type" : "string" + } }, + "optional" : 1, + "type" : "string", + "typetext" : "[volume=] [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]" + }, + "searchdomain" : { + "description" : "Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.", + "format" : "dns-name-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "ssh-public-keys" : { + "description" : "Setup public SSH keys (one key per line, OpenSSH format).", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "start" : { + "default" : 0, + "description" : "Start the CT after its creation finished successfully.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "startup" : { + "description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.", + "format" : "pve-startup-order", + "optional" : 1, + "type" : "string", + "typetext" : "[[order=]\\d+] [,up=\\d+] [,down=\\d+] " + }, + "storage" : { + "default" : "local", + "description" : "Default Storage.", + "format" : "pve-storage-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "swap" : { + "default" : 512, + "description" : "Amount of SWAP for the VM in MB.", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "template" : { + "default" : 0, + "description" : "Enable/disable Template.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "tty" : { + "default" : 2, + "description" : "Specify the number of tty available to the container", + "maximum" : 6, + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - 6)" + }, + "unique" : { + "description" : "Assign a unique random ethernet address.", + "optional" : 1, + "requires" : "restore", + "type" : "boolean", + "typetext" : "" + }, + "unprivileged" : { + "default" : 0, + "description" : "Makes the container run as unprivileged user. (Should not be modified manually.)", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "unused[n]" : { + "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.", + "format" : "pve-volume-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "description" : "You need 'VM.Allocate' permissions on /vms/{vmid} or on the VM pool /pool/{pool}. For restore, it is enough if the user has 'VM.Backup' permission and the VM already exists. You also need 'Datastore.AllocateSpace' permissions on the storage.", + "user" : "all" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/lxc", + "text" : "lxc" + }, + { + "children" : [ + { + "children" : [ + { + "children" : [ { "info" : { - "GET" : { - "description" : "Read firewall log", - "method" : "GET", - "name" : "log", + "POST" : { + "description" : "ceph osd in", + "method" : "POST", + "name" : "in", "parameters" : { "additionalProperties" : 0, "properties" : { - "limit" : { - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" }, - "start" : { - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, + "osdid" : { + "description" : "OSD ID", "type" : "integer", - "typetext" : " (1 - N)" + "typetext" : "" } } }, "permissions" : { "check" : [ "perm", - "/vms/{vmid}", + "/", [ - "VM.Console" + "Sys.Modify" ] ] }, "protected" : 1, "proxyto" : "node", "returns" : { - "items" : { - "properties" : { - "n" : { - "description" : "Line number", - "type" : "integer" - }, - "t" : { - "description" : "Line text", - "type" : "string" - } - }, - "type" : "object" - }, - "type" : "array" + "type" : "null" } } }, "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/firewall/log", - "text" : "log" + "path" : "/nodes/{node}/ceph/osd/{osdid}/in", + "text" : "in" }, { "info" : { - "GET" : { - "description" : "Lists possible IPSet/Alias reference which are allowed in source/dest properties.", - "method" : "GET", - "name" : "refs", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "type" : { - "description" : "Only list references of specified type.", - "enum" : [ - "alias", - "ipset" - ], - "optional" : 1, - "type" : "string" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "returns" : { - "items" : { - "properties" : { - "comment" : { - "optional" : 1, - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "type" : { - "enum" : [ - "alias", - "ipset" - ], - "type" : "string" - } - }, - "type" : "object" - }, - "type" : "array" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/firewall/refs", - "text" : "refs" - } - ], - "info" : { - "GET" : { - "description" : "Directory index.", - "method" : "GET", - "name" : "index", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "user" : "all" - }, - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "links" : [ - { - "href" : "{name}", - "rel" : "child" - } - ], - "type" : "array" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/lxc/{vmid}/firewall", - "text" : "firewall" - }, - { - "info" : { - "GET" : { - "description" : "Read VM RRD statistics (returns PNG)", - "method" : "GET", - "name" : "rrd", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "cf" : { - "description" : "The RRD consolidation function", - "enum" : [ - "AVERAGE", - "MAX" - ], - "optional" : 1, - "type" : "string" - }, - "ds" : { - "description" : "The list of datasources you want to display.", - "format" : "pve-configid-list", - "type" : "string", - "typetext" : "" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "timeframe" : { - "description" : "Specify the time frame you are interested in.", - "enum" : [ - "hour", - "day", - "week", - "month", - "year" - ], - "type" : "string" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "protected" : 1, - "returns" : { - "properties" : { - "filename" : { - "type" : "string" - } - }, - "type" : "object" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/rrd", - "text" : "rrd" - }, - { - "info" : { - "GET" : { - "description" : "Read VM RRD statistics", - "method" : "GET", - "name" : "rrddata", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "cf" : { - "description" : "The RRD consolidation function", - "enum" : [ - "AVERAGE", - "MAX" - ], - "optional" : 1, - "type" : "string" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "POST" : { + "description" : "ceph osd out", + "method" : "POST", + "name" : "out", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "osdid" : { + "description" : "OSD ID", + "type" : "integer", + "typetext" : "" + } + } }, - "timeframe" : { - "description" : "Specify the time frame you are interested in.", - "enum" : [ - "hour", - "day", - "week", - "month", - "year" - ], - "type" : "string" + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" } } }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "protected" : 1, - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "type" : "array" - } + "leaf" : 1, + "path" : "/nodes/{node}/ceph/osd/{osdid}/out", + "text" : "out" } - }, - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/rrddata", - "text" : "rrddata" - }, - { + ], "info" : { - "POST" : { - "description" : "Creates a TCP VNC proxy connections.", - "method" : "POST", - "name" : "vncproxy", + "DELETE" : { + "description" : "Destroy OSD", + "method" : "DELETE", + "name" : "destroyosd", "parameters" : { "additionalProperties" : 0, "properties" : { - "height" : { - "description" : "sets the height of the console in pixels.", - "maximum" : 2160, - "minimum" : 16, + "cleanup" : { + "default" : 0, + "description" : "If set, we remove partition table entries.", "optional" : 1, - "type" : "integer", - "typetext" : " (16 - 2160)" + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", @@ -16955,342 +25495,342 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - }, - "websocket" : { - "description" : "use websocket instead of standard VNC.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "width" : { - "description" : "sets the width of the console in pixels.", - "maximum" : 4096, - "minimum" : 16, - "optional" : 1, + "osdid" : { + "description" : "OSD ID", "type" : "integer", - "typetext" : " (16 - 4096)" + "typetext" : "" } } }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Console" - ] - ] - }, "protected" : 1, + "proxyto" : "node", "returns" : { - "additionalProperties" : 0, - "properties" : { - "cert" : { - "type" : "string" - }, - "port" : { - "type" : "integer" - }, - "ticket" : { - "type" : "string" - }, - "upid" : { - "type" : "string" - }, - "user" : { - "type" : "string" - } - } + "type" : "string" } } }, - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/vncproxy", - "text" : "vncproxy" + "leaf" : 0, + "path" : "/nodes/{node}/ceph/osd/{osdid}", + "text" : "{osdid}" + } + ], + "info" : { + "GET" : { + "description" : "Get Ceph osd list/tree.", + "method" : "GET", + "name" : "index", + "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" : { + "type" : "object" + } }, - { - "info" : { - "POST" : { - "description" : "Creates a TCP proxy connection.", - "method" : "POST", - "name" : "termproxy", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } + "POST" : { + "description" : "Create OSD", + "method" : "POST", + "name" : "createosd", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "db_dev" : { + "description" : "Block device name for block.db.", + "optional" : 1, + "type" : "string", + "typetext" : "" }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Console" - ] - ] + "db_size" : { + "default" : "bluestore_block_db_size or 10% of OSD size", + "description" : "Size in GiB for block.db.", + "minimum" : 1, + "optional" : 1, + "requires" : "db_dev", + "type" : "number", + "typetext" : " (1 - N)", + "verbose_description" : "If a block.db is requested but the size is not given, will be automatically selected by: bluestore_block_db_size from the ceph database (osd or global section) or config (osd or global section)in that order. If this is not available, it will be sized 10% of the size of the OSD device. Fails if the available size is not enough." }, - "protected" : 1, - "returns" : { - "additionalProperties" : 0, - "properties" : { - "port" : { - "type" : "integer" - }, - "ticket" : { - "type" : "string" - }, - "upid" : { - "type" : "string" - }, - "user" : { - "type" : "string" - } - } + "dev" : { + "description" : "Block device name.", + "type" : "string", + "typetext" : "" + }, + "encrypted" : { + "default" : 0, + "description" : "Enables encryption of the OSD.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "wal_dev" : { + "description" : "Block device name for block.wal.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "wal_size" : { + "default" : "bluestore_block_wal_size or 1% of OSD size", + "description" : "Size in GiB for block.wal.", + "minimum" : 0.5, + "optional" : 1, + "requires" : "wal_dev", + "type" : "number", + "typetext" : " (0.5 - N)", + "verbose_description" : "If a block.wal is requested but the size is not given, will be automatically selected by: bluestore_block_wal_size from the ceph database (osd or global section) or config (osd or global section)in that order. If this is not available, it will be sized 1% of the size of the OSD device. Fails if the available size is not enough." } } }, - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/termproxy", - "text" : "termproxy" - }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/ceph/osd", + "text" : "osd" + }, + { + "children" : [ { "info" : { - "GET" : { - "description" : "Opens a weksocket for VNC traffic.", - "method" : "GET", - "name" : "vncwebsocket", + "DELETE" : { + "description" : "Destroy Ceph Metadata Server", + "method" : "DELETE", + "name" : "destroymds", "parameters" : { "additionalProperties" : 0, "properties" : { + "name" : { + "description" : "The name (ID) of the mds", + "pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?", + "type" : "string" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" - }, - "port" : { - "description" : "Port number returned by previous vncproxy call.", - "maximum" : 5999, - "minimum" : 5900, - "type" : "integer", - "typetext" : " (5900 - 5999)" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - }, - "vncticket" : { - "description" : "Ticket from previous call to vncproxy.", - "maxLength" : 512, - "type" : "string", - "typetext" : "" } } }, "permissions" : { "check" : [ "perm", - "/vms/{vmid}", + "/", [ - "VM.Console" + "Sys.Modify" ] - ], - "description" : "You also need to pass a valid ticket (vncticket)." + ] }, + "protected" : 1, + "proxyto" : "node", "returns" : { - "properties" : { - "port" : { - "type" : "string" - } - }, - "type" : "object" + "type" : "string" } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/vncwebsocket", - "text" : "vncwebsocket" - }, - { - "info" : { + }, "POST" : { - "description" : "Returns a SPICE configuration to connect to the CT.", + "description" : "Create Ceph Metadata Server (MDS)", "method" : "POST", - "name" : "spiceproxy", + "name" : "createmds", "parameters" : { "additionalProperties" : 0, "properties" : { + "hotstandby" : { + "default" : "0", + "description" : "Determines whether a ceph-mds daemon should poll and replay the log of an active MDS. Faster switch on MDS failure, but needs more idle resources.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "name" : { + "default" : "nodename", + "description" : "The ID for the mds, when omitted the same as the nodename", + "optional" : 1, + "pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?", + "type" : "string" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" - }, - "proxy" : { - "description" : "SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As resonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).", - "format" : "address", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" } } }, "permissions" : { "check" : [ "perm", - "/vms/{vmid}", + "/", [ - "VM.Console" + "Sys.Modify" ] ] }, "protected" : 1, "proxyto" : "node", "returns" : { - "additionalProperties" : 1, - "description" : "Returned values can be directly passed to the 'remote-viewer' application.", - "properties" : { - "host" : { - "type" : "string" - }, - "password" : { - "type" : "string" - }, - "proxy" : { - "type" : "string" - }, - "tls-port" : { - "type" : "integer" - }, - "type" : { - "type" : "string" - } - } + "type" : "string" } } }, "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/spiceproxy", - "text" : "spiceproxy" - }, + "path" : "/nodes/{node}/ceph/mds/{name}", + "text" : "{name}" + } + ], + "info" : { + "GET" : { + "description" : "MDS directory index.", + "method" : "GET", + "name" : "index", + "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" : { + "addr" : { + "optional" : 1, + "type" : "string" + }, + "host" : { + "optional" : 1, + "type" : "string" + }, + "name" : { + "description" : "The name (ID) for the MDS" + }, + "rank" : { + "optional" : 1, + "type" : "integer" + }, + "standby_replay" : { + "description" : "If true, the standby MDS is polling the active MDS for faster recovery (hot standby).", + "optional" : 1, + "type" : "boolean" + }, + "state" : { + "description" : "State of the MDS", + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/ceph/mds", + "text" : "mds" + }, + { + "children" : [ { "info" : { - "POST" : { - "description" : "Migrate the container to another node. Creates a new migration task.", - "method" : "POST", - "name" : "migrate_vm", + "DELETE" : { + "description" : "Destroy Ceph Manager.", + "method" : "DELETE", + "name" : "destroymgr", "parameters" : { "additionalProperties" : 0, "properties" : { - "force" : { - "description" : "Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "online" : { - "description" : "Use online/live migration.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "restart" : { - "description" : "Use restart migration", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "target" : { - "description" : "Target node.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "timeout" : { - "default" : 180, - "description" : "Timeout in seconds for shutdown for restart migration", - "optional" : 1, - "type" : "integer", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" + "id" : { + "description" : "The ID of the manager", + "pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" } } }, "permissions" : { "check" : [ "perm", - "/vms/{vmid}", + "/", [ - "VM.Migrate" + "Sys.Modify" ] ] }, "protected" : 1, "proxyto" : "node", "returns" : { - "description" : "the task ID.", "type" : "string" } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/migrate", - "text" : "migrate" - }, - { - "info" : { - "GET" : { - "description" : "Check if feature for virtual machine is available.", - "method" : "GET", - "name" : "vm_feature", + }, + "POST" : { + "description" : "Create Ceph Manager", + "method" : "POST", + "name" : "createmgr", "parameters" : { "additionalProperties" : 0, "properties" : { - "feature" : { - "description" : "Feature to check.", - "enum" : [ - "snapshot" - ], + "id" : { + "description" : "The ID for the manager, when omitted the same as the nodename", + "optional" : 1, + "pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?", "type" : "string" }, "node" : { @@ -17298,211 +25838,170 @@ var pveapi = [ "format" : "pve-node", "type" : "string", "typetext" : "" - }, - "snapname" : { - "description" : "The name of the snapshot.", - "format" : "pve-configid", - "maxLength" : 40, - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" } } }, "permissions" : { "check" : [ "perm", - "/vms/{vmid}", + "/", [ - "VM.Audit" + "Sys.Modify" ] ] }, "protected" : 1, "proxyto" : "node", "returns" : { - "properties" : { - "hasFeature" : { - "type" : "boolean" - } - }, - "type" : "object" + "type" : "string" } } }, "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/feature", - "text" : "feature" - }, + "path" : "/nodes/{node}/ceph/mgr/{id}", + "text" : "{id}" + } + ], + "info" : { + "GET" : { + "description" : "MGR directory index.", + "method" : "GET", + "name" : "index", + "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" : { + "addr" : { + "optional" : 1, + "type" : "string" + }, + "host" : { + "optional" : 1, + "type" : "string" + }, + "name" : { + "description" : "The name (ID) for the MGR" + }, + "state" : { + "description" : "State of the MGR", + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/ceph/mgr", + "text" : "mgr" + }, + { + "children" : [ { "info" : { - "POST" : { - "description" : "Create a Template.", - "method" : "POST", - "name" : "template", + "DELETE" : { + "description" : "Destroy Ceph Monitor and Manager.", + "method" : "DELETE", + "name" : "destroymon", "parameters" : { "additionalProperties" : 0, "properties" : { - "experimental" : { - "default" : 0, - "description" : "The template feature is experimental, set this flag if you know what you are doing.", - "type" : "boolean", - "typetext" : "" + "monid" : { + "description" : "Monitor ID", + "pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?", + "type" : "string" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" } } }, "permissions" : { "check" : [ "perm", - "/vms/{vmid}", + "/", [ - "VM.Allocate" + "Sys.Modify" ] - ], - "description" : "You need 'VM.Allocate' permissions on /vms/{vmid}" + ] }, "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "null" + "type" : "string" } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/template", - "text" : "template" - }, - { - "info" : { + }, "POST" : { - "description" : "Create a container clone/copy", + "description" : "Create Ceph Monitor and Manager", "method" : "POST", - "name" : "clone_vm", + "name" : "createmon", "parameters" : { "additionalProperties" : 0, "properties" : { - "description" : { - "description" : "Description for the new CT.", + "mon-address" : { + "description" : "Overwrites autodetected monitor IP address. Must be in the public network of ceph.", + "format" : "ip", "optional" : 1, "type" : "string", "typetext" : "" }, - "experimental" : { - "default" : 0, - "description" : "The clone feature is experimental, set this flag if you know what you are doing.", - "type" : "boolean", - "typetext" : "" - }, - "full" : { - "default" : 0, - "description" : "Create a full copy of all disk. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "hostname" : { - "description" : "Set a hostname for the new CT.", - "format" : "dns-name", + "monid" : { + "description" : "The ID for the monitor, when omitted the same as the nodename", "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "newid" : { - "description" : "VMID for the clone.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" + "pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?", + "type" : "string" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" - }, - "pool" : { - "description" : "Add the new CT to the specified pool.", - "format" : "pve-poolid", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "snapname" : { - "description" : "The name of the snapshot.", - "format" : "pve-configid", - "maxLength" : 40, - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "storage" : { - "description" : "Target storage for full clone.", - "format" : "pve-storage-id", - "optional" : 1, - "requires" : "full", - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" } } }, "permissions" : { "check" : [ - "and", - [ - "perm", - "/vms/{vmid}", - [ - "VM.Clone" - ] - ], - [ - "or", - [ - "perm", - "/vms/{newid}", - [ - "VM.Allocate" - ] - ], - [ - "perm", - "/pool/{pool}", - [ - "VM.Allocate" - ], - "require_param", - "pool" - ] + "perm", + "/", + [ + "Sys.Modify" ] - ], - "description" : "You need 'VM.Clone' permissions on /vms/{vmid}, and 'VM.Allocate' permissions on /vms/{newid} (or on the VM pool /pool/{pool}). You also need 'Datastore.AllocateSpace' on any used storage." + ] }, "protected" : 1, "proxyto" : "node", @@ -17512,91 +26011,139 @@ var pveapi = [ } }, "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/clone", - "text" : "clone" - }, + "path" : "/nodes/{node}/ceph/mon/{monid}", + "text" : "{monid}" + } + ], + "info" : { + "GET" : { + "description" : "Get Ceph monitor list.", + "method" : "GET", + "name" : "listmon", + "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" : { + "addr" : { + "optional" : 1, + "type" : "string" + }, + "host" : { + "optional" : 1, + "type" : "string" + }, + "name" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/ceph/mon", + "text" : "mon" + }, + { + "children" : [ { "info" : { - "PUT" : { - "description" : "Resize a container mount point.", - "method" : "PUT", - "name" : "resize_vm", + "POST" : { + "description" : "Create a Ceph filesystem", + "method" : "POST", + "name" : "createfs", "parameters" : { "additionalProperties" : 0, "properties" : { - "digest" : { - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "maxLength" : 40, + "add-storage" : { + "default" : 0, + "description" : "Configure the created CephFS as storage for this cluster.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "name" : { + "default" : "cephfs", + "description" : "The ceph filesystem name.", "optional" : 1, "type" : "string", "typetext" : "" }, - "disk" : { - "description" : "The disk you want to resize.", - "enum" : [ - "rootfs", - "mp0", - "mp1", - "mp2", - "mp3", - "mp4", - "mp5", - "mp6", - "mp7", - "mp8", - "mp9" - ], - "type" : "string" - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" }, - "size" : { - "description" : "The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.", - "pattern" : "\\+?\\d+(\\.\\d+)?[KMGT]?", - "type" : "string" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, + "pg_num" : { + "default" : 128, + "description" : "Number of placement groups for the backing data pool. The metadata pool will use a quarter of this.", + "maximum" : 32768, + "minimum" : 8, + "optional" : 1, "type" : "integer", - "typetext" : " (1 - N)" + "typetext" : " (8 - 32768)" } } }, "permissions" : { "check" : [ "perm", - "/vms/{vmid}", + "/", [ - "VM.Config.Disk" - ], - "any", - 1 + "Sys.Modify" + ] ] }, "protected" : 1, "proxyto" : "node", "returns" : { - "description" : "the task ID.", "type" : "string" } } }, "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/resize", - "text" : "resize" + "path" : "/nodes/{node}/ceph/fs/{name}", + "text" : "{name}" } ], "info" : { - "DELETE" : { - "description" : "Destroy the container (also delete all uses files).", - "method" : "DELETE", - "name" : "destroy_vm", + "GET" : { + "description" : "Directory index.", + "method" : "GET", + "name" : "index", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -17605,35 +26152,143 @@ var pveapi = [ "format" : "pve-node", "type" : "string", "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit", + "Datastore.Audit" + ], + "any", + 1 + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "data_pool" : { + "description" : "The name of the data pool.", + "type" : "string" + }, + "metadata_pool" : { + "description" : "The name of the metadata pool.", + "type" : "string" + }, + "name" : { + "description" : "The ceph filesystem name.", + "type" : "string" + } }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/ceph/fs", + "text" : "fs" + }, + { + "info" : { + "GET" : { + "description" : "List local disks.", + "method" : "GET", + "name" : "disks", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "type" : { + "description" : "Only list specific types of disks.", + "enum" : [ + "unused", + "journal_disks" + ], + "optional" : 1, + "type" : "string" } } }, "permissions" : { "check" : [ "perm", - "/vms/{vmid}", + "/", [ - "VM.Allocate" - ] + "Sys.Audit", + "Datastore.Audit" + ], + "any", + 1 ] }, "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "string" + "items" : { + "properties" : { + "dev" : { + "type" : "string" + }, + "gpt" : { + "type" : "boolean" + }, + "model" : { + "optional" : 1, + "type" : "string" + }, + "osdid" : { + "type" : "integer" + }, + "serial" : { + "optional" : 1, + "type" : "string" + }, + "size" : { + "type" : "integer" + }, + "used" : { + "optional" : 1, + "type" : "string" + }, + "vendor" : { + "optional" : 1, + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" } - }, + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/ceph/disks", + "text" : "disks" + }, + { + "info" : { "GET" : { - "description" : "Directory index", + "description" : "Get Ceph configuration.", "method" : "GET", - "name" : "vmdiridx", + "name" : "config", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -17642,689 +26297,641 @@ var pveapi = [ "format" : "pve-node", "type" : "string", "typetext" : "" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" } } }, "permissions" : { - "user" : "all" - }, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : { - "subdir" : { - "type" : "string" - } - }, - "type" : "object" - }, - "links" : [ - { - "href" : "{subdir}", - "rel" : "child" - } - ], - "type" : "array" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/lxc/{vmid}", - "text" : "{vmid}" - } - ], - "info" : { - "GET" : { - "description" : "LXC container index (per node).", - "method" : "GET", - "name" : "vmlist", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "description" : "Only list CTs where you have VM.Audit permissons on /vms/.", - "user" : "all" - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "links" : [ - { - "href" : "{vmid}", - "rel" : "child" - } - ], - "type" : "array" - } - }, - "POST" : { - "description" : "Create or restore a container.", - "method" : "POST", - "name" : "create_vm", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "arch" : { - "default" : "amd64", - "description" : "OS architecture type.", - "enum" : [ - "amd64", - "i386" - ], - "optional" : 1, - "type" : "string" - }, - "cmode" : { - "default" : "tty", - "description" : "Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).", - "enum" : [ - "shell", - "console", - "tty" - ], - "optional" : 1, - "type" : "string" - }, - "console" : { - "default" : 1, - "description" : "Attach a console device (/dev/console) to the container.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "cores" : { - "description" : "The number of cores assigned to the container. A container can use all available cores by default.", - "maximum" : 128, - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - 128)" - }, - "cpulimit" : { - "default" : 0, - "description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.", - "maximum" : 128, - "minimum" : 0, - "optional" : 1, - "type" : "number", - "typetext" : " (0 - 128)" - }, - "cpuunits" : { - "default" : 1024, - "description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0.", - "maximum" : 500000, - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - 500000)" - }, - "description" : { - "description" : "Container description. Only used on the configuration web interface.", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "force" : { - "description" : "Allow to overwrite existing container.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "hostname" : { - "description" : "Set a host name for the container.", - "format" : "dns-name", - "maxLength" : 255, - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "ignore-unpack-errors" : { - "description" : "Ignore errors when extracting the template.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "lock" : { - "description" : "Lock/unlock the VM.", - "enum" : [ - "migrate", - "backup", - "snapshot", - "rollback" - ], - "optional" : 1, - "type" : "string" - }, - "memory" : { - "default" : 512, - "description" : "Amount of RAM for the VM in MB.", - "minimum" : 16, - "optional" : 1, - "type" : "integer", - "typetext" : " (16 - N)" - }, - "mp[n]" : { - "description" : "Use volume as container mount point.", - "format" : { - "acl" : { - "description" : "Explicitly enable or disable ACL support.", - "optional" : 1, - "type" : "boolean" - }, - "backup" : { - "description" : "Whether to include the mount point in backups.", - "optional" : 1, - "type" : "boolean", - "verbose_description" : "Whether to include the mount point in backups (only used for volume mount points)." - }, - "mp" : { - "description" : "Path to the mount point as seen from inside the container (must not contain symlinks).", - "format" : "pve-lxc-mp-string", - "format_description" : "Path", - "type" : "string", - "verbose_description" : "Path to the mount point as seen from inside the container.\n\nNOTE: Must not contain any symlinks for security reasons." - }, - "quota" : { - "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)", - "optional" : 1, - "type" : "boolean" - }, - "replicate" : { - "default" : 1, - "description" : "Will include this volume to a storage replica job.", - "optional" : 1, - "type" : "boolean" - }, - "ro" : { - "description" : "Read-only mount point", - "optional" : 1, - "type" : "boolean" - }, - "shared" : { - "default" : 0, - "description" : "Mark this non-volume mount point as available on multiple nodes (see 'nodes')", - "optional" : 1, - "type" : "boolean", - "verbose_description" : "Mark this non-volume mount point as available on all nodes.\n\nWARNING: This option does not share the mount point automatically, it assumes it is shared already!" - }, - "size" : { - "description" : "Volume size (read only value).", - "format" : "disk-size", - "format_description" : "DiskSize", - "optional" : 1, - "type" : "string" - }, - "volume" : { - "default_key" : 1, - "description" : "Volume, device or directory to mount into the container.", - "format" : "pve-lxc-mp-string", - "format_description" : "volume", - "type" : "string" - } - }, - "optional" : 1, - "type" : "string", - "typetext" : "[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]" - }, - "nameserver" : { - "description" : "Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.", - "format" : "address-list", - "optional" : 1, - "type" : "string", - "typetext" : "" + "check" : [ + "perm", + "/", + [ + "Sys.Audit", + "Datastore.Audit" + ], + "any", + 1 + ] }, - "net[n]" : { - "description" : "Specifies network interfaces for the container.", - "format" : { - "bridge" : { - "description" : "Bridge to attach the network device to.", - "format_description" : "bridge", - "optional" : 1, - "pattern" : "[-_.\\w\\d]+", - "type" : "string" - }, - "firewall" : { - "description" : "Controls whether this interface's firewall rules should be used.", - "optional" : 1, - "type" : "boolean" - }, - "gw" : { - "description" : "Default gateway for IPv4 traffic.", - "format" : "ipv4", - "format_description" : "GatewayIPv4", - "optional" : 1, - "type" : "string" - }, - "gw6" : { - "description" : "Default gateway for IPv6 traffic.", - "format" : "ipv6", - "format_description" : "GatewayIPv6", - "optional" : 1, - "type" : "string" - }, - "hwaddr" : { - "description" : "The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)", - "format_description" : "XX:XX:XX:XX:XX:XX", + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/ceph/config", + "text" : "config" + }, + { + "info" : { + "POST" : { + "description" : "Create initial ceph default configuration and setup symlinks.", + "method" : "POST", + "name" : "init", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "cluster-network" : { + "description" : "Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it", + "format" : "CIDR", + "maxLength" : 128, "optional" : 1, - "pattern" : "(?^i:(?:[a-f0-9]{2}:){5}[a-f0-9]{2})", - "type" : "string" + "requires" : "network", + "type" : "string", + "typetext" : "" }, - "ip" : { - "description" : "IPv4 address in CIDR format.", - "format" : "pve-ipv4-config", - "format_description" : "(IPv4/CIDR|dhcp|manual)", + "disable_cephx" : { + "default" : 0, + "description" : "Disable cephx authentication.\n\nWARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private!", "optional" : 1, - "type" : "string" + "type" : "boolean", + "typetext" : "" }, - "ip6" : { - "description" : "IPv6 address in CIDR format.", - "format" : "pve-ipv6-config", - "format_description" : "(IPv6/CIDR|auto|dhcp|manual)", + "min_size" : { + "default" : 2, + "description" : "Minimum number of available replicas per object to allow I/O", + "maximum" : 7, + "minimum" : 1, "optional" : 1, - "type" : "string" + "type" : "integer", + "typetext" : " (1 - 7)" }, - "mtu" : { - "description" : "Maximum transfer unit of the interface. (lxc.network.mtu)", - "minimum" : 64, + "network" : { + "description" : "Use specific network for all ceph related traffic", + "format" : "CIDR", + "maxLength" : 128, "optional" : 1, - "type" : "integer" + "type" : "string", + "typetext" : "" }, - "name" : { - "description" : "Name of the network device as seen from inside the container. (lxc.network.name)", - "format_description" : "string", - "pattern" : "[-_.\\w\\d]+", - "type" : "string" + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "rate" : { - "description" : "Apply rate limiting to the interface", - "format_description" : "mbps", + "pg_bits" : { + "default" : 6, + "description" : "Placement group bits, used to specify the default number of placement groups.\n\nNOTE: 'osd pool default pg num' does not work for default pools.", + "maximum" : 14, + "minimum" : 6, "optional" : 1, - "type" : "number" + "type" : "integer", + "typetext" : " (6 - 14)" }, - "tag" : { - "description" : "VLAN tag for this interface.", - "maximum" : 4094, + "size" : { + "default" : 3, + "description" : "Targeted number of replicas per object", + "maximum" : 7, "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - 7)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/ceph/init", + "text" : "init" + }, + { + "info" : { + "POST" : { + "description" : "Stop ceph services.", + "method" : "POST", + "name" : "stop", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "trunks" : { - "description" : "VLAN ids to pass through the interface", - "format_description" : "vlanid[;vlanid...]", + "service" : { + "default" : "ceph.target", + "description" : "Ceph service name.", "optional" : 1, - "pattern" : "(?^:\\d+(?:;\\d+)*)", + "pattern" : "(ceph|mon|mds|osd|mgr)\\.[A-Za-z0-9\\-]{1,32}", "type" : "string" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/ceph/stop", + "text" : "stop" + }, + { + "info" : { + "POST" : { + "description" : "Start ceph services.", + "method" : "POST", + "name" : "start", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "type" : { - "description" : "Network interface type.", - "enum" : [ - "veth" - ], + "service" : { + "default" : "ceph.target", + "description" : "Ceph service name.", "optional" : 1, + "pattern" : "(ceph|mon|mds|osd|mgr)\\.[A-Za-z0-9\\-]{1,32}", "type" : "string" } - }, - "optional" : 1, - "type" : "string", - "typetext" : "name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]" + } }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] }, - "onboot" : { - "default" : 0, - "description" : "Specifies whether a VM will be started during system bootup.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/ceph/start", + "text" : "start" + }, + { + "info" : { + "POST" : { + "description" : "Restart ceph services.", + "method" : "POST", + "name" : "restart", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "service" : { + "default" : "ceph.target", + "description" : "Ceph service name.", + "optional" : 1, + "pattern" : "(mon|mds|osd|mgr)\\.[A-Za-z0-9\\-]{1,32}", + "type" : "string" + } + } }, - "ostemplate" : { - "description" : "The OS template or backup file.", - "maxLength" : 255, - "type" : "string", - "typetext" : "" + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] }, - "ostype" : { - "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", - "ubuntu", - "centos", - "fedora", - "opensuse", - "archlinux", - "alpine", - "gentoo", - "unmanaged" - ], - "optional" : 1, + "protected" : 1, + "proxyto" : "node", + "returns" : { "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/ceph/restart", + "text" : "restart" + }, + { + "info" : { + "GET" : { + "description" : "Get ceph status.", + "method" : "GET", + "name" : "status", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } }, - "password" : { - "description" : "Sets root password inside container.", - "minLength" : 5, - "optional" : 1, - "type" : "string", - "typetext" : "" + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit", + "Datastore.Audit" + ], + "any", + 1 + ] }, - "pool" : { - "description" : "Add the VM to the specified pool.", - "format" : "pve-poolid", - "optional" : 1, - "type" : "string", - "typetext" : "" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/ceph/status", + "text" : "status" + }, + { + "children" : [ + { + "info" : { + "DELETE" : { + "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" + } + } }, - "protection" : { - "default" : 0, - "description" : "Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" + "leaf" : 1, + "path" : "/nodes/{node}/ceph/pools/{name}", + "text" : "{name}" + } + ], + "info" : { + "GET" : { + "description" : "List all pools.", + "method" : "GET", + "name" : "lspools", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } }, - "restore" : { - "description" : "Mark this as restore task.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit", + "Datastore.Audit" + ], + "any", + 1 + ] }, - "rootfs" : { - "description" : "Use volume as container root.", - "format" : { - "acl" : { - "description" : "Explicitly enable or disable ACL support.", + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "pool" : { + "type" : "integer" + }, + "pool_name" : { + "type" : "string" + }, + "size" : { + "type" : "integer" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{pool_name}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "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" + "type" : "boolean", + "typetext" : "" }, - "quota" : { - "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)", + "application" : { + "description" : "The application of the pool, 'rbd' by default.", + "enum" : [ + "rbd", + "cephfs", + "rgw" + ], "optional" : 1, - "type" : "boolean" + "type" : "string" }, - "replicate" : { - "default" : 1, - "description" : "Will include this volume to a storage replica job.", + "crush_rule" : { + "description" : "The rule to use for mapping object placement in the cluster.", "optional" : 1, - "type" : "boolean" + "type" : "string", + "typetext" : "" }, - "ro" : { - "description" : "Read-only mount point", + "min_size" : { + "default" : 2, + "description" : "Minimum number of replicas per object", + "maximum" : 7, + "minimum" : 1, "optional" : 1, - "type" : "boolean" + "type" : "integer", + "typetext" : " (1 - 7)" }, - "shared" : { - "default" : 0, - "description" : "Mark this non-volume mount point as available on multiple nodes (see 'nodes')", + "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_num" : { + "default" : 128, + "description" : "Number of placement groups.", + "maximum" : 32768, + "minimum" : 8, "optional" : 1, - "type" : "boolean", - "verbose_description" : "Mark this non-volume mount point as available on all nodes.\n\nWARNING: This option does not share the mount point automatically, it assumes it is shared already!" + "type" : "integer", + "typetext" : " (8 - 32768)" }, "size" : { - "description" : "Volume size (read only value).", - "format" : "disk-size", - "format_description" : "DiskSize", + "default" : 3, + "description" : "Number of replicas per object", + "maximum" : 7, + "minimum" : 1, "optional" : 1, - "type" : "string" - }, - "volume" : { - "default_key" : 1, - "description" : "Volume, device or directory to mount into the container.", - "format" : "pve-lxc-mp-string", - "format_description" : "volume", - "type" : "string" + "type" : "integer", + "typetext" : " (1 - 7)" } - }, - "optional" : 1, - "type" : "string", - "typetext" : "[volume=] [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]" - }, - "searchdomain" : { - "description" : "Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.", - "format" : "dns-name-list", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "ssh-public-keys" : { - "description" : "Setup public SSH keys (one key per line, OpenSSH format).", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "startup" : { - "description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.", - "format" : "pve-startup-order", - "optional" : 1, - "type" : "string", - "typetext" : "[[order=]\\d+] [,up=\\d+] [,down=\\d+] " - }, - "storage" : { - "default" : "local", - "description" : "Default Storage.", - "format" : "pve-storage-id", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "swap" : { - "default" : 512, - "description" : "Amount of SWAP for the VM in MB.", - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" - }, - "template" : { - "default" : 0, - "description" : "Enable/disable Template.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "tty" : { - "default" : 2, - "description" : "Specify the number of tty available to the container", - "maximum" : 6, - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - 6)" - }, - "unprivileged" : { - "default" : 0, - "description" : "Makes the container run as unprivileged user. (Should not be modified manually.)", - "optional" : 1, - "type" : "boolean", - "typetext" : "" + } }, - "unused[n]" : { - "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.", - "format" : "pve-volume-id", - "optional" : 1, - "type" : "string", - "typetext" : "" + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" } } }, - "permissions" : { - "description" : "You need 'VM.Allocate' permissions on /vms/{vmid} or on the VM pool /pool/{pool}. For restore, it is enough if the user has 'VM.Backup' permission and the VM already exists. You also need 'Datastore.AllocateSpace' permissions on the storage.", - "user" : "all" - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/lxc", - "text" : "lxc" - }, - { - "children" : [ + "leaf" : 0, + "path" : "/nodes/{node}/ceph/pools", + "text" : "pools" + }, { "children" : [ { - "children" : [ - { - "info" : { - "POST" : { - "description" : "ceph osd in", - "method" : "POST", - "name" : "in", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "osdid" : { - "description" : "OSD ID", - "type" : "integer", - "typetext" : "" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "null" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/ceph/osd/{osdid}/in", - "text" : "in" - }, - { - "info" : { - "POST" : { - "description" : "ceph osd out", - "method" : "POST", - "name" : "out", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "osdid" : { - "description" : "OSD ID", - "type" : "integer", - "typetext" : "" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] + "info" : { + "DELETE" : { + "description" : "Unset a ceph flag", + "method" : "DELETE", + "name" : "unset_flag", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "flag" : { + "description" : "The ceph flag to set/unset", + "enum" : [ + "full", + "pause", + "noup", + "nodown", + "noout", + "noin", + "nobackfill", + "norebalance", + "norecover", + "noscrub", + "nodeep-scrub", + "notieragent" + ], + "type" : "string" }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "null" + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" } } }, - "leaf" : 1, - "path" : "/nodes/{node}/ceph/osd/{osdid}/out", - "text" : "out" - } - ], - "info" : { - "DELETE" : { - "description" : "Destroy OSD", - "method" : "DELETE", - "name" : "destroyosd", + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + }, + "POST" : { + "description" : "Set a ceph flag", + "method" : "POST", + "name" : "set_flag", "parameters" : { "additionalProperties" : 0, "properties" : { - "cleanup" : { - "default" : 0, - "description" : "If set, we remove partition table entries.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" + "flag" : { + "description" : "The ceph flag to set/unset", + "enum" : [ + "full", + "pause", + "noup", + "nodown", + "noout", + "noin", + "nobackfill", + "norebalance", + "norecover", + "noscrub", + "nodeep-scrub", + "notieragent" + ], + "type" : "string" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" - }, - "osdid" : { - "description" : "OSD ID", - "type" : "integer", - "typetext" : "" } } }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "string" + "type" : "null" } } }, - "leaf" : 0, - "path" : "/nodes/{node}/ceph/osd/{osdid}", - "text" : "{osdid}" + "leaf" : 1, + "path" : "/nodes/{node}/ceph/flags/{flag}", + "text" : "{flag}" } ], "info" : { "GET" : { - "description" : "Get Ceph osd list/tree.", + "description" : "get all set ceph flags", "method" : "GET", - "name" : "index", + "name" : "get_flags", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/ceph/flags", + "text" : "flags" + }, + { + "info" : { + "GET" : { + "description" : "Get OSD crush map", + "method" : "GET", + "name" : "crush", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -18351,44 +26958,28 @@ var pveapi = [ "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "object" + "type" : "string" } - }, - "POST" : { - "description" : "Create OSD", - "method" : "POST", - "name" : "createosd", + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/ceph/crush", + "text" : "crush" + }, + { + "info" : { + "GET" : { + "description" : "Read ceph log", + "method" : "GET", + "name" : "log", "parameters" : { "additionalProperties" : 0, "properties" : { - "bluestore" : { - "default" : 1, - "description" : "Use bluestore instead of filestore. This is the default.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "dev" : { - "description" : "Block device name.", - "type" : "string", - "typetext" : "" - }, - "fstype" : { - "default" : "xfs", - "description" : "File system type (filestore only).", - "enum" : [ - "xfs", - "ext4", - "btrfs" - ], - "optional" : 1, - "type" : "string" - }, - "journal_dev" : { - "description" : "Block device name for journal (filestore) or block.db (bluestore).", + "limit" : { + "minimum" : 0, "optional" : 1, - "type" : "string", - "typetext" : "" + "type" : "integer", + "typetext" : " (0 - N)" }, "node" : { "description" : "The cluster node name.", @@ -18396,31 +26987,53 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "wal_dev" : { - "description" : "Block device name for block.wal (bluestore only).", + "start" : { + "minimum" : 0, "optional" : 1, - "type" : "string", - "typetext" : "" + "type" : "integer", + "typetext" : " (0 - N)" } } }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Syslog" + ] + ] + }, "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "string" + "items" : { + "properties" : { + "n" : { + "description" : "Line number", + "type" : "integer" + }, + "t" : { + "description" : "Line text", + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" } } }, - "leaf" : 0, - "path" : "/nodes/{node}/ceph/osd", - "text" : "osd" + "leaf" : 1, + "path" : "/nodes/{node}/ceph/log", + "text" : "log" }, { "info" : { "GET" : { - "description" : "List local disks.", + "description" : "List ceph rules.", "method" : "GET", - "name" : "disks", + "name" : "rules", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -18429,15 +27042,6 @@ var pveapi = [ "format" : "pve-node", "type" : "string", "typetext" : "" - }, - "type" : { - "description" : "Only list specific types of disks.", - "enum" : [ - "unused", - "journal_disks" - ], - "optional" : 1, - "type" : "string" } } }, @@ -18457,52 +27061,79 @@ var pveapi = [ "proxyto" : "node", "returns" : { "items" : { - "properties" : { - "dev" : { - "type" : "string" - }, - "gpt" : { - "type" : "boolean" - }, - "model" : { - "optional" : 1, - "type" : "string" - }, - "osdid" : { - "type" : "integer" - }, - "serial" : { - "optional" : 1, - "type" : "string" - }, - "size" : { - "type" : "integer" - }, - "used" : { - "optional" : 1, - "type" : "string" - }, - "vendor" : { - "optional" : 1, - "type" : "string" - } - }, + "properties" : {}, "type" : "object" }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], "type" : "array" } } }, - "leaf" : 1, - "path" : "/nodes/{node}/ceph/disks", - "text" : "disks" - }, + "leaf" : 1, + "path" : "/nodes/{node}/ceph/rules", + "text" : "rules" + } + ], + "info" : { + "GET" : { + "description" : "Directory index.", + "method" : "GET", + "name" : "index", + "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 + ] + }, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/ceph", + "text" : "ceph" + }, + { + "children" : [ { "info" : { "GET" : { - "description" : "Get Ceph configuration.", + "description" : "Extract configuration from vzdump backup archive.", "method" : "GET", - "name" : "config", + "name" : "extractconfig", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -18511,295 +27142,416 @@ var pveapi = [ "format" : "pve-node", "type" : "string", "typetext" : "" + }, + "volume" : { + "description" : "Volume identifier", + "type" : "string", + "typetext" : "" } } }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit", - "Datastore.Audit" - ], - "any", - 1 - ] + "permissions" : { + "description" : "The user needs 'VM.Backup' permissions on the backed up guest ID, and 'Datastore.AllocateSpace' on the backup storage.", + "user" : "all" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/vzdump/extractconfig", + "text" : "extractconfig" + } + ], + "info" : { + "POST" : { + "description" : "Create backup.", + "method" : "POST", + "name" : "vzdump", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "all" : { + "default" : 0, + "description" : "Backup all known guest systems on this host.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "bwlimit" : { + "default" : 0, + "description" : "Limit I/O bandwidth (KBytes per second).", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "compress" : { + "default" : "0", + "description" : "Compress dump file.", + "enum" : [ + "0", + "1", + "gzip", + "lzo" + ], + "optional" : 1, + "type" : "string" + }, + "dumpdir" : { + "description" : "Store resulting files to specified directory.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "exclude" : { + "description" : "Exclude specified guest systems (assumes --all)", + "format" : "pve-vmid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "exclude-path" : { + "description" : "Exclude certain files/directories (shell globs).", + "format" : "string-alist", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "ionice" : { + "default" : 7, + "description" : "Set CFQ ionice priority.", + "maximum" : 8, + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - 8)" + }, + "lockwait" : { + "default" : 180, + "description" : "Maximal time to wait for the global lock (minutes).", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "mailnotification" : { + "default" : "always", + "description" : "Specify when to send an email", + "enum" : [ + "always", + "failure" + ], + "optional" : 1, + "type" : "string" + }, + "mailto" : { + "description" : "Comma-separated list of email addresses that should receive email notifications.", + "format" : "string-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "maxfiles" : { + "default" : 1, + "description" : "Maximal number of backup files per guest system.", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "mode" : { + "default" : "snapshot", + "description" : "Backup mode.", + "enum" : [ + "snapshot", + "suspend", + "stop" + ], + "optional" : 1, + "type" : "string" + }, + "node" : { + "description" : "Only run if executed on this node.", + "format" : "pve-node", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "pigz" : { + "default" : 0, + "description" : "Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "pool" : { + "description" : "Backup all known guest systems included in the specified pool.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "quiet" : { + "default" : 0, + "description" : "Be quiet.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "remove" : { + "default" : 1, + "description" : "Remove old backup files if there are more than 'maxfiles' backup files.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "script" : { + "description" : "Use specified hook script.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "size" : { + "default" : 1024, + "description" : "Unused, will be removed in a future release.", + "minimum" : 500, + "optional" : 1, + "type" : "integer", + "typetext" : " (500 - N)" + }, + "stdexcludes" : { + "default" : 1, + "description" : "Exclude temporary files and logs.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "stdout" : { + "description" : "Write tar to stdout, not to a file.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "stop" : { + "default" : 0, + "description" : "Stop running backup jobs on this host.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "stopwait" : { + "default" : 10, + "description" : "Maximal time to wait until a guest system is stopped (minutes).", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "storage" : { + "description" : "Store resulting file to this storage.", + "format" : "pve-storage-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "tmpdir" : { + "description" : "Store temporary files to specified directory.", + "optional" : 1, + "type" : "string", + "typetext" : "" }, - "returns" : { - "type" : "string" + "vmid" : { + "description" : "The ID of the guest system you want to backup.", + "format" : "pve-vmid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" } } }, - "leaf" : 1, - "path" : "/nodes/{node}/ceph/config", - "text" : "config" - }, + "permissions" : { + "description" : "The user needs 'VM.Backup' permissions on any VM, and 'Datastore.AllocateSpace' on the backup storage. The 'maxfiles', 'tmpdir', 'dumpdir', 'script', 'bwlimit' and 'ionice' parameters are restricted to the 'root@pam' user.", + "user" : "all" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/vzdump", + "text" : "vzdump" + }, + { + "children" : [ { "children" : [ { "info" : { - "DELETE" : { - "description" : "Destroy Ceph Monitor and Manager.", - "method" : "DELETE", - "name" : "destroymon", + "GET" : { + "description" : "Read service properties", + "method" : "GET", + "name" : "service_state", "parameters" : { "additionalProperties" : 0, "properties" : { - "exclude-manager" : { - "default" : 0, - "description" : "When set, removes only the monitor, not the manager", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "monid" : { - "description" : "Monitor ID", - "pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?", - "type" : "string" - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" + }, + "service" : { + "description" : "Service ID", + "enum" : [ + "pveproxy", + "pvedaemon", + "spiceproxy", + "pvestatd", + "pve-cluster", + "corosync", + "pve-firewall", + "pvefw-logger", + "pve-ha-crm", + "pve-ha-lrm", + "sshd", + "syslog", + "cron", + "postfix", + "ksmtuned", + "systemd-timesyncd" + ], + "type" : "string" } } }, "permissions" : { "check" : [ "perm", - "/", + "/nodes/{node}", [ - "Sys.Modify" + "Sys.Audit" ] ] }, "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "string" + "type" : "object" } } }, "leaf" : 1, - "path" : "/nodes/{node}/ceph/mon/{monid}", - "text" : "{monid}" - } - ], - "info" : { - "GET" : { - "description" : "Get Ceph monitor list.", - "method" : "GET", - "name" : "listmon", - "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" : { - "addr" : { - "type" : "string" - }, - "name" : { - "type" : "string" - } - }, - "type" : "object" - }, - "links" : [ - { - "href" : "{name}", - "rel" : "child" - } - ], - "type" : "array" - } + "path" : "/nodes/{node}/services/{service}/state", + "text" : "state" }, - "POST" : { - "description" : "Create Ceph Monitor and Manager", - "method" : "POST", - "name" : "createmon", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "exclude-manager" : { - "default" : 0, - "description" : "When set, only a monitor will be created.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "id" : { - "description" : "The ID for the monitor, when omitted the same as the nodename", - "optional" : 1, - "pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?", - "type" : "string" - }, - "mon-address" : { - "description" : "Overwrites autodetected monitor IP address. Must be in the public network of ceph.", - "format" : "ip", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/ceph/mon", - "text" : "mon" - }, - { - "info" : { - "POST" : { - "description" : "Create initial ceph default configuration and setup symlinks.", - "method" : "POST", - "name" : "init", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "disable_cephx" : { - "default" : 0, - "description" : "Disable cephx authentification.\n\nWARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private!", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "min_size" : { - "default" : 2, - "description" : "Minimum number of available replicas per object to allow I/O", - "maximum" : 7, - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - 7)" - }, - "network" : { - "description" : "Use specific network for all ceph related traffic", - "format" : "CIDR", - "maxLength" : 128, - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + { + "info" : { + "POST" : { + "description" : "Start service.", + "method" : "POST", + "name" : "service_start", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "service" : { + "description" : "Service ID", + "enum" : [ + "pveproxy", + "pvedaemon", + "spiceproxy", + "pvestatd", + "pve-cluster", + "corosync", + "pve-firewall", + "pvefw-logger", + "pve-ha-crm", + "pve-ha-lrm", + "sshd", + "syslog", + "cron", + "postfix", + "ksmtuned", + "systemd-timesyncd" + ], + "type" : "string" + } + } }, - "pg_bits" : { - "default" : 6, - "description" : "Placement group bits, used to specify the default number of placement groups.\n\nNOTE: 'osd pool default pg num' does not work for default pools.", - "maximum" : 14, - "minimum" : 6, - "optional" : 1, - "type" : "integer", - "typetext" : " (6 - 14)" + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Modify" + ] + ] }, - "size" : { - "default" : 3, - "description" : "Targeted number of replicas per object", - "maximum" : 7, - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - 7)" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" } } }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "null" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/ceph/init", - "text" : "init" - }, - { - "children" : [ + "leaf" : 1, + "path" : "/nodes/{node}/services/{service}/start", + "text" : "start" + }, { "info" : { - "DELETE" : { - "description" : "Destroy Ceph Manager.", - "method" : "DELETE", - "name" : "destroymgr", + "POST" : { + "description" : "Stop service.", + "method" : "POST", + "name" : "service_stop", "parameters" : { "additionalProperties" : 0, "properties" : { - "id" : { - "description" : "The ID of the manager", - "pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?", - "type" : "string" - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" + }, + "service" : { + "description" : "Service ID", + "enum" : [ + "pveproxy", + "pvedaemon", + "spiceproxy", + "pvestatd", + "pve-cluster", + "corosync", + "pve-firewall", + "pvefw-logger", + "pve-ha-crm", + "pve-ha-lrm", + "sshd", + "syslog", + "cron", + "postfix", + "ksmtuned", + "systemd-timesyncd" + ], + "type" : "string" } } }, "permissions" : { "check" : [ "perm", - "/", + "/nodes/{node}", [ "Sys.Modify" ] @@ -18813,101 +27565,133 @@ var pveapi = [ } }, "leaf" : 1, - "path" : "/nodes/{node}/ceph/mgr/{id}", - "text" : "{id}" - } - ], - "info" : { - "POST" : { - "description" : "Create Ceph Manager", - "method" : "POST", - "name" : "createmgr", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "id" : { - "description" : "The ID for the manager, when omitted the same as the nodename", - "optional" : 1, - "pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?", - "type" : "string" + "path" : "/nodes/{node}/services/{service}/stop", + "text" : "stop" + }, + { + "info" : { + "POST" : { + "description" : "Restart service.", + "method" : "POST", + "name" : "service_restart", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "service" : { + "description" : "Service ID", + "enum" : [ + "pveproxy", + "pvedaemon", + "spiceproxy", + "pvestatd", + "pve-cluster", + "corosync", + "pve-firewall", + "pvefw-logger", + "pve-ha-crm", + "pve-ha-lrm", + "sshd", + "syslog", + "cron", + "postfix", + "ksmtuned", + "systemd-timesyncd" + ], + "type" : "string" + } + } }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" } } }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/ceph/mgr", - "text" : "mgr" - }, - { - "info" : { - "POST" : { - "description" : "Stop ceph services.", - "method" : "POST", - "name" : "stop", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "leaf" : 1, + "path" : "/nodes/{node}/services/{service}/restart", + "text" : "restart" + }, + { + "info" : { + "POST" : { + "description" : "Reload service.", + "method" : "POST", + "name" : "service_reload", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "service" : { + "description" : "Service ID", + "enum" : [ + "pveproxy", + "pvedaemon", + "spiceproxy", + "pvestatd", + "pve-cluster", + "corosync", + "pve-firewall", + "pvefw-logger", + "pve-ha-crm", + "pve-ha-lrm", + "sshd", + "syslog", + "cron", + "postfix", + "ksmtuned", + "systemd-timesyncd" + ], + "type" : "string" + } + } }, - "service" : { - "description" : "Ceph service name.", - "optional" : 1, - "pattern" : "(mon|mds|osd|mgr)\\.[A-Za-z0-9\\-]{1,32}", + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { "type" : "string" } } }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } + "leaf" : 1, + "path" : "/nodes/{node}/services/{service}/reload", + "text" : "reload" } - }, - "leaf" : 1, - "path" : "/nodes/{node}/ceph/stop", - "text" : "stop" - }, - { + ], "info" : { - "POST" : { - "description" : "Start ceph services.", - "method" : "POST", - "name" : "start", + "GET" : { + "description" : "Directory index", + "method" : "GET", + "name" : "srvcmdidx", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -18918,9 +27702,25 @@ var pveapi = [ "typetext" : "" }, "service" : { - "description" : "Ceph service name.", - "optional" : 1, - "pattern" : "(mon|mds|osd|mgr)\\.[A-Za-z0-9\\-]{1,32}", + "description" : "Service ID", + "enum" : [ + "pveproxy", + "pvedaemon", + "spiceproxy", + "pvestatd", + "pve-cluster", + "corosync", + "pve-firewall", + "pvefw-logger", + "pve-ha-crm", + "pve-ha-lrm", + "sshd", + "syslog", + "cron", + "postfix", + "ksmtuned", + "systemd-timesyncd" + ], "type" : "string" } } @@ -18928,32 +27728,204 @@ var pveapi = [ "permissions" : { "check" : [ "perm", - "/", + "/nodes/{node}", [ - "Sys.Modify" + "Sys.Audit" ] ] }, - "protected" : 1, - "proxyto" : "node", "returns" : { - "type" : "string" + "items" : { + "properties" : { + "subdir" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{subdir}", + "rel" : "child" + } + ], + "type" : "array" } } }, - "leaf" : 1, - "path" : "/nodes/{node}/ceph/start", - "text" : "start" + "leaf" : 0, + "path" : "/nodes/{node}/services/{service}", + "text" : "{service}" + } + ], + "info" : { + "GET" : { + "description" : "Service list.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Audit" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{service}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/services", + "text" : "services" + }, + { + "info" : { + "GET" : { + "description" : "Read subscription info.", + "method" : "GET", + "name" : "get", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "user" : "all" + }, + "proxyto" : "node", + "returns" : { + "type" : "object" + } + }, + "POST" : { + "description" : "Update subscription info.", + "method" : "POST", + "name" : "update", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "force" : { + "default" : 0, + "description" : "Always connect to server, even if we have up to date info inside local cache.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } }, + "PUT" : { + "description" : "Set subscription key.", + "method" : "PUT", + "name" : "set", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "key" : { + "description" : "Proxmox VE subscription key", + "maxLength" : 32, + "pattern" : "pve([1248])([cbsp])-[0-9a-f]{10}", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/subscription", + "text" : "subscription" + }, + { + "children" : [ { "info" : { - "GET" : { - "description" : "Get ceph status.", - "method" : "GET", - "name" : "status", + "DELETE" : { + "description" : "Delete network device configuration", + "method" : "DELETE", + "name" : "delete_network", "parameters" : { "additionalProperties" : 0, "properties" : { + "iface" : { + "description" : "Network interface name.", + "format" : "pve-iface", + "maxLength" : 20, + "minLength" : 2, + "type" : "string", + "typetext" : "" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", @@ -18965,93 +27937,33 @@ var pveapi = [ "permissions" : { "check" : [ "perm", - "/", + "/nodes/{node}", [ - "Sys.Audit", - "Datastore.Audit" - ], - "any", - 1 + "Sys.Modify" + ] ] }, "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "object" + "type" : "null" } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/ceph/status", - "text" : "status" - }, - { - "children" : [ - { - "info" : { - "DELETE" : { - "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" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/ceph/pools/{name}", - "text" : "{name}" - } - ], - "info" : { + }, "GET" : { - "description" : "List all pools.", + "description" : "Read network device configuration", "method" : "GET", - "name" : "lspools", + "name" : "network_config", "parameters" : { "additionalProperties" : 0, "properties" : { + "iface" : { + "description" : "Network interface name.", + "format" : "pve-iface", + "maxLength" : 20, + "minLength" : 2, + "type" : "string", + "typetext" : "" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", @@ -19063,83 +27975,165 @@ var pveapi = [ "permissions" : { "check" : [ "perm", - "/", + "/nodes/{node}", [ - "Sys.Audit", - "Datastore.Audit" - ], - "any", - 1 + "Sys.Audit" + ] ] }, - "protected" : 1, "proxyto" : "node", "returns" : { - "items" : { - "properties" : { - "pool" : { - "type" : "integer" - }, - "pool_name" : { - "type" : "string" - }, - "size" : { - "type" : "integer" - } + "properties" : { + "method" : { + "type" : "string" }, - "type" : "object" - }, - "links" : [ - { - "href" : "{pool_name}", - "rel" : "child" + "type" : { + "type" : "string" } - ], - "type" : "array" + }, + "type" : "object" } }, - "POST" : { - "description" : "Create POOL", - "method" : "POST", - "name" : "createpool", + "PUT" : { + "description" : "Update network device configuration", + "method" : "PUT", + "name" : "update_network", "parameters" : { "additionalProperties" : 0, "properties" : { - "add_storages" : { - "description" : "Configure VM and CT storages using the new pool.", + "address" : { + "description" : "IP address.", + "format" : "ipv4", + "optional" : 1, + "requires" : "netmask", + "type" : "string", + "typetext" : "" + }, + "address6" : { + "description" : "IP address.", + "format" : "ipv6", + "optional" : 1, + "requires" : "netmask6", + "type" : "string", + "typetext" : "" + }, + "autostart" : { + "description" : "Automatically start interface on boot.", "optional" : 1, "type" : "boolean", "typetext" : "" }, - "application" : { - "description" : "The application of the pool, 'rbd' by default.", + "bond_mode" : { + "description" : "Bonding mode.", "enum" : [ - "rbd", - "cephfs", - "rgw" + "balance-rr", + "active-backup", + "balance-xor", + "broadcast", + "802.3ad", + "balance-tlb", + "balance-alb", + "balance-slb", + "lacp-balance-slb", + "lacp-balance-tcp" ], "optional" : 1, "type" : "string" }, - "crush_rule" : { - "description" : "The rule to use for mapping object placement in the cluster.", + "bond_xmit_hash_policy" : { + "description" : "Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes.", + "enum" : [ + "layer2", + "layer2+3", + "layer3+4" + ], + "optional" : 1, + "type" : "string" + }, + "bridge_ports" : { + "description" : "Specify the interfaces you want to add to your bridge.", + "format" : "pve-iface-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "bridge_vlan_aware" : { + "description" : "Enable bridge vlan support.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "cidr" : { + "description" : "IPv4 CIDR.", + "format" : "CIDRv4", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "cidr6" : { + "description" : "IPv6 CIDR.", + "format" : "CIDRv6", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "comments" : { + "description" : "Comments", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "comments6" : { + "description" : "Comments", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "gateway" : { + "description" : "Default gateway address.", + "format" : "ipv4", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "gateway6" : { + "description" : "Default ipv6 gateway address.", + "format" : "ipv6", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "iface" : { + "description" : "Network interface name.", + "format" : "pve-iface", + "maxLength" : 20, + "minLength" : 2, + "type" : "string", + "typetext" : "" + }, + "netmask" : { + "description" : "Network mask.", + "format" : "ipv4mask", "optional" : 1, + "requires" : "address", "type" : "string", "typetext" : "" }, - "min_size" : { - "default" : 2, - "description" : "Minimum number of replicas per object", - "maximum" : 7, - "minimum" : 1, + "netmask6" : { + "description" : "Network mask.", + "maximum" : 128, + "minimum" : 0, "optional" : 1, + "requires" : "address6", "type" : "integer", - "typetext" : " (1 - 7)" - }, - "name" : { - "description" : "The name of the pool. It must be unique.", - "type" : "string", - "typetext" : "" + "typetext" : " (0 - 128)" }, "node" : { "description" : "The cluster node name.", @@ -19147,396 +28141,570 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "pg_num" : { - "default" : 64, - "description" : "Number of placement groups.", - "maximum" : 32768, - "minimum" : 8, + "ovs_bonds" : { + "description" : "Specify the interfaces used by the bonding device.", + "format" : "pve-iface-list", "optional" : 1, - "type" : "integer", - "typetext" : " (8 - 32768)" + "type" : "string", + "typetext" : "" }, - "size" : { - "default" : 3, - "description" : "Number of replicas per object", - "maximum" : 7, + "ovs_bridge" : { + "description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port.", + "format" : "pve-iface", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "ovs_options" : { + "description" : "OVS interface options.", + "maxLength" : 1024, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "ovs_ports" : { + "description" : "Specify the interfaces you want to add to your bridge.", + "format" : "pve-iface-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "ovs_tag" : { + "description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)", + "maximum" : 4094, "minimum" : 1, "optional" : 1, "type" : "integer", - "typetext" : " (1 - 7)" + "typetext" : " (1 - 4094)" + }, + "slaves" : { + "description" : "Specify the interfaces used by the bonding device.", + "format" : "pve-iface-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "type" : { + "description" : "Network interface type", + "enum" : [ + "bridge", + "bond", + "eth", + "alias", + "vlan", + "OVSBridge", + "OVSBond", + "OVSPort", + "OVSIntPort", + "unknown" + ], + "type" : "string" } } }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/network/{iface}", + "text" : "{iface}" + } + ], + "info" : { + "DELETE" : { + "description" : "Revert network configuration changes.", + "method" : "DELETE", + "name" : "revert_network_changes", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + }, + "GET" : { + "description" : "List available networks", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "type" : { + "description" : "Only list specific interface types.", + "enum" : [ + "bridge", + "bond", + "eth", + "alias", + "vlan", + "OVSBridge", + "OVSBond", + "OVSPort", + "OVSIntPort", + "any_bridge" + ], + "optional" : 1, + "type" : "string" + } + } + }, + "permissions" : { + "user" : "all" + }, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{iface}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "description" : "Create network device configuration", + "method" : "POST", + "name" : "create_network", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "address" : { + "description" : "IP address.", + "format" : "ipv4", + "optional" : 1, + "requires" : "netmask", + "type" : "string", + "typetext" : "" + }, + "address6" : { + "description" : "IP address.", + "format" : "ipv6", + "optional" : 1, + "requires" : "netmask6", + "type" : "string", + "typetext" : "" + }, + "autostart" : { + "description" : "Automatically start interface on boot.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "bond_mode" : { + "description" : "Bonding mode.", + "enum" : [ + "balance-rr", + "active-backup", + "balance-xor", + "broadcast", + "802.3ad", + "balance-tlb", + "balance-alb", + "balance-slb", + "lacp-balance-slb", + "lacp-balance-tcp" + ], + "optional" : 1, + "type" : "string" + }, + "bond_xmit_hash_policy" : { + "description" : "Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes.", + "enum" : [ + "layer2", + "layer2+3", + "layer3+4" + ], + "optional" : 1, + "type" : "string" + }, + "bridge_ports" : { + "description" : "Specify the interfaces you want to add to your bridge.", + "format" : "pve-iface-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "bridge_vlan_aware" : { + "description" : "Enable bridge vlan support.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "cidr" : { + "description" : "IPv4 CIDR.", + "format" : "CIDRv4", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "cidr6" : { + "description" : "IPv6 CIDR.", + "format" : "CIDRv6", + "optional" : 1, + "type" : "string", + "typetext" : "" }, - "protected" : 1, - "proxyto" : "node", - "returns" : { + "comments" : { + "description" : "Comments", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "comments6" : { + "description" : "Comments", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "gateway" : { + "description" : "Default gateway address.", + "format" : "ipv4", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "gateway6" : { + "description" : "Default ipv6 gateway address.", + "format" : "ipv6", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "iface" : { + "description" : "Network interface name.", + "format" : "pve-iface", + "maxLength" : 20, + "minLength" : 2, + "type" : "string", + "typetext" : "" + }, + "netmask" : { + "description" : "Network mask.", + "format" : "ipv4mask", + "optional" : 1, + "requires" : "address", + "type" : "string", + "typetext" : "" + }, + "netmask6" : { + "description" : "Network mask.", + "maximum" : 128, + "minimum" : 0, + "optional" : 1, + "requires" : "address6", + "type" : "integer", + "typetext" : " (0 - 128)" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "ovs_bonds" : { + "description" : "Specify the interfaces used by the bonding device.", + "format" : "pve-iface-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "ovs_bridge" : { + "description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port.", + "format" : "pve-iface", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "ovs_options" : { + "description" : "OVS interface options.", + "maxLength" : 1024, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "ovs_ports" : { + "description" : "Specify the interfaces you want to add to your bridge.", + "format" : "pve-iface-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "ovs_tag" : { + "description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)", + "maximum" : 4094, + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - 4094)" + }, + "slaves" : { + "description" : "Specify the interfaces used by the bonding device.", + "format" : "pve-iface-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "type" : { + "description" : "Network interface type", + "enum" : [ + "bridge", + "bond", + "eth", + "alias", + "vlan", + "OVSBridge", + "OVSBond", + "OVSPort", + "OVSIntPort", + "unknown" + ], "type" : "string" } } }, - "leaf" : 0, - "path" : "/nodes/{node}/ceph/pools", - "text" : "pools" + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } }, + "PUT" : { + "description" : "Reload network configuration", + "method" : "PUT", + "name" : "reload_network_config", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/network", + "text" : "network" + }, + { + "children" : [ { "children" : [ { "info" : { - "DELETE" : { - "description" : "Unset a ceph flag", - "method" : "DELETE", - "name" : "unset_flag", + "GET" : { + "description" : "Read task log.", + "method" : "GET", + "name" : "read_task_log", "parameters" : { "additionalProperties" : 0, "properties" : { - "flag" : { - "description" : "The ceph flag to set/unset", - "enum" : [ - "full", - "pause", - "noup", - "nodown", - "noout", - "noin", - "nobackfill", - "norebalance", - "norecover", - "noscrub", - "nodeep-scrub", - "notieragent" - ], - "type" : "string" + "limit" : { + "default" : 50, + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" + }, + "start" : { + "default" : 0, + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "upid" : { + "type" : "string", + "typetext" : "" } } }, "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] + "description" : "The user needs 'Sys.Audit' permissions on '/nodes/' if the task does not belong to him.", + "user" : "all" }, "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "null" + "items" : { + "properties" : { + "n" : { + "description" : "Line number", + "type" : "integer" + }, + "t" : { + "description" : "Line text", + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" } - }, - "POST" : { - "description" : "Set a ceph flag", - "method" : "POST", - "name" : "set_flag", + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/tasks/{upid}/log", + "text" : "log" + }, + { + "info" : { + "GET" : { + "description" : "Read task status.", + "method" : "GET", + "name" : "read_task_status", "parameters" : { "additionalProperties" : 0, "properties" : { - "flag" : { - "description" : "The ceph flag to set/unset", - "enum" : [ - "full", - "pause", - "noup", - "nodown", - "noout", - "noin", - "nobackfill", - "norebalance", - "norecover", - "noscrub", - "nodeep-scrub", - "notieragent" - ], - "type" : "string" - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" + }, + "upid" : { + "type" : "string", + "typetext" : "" } } }, "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] + "description" : "The user needs 'Sys.Audit' permissions on '/nodes/' if the task does not belong to him.", + "user" : "all" }, "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "null" + "properties" : { + "pid" : { + "type" : "integer" + }, + "status" : { + "enum" : [ + "running", + "stopped" + ], + "type" : "string" + } + }, + "type" : "object" } } }, "leaf" : 1, - "path" : "/nodes/{node}/ceph/flags/{flag}", - "text" : "{flag}" + "path" : "/nodes/{node}/tasks/{upid}/status", + "text" : "status" } ], "info" : { - "GET" : { - "description" : "get all set ceph flags", - "method" : "GET", - "name" : "get_flags", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/ceph/flags", - "text" : "flags" - }, - { - "info" : { - "GET" : { - "description" : "Get OSD crush map", - "method" : "GET", - "name" : "crush", - "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" : { - "type" : "string" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/ceph/crush", - "text" : "crush" - }, - { - "info" : { - "GET" : { - "description" : "Read ceph log", - "method" : "GET", - "name" : "log", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "limit" : { - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "start" : { - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Syslog" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : { - "n" : { - "description" : "Line number", - "type" : "integer" - }, - "t" : { - "description" : "Line text", - "type" : "string" - } - }, - "type" : "object" - }, - "type" : "array" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/ceph/log", - "text" : "log" - }, - { - "info" : { - "GET" : { - "description" : "List ceph rules.", - "method" : "GET", - "name" : "rules", - "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" : {}, - "type" : "object" - }, - "links" : [ - { - "href" : "{name}", - "rel" : "child" - } - ], - "type" : "array" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/ceph/rules", - "text" : "rules" - } - ], - "info" : { - "GET" : { - "description" : "Directory index.", - "method" : "GET", - "name" : "index", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "DELETE" : { + "description" : "Stop a task.", + "method" : "DELETE", + "name" : "stop_task", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "upid" : { + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "description" : "The user needs 'Sys.Modify' permissions on '/nodes/' if the task does not belong to him.", + "user" : "all" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" } - } - }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit", - "Datastore.Audit" - ], - "any", - 1 - ] - }, - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" }, - "links" : [ - { - "href" : "{name}", - "rel" : "child" - } - ], - "type" : "array" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/ceph", - "text" : "ceph" - }, - { - "children" : [ - { - "info" : { "GET" : { - "description" : "Extract configuration from vzdump backup archive.", + "description" : "", "method" : "GET", - "name" : "extractconfig", + "name" : "upid_index", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -19546,550 +28714,406 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "volume" : { - "description" : "Volume identifier", + "upid" : { "type" : "string", "typetext" : "" } } }, "permissions" : { - "description" : "The user needs 'VM.Backup' permissions on the backed up guest ID, and 'Datastore.AllocateSpace' on the backup storage.", "user" : "all" }, - "protected" : 1, - "proxyto" : "node", "returns" : { - "type" : "string" + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" } } }, - "leaf" : 1, - "path" : "/nodes/{node}/vzdump/extractconfig", - "text" : "extractconfig" + "leaf" : 0, + "path" : "/nodes/{node}/tasks/{upid}", + "text" : "{upid}" } ], "info" : { - "POST" : { - "description" : "Create backup.", - "method" : "POST", - "name" : "vzdump", + "GET" : { + "description" : "Read task list for one node (finished tasks).", + "method" : "GET", + "name" : "node_tasks", "parameters" : { "additionalProperties" : 0, "properties" : { - "all" : { + "errors" : { "default" : 0, - "description" : "Backup all known guest systems on this host.", "optional" : 1, "type" : "boolean", "typetext" : "" }, - "bwlimit" : { - "default" : 0, - "description" : "Limit I/O bandwidth (KBytes per second).", - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" - }, - "compress" : { - "default" : "0", - "description" : "Compress dump file.", - "enum" : [ - "0", - "1", - "gzip", - "lzo" - ], - "optional" : 1, - "type" : "string" - }, - "dumpdir" : { - "description" : "Store resulting files to specified directory.", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "exclude" : { - "description" : "Exclude specified guest systems (assumes --all)", - "format" : "pve-vmid-list", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "exclude-path" : { - "description" : "Exclude certain files/directories (shell globs).", - "format" : "string-alist", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "ionice" : { - "default" : 7, - "description" : "Set CFQ ionice priority.", - "maximum" : 8, - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - 8)" - }, - "lockwait" : { - "default" : 180, - "description" : "Maximal time to wait for the global lock (minutes).", + "limit" : { + "default" : 50, + "description" : "Only list this amount of tasks.", "minimum" : 0, "optional" : 1, "type" : "integer", "typetext" : " (0 - N)" }, - "mailnotification" : { - "default" : "always", - "description" : "Specify when to send an email", - "enum" : [ - "always", - "failure" - ], - "optional" : 1, - "type" : "string" - }, - "mailto" : { - "description" : "Comma-separated list of email addresses that should receive email notifications.", - "format" : "string-list", - "optional" : 1, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", "typetext" : "" }, - "maxfiles" : { - "default" : 1, - "description" : "Maximal number of backup files per guest system.", - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - }, - "mode" : { - "default" : "snapshot", - "description" : "Backup mode.", + "source" : { + "default" : "archive", + "description" : "List archived, active or all tasks.", "enum" : [ - "snapshot", - "suspend", - "stop" + "archive", + "active", + "all" ], "optional" : 1, "type" : "string" }, - "node" : { - "description" : "Only run if executed on this node.", - "format" : "pve-node", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "pigz" : { - "default" : 0, - "description" : "Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.", - "optional" : 1, - "type" : "integer", - "typetext" : "" - }, - "quiet" : { - "default" : 0, - "description" : "Be quiet.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "remove" : { - "default" : 1, - "description" : "Remove old backup files if there are more than 'maxfiles' backup files.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "script" : { - "description" : "Use specified hook script.", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "size" : { - "default" : 1024, - "description" : "Unused, will be removed in a future release.", - "minimum" : 500, - "optional" : 1, - "type" : "integer", - "typetext" : " (500 - N)" - }, - "stdexcludes" : { - "default" : 1, - "description" : "Exclude temporary files and logs.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "stdout" : { - "description" : "Write tar to stdout, not to a file.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "stop" : { + "start" : { "default" : 0, - "description" : "Stop runnig backup jobs on this host.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "stopwait" : { - "default" : 10, - "description" : "Maximal time to wait until a guest system is stopped (minutes).", + "description" : "List tasks beginning from this offset.", "minimum" : 0, "optional" : 1, "type" : "integer", "typetext" : " (0 - N)" }, - "storage" : { - "description" : "Store resulting file to this storage.", - "format" : "pve-storage-id", + "typefilter" : { + "description" : "Only list tasks of this type (e.g., vzstart, vzdump).", "optional" : 1, "type" : "string", "typetext" : "" }, - "tmpdir" : { - "description" : "Store temporary files to specified directory.", + "userfilter" : { + "description" : "Only list tasks from this user.", "optional" : 1, "type" : "string", "typetext" : "" }, "vmid" : { - "description" : "The ID of the guest system you want to backup.", - "format" : "pve-vmid-list", + "description" : "Only list tasks for this VM.", + "format" : "pve-vmid", + "minimum" : 1, "optional" : 1, - "type" : "string", - "typetext" : "" + "type" : "integer", + "typetext" : " (1 - N)" } } }, "permissions" : { - "description" : "The user needs 'VM.Backup' permissions on any VM, and 'Datastore.AllocateSpace' on the backup storage. The 'maxfiles', 'tmpdir', 'dumpdir', 'script', 'bwlimit' and 'ionice' parameters are restricted to the 'root@pam' user.", + "description" : "List task associated with the current user, or all task the user has 'Sys.Audit' permissions on /nodes/ (the the task runs on).", "user" : "all" }, - "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "string" + "items" : { + "properties" : { + "endtime" : { + "optional" : 1, + "title" : "Endtime", + "type" : "integer" + }, + "id" : { + "title" : "ID", + "type" : "string" + }, + "node" : { + "title" : "Node", + "type" : "string" + }, + "pid" : { + "title" : "PID", + "type" : "integer" + }, + "pstart" : { + "type" : "integer" + }, + "starttime" : { + "title" : "Starttime", + "type" : "integer" + }, + "status" : { + "optional" : 1, + "title" : "Status", + "type" : "string" + }, + "type" : { + "title" : "Type", + "type" : "string" + }, + "upid" : { + "title" : "UPID", + "type" : "string" + }, + "user" : { + "title" : "User", + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{upid}", + "rel" : "child" + } + ], + "type" : "array" } } }, "leaf" : 0, - "path" : "/nodes/{node}/vzdump", - "text" : "vzdump" + "path" : "/nodes/{node}/tasks", + "text" : "tasks" }, { "children" : [ { - "children" : [ - { - "info" : { - "GET" : { - "description" : "Read service properties", - "method" : "GET", - "name" : "service_state", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "service" : { - "description" : "Service ID", - "enum" : [ - "pveproxy", - "pvedaemon", - "spiceproxy", - "pvestatd", - "pve-cluster", - "corosync", - "pve-firewall", - "pvefw-logger", - "pve-ha-crm", - "pve-ha-lrm", - "sshd", - "syslog", - "cron", - "postfix", - "ksmtuned", - "systemd-timesyncd" - ], - "type" : "string" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Audit" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "properties" : {}, - "type" : "object" + "info" : { + "GET" : { + "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" : "" } } }, - "leaf" : 1, - "path" : "/nodes/{node}/services/{service}/state", - "text" : "state" - }, - { - "info" : { - "POST" : { - "description" : "Start service.", - "method" : "POST", - "name" : "service_start", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "service" : { - "description" : "Service ID", - "enum" : [ - "pveproxy", - "pvedaemon", - "spiceproxy", - "pvestatd", - "pve-cluster", - "corosync", - "pve-firewall", - "pvefw-logger", - "pve-ha-crm", - "pve-ha-lrm", - "sshd", - "syslog", - "cron", - "postfix", - "ksmtuned", - "systemd-timesyncd" - ], - "type" : "string" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - } + "permissions" : { + "check" : [ + "perm", + "/storage", + [ + "Datastore.Allocate" + ] + ] }, - "leaf" : 1, - "path" : "/nodes/{node}/services/{service}/start", - "text" : "start" - }, - { - "info" : { - "POST" : { - "description" : "Stop service.", - "method" : "POST", - "name" : "service_stop", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "service" : { - "description" : "Service ID", - "enum" : [ - "pveproxy", - "pvedaemon", - "spiceproxy", - "pvestatd", - "pve-cluster", - "corosync", - "pve-firewall", - "pvefw-logger", - "pve-ha-crm", - "pve-ha-lrm", - "sshd", - "syslog", - "cron", - "postfix", - "ksmtuned", - "systemd-timesyncd" - ], - "type" : "string" - } + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "pool" : { + "description" : "ZFS pool name.", + "type" : "string" } }, - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Modify" - ] - ] + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/scan/zfs", + "text" : "zfs" + }, + { + "info" : { + "GET" : { + "description" : "Scan remote NFS server.", + "method" : "GET", + "name" : "nfsscan", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" + "server" : { + "description" : "The server address (name or IP).", + "format" : "pve-storage-server", + "type" : "string", + "typetext" : "" } } }, - "leaf" : 1, - "path" : "/nodes/{node}/services/{service}/stop", - "text" : "stop" - }, - { - "info" : { - "POST" : { - "description" : "Restart service.", - "method" : "POST", - "name" : "service_restart", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "service" : { - "description" : "Service ID", - "enum" : [ - "pveproxy", - "pvedaemon", - "spiceproxy", - "pvestatd", - "pve-cluster", - "corosync", - "pve-firewall", - "pvefw-logger", - "pve-ha-crm", - "pve-ha-lrm", - "sshd", - "syslog", - "cron", - "postfix", - "ksmtuned", - "systemd-timesyncd" - ], - "type" : "string" - } + "permissions" : { + "check" : [ + "perm", + "/storage", + [ + "Datastore.Allocate" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "options" : { + "description" : "NFS export options.", + "type" : "string" + }, + "path" : { + "description" : "The exported path.", + "type" : "string" } }, - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Modify" - ] - ] + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/scan/nfs", + "text" : "nfs" + }, + { + "info" : { + "GET" : { + "description" : "Scan remote CIFS server.", + "method" : "GET", + "name" : "cifsscan", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "domain" : { + "description" : "SMB domain (Workgroup).", + "optional" : 1, + "type" : "string", + "typetext" : "" }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" + "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" : "" } } }, - "leaf" : 1, - "path" : "/nodes/{node}/services/{service}/restart", - "text" : "restart" - }, - { - "info" : { - "POST" : { - "description" : "Reload service.", - "method" : "POST", - "name" : "service_reload", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "service" : { - "description" : "Service ID", - "enum" : [ - "pveproxy", - "pvedaemon", - "spiceproxy", - "pvestatd", - "pve-cluster", - "corosync", - "pve-firewall", - "pvefw-logger", - "pve-ha-crm", - "pve-ha-lrm", - "sshd", - "syslog", - "cron", - "postfix", - "ksmtuned", - "systemd-timesyncd" - ], - "type" : "string" - } + "permissions" : { + "check" : [ + "perm", + "/storage", + [ + "Datastore.Allocate" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "description" : { + "description" : "Descriptive text from server.", + "type" : "string" + }, + "share" : { + "description" : "The cifs share name.", + "type" : "string" } }, - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Modify" - ] - ] + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/scan/cifs", + "text" : "cifs" + }, + { + "info" : { + "GET" : { + "description" : "Scan remote GlusterFS server.", + "method" : "GET", + "name" : "glusterfsscan", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" + "server" : { + "description" : "The server address (name or IP).", + "format" : "pve-storage-server", + "type" : "string", + "typetext" : "" } } }, - "leaf" : 1, - "path" : "/nodes/{node}/services/{service}/reload", - "text" : "reload" + "permissions" : { + "check" : [ + "perm", + "/storage", + [ + "Datastore.Allocate" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "volname" : { + "description" : "The volume name.", + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + } } - ], + }, + "leaf" : 1, + "path" : "/nodes/{node}/scan/glusterfs", + "text" : "glusterfs" + }, + { "info" : { "GET" : { - "description" : "Directory index", + "description" : "Scan remote iSCSI server.", "method" : "GET", - "name" : "srvcmdidx", + "name" : "iscsiscan", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -20099,231 +29123,56 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "service" : { - "description" : "Service ID", - "enum" : [ - "pveproxy", - "pvedaemon", - "spiceproxy", - "pvestatd", - "pve-cluster", - "corosync", - "pve-firewall", - "pvefw-logger", - "pve-ha-crm", - "pve-ha-lrm", - "sshd", - "syslog", - "cron", - "postfix", - "ksmtuned", - "systemd-timesyncd" - ], - "type" : "string" + "portal" : { + "description" : "The iSCSI portal (IP or DNS name with optional port).", + "format" : "pve-storage-portal-dns", + "type" : "string", + "typetext" : "" } } }, "permissions" : { "check" : [ "perm", - "/nodes/{node}", + "/storage", [ - "Sys.Audit" + "Datastore.Allocate" ] ] }, + "protected" : 1, + "proxyto" : "node", "returns" : { "items" : { "properties" : { - "subdir" : { + "portal" : { + "description" : "The iSCSI portal name.", + "type" : "string" + }, + "target" : { + "description" : "The iSCSI target name.", "type" : "string" } }, "type" : "object" }, - "links" : [ - { - "href" : "{subdir}", - "rel" : "child" - } - ], "type" : "array" } } }, - "leaf" : 0, - "path" : "/nodes/{node}/services/{service}", - "text" : "{service}" - } - ], - "info" : { - "GET" : { - "description" : "Service list.", - "method" : "GET", - "name" : "index", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Audit" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "links" : [ - { - "href" : "{service}", - "rel" : "child" - } - ], - "type" : "array" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/services", - "text" : "services" - }, - { - "info" : { - "GET" : { - "description" : "Read subscription info.", - "method" : "GET", - "name" : "get", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "user" : "all" - }, - "proxyto" : "node", - "returns" : { - "type" : "object" - } - }, - "POST" : { - "description" : "Update subscription info.", - "method" : "POST", - "name" : "update", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "force" : { - "default" : 0, - "description" : "Always connect to server, even if we have up to date info inside local cache.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "null" - } + "leaf" : 1, + "path" : "/nodes/{node}/scan/iscsi", + "text" : "iscsi" }, - "PUT" : { - "description" : "Set subscription key.", - "method" : "PUT", - "name" : "set", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "key" : { - "description" : "Proxmox VE subscription key", - "maxLength" : 32, - "pattern" : "pve([124])([cbsp])-[0-9a-f]{10}", - "type" : "string" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "null" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/subscription", - "text" : "subscription" - }, - { - "children" : [ { "info" : { - "DELETE" : { - "description" : "Delete network device configuration", - "method" : "DELETE", - "name" : "delete_network", + "GET" : { + "description" : "List local LVM volume groups.", + "method" : "GET", + "name" : "lvmscan", "parameters" : { "additionalProperties" : 0, "properties" : { - "iface" : { - "description" : "Network interface name.", - "format" : "pve-iface", - "maxLength" : 20, - "minLength" : 2, - "type" : "string", - "typetext" : "" - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", @@ -20335,261 +29184,104 @@ var pveapi = [ "permissions" : { "check" : [ "perm", - "/nodes/{node}", + "/storage", [ - "Sys.Modify" + "Datastore.Allocate" ] ] }, "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "null" + "items" : { + "properties" : { + "vg" : { + "description" : "The LVM logical volume group name.", + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" } - }, + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/scan/lvm", + "text" : "lvm" + }, + { + "info" : { "GET" : { - "description" : "Read network device configuration", + "description" : "List local LVM Thin Pools.", "method" : "GET", - "name" : "network_config", + "name" : "lvmthinscan", "parameters" : { "additionalProperties" : 0, - "properties" : { - "iface" : { - "description" : "Network interface name.", - "format" : "pve-iface", - "maxLength" : 20, - "minLength" : 2, - "type" : "string", - "typetext" : "" - }, + "properties" : { "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" + }, + "vg" : { + "maxLength" : 100, + "pattern" : "[a-zA-Z0-9\\.\\+\\_][a-zA-Z0-9\\.\\+\\_\\-]+", + "type" : "string" } } }, "permissions" : { "check" : [ "perm", - "/nodes/{node}", + "/storage", [ - "Sys.Audit" + "Datastore.Allocate" ] ] }, + "protected" : 1, "proxyto" : "node", "returns" : { - "properties" : { - "method" : { - "type" : "string" + "items" : { + "properties" : { + "lv" : { + "description" : "The LVM Thin Pool name (LVM logical volume).", + "type" : "string" + } }, - "type" : { - "type" : "string" - } + "type" : "object" }, - "type" : "object" + "type" : "array" } - }, - "PUT" : { - "description" : "Update network device configuration", - "method" : "PUT", - "name" : "update_network", + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/scan/lvmthin", + "text" : "lvmthin" + }, + { + "info" : { + "GET" : { + "description" : "List local USB devices.", + "method" : "GET", + "name" : "usbscan", "parameters" : { "additionalProperties" : 0, "properties" : { - "address" : { - "description" : "IP address.", - "format" : "ipv4", - "optional" : 1, - "requires" : "netmask", - "type" : "string", - "typetext" : "" - }, - "address6" : { - "description" : "IP address.", - "format" : "ipv6", - "optional" : 1, - "requires" : "netmask6", - "type" : "string", - "typetext" : "" - }, - "autostart" : { - "description" : "Automatically start interface on boot.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "bond_mode" : { - "description" : "Bonding mode.", - "enum" : [ - "balance-rr", - "active-backup", - "balance-xor", - "broadcast", - "802.3ad", - "balance-tlb", - "balance-alb", - "balance-slb", - "lacp-balance-slb", - "lacp-balance-tcp" - ], - "optional" : 1, - "type" : "string" - }, - "bond_xmit_hash_policy" : { - "description" : "Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes.", - "enum" : [ - "layer2", - "layer2+3", - "layer3+4" - ], - "optional" : 1, - "type" : "string" - }, - "bridge_ports" : { - "description" : "Specify the iterfaces you want to add to your bridge.", - "format" : "pve-iface-list", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "bridge_vlan_aware" : { - "description" : "Enable bridge vlan support.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "comments" : { - "description" : "Comments", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "comments6" : { - "description" : "Comments", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "delete" : { - "description" : "A list of settings you want to delete.", - "format" : "pve-configid-list", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "gateway" : { - "description" : "Default gateway address.", - "format" : "ipv4", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "gateway6" : { - "description" : "Default ipv6 gateway address.", - "format" : "ipv6", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "iface" : { - "description" : "Network interface name.", - "format" : "pve-iface", - "maxLength" : 20, - "minLength" : 2, - "type" : "string", - "typetext" : "" - }, - "netmask" : { - "description" : "Network mask.", - "format" : "ipv4mask", - "optional" : 1, - "requires" : "address", - "type" : "string", - "typetext" : "" - }, - "netmask6" : { - "description" : "Network mask.", - "maximum" : 128, - "minimum" : 0, - "optional" : 1, - "requires" : "address6", - "type" : "integer", - "typetext" : " (0 - 128)" - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" - }, - "ovs_bonds" : { - "description" : "Specify the interfaces used by the bonding device.", - "format" : "pve-iface-list", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "ovs_bridge" : { - "description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port.", - "format" : "pve-iface", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "ovs_options" : { - "description" : "OVS interface options.", - "maxLength" : 1024, - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "ovs_ports" : { - "description" : "Specify the iterfaces you want to add to your bridge.", - "format" : "pve-iface-list", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "ovs_tag" : { - "description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)", - "maximum" : 4094, - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - 4094)" - }, - "slaves" : { - "description" : "Specify the interfaces used by the bonding device.", - "format" : "pve-iface-list", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "type" : { - "description" : "Network interface type", - "enum" : [ - "bridge", - "bond", - "eth", - "alias", - "vlan", - "OVSBridge", - "OVSBond", - "OVSPort", - "OVSIntPort", - "unknown" - ], - "type" : "string" } } }, "permissions" : { "check" : [ "perm", - "/nodes/{node}", + "/", [ "Sys.Modify" ] @@ -20598,374 +29290,172 @@ var pveapi = [ "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "null" + "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}/network/{iface}", - "text" : "{iface}" + "path" : "/nodes/{node}/scan/usb", + "text" : "usb" } ], "info" : { - "DELETE" : { - "description" : "Revert network configuration changes.", - "method" : "DELETE", - "name" : "revert_network_changes", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "null" - } - }, "GET" : { - "description" : "List available networks", + "description" : "Index of available scan methods", "method" : "GET", "name" : "index", "parameters" : { "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "type" : { - "description" : "Only list specific interface types.", - "enum" : [ - "bridge", - "bond", - "eth", - "alias", - "vlan", - "OVSBridge", - "OVSBond", - "OVSPort", - "OVSIntPort", - "any_bridge" - ], - "optional" : 1, - "type" : "string" - } - } - }, - "permissions" : { - "user" : "all" - }, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "links" : [ - { - "href" : "{iface}", - "rel" : "child" - } - ], - "type" : "array" - } - }, - "POST" : { - "description" : "Create network device configuration", - "method" : "POST", - "name" : "create_network", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "address" : { - "description" : "IP address.", - "format" : "ipv4", - "optional" : 1, - "requires" : "netmask", - "type" : "string", - "typetext" : "" - }, - "address6" : { - "description" : "IP address.", - "format" : "ipv6", - "optional" : 1, - "requires" : "netmask6", - "type" : "string", - "typetext" : "" - }, - "autostart" : { - "description" : "Automatically start interface on boot.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "bond_mode" : { - "description" : "Bonding mode.", - "enum" : [ - "balance-rr", - "active-backup", - "balance-xor", - "broadcast", - "802.3ad", - "balance-tlb", - "balance-alb", - "balance-slb", - "lacp-balance-slb", - "lacp-balance-tcp" - ], - "optional" : 1, - "type" : "string" - }, - "bond_xmit_hash_policy" : { - "description" : "Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes.", - "enum" : [ - "layer2", - "layer2+3", - "layer3+4" - ], - "optional" : 1, - "type" : "string" - }, - "bridge_ports" : { - "description" : "Specify the iterfaces you want to add to your bridge.", - "format" : "pve-iface-list", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "bridge_vlan_aware" : { - "description" : "Enable bridge vlan support.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "comments" : { - "description" : "Comments", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "comments6" : { - "description" : "Comments", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "gateway" : { - "description" : "Default gateway address.", - "format" : "ipv4", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "gateway6" : { - "description" : "Default ipv6 gateway address.", - "format" : "ipv6", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "iface" : { - "description" : "Network interface name.", - "format" : "pve-iface", - "maxLength" : 20, - "minLength" : 2, - "type" : "string", - "typetext" : "" - }, - "netmask" : { - "description" : "Network mask.", - "format" : "ipv4mask", - "optional" : 1, - "requires" : "address", - "type" : "string", - "typetext" : "" - }, - "netmask6" : { - "description" : "Network mask.", - "maximum" : 128, - "minimum" : 0, - "optional" : 1, - "requires" : "address6", - "type" : "integer", - "typetext" : " (0 - 128)" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "ovs_bonds" : { - "description" : "Specify the interfaces used by the bonding device.", - "format" : "pve-iface-list", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "ovs_bridge" : { - "description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port.", - "format" : "pve-iface", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "ovs_options" : { - "description" : "OVS interface options.", - "maxLength" : 1024, - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "ovs_ports" : { - "description" : "Specify the iterfaces you want to add to your bridge.", - "format" : "pve-iface-list", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "ovs_tag" : { - "description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)", - "maximum" : 4094, - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - 4094)" - }, - "slaves" : { - "description" : "Specify the interfaces used by the bonding device.", - "format" : "pve-iface-list", - "optional" : 1, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", "typetext" : "" - }, - "type" : { - "description" : "Network interface type", - "enum" : [ - "bridge", - "bond", - "eth", - "alias", - "vlan", - "OVSBridge", - "OVSBond", - "OVSPort", - "OVSIntPort", - "unknown" - ], - "type" : "string" } } }, "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Modify" - ] - ] + "user" : "all" }, - "protected" : 1, - "proxyto" : "node", "returns" : { - "type" : "null" + "items" : { + "properties" : { + "method" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{method}", + "rel" : "child" + } + ], + "type" : "array" } } }, "leaf" : 0, - "path" : "/nodes/{node}/network", - "text" : "network" + "path" : "/nodes/{node}/scan", + "text" : "scan" }, { "children" : [ { "children" : [ { - "info" : { - "GET" : { - "description" : "Read task log.", - "method" : "GET", - "name" : "read_task_log", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "limit" : { - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "children" : [ + { + "info" : { + "GET" : { + "description" : "List mediated device types for given PCI device.", + "method" : "GET", + "name" : "mdevscan", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "pciid" : { + "description" : "The PCI ID to list the mdev types for.", + "pattern" : "(?:[0-9a-fA-F]{4}:)?[0-9a-fA-F]{2}:[0-9a-fA-F]{2}\\.[0-9a-fA-F]", + "type" : "string" + } + } }, - "start" : { - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] }, - "upid" : { - "type" : "string", - "typetext" : "" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "available" : { + "description" : "The number of still available instances of this type.", + "type" : "integer" + }, + "description" : { + "type" : "string" + }, + "type" : { + "description" : "The name of the mdev type.", + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" } } }, - "permissions" : { - "description" : "The user needs 'Sys.Audit' permissions on '/nodes/' if the task does not belong to him.", - "user" : "all" - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : { - "n" : { - "description" : "Line number", - "type" : "integer" - }, - "t" : { - "description" : "Line text", - "type" : "string" - } - }, - "type" : "object" - }, - "type" : "array" - } + "leaf" : 1, + "path" : "/nodes/{node}/hardware/pci/{pciid}/mdev", + "text" : "mdev" } - }, - "leaf" : 1, - "path" : "/nodes/{node}/tasks/{upid}/log", - "text" : "log" - }, - { + ], "info" : { "GET" : { - "description" : "Read task status.", + "description" : "Index of available pci methods", "method" : "GET", - "name" : "read_task_status", + "name" : "pciindex", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -20975,74 +29465,44 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "upid" : { - "type" : "string", - "typetext" : "" + "pciid" : { + "pattern" : "(?:[0-9a-fA-F]{4}:)?[0-9a-fA-F]{2}:[0-9a-fA-F]{2}\\.[0-9a-fA-F]", + "type" : "string" } } }, "permissions" : { - "description" : "The user needs 'Sys.Audit' permissions on '/nodes/' if the task does not belong to him.", "user" : "all" }, - "protected" : 1, - "proxyto" : "node", "returns" : { - "properties" : { - "pid" : { - "type" : "integer" + "items" : { + "properties" : { + "method" : { + "type" : "string" + } }, - "status" : { - "enum" : [ - "running", - "stopped" - ], - "type" : "string" - } + "type" : "object" }, - "type" : "object" + "links" : [ + { + "href" : "{method}", + "rel" : "child" + } + ], + "type" : "array" } } }, - "leaf" : 1, - "path" : "/nodes/{node}/tasks/{upid}/status", - "text" : "status" + "leaf" : 0, + "path" : "/nodes/{node}/hardware/pci/{pciid}", + "text" : "{pciid}" } ], "info" : { - "DELETE" : { - "description" : "Stop a task.", - "method" : "DELETE", - "name" : "stop_task", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "upid" : { - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "description" : "The user needs 'Sys.Modify' permissions on '/nodes/' if the task does not belong to him.", - "user" : "all" - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "null" - } - }, "GET" : { - "description" : "", + "description" : "List local PCI devices.", "method" : "GET", - "name" : "upid_index", + "name" : "pciscan", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -21052,23 +29512,94 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "upid" : { + "pci-class-blacklist" : { + "default" : "05;06;08;0b", + "description" : "A list of blacklisted PCI classes, which will not be returned. Following are filtered by default: Memory Controller (05), Bridge (06), Generic System Peripheral (08) and Processor (0b).", + "format" : "string-list", + "optional" : 1, "type" : "string", "typetext" : "" + }, + "verbose" : { + "default" : 1, + "description" : "If disabled, does only print the PCI IDs. Otherwise, additional information like vendor and device will be returned.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" } } }, "permissions" : { - "user" : "all" + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] }, + "protected" : 1, + "proxyto" : "node", "returns" : { "items" : { - "properties" : {}, + "properties" : { + "class" : { + "description" : "The PCI Class of the device.", + "type" : "string" + }, + "device" : { + "description" : "The Device ID.", + "type" : "string" + }, + "device_name" : { + "optional" : 1, + "type" : "string" + }, + "id" : { + "description" : "The PCI ID.", + "type" : "string" + }, + "iommugroup" : { + "description" : "The IOMMU group in which the device is in. If no IOMMU group is detected, it is set to -1.", + "type" : "integer" + }, + "mdev" : { + "description" : "If set, marks that the device is capable of creating mediated devices.", + "optional" : 1, + "type" : "boolean" + }, + "subsystem_device" : { + "description" : "The Subsystem Device ID.", + "optional" : 1, + "type" : "string" + }, + "subsystem_device_name" : { + "optional" : 1, + "type" : "string" + }, + "subsystem_vendor" : { + "description" : "The Subsystem Vendor ID.", + "optional" : 1, + "type" : "string" + }, + "subsystem_vendor_name" : { + "optional" : 1, + "type" : "string" + }, + "vendor" : { + "description" : "The Vendor ID.", + "type" : "string" + }, + "vendor_name" : { + "optional" : 1, + "type" : "string" + } + }, "type" : "object" }, "links" : [ { - "href" : "{name}", + "href" : "{id}", "rel" : "child" } ], @@ -21077,65 +29608,33 @@ var pveapi = [ } }, "leaf" : 0, - "path" : "/nodes/{node}/tasks/{upid}", - "text" : "{upid}" + "path" : "/nodes/{node}/hardware/pci", + "text" : "pci" } ], "info" : { "GET" : { - "description" : "Read task list for one node (finished tasks).", + "description" : "Index of hardware types", "method" : "GET", - "name" : "node_tasks", + "name" : "index", "parameters" : { "additionalProperties" : 0, "properties" : { - "errors" : { - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "limit" : { - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" - }, - "start" : { - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" - }, - "userfilter" : { - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "Only list tasks for this VM.", - "format" : "pve-vmid", - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - N)" } } }, "permissions" : { - "description" : "List task associated with the current user, or all task the user has 'Sys.Audit' permissions on /nodes/ (the the task runs on).", "user" : "all" }, - "proxyto" : "node", "returns" : { "items" : { "properties" : { - "upid" : { + "type" : { "type" : "string" } }, @@ -21143,7 +29642,7 @@ var pveapi = [ }, "links" : [ { - "href" : "{upid}", + "href" : "{type}", "rel" : "child" } ], @@ -21152,263 +29651,564 @@ var pveapi = [ } }, "leaf" : 0, - "path" : "/nodes/{node}/tasks", - "text" : "tasks" + "path" : "/nodes/{node}/hardware", + "text" : "hardware" }, { "children" : [ { - "info" : { - "GET" : { - "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" : "" + "children" : [ + { + "children" : [ + { + "info" : { + "DELETE" : { + "description" : "Delete volume", + "method" : "DELETE", + "name" : "delete", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "storage" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "volume" : { + "description" : "Volume identifier", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "description" : "You need 'Datastore.Allocate' privilege on the storage (or 'Datastore.AllocateSpace' for backup volumes if you have VM.Backup privilege on the VM).", + "user" : "all" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + }, + "GET" : { + "description" : "Get volume attributes", + "method" : "GET", + "name" : "info", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "storage" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "volume" : { + "description" : "Volume identifier", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "description" : "You need read access for the volume.", + "user" : "all" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "object" + } + }, + "POST" : { + "description" : "Copy a volume. This is experimental code - do not use.", + "method" : "POST", + "name" : "copy", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "storage" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "target" : { + "description" : "Target volume identifier", + "type" : "string", + "typetext" : "" + }, + "target_node" : { + "description" : "Target node. Default is local node.", + "format" : "pve-node", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "volume" : { + "description" : "Source volume identifier", + "type" : "string", + "typetext" : "" + } + } + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/storage/{storage}/content/{volume}", + "text" : "{volume}" + } + ], + "info" : { + "GET" : { + "description" : "List storage content.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "content" : { + "description" : "Only list content of this type.", + "format" : "pve-storage-content", + "optional" : 1, + "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" : "" + }, + "vmid" : { + "description" : "Only list images for this VM", + "format" : "pve-vmid", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/storage/{storage}", + [ + "Datastore.Audit", + "Datastore.AllocateSpace" + ], + "any", + 1 + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "format" : { + "description" : "Format identifier ('raw', 'qcow2', 'subvol', 'iso', 'tgz' ...)", + "type" : "string" + }, + "parent" : { + "description" : "Volume identifier of parent (for linked cloned).", + "optional" : 1, + "type" : "string" + }, + "size" : { + "description" : "Volume size in bytes.", + "renderer" : "bytes", + "type" : "integer" + }, + "used" : { + "description" : "Used space. Please note that most storage plugins does not report anything useful here.", + "optional" : 1, + "renderer" : "bytes", + "type" : "integer" + }, + "vmid" : { + "description" : "Associated Owner VMID.", + "optional" : 1, + "type" : "integer" + }, + "volid" : { + "description" : "Volume identifier.", + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{volid}", + "rel" : "child" + } + ], + "type" : "array" } - } - }, - "permissions" : { - "check" : [ - "perm", - "/storage", - [ - "Datastore.Allocate" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : { - "pool" : { - "type" : "string" + }, + "POST" : { + "description" : "Allocate disk images.", + "method" : "POST", + "name" : "create", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "filename" : { + "description" : "The name of the file to create.", + "type" : "string", + "typetext" : "" + }, + "format" : { + "enum" : [ + "raw", + "qcow2", + "subvol" + ], + "optional" : 1, + "requires" : "size", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "size" : { + "description" : "Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)", + "pattern" : "\\d+[MG]?", + "type" : "string" + }, + "storage" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "Specify owner VM", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } } }, - "type" : "object" - }, - "type" : "array" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/scan/zfs", - "text" : "zfs" - }, - { - "info" : { - "GET" : { - "description" : "Scan remote NFS server.", - "method" : "GET", - "name" : "nfsscan", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "permissions" : { + "check" : [ + "perm", + "/storage/{storage}", + [ + "Datastore.AllocateSpace" + ] + ] }, - "server" : { - "format" : "pve-storage-server", - "type" : "string", - "typetext" : "" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "Volume identifier", + "type" : "string" } } }, - "permissions" : { - "check" : [ - "perm", - "/storage", - [ - "Datastore.Allocate" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : { - "options" : { - "type" : "string" - }, - "path" : { - "type" : "string" + "leaf" : 0, + "path" : "/nodes/{node}/storage/{storage}/content", + "text" : "content" + }, + { + "info" : { + "GET" : { + "description" : "Read storage status.", + "method" : "GET", + "name" : "read_status", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "storage" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", + "type" : "string", + "typetext" : "" + } } }, - "type" : "object" - }, - "type" : "array" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/scan/nfs", - "text" : "nfs" - }, - { - "info" : { - "GET" : { - "description" : "Scan remote GlusterFS server.", - "method" : "GET", - "name" : "glusterfsscan", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "permissions" : { + "check" : [ + "perm", + "/storage/{storage}", + [ + "Datastore.Audit", + "Datastore.AllocateSpace" + ], + "any", + 1 + ] }, - "server" : { - "format" : "pve-storage-server", - "type" : "string", - "typetext" : "" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "object" } } }, - "permissions" : { - "check" : [ - "perm", - "/storage", - [ - "Datastore.Allocate" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : { - "volname" : { - "type" : "string" + "leaf" : 1, + "path" : "/nodes/{node}/storage/{storage}/status", + "text" : "status" + }, + { + "info" : { + "GET" : { + "description" : "Read storage RRD statistics (returns PNG).", + "method" : "GET", + "name" : "rrd", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "cf" : { + "description" : "The RRD consolidation function", + "enum" : [ + "AVERAGE", + "MAX" + ], + "optional" : 1, + "type" : "string" + }, + "ds" : { + "description" : "The list of datasources you want to display.", + "format" : "pve-configid-list", + "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" : "" + }, + "timeframe" : { + "description" : "Specify the time frame you are interested in.", + "enum" : [ + "hour", + "day", + "week", + "month", + "year" + ], + "type" : "string" + } } }, - "type" : "object" - }, - "type" : "array" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/scan/glusterfs", - "text" : "glusterfs" - }, - { - "info" : { - "GET" : { - "description" : "Scan remote iSCSI server.", - "method" : "GET", - "name" : "iscsiscan", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "permissions" : { + "check" : [ + "perm", + "/storage/{storage}", + [ + "Datastore.Audit", + "Datastore.AllocateSpace" + ], + "any", + 1 + ] }, - "portal" : { - "format" : "pve-storage-portal-dns", - "type" : "string", - "typetext" : "" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "properties" : { + "filename" : { + "type" : "string" + } + }, + "type" : "object" } } }, - "permissions" : { - "check" : [ - "perm", - "/storage", - [ - "Datastore.Allocate" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : { - "portal" : { - "type" : "string" - }, - "target" : { - "type" : "string" + "leaf" : 1, + "path" : "/nodes/{node}/storage/{storage}/rrd", + "text" : "rrd" + }, + { + "info" : { + "GET" : { + "description" : "Read storage RRD statistics.", + "method" : "GET", + "name" : "rrddata", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "cf" : { + "description" : "The RRD consolidation function", + "enum" : [ + "AVERAGE", + "MAX" + ], + "optional" : 1, + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "storage" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", + "type" : "string", + "typetext" : "" + }, + "timeframe" : { + "description" : "Specify the time frame you are interested in.", + "enum" : [ + "hour", + "day", + "week", + "month", + "year" + ], + "type" : "string" + } } }, - "type" : "object" - }, - "type" : "array" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/scan/iscsi", - "text" : "iscsi" - }, - { - "info" : { - "GET" : { - "description" : "List local LVM volume groups.", - "method" : "GET", - "name" : "lvmscan", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "permissions" : { + "check" : [ + "perm", + "/storage/{storage}", + [ + "Datastore.Audit", + "Datastore.AllocateSpace" + ], + "any", + 1 + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "type" : "array" } } }, - "permissions" : { - "check" : [ - "perm", - "/storage", - [ - "Datastore.Allocate" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : { - "vg" : { - "type" : "string" + "leaf" : 1, + "path" : "/nodes/{node}/storage/{storage}/rrddata", + "text" : "rrddata" + }, + { + "info" : { + "POST" : { + "description" : "Upload templates and ISO images.", + "method" : "POST", + "name" : "upload", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "content" : { + "description" : "Content type.", + "format" : "pve-storage-content", + "type" : "string", + "typetext" : "" + }, + "filename" : { + "description" : "The name of the file to create.", + "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" : "" + }, + "tmpfilename" : { + "description" : "The source file name. This parameter is usually set by the REST handler. You can only overwrite it when connecting to the trusted port on localhost.", + "optional" : 1, + "type" : "string", + "typetext" : "" + } } }, - "type" : "object" - }, - "type" : "array" - } + "permissions" : { + "check" : [ + "perm", + "/storage/{storage}", + [ + "Datastore.AllocateTemplate" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/storage/{storage}/upload", + "text" : "upload" } - }, - "leaf" : 1, - "path" : "/nodes/{node}/scan/lvm", - "text" : "lvm" - }, - { + ], "info" : { "GET" : { - "description" : "List local LVM Thin Pools.", + "description" : "", "method" : "GET", - "name" : "lvmthinscan", + "name" : "diridx", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -21418,47 +30218,188 @@ var pveapi = [ "type" : "string", "typetext" : "" }, - "vg" : { - "maxLength" : 100, - "pattern" : "[a-zA-Z0-9\\.\\+\\_][a-zA-Z0-9\\.\\+\\_\\-]+", - "type" : "string" + "storage" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", + "type" : "string", + "typetext" : "" } } }, "permissions" : { "check" : [ "perm", - "/storage", + "/storage/{storage}", [ - "Datastore.Allocate" - ] + "Datastore.Audit", + "Datastore.AllocateSpace" + ], + "any", + 1 ] }, - "protected" : 1, - "proxyto" : "node", "returns" : { "items" : { "properties" : { - "lv" : { + "subdir" : { "type" : "string" } }, "type" : "object" }, + "links" : [ + { + "href" : "{subdir}", + "rel" : "child" + } + ], "type" : "array" } } }, - "leaf" : 1, - "path" : "/nodes/{node}/scan/lvmthin", - "text" : "lvmthin" - }, + "leaf" : 0, + "path" : "/nodes/{node}/storage/{storage}", + "text" : "{storage}" + } + ], + "info" : { + "GET" : { + "description" : "Get status for all datastores.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "content" : { + "description" : "Only list stores which support this content type.", + "format" : "pve-storage-content-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "enabled" : { + "default" : 0, + "description" : "Only list stores which are enabled (not disabled in config).", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "format" : { + "default" : 0, + "description" : "Include information about formats", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "storage" : { + "description" : "Only list status for specified storage", + "format" : "pve-storage-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "target" : { + "description" : "If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.", + "format" : "pve-node", + "optional" : 1, + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "description" : "Only list entries where you have 'Datastore.Audit' or 'Datastore.AllocateSpace' permissions on '/storage/'", + "user" : "all" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "active" : { + "description" : "Set when storage is accessible.", + "optional" : 1, + "type" : "boolean" + }, + "avail" : { + "description" : "Available storage space in bytes.", + "optional" : 1, + "renderer" : "bytes", + "type" : "integer" + }, + "content" : { + "description" : "Allowed storage content types.", + "format" : "pve-storage-content-list", + "type" : "string" + }, + "enabled" : { + "description" : "Set when storage is enabled (not disabled).", + "optional" : 1, + "type" : "boolean" + }, + "shared" : { + "description" : "Shared flag from storage configuration.", + "optional" : 1, + "type" : "boolean" + }, + "storage" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", + "type" : "string" + }, + "total" : { + "description" : "Total storage space in bytes.", + "optional" : 1, + "renderer" : "bytes", + "type" : "integer" + }, + "type" : { + "description" : "Storage type.", + "type" : "string" + }, + "used" : { + "description" : "Used storage space in bytes.", + "optional" : 1, + "renderer" : "bytes", + "type" : "integer" + }, + "used_fraction" : { + "description" : "Used fraction (used/total).", + "optional" : 1, + "renderer" : "fraction_as_percentage", + "type" : "number" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{storage}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/storage", + "text" : "storage" + }, + { + "children" : [ { "info" : { "GET" : { - "description" : "List local USB devices.", + "description" : "List LVM Volume Groups", "method" : "GET", - "name" : "usbscan", + "name" : "index", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -21475,448 +30416,378 @@ var pveapi = [ "perm", "/", [ - "Sys.Modify" - ] + "Sys.Audit", + "Datastore.Audit" + ], + "any", + 1 ] }, "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" + "properties" : { + "children" : { + "items" : { + "properties" : { + "children" : { + "description" : "The underlying physical volumes", + "items" : { + "properties" : { + "free" : { + "description" : "The free bytes in the physical volume", + "type" : "integer" + }, + "leaf" : { + "type" : "boolean" + }, + "name" : { + "description" : "The name of the physical volume", + "type" : "string" + }, + "size" : { + "description" : "The size of the physical volume in bytes", + "type" : "integer" + } + }, + "type" : "object" + }, + "optional" : 1, + "type" : "array" + }, + "free" : { + "description" : "The free bytes in the volume group", + "type" : "integer" + }, + "leaf" : { + "type" : "boolean" + }, + "name" : { + "description" : "The name of the volume group", + "type" : "string" + }, + "size" : { + "description" : "The size of the volume group in bytes", + "type" : "integer" + } + }, + "type" : "object" }, - "vendid" : { - "type" : "string" - } + "type" : "array" + }, + "leaf" : { + "type" : "boolean" + } + }, + "type" : "object" + } + }, + "POST" : { + "description" : "Create an LVM Volume Group", + "method" : "POST", + "name" : "create", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "add_storage" : { + "default" : 0, + "description" : "Configure storage using the Volume Group", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "device" : { + "description" : "The block device you want to create the volume group on", + "type" : "string", + "typetext" : "" + }, + "name" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", + "type" : "string", + "typetext" : "" }, - "type" : "object" - }, - "type" : "array" + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify", + "Datastore.Allocate" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" } } }, "leaf" : 1, - "path" : "/nodes/{node}/scan/usb", - "text" : "usb" - } - ], - "info" : { - "GET" : { - "description" : "Index of available scan methods", - "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" : { - "method" : { - "type" : "string" - } - }, - "type" : "object" - }, - "links" : [ - { - "href" : "{method}", - "rel" : "child" - } - ], - "type" : "array" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/scan", - "text" : "scan" - }, - { - "children" : [ + "path" : "/nodes/{node}/disks/lvm", + "text" : "lvm" + }, { - "children" : [ - { - "children" : [ - { - "info" : { - "DELETE" : { - "description" : "Delete volume", - "method" : "DELETE", - "name" : "delete", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "storage" : { - "description" : "The storage identifier.", - "format" : "pve-storage-id", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "volume" : { - "description" : "Volume identifier", - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "description" : "You need 'Datastore.Allocate' privilege on the storage (or 'Datastore.AllocateSpace' for backup volumes if you have VM.Backup privilege on the VM).", - "user" : "all" - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "null" - } - }, - "GET" : { - "description" : "Get volume attributes", - "method" : "GET", - "name" : "info", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "storage" : { - "description" : "The storage identifier.", - "format" : "pve-storage-id", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "volume" : { - "description" : "Volume identifier", - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "description" : "You need read access for the volume.", - "user" : "all" - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "object" - } - }, - "POST" : { - "description" : "Copy a volume. This is experimental code - do not use.", - "method" : "POST", - "name" : "copy", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "storage" : { - "description" : "The storage identifier.", - "format" : "pve-storage-id", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "target" : { - "description" : "Target volume identifier", - "type" : "string", - "typetext" : "" - }, - "target_node" : { - "description" : "Target node. Default is local node.", - "format" : "pve-node", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "volume" : { - "description" : "Source volume identifier", - "type" : "string", - "typetext" : "" - } - } - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "type" : "string" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/storage/{storage}/content/{volume}", - "text" : "{volume}" + "info" : { + "GET" : { + "description" : "List LVM thinpools", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } } - ], - "info" : { - "GET" : { - "description" : "List storage content.", - "method" : "GET", - "name" : "index", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "content" : { - "description" : "Only list content of this type.", - "format" : "pve-storage-content", - "optional" : 1, - "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" : "" - }, - "vmid" : { - "description" : "Only list images for this VM", - "format" : "pve-vmid", - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit", + "Datastore.Audit" + ], + "any", + 1 + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "lv" : { + "description" : "The name of the thinpool.", + "type" : "string" + }, + "lv_size" : { + "description" : "The size of the thinpool in bytes.", + "type" : "integer" + }, + "metadata_size" : { + "description" : "The size of the metadata lv in bytes.", + "type" : "integer" + }, + "metadata_used" : { + "description" : "The used bytes of the metadata lv.", + "type" : "integer" + }, + "used" : { + "description" : "The used bytes of the thinpool.", + "type" : "integer" } }, - "permissions" : { - "check" : [ - "perm", - "/storage/{storage}", - [ - "Datastore.Audit", - "Datastore.AllocateSpace" - ], - "any", - 1 - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : { - "volid" : { - "type" : "string" - } - }, - "type" : "object" - }, - "links" : [ - { - "href" : "{volid}", - "rel" : "child" - } - ], - "type" : "array" - } + "type" : "object" }, - "POST" : { - "description" : "Allocate disk images.", - "method" : "POST", - "name" : "create", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "filename" : { - "description" : "The name of the file to create.", - "type" : "string", - "typetext" : "" - }, - "format" : { - "enum" : [ - "raw", - "qcow2", - "subvol" - ], - "optional" : 1, - "requires" : "size", - "type" : "string" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "size" : { - "description" : "Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)", - "pattern" : "\\d+[MG]?", - "type" : "string" - }, - "storage" : { - "description" : "The storage identifier.", - "format" : "pve-storage-id", - "type" : "string", - "typetext" : "" - }, - "vmid" : { - "description" : "Specify owner VM", - "format" : "pve-vmid", - "minimum" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - } - } + "type" : "array" + } + }, + "POST" : { + "description" : "Create an LVM thinpool", + "method" : "POST", + "name" : "create", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "add_storage" : { + "default" : 0, + "description" : "Configure storage using the thinpool.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, - "permissions" : { - "check" : [ - "perm", - "/storage/{storage}", - [ - "Datastore.AllocateSpace" - ] - ] + "device" : { + "description" : "The block device you want to create the thinpool on.", + "type" : "string", + "typetext" : "" }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "description" : "Volume identifier", - "type" : "string" + "name" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" } } }, - "leaf" : 0, - "path" : "/nodes/{node}/storage/{storage}/content", - "text" : "content" - }, - { - "info" : { - "GET" : { - "description" : "Read storage status.", - "method" : "GET", - "name" : "read_status", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "storage" : { - "description" : "The storage identifier.", - "format" : "pve-storage-id", - "type" : "string", - "typetext" : "" - } + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify", + "Datastore.Allocate" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/disks/lvmthin", + "text" : "lvmthin" + }, + { + "info" : { + "GET" : { + "description" : "PVE Managed Directory storages.", + "method" : "GET", + "name" : "index", + "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" : { + "device" : { + "description" : "The mounted device.", + "type" : "string" + }, + "options" : { + "description" : "The mount options.", + "type" : "string" + }, + "path" : { + "description" : "The mount path.", + "type" : "string" + }, + "type" : { + "description" : "The filesystem type.", + "type" : "string" + }, + "unitfile" : { + "description" : "The path of the mount unit.", + "type" : "string" } }, - "permissions" : { - "check" : [ - "perm", - "/storage/{storage}", - [ - "Datastore.Audit", - "Datastore.AllocateSpace" - ], - "any", - 1 - ] + "type" : "object" + }, + "type" : "array" + } + }, + "POST" : { + "description" : "Create a Filesystem on an unused disk. Will be mounted under '/mnt/pve/NAME'.", + "method" : "POST", + "name" : "create", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "add_storage" : { + "default" : 0, + "description" : "Configure storage using the directory.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "device" : { + "description" : "The block device you want to create the filesystem on.", + "type" : "string", + "typetext" : "" + }, + "filesystem" : { + "default" : "ext4", + "description" : "The desired filesystem.", + "enum" : [ + "ext4", + "xfs" + ], + "optional" : 1, + "type" : "string" + }, + "name" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", + "type" : "string", + "typetext" : "" }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "properties" : {}, - "type" : "object" + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" } } }, - "leaf" : 1, - "path" : "/nodes/{node}/storage/{storage}/status", - "text" : "status" - }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify", + "Datastore.Allocate" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/disks/directory", + "text" : "directory" + }, + { + "children" : [ { "info" : { "GET" : { - "description" : "Read storage RRD statistics (returns PNG).", + "description" : "Get details about a zpool.", "method" : "GET", - "name" : "rrd", + "name" : "detail", "parameters" : { "additionalProperties" : 0, "properties" : { - "cf" : { - "description" : "The RRD consolidation function", - "enum" : [ - "AVERAGE", - "MAX" - ], - "optional" : 1, - "type" : "string" - }, - "ds" : { - "description" : "The list of datasources you want to display.", - "format" : "pve-configid-list", + "name" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", "type" : "string", "typetext" : "" }, @@ -21925,33 +30796,16 @@ var pveapi = [ "format" : "pve-node", "type" : "string", "typetext" : "" - }, - "storage" : { - "description" : "The storage identifier.", - "format" : "pve-storage-id", - "type" : "string", - "typetext" : "" - }, - "timeframe" : { - "description" : "Specify the time frame you are interested in.", - "enum" : [ - "hour", - "day", - "week", - "month", - "year" - ], - "type" : "string" } } }, "permissions" : { "check" : [ "perm", - "/storage/{storage}", + "/", [ - "Datastore.Audit", - "Datastore.AllocateSpace" + "Sys.Audit", + "Datastore.Audit" ], "any", 1 @@ -21961,153 +30815,81 @@ var pveapi = [ "proxyto" : "node", "returns" : { "properties" : { - "filename" : { - "type" : "string" - } - }, - "type" : "object" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/storage/{storage}/rrd", - "text" : "rrd" - }, - { - "info" : { - "GET" : { - "description" : "Read storage RRD statistics.", - "method" : "GET", - "name" : "rrddata", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "cf" : { - "description" : "The RRD consolidation function", - "enum" : [ - "AVERAGE", - "MAX" - ], + "action" : { + "description" : "Information about the recommended action to fix the state.", "optional" : 1, "type" : "string" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" - }, - "storage" : { - "description" : "The storage identifier.", - "format" : "pve-storage-id", - "type" : "string", - "typetext" : "" + "children" : { + "description" : "The pool configuration information, including the vdevs for each section (e.g. spares, cache), may be nested.", + "items" : { + "properties" : { + "cksum" : { + "optional" : 1, + "type" : "number" + }, + "msg" : { + "description" : "An optional message about the vdev.", + "type" : "string" + }, + "name" : { + "description" : "The name of the vdev or section.", + "type" : "string" + }, + "read" : { + "optional" : 1, + "type" : "number" + }, + "state" : { + "description" : "The state of the vdev.", + "optional" : 1, + "type" : "string" + }, + "write" : { + "optional" : 1, + "type" : "number" + } + }, + "type" : "object" + }, + "type" : "array" }, - "timeframe" : { - "description" : "Specify the time frame you are interested in.", - "enum" : [ - "hour", - "day", - "week", - "month", - "year" - ], + "errors" : { + "description" : "Information about the errors on the zpool.", "type" : "string" - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/storage/{storage}", - [ - "Datastore.Audit", - "Datastore.AllocateSpace" - ], - "any", - 1 - ] - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "type" : "array" - } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/storage/{storage}/rrddata", - "text" : "rrddata" - }, - { - "info" : { - "POST" : { - "description" : "Upload templates and ISO images.", - "method" : "POST", - "name" : "upload", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "content" : { - "description" : "Content type.", - "format" : "pve-storage-content", - "type" : "string", - "typetext" : "" }, - "filename" : { - "description" : "The name of the file to create.", - "type" : "string", - "typetext" : "" + "name" : { + "description" : "The name of the zpool.", + "type" : "string" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + "scan" : { + "description" : "Information about the last/current scrub.", + "type" : "string" }, - "storage" : { - "description" : "The storage identifier.", - "format" : "pve-storage-id", - "type" : "string", - "typetext" : "" + "state" : { + "description" : "The state of the zpool.", + "type" : "string" }, - "tmpfilename" : { - "description" : "The source file name. This parameter is usually set by the REST handler. You can only overwrite it when connecting to the trustet port on localhost.", + "status" : { + "description" : "Information about the state of the zpool.", "optional" : 1, - "type" : "string", - "typetext" : "" + "type" : "string" } - } - }, - "permissions" : { - "check" : [ - "perm", - "/storage/{storage}", - [ - "Datastore.AllocateTemplate" - ] - ] - }, - "protected" : 1, - "returns" : { - "type" : "string" + }, + "type" : "object" } } }, "leaf" : 1, - "path" : "/nodes/{node}/storage/{storage}/upload", - "text" : "upload" + "path" : "/nodes/{node}/disks/zfs/{name}", + "text" : "{name}" } ], "info" : { "GET" : { - "description" : "", + "description" : "List Zpools.", "method" : "GET", - "name" : "diridx", + "name" : "index", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -22116,133 +30898,156 @@ var pveapi = [ "format" : "pve-node", "type" : "string", "typetext" : "" - }, - "storage" : { - "description" : "The storage identifier.", - "format" : "pve-storage-id", - "type" : "string", - "typetext" : "" } } }, "permissions" : { "check" : [ "perm", - "/storage/{storage}", - [ - "Datastore.Audit", - "Datastore.AllocateSpace" + "/", + [ + "Sys.Audit", + "Datastore.Audit" ], "any", 1 ] }, + "protected" : 1, + "proxyto" : "node", "returns" : { "items" : { "properties" : { - "subdir" : { + "alloc" : { + "description" : "", + "type" : "integer" + }, + "dedup" : { + "description" : "", + "type" : "number" + }, + "frag" : { + "description" : "", + "type" : "integer" + }, + "free" : { + "description" : "", + "type" : "integer" + }, + "health" : { + "description" : "", + "type" : "string" + }, + "name" : { + "description" : "", "type" : "string" + }, + "size" : { + "description" : "", + "type" : "integer" } }, "type" : "object" }, "links" : [ { - "href" : "{subdir}", + "href" : "{name}", "rel" : "child" } ], "type" : "array" } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/storage/{storage}", - "text" : "{storage}" - } - ], - "info" : { - "GET" : { - "description" : "Get status for all datastores.", - "method" : "GET", - "name" : "index", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "content" : { - "description" : "Only list stores which support this content type.", - "format" : "pve-storage-content-list", - "optional" : 1, - "type" : "string", - "typetext" : "" - }, - "enabled" : { - "default" : 0, - "description" : "Only list stores which are enabled (not disabled in config).", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "format" : { - "default" : 0, - "description" : "Include information about formats", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string", - "typetext" : "" + }, + "POST" : { + "description" : "Create a ZFS pool.", + "method" : "POST", + "name" : "create", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "add_storage" : { + "default" : 0, + "description" : "Configure storage using the zpool.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "ashift" : { + "default" : 12, + "description" : "Pool sector size exponent.", + "maximum" : 16, + "minimum" : 9, + "optional" : 1, + "type" : "integer", + "typetext" : " (9 - 16)" + }, + "compression" : { + "default" : "on", + "description" : "The compression algorithm to use.", + "enum" : [ + "on", + "off", + "gzip", + "lz4", + "lzjb", + "zle" + ], + "optional" : 1, + "type" : "string" + }, + "devices" : { + "description" : "The block devices you want to create the zpool on.", + "format" : "string-list", + "type" : "string", + "typetext" : "" + }, + "name" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "raidlevel" : { + "description" : "The RAID level to use.", + "enum" : [ + "single", + "mirror", + "raid10", + "raidz", + "raidz2", + "raidz3" + ], + "type" : "string" + } + } }, - "storage" : { - "description" : "Only list status for specified storage", - "format" : "pve-storage-id", - "optional" : 1, - "type" : "string", - "typetext" : "" + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify", + "Datastore.Allocate" + ] + ] }, - "target" : { - "description" : "If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.", - "format" : "pve-node", - "optional" : 1, - "type" : "string", - "typetext" : "" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" } } }, - "permissions" : { - "description" : "Only list entries where you have 'Datastore.Audit' or 'Datastore.AllocateSpace' permissions on '/storage/'", - "user" : "all" - }, - "protected" : 1, - "proxyto" : "node", - "returns" : { - "items" : { - "properties" : { - "storage" : { - "type" : "string" - } - }, - "type" : "object" - }, - "links" : [ - { - "href" : "{storage}", - "rel" : "child" - } - ], - "type" : "array" - } - } - }, - "leaf" : 0, - "path" : "/nodes/{node}/storage", - "text" : "storage" - }, - { - "children" : [ + "leaf" : 0, + "path" : "/nodes/{node}/disks/zfs", + "text" : "zfs" + }, { "info" : { "GET" : { @@ -22257,6 +31062,22 @@ var pveapi = [ "format" : "pve-node", "type" : "string", "typetext" : "" + }, + "skipsmart" : { + "default" : 0, + "description" : "Skip smart checks.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "type" : { + "description" : "Only list specific types of disks.", + "enum" : [ + "unused", + "journal_disks" + ], + "optional" : 1, + "type" : "string" } } }, @@ -22783,8 +31604,70 @@ var pveapi = [ "proxyto" : "node", "returns" : { "properties" : { + "action" : { + "type" : "string" + }, + "comment" : { + "optional" : 1, + "type" : "string" + }, + "dest" : { + "optional" : 1, + "type" : "string" + }, + "dport" : { + "optional" : 1, + "type" : "string" + }, + "enable" : { + "optional" : 1, + "type" : "integer" + }, + "iface" : { + "optional" : 1, + "type" : "string" + }, + "ipversion" : { + "optional" : 1, + "type" : "integer" + }, + "log" : { + "description" : "Log level for firewall rule", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, + "macro" : { + "optional" : 1, + "type" : "string" + }, "pos" : { "type" : "integer" + }, + "proto" : { + "optional" : 1, + "type" : "string" + }, + "source" : { + "optional" : 1, + "type" : "string" + }, + "sport" : { + "optional" : 1, + "type" : "string" + }, + "type" : { + "type" : "string" } }, "type" : "object" @@ -22855,6 +31738,22 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "log" : { + "description" : "Log level for firewall rule.", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, "macro" : { "description" : "Use predefined standard macro.", "maxLength" : 128, @@ -23038,6 +31937,22 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "log" : { + "description" : "Log level for firewall rule.", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], + "optional" : 1, + "type" : "string" + }, "macro" : { "description" : "Use predefined standard macro.", "maxLength" : 128, @@ -23177,11 +32092,23 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "log_nf_conntrack" : { + "default" : 0, + "description" : "Enable logging of conntrack information.", + "optional" : 1, + "type" : "boolean" + }, "ndp" : { "description" : "Enable NDP.", "optional" : 1, "type" : "boolean" }, + "nf_conntrack_allow_invalid" : { + "default" : 0, + "description" : "Allow invalid packets on connection tracking.", + "optional" : 1, + "type" : "boolean" + }, "nf_conntrack_max" : { "description" : "Maximum number of tracked connections.", "minimum" : 32768, @@ -23299,12 +32226,26 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "log_nf_conntrack" : { + "default" : 0, + "description" : "Enable logging of conntrack information.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "ndp" : { "description" : "Enable NDP.", "optional" : 1, "type" : "boolean", "typetext" : "" }, + "nf_conntrack_allow_invalid" : { + "default" : 0, + "description" : "Allow invalid packets on connection tracking.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "nf_conntrack_max" : { "description" : "Maximum number of tracked connections.", "minimum" : 32768, @@ -23475,12 +32416,259 @@ var pveapi = [ }, "returns" : { "items" : { - "properties" : {}, + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/firewall", + "text" : "firewall" + }, + { + "children" : [ + { + "children" : [ + { + "info" : { + "GET" : { + "description" : "Get replication job status.", + "method" : "GET", + "name" : "job_status", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "id" : { + "description" : "Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'.", + "format" : "pve-replication-job-id", + "pattern" : "[1-9][0-9]{2,8}-\\d{1,9}", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "description" : "Requires the VM.Audit permission on /vms/.", + "user" : "all" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/replication/{id}/status", + "text" : "status" + }, + { + "info" : { + "GET" : { + "description" : "Read replication job log.", + "method" : "GET", + "name" : "read_job_log", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "id" : { + "description" : "Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'.", + "format" : "pve-replication-job-id", + "pattern" : "[1-9][0-9]{2,8}-\\d{1,9}", + "type" : "string" + }, + "limit" : { + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "start" : { + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + } + } + }, + "permissions" : { + "description" : "Requires the VM.Audit permission on /vms/, or 'Sys.Audit' on '/nodes/'", + "user" : "all" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "n" : { + "description" : "Line number", + "type" : "integer" + }, + "t" : { + "description" : "Line text", + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/replication/{id}/log", + "text" : "log" + }, + { + "info" : { + "POST" : { + "description" : "Schedule replication job to start as soon as possible.", + "method" : "POST", + "name" : "schedule_now", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "id" : { + "description" : "Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'.", + "format" : "pve-replication-job-id", + "pattern" : "[1-9][0-9]{2,8}-\\d{1,9}", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/storage", + [ + "Datastore.Allocate" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/replication/{id}/schedule_now", + "text" : "schedule_now" + } + ], + "info" : { + "GET" : { + "description" : "Directory index.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "id" : { + "description" : "Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'.", + "format" : "pve-replication-job-id", + "pattern" : "[1-9][0-9]{2,8}-\\d{1,9}", + "type" : "string" + }, + "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}/replication/{id}", + "text" : "{id}" + } + ], + "info" : { + "GET" : { + "description" : "List status of all replication jobs on this node.", + "method" : "GET", + "name" : "status", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "guest" : { + "description" : "Only list replication jobs for this guest.", + "format" : "pve-vmid", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "description" : "Requires the VM.Audit permission on /vms/.", + "user" : "all" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "id" : { + "type" : "string" + } + }, "type" : "object" }, "links" : [ { - "href" : "{name}", + "href" : "{id}", "rel" : "child" } ], @@ -23489,8 +32677,8 @@ var pveapi = [ } }, "leaf" : 0, - "path" : "/nodes/{node}/firewall", - "text" : "firewall" + "path" : "/nodes/{node}/replication", + "text" : "replication" }, { "children" : [ @@ -23498,19 +32686,13 @@ var pveapi = [ "children" : [ { "info" : { - "GET" : { - "description" : "Get replication job status.", - "method" : "GET", - "name" : "job_status", + "DELETE" : { + "description" : "Revoke existing certificate from CA.", + "method" : "DELETE", + "name" : "revoke_certificate", "parameters" : { "additionalProperties" : 0, "properties" : { - "id" : { - "description" : "Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'.", - "format" : "pve-replication-job-id", - "pattern" : "[1-9][0-9]{2,8}-\\d{1,9}", - "type" : "string" - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", @@ -23519,99 +32701,53 @@ var pveapi = [ } } }, - "permissions" : { - "description" : "Requires the VM.Audit permission on /vms/.", - "user" : "all" - }, "protected" : 1, "proxyto" : "node", "returns" : { - "properties" : {}, - "type" : "object" + "type" : "string" } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/replication/{id}/status", - "text" : "status" - }, - { - "info" : { - "GET" : { - "description" : "Read replication job log.", - "method" : "GET", - "name" : "read_job_log", + }, + "POST" : { + "description" : "Order a new certificate from ACME-compatible CA.", + "method" : "POST", + "name" : "new_certificate", "parameters" : { "additionalProperties" : 0, "properties" : { - "id" : { - "description" : "Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'.", - "format" : "pve-replication-job-id", - "pattern" : "[1-9][0-9]{2,8}-\\d{1,9}", - "type" : "string" - }, - "limit" : { - "minimum" : 0, + "force" : { + "default" : 0, + "description" : "Overwrite existing custom certificate.", "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" - }, - "start" : { - "minimum" : 0, - "optional" : 1, - "type" : "integer", - "typetext" : " (0 - N)" } } }, - "permissions" : { - "description" : "Requires the VM.Audit permission on /vms/, or 'Sys.Audit' on '/nodes/'", - "user" : "all" - }, "protected" : 1, "proxyto" : "node", "returns" : { - "items" : { - "properties" : { - "n" : { - "description" : "Line number", - "type" : "integer" - }, - "t" : { - "description" : "Line text", - "type" : "string" - } - }, - "type" : "object" - }, - "type" : "array" + "type" : "string" } - } - }, - "leaf" : 1, - "path" : "/nodes/{node}/replication/{id}/log", - "text" : "log" - }, - { - "info" : { - "POST" : { - "description" : "Schedule replication job to start as soon as possible.", - "method" : "POST", - "name" : "schedule_now", + }, + "PUT" : { + "description" : "Renew existing certificate from CA.", + "method" : "PUT", + "name" : "renew_certificate", "parameters" : { "additionalProperties" : 0, "properties" : { - "id" : { - "description" : "Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'.", - "format" : "pve-replication-job-id", - "pattern" : "[1-9][0-9]{2,8}-\\d{1,9}", - "type" : "string" + "force" : { + "default" : 0, + "description" : "Force renewal even if expiry is more than 30 days away.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", @@ -23621,15 +32757,6 @@ var pveapi = [ } } }, - "permissions" : { - "check" : [ - "perm", - "/storage", - [ - "Datastore.Allocate" - ] - ] - }, "protected" : 1, "proxyto" : "node", "returns" : { @@ -23638,71 +32765,271 @@ var pveapi = [ } }, "leaf" : 1, - "path" : "/nodes/{node}/replication/{id}/schedule_now", - "text" : "schedule_now" + "path" : "/nodes/{node}/certificates/acme/certificate", + "text" : "certificate" } ], "info" : { "GET" : { - "description" : "Directory index.", + "description" : "ACME index.", "method" : "GET", "name" : "index", "parameters" : { "additionalProperties" : 0, "properties" : { - "id" : { - "description" : "Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'.", - "format" : "pve-replication-job-id", - "pattern" : "[1-9][0-9]{2,8}-\\d{1,9}", - "type" : "string" + "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}/certificates/acme", + "text" : "acme" + }, + { + "info" : { + "GET" : { + "description" : "Get information about node's certificates.", + "method" : "GET", + "name" : "info", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "user" : "all" + }, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "filename" : { + "optional" : 1, + "type" : "string" + }, + "fingerprint" : { + "description" : "Certificate SHA 256 fingerprint.", + "optional" : 1, + "pattern" : "([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}", + "type" : "string" + }, + "issuer" : { + "description" : "Certificate issuer name.", + "optional" : 1, + "type" : "string" + }, + "notafter" : { + "description" : "Certificate's notAfter timestamp (UNIX epoch).", + "optional" : 1, + "renderer" : "timestamp", + "type" : "integer" + }, + "notbefore" : { + "description" : "Certificate's notBefore timestamp (UNIX epoch).", + "optional" : 1, + "renderer" : "timestamp", + "type" : "integer" + }, + "pem" : { + "description" : "Certificate in PEM format", + "format" : "pem-certificate", + "optional" : 1, + "type" : "string" + }, + "san" : { + "description" : "List of Certificate's SubjectAlternativeName entries.", + "items" : { + "type" : "string" + }, + "optional" : 1, + "renderer" : "yaml", + "type" : "array" + }, + "subject" : { + "description" : "Certificate subject name.", + "optional" : 1, + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/certificates/info", + "text" : "info" + }, + { + "info" : { + "DELETE" : { + "description" : "DELETE custom certificate chain and key.", + "method" : "DELETE", + "name" : "remove_custom_cert", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "restart" : { + "default" : 0, + "description" : "Restart pveproxy.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + } + } + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + }, + "POST" : { + "description" : "Upload or update custom certificate chain and key.", + "method" : "POST", + "name" : "upload_custom_cert", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "certificates" : { + "description" : "PEM encoded certificate (chain).", + "format" : "pem-certificate-chain", + "type" : "string", + "typetext" : "" + }, + "force" : { + "default" : 0, + "description" : "Overwrite existing custom or ACME certificate files.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "key" : { + "description" : "PEM encoded private key.", + "format" : "pem-string", + "optional" : 1, + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", "typetext" : "" + }, + "restart" : { + "default" : 0, + "description" : "Restart pveproxy.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" } } }, - "permissions" : { - "user" : "all" - }, + "protected" : 1, + "proxyto" : "node", "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "links" : [ - { - "href" : "{name}", - "rel" : "child" + "properties" : { + "filename" : { + "optional" : 1, + "type" : "string" + }, + "fingerprint" : { + "description" : "Certificate SHA 256 fingerprint.", + "optional" : 1, + "pattern" : "([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}", + "type" : "string" + }, + "issuer" : { + "description" : "Certificate issuer name.", + "optional" : 1, + "type" : "string" + }, + "notafter" : { + "description" : "Certificate's notAfter timestamp (UNIX epoch).", + "optional" : 1, + "renderer" : "timestamp", + "type" : "integer" + }, + "notbefore" : { + "description" : "Certificate's notBefore timestamp (UNIX epoch).", + "optional" : 1, + "renderer" : "timestamp", + "type" : "integer" + }, + "pem" : { + "description" : "Certificate in PEM format", + "format" : "pem-certificate", + "optional" : 1, + "type" : "string" + }, + "san" : { + "description" : "List of Certificate's SubjectAlternativeName entries.", + "items" : { + "type" : "string" + }, + "optional" : 1, + "renderer" : "yaml", + "type" : "array" + }, + "subject" : { + "description" : "Certificate subject name.", + "optional" : 1, + "type" : "string" } - ], - "type" : "array" + }, + "type" : "object" } } }, - "leaf" : 0, - "path" : "/nodes/{node}/replication/{id}", - "text" : "{id}" + "leaf" : 1, + "path" : "/nodes/{node}/certificates/custom", + "text" : "custom" } ], "info" : { "GET" : { - "description" : "List status of all replication jobs on this node.", + "description" : "Node index.", "method" : "GET", - "name" : "status", + "name" : "index", "parameters" : { "additionalProperties" : 0, "properties" : { - "guest" : { - "description" : "Only list replication jobs for this guest.", - "format" : "pve-vmid", - "minimum" : 1, - "optional" : 1, - "type" : "integer", - "typetext" : " (1 - N)" - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", @@ -23712,23 +33039,16 @@ var pveapi = [ } }, "permissions" : { - "description" : "Requires the VM.Audit permission on /vms/.", "user" : "all" }, - "protected" : 1, - "proxyto" : "node", "returns" : { "items" : { - "properties" : { - "id" : { - "type" : "string" - } - }, + "properties" : {}, "type" : "object" }, "links" : [ { - "href" : "{id}", + "href" : "{name}", "rel" : "child" } ], @@ -23737,8 +33057,123 @@ var pveapi = [ } }, "leaf" : 0, - "path" : "/nodes/{node}/replication", - "text" : "replication" + "path" : "/nodes/{node}/certificates", + "text" : "certificates" + }, + { + "info" : { + "GET" : { + "description" : "Get node configuration options.", + "method" : "GET", + "name" : "get_config", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] + ] + }, + "proxyto" : "node", + "returns" : { + "type" : "object" + } + }, + "PUT" : { + "description" : "Set node configuration options.", + "method" : "PUT", + "name" : "set_options", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "acme" : { + "description" : "Node specific ACME settings.", + "format" : { + "account" : { + "default" : "default", + "description" : "ACME account config file name.", + "format" : "pve-configid", + "format_description" : "name", + "optional" : 1, + "type" : "string" + }, + "domains" : { + "description" : "List of domains for this node's ACME certificate", + "format" : "pve-acme-domain-list", + "format_description" : "domain[;domain;...]", + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "domains= [,account=]" + }, + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "description" : { + "description" : "Node description/comment.", + "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" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "wakeonlan" : { + "description" : "MAC address for wake on LAN", + "format" : "mac-addr", + "optional" : 1, + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/config", + "text" : "config" }, { "info" : { @@ -23764,12 +33199,15 @@ var pveapi = [ "returns" : { "properties" : { "release" : { + "description" : "The current installed Proxmox VE Release", "type" : "string" }, "repoid" : { + "description" : "The short git commit hash ID from which this version was build", "type" : "string" }, "version" : { + "description" : "The current installed pve-manager package version", "type" : "string" } }, @@ -23809,7 +33247,6 @@ var pveapi = [ }, "proxyto" : "node", "returns" : { - "properties" : {}, "type" : "object" } }, @@ -23930,7 +33367,6 @@ var pveapi = [ "protected" : 1, "proxyto" : "node", "returns" : { - "properties" : {}, "type" : "array" } } @@ -23939,6 +33375,44 @@ var pveapi = [ "path" : "/nodes/{node}/execute", "text" : "execute" }, + { + "info" : { + "POST" : { + "description" : "Try to wake a node via 'wake on LAN' network packet.", + "method" : "POST", + "name" : "wakeonlan", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "target node for wake on LAN packet", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.PowerMgmt" + ] + ] + }, + "protected" : 1, + "returns" : { + "description" : "MAC address used to assemble the WoL magic packet.", + "format" : "mac-addr", + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/wakeonlan", + "text" : "wakeonlan" + }, { "info" : { "GET" : { @@ -24144,8 +33618,81 @@ var pveapi = [ } }, "leaf" : 1, - "path" : "/nodes/{node}/syslog", - "text" : "syslog" + "path" : "/nodes/{node}/syslog", + "text" : "syslog" + }, + { + "info" : { + "GET" : { + "description" : "Read Journal", + "method" : "GET", + "name" : "journal", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "endcursor" : { + "description" : "End before the given Cursor. Conflicts with 'until'", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "lastentries" : { + "description" : "Limit to the last X lines. Conflicts with a range.", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "since" : { + "description" : "Display all log since this UNIX epoch. Conflicts with 'startcursor'.", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "startcursor" : { + "description" : "Start after the given Cursor. Conflicts with 'since'", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "until" : { + "description" : "Display all log until this UNIX epoch. Conflicts with 'endcursor'.", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Syslog" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "type" : "string" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/journal", + "text" : "journal" }, { "info" : { @@ -24156,6 +33703,17 @@ var pveapi = [ "parameters" : { "additionalProperties" : 0, "properties" : { + "cmd" : { + "default" : "login", + "description" : "Run specific command or default to login.", + "enum" : [ + "upgrade", + "login", + "ceph_install" + ], + "optional" : 1, + "type" : "string" + }, "height" : { "description" : "sets the height of the console in pixels.", "maximum" : 2160, @@ -24172,7 +33730,7 @@ var pveapi = [ }, "upgrade" : { "default" : 0, - "description" : "Run 'apt-get dist-upgrade' instead of normal shell.", + "description" : "Deprecated, use the 'cmd' property instead! Run 'apt-get dist-upgrade' instead of normal shell.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -24239,6 +33797,17 @@ var pveapi = [ "parameters" : { "additionalProperties" : 0, "properties" : { + "cmd" : { + "default" : "login", + "description" : "Run specific command or default to login.", + "enum" : [ + "upgrade", + "login", + "ceph_install" + ], + "optional" : 1, + "type" : "string" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", @@ -24247,7 +33816,7 @@ var pveapi = [ }, "upgrade" : { "default" : 0, - "description" : "Run 'apt-get dist-upgrade' instead of normal shell.", + "description" : "Deprecated, use the 'cmd' property instead! Run 'apt-get dist-upgrade' instead of normal shell.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -24351,6 +33920,17 @@ var pveapi = [ "parameters" : { "additionalProperties" : 0, "properties" : { + "cmd" : { + "default" : "login", + "description" : "Run specific command or default to login.", + "enum" : [ + "upgrade", + "login", + "ceph_install" + ], + "optional" : 1, + "type" : "string" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", @@ -24358,7 +33938,7 @@ var pveapi = [ "typetext" : "" }, "proxy" : { - "description" : "SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As resonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).", + "description" : "SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).", "format" : "address", "optional" : 1, "type" : "string", @@ -24366,7 +33946,7 @@ var pveapi = [ }, "upgrade" : { "default" : 0, - "description" : "Run 'apt-get dist-upgrade' instead of normal shell.", + "description" : "Deprecated, use the 'cmd' property instead! Run 'apt-get dist-upgrade' instead of normal shell.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -24560,11 +34140,13 @@ var pveapi = [ "localtime" : { "description" : "Seconds since 1970-01-01 00:00:00 (local time)", "minimum" : 1297163644, + "renderer" : "timestamp_gmt", "type" : "integer" }, "time" : { "description" : "Seconds since 1970-01-01 00:00:00 UTC.", "minimum" : 1297163644, + "renderer" : "timestamp", "type" : "integer" }, "timezone" : { @@ -24664,7 +34246,7 @@ var pveapi = [ "typetext" : "" }, "template" : { - "description" : "The template wich will downloaded", + "description" : "The template which will downloaded", "maxLength" : 255, "type" : "string", "typetext" : "" @@ -24878,6 +34460,97 @@ var pveapi = [ "leaf" : 1, "path" : "/nodes/{node}/migrateall", "text" : "migrateall" + }, + { + "info" : { + "GET" : { + "description" : "Get the content of /etc/hosts.", + "method" : "GET", + "name" : "get_etc_hosts", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "properties" : { + "data" : { + "description" : "The content of /etc/hosts.", + "type" : "string" + }, + "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" + } + }, + "type" : "object" + } + }, + "POST" : { + "description" : "Write /etc/hosts.", + "method" : "POST", + "name" : "write_etc_hosts", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "data" : { + "description" : "The target content of /etc/hosts.", + "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" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/hosts", + "text" : "hosts" } ], "info" : { @@ -24932,7 +34605,61 @@ var pveapi = [ }, "returns" : { "items" : { - "properties" : {}, + "properties" : { + "cpu" : { + "description" : "CPU utilization.", + "optional" : 1, + "renderer" : "fraction_as_percentage", + "type" : "number" + }, + "level" : { + "description" : "Support level.", + "optional" : 1, + "type" : "string" + }, + "maxcpu" : { + "description" : "Number of available CPUs.", + "optional" : 1, + "type" : "integer" + }, + "maxmem" : { + "description" : "Number of available memory in bytes.", + "optional" : 1, + "renderer" : "bytes", + "type" : "integer" + }, + "mem" : { + "description" : "Used memory in bytes.", + "optional" : 1, + "renderer" : "bytes", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string" + }, + "ssl_fingerprint" : { + "description" : "The SSL fingerprint for the node certificate.", + "optional" : 1, + "type" : "string" + }, + "status" : { + "description" : "Node status.", + "enum" : [ + "unknown", + "online", + "offline" + ], + "type" : "string" + }, + "uptime" : { + "description" : "Node uptime in seconds.", + "optional" : 1, + "renderer" : "duration", + "type" : "integer" + } + }, "type" : "object" }, "links" : [ @@ -25006,7 +34733,9 @@ var pveapi = [ ] ] }, - "returns" : {} + "returns" : { + "type" : "object" + } }, "PUT" : { "description" : "Update storage configuration.", @@ -25021,6 +34750,49 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "bwlimit" : { + "description" : "Set bandwidth/io limits various operations.", + "format" : { + "clone" : { + "description" : "bandwidth limit in KiB/s for cloning disks", + "format_description" : "LIMIT", + "minimum" : "0", + "optional" : 1, + "type" : "number" + }, + "default" : { + "description" : "default bandwidth limit in KiB/s", + "format_description" : "LIMIT", + "minimum" : "0", + "optional" : 1, + "type" : "number" + }, + "migration" : { + "description" : "bandwidth limit in KiB/s for migrating guests (including moving local disks)", + "format_description" : "LIMIT", + "minimum" : "0", + "optional" : 1, + "type" : "number" + }, + "move" : { + "description" : "bandwidth limit in KiB/s for moving disks", + "format_description" : "LIMIT", + "minimum" : "0", + "optional" : 1, + "type" : "number" + }, + "restore" : { + "description" : "bandwidth limit in KiB/s for restoring guests from backups", + "format_description" : "LIMIT", + "minimum" : "0", + "optional" : 1, + "type" : "number" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[clone=] [,default=] [,migration=] [,move=] [,restore=]" + }, "comstar_hg" : { "description" : "host group for comstar views", "optional" : 1, @@ -25061,6 +34833,13 @@ var pveapi = [ "type" : "boolean", "typetext" : "" }, + "domain" : { + "description" : "CIFS domain.", + "maxLength" : 256, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "format" : { "description" : "Default image format.", "format" : "pve-storage-format", @@ -25068,6 +34847,12 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "fuse" : { + "description" : "Mount CephFS through FUSE.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "is_mountpoint" : { "default" : "no", "description" : "Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.", @@ -25076,11 +34861,17 @@ var pveapi = [ "typetext" : "" }, "krbd" : { - "description" : "Access rbd through krbd kernel module.", + "description" : "Always access rbd through krbd kernel module.", "optional" : 1, "type" : "boolean", "typetext" : "" }, + "lio_tpg" : { + "description" : "target portal group for Linux LIO targets", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "maxfiles" : { "description" : "Maximal number of backup files per VM. Use '0' for unlimted.", "minimum" : 0, @@ -25122,6 +34913,13 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "password" : { + "description" : "Password for CIFS share.", + "maxLength" : 256, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "pool" : { "description" : "Pool.", "optional" : 1, @@ -25170,6 +34968,16 @@ var pveapi = [ "type" : "boolean", "typetext" : "" }, + "smbversion" : { + "description" : "SMB protocol version", + "enum" : [ + "2.0", + "2.1", + "3.0" + ], + "optional" : 1, + "type" : "string" + }, "sparse" : { "description" : "use sparse volumes", "optional" : 1, @@ -25182,6 +34990,13 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "subdir" : { + "description" : "Subdir to mount.", + "format" : "pve-storage-path", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "tagged_only" : { "description" : "Only use logical volumes tagged with 'pve-vm-ID'.", "optional" : 1, @@ -25238,6 +35053,8 @@ var pveapi = [ "type" : { "description" : "Only list storage of specific type", "enum" : [ + "cephfs", + "cifs", "dir", "drbd", "glusterfs", @@ -25247,7 +35064,6 @@ var pveapi = [ "lvmthin", "nfs", "rbd", - "sheepdog", "zfs", "zfspool" ], @@ -25304,6 +35120,49 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "bwlimit" : { + "description" : "Set bandwidth/io limits various operations.", + "format" : { + "clone" : { + "description" : "bandwidth limit in KiB/s for cloning disks", + "format_description" : "LIMIT", + "minimum" : "0", + "optional" : 1, + "type" : "number" + }, + "default" : { + "description" : "default bandwidth limit in KiB/s", + "format_description" : "LIMIT", + "minimum" : "0", + "optional" : 1, + "type" : "number" + }, + "migration" : { + "description" : "bandwidth limit in KiB/s for migrating guests (including moving local disks)", + "format_description" : "LIMIT", + "minimum" : "0", + "optional" : 1, + "type" : "number" + }, + "move" : { + "description" : "bandwidth limit in KiB/s for moving disks", + "format_description" : "LIMIT", + "minimum" : "0", + "optional" : 1, + "type" : "number" + }, + "restore" : { + "description" : "bandwidth limit in KiB/s for restoring guests from backups", + "format_description" : "LIMIT", + "minimum" : "0", + "optional" : 1, + "type" : "number" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[clone=] [,default=] [,migration=] [,move=] [,restore=]" + }, "comstar_hg" : { "description" : "host group for comstar views", "optional" : 1, @@ -25329,6 +35188,13 @@ var pveapi = [ "type" : "boolean", "typetext" : "" }, + "domain" : { + "description" : "CIFS domain.", + "maxLength" : 256, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "export" : { "description" : "NFS export path.", "format" : "pve-storage-path", @@ -25343,6 +35209,12 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "fuse" : { + "description" : "Mount CephFS through FUSE.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "is_mountpoint" : { "default" : "no", "description" : "Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.", @@ -25357,11 +35229,17 @@ var pveapi = [ "typetext" : "" }, "krbd" : { - "description" : "Access rbd through krbd kernel module.", + "description" : "Always access rbd through krbd kernel module.", "optional" : 1, "type" : "boolean", "typetext" : "" }, + "lio_tpg" : { + "description" : "target portal group for Linux LIO targets", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "maxfiles" : { "description" : "Maximal number of backup files per VM. Use '0' for unlimted.", "minimum" : 0, @@ -25403,6 +35281,13 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "password" : { + "description" : "Password for CIFS share.", + "maxLength" : 256, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "path" : { "description" : "File system path.", "format" : "pve-storage-path", @@ -25459,12 +35344,28 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "share" : { + "description" : "CIFS share.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "shared" : { "description" : "Mark storage as shared.", "optional" : 1, "type" : "boolean", "typetext" : "" }, + "smbversion" : { + "description" : "SMB protocol version", + "enum" : [ + "2.0", + "2.1", + "3.0" + ], + "optional" : 1, + "type" : "string" + }, "sparse" : { "description" : "use sparse volumes", "optional" : 1, @@ -25477,6 +35378,13 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "subdir" : { + "description" : "Subdir to mount.", + "format" : "pve-storage-path", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "tagged_only" : { "description" : "Only use logical volumes tagged with 'pve-vm-ID'.", "optional" : 1, @@ -25509,6 +35417,8 @@ var pveapi = [ "type" : { "description" : "Storage type.", "enum" : [ + "cephfs", + "cifs", "dir", "drbd", "glusterfs", @@ -25518,7 +35428,6 @@ var pveapi = [ "lvmthin", "nfs", "rbd", - "sheepdog", "zfs", "zfspool" ], @@ -25570,6 +35479,73 @@ var pveapi = [ { "children" : [ { + "children" : [ + { + "info" : { + "GET" : { + "description" : "Get user TFA types (Personal and Realm).", + "method" : "GET", + "name" : "read_user_tfa_type", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "userid" : { + "description" : "User ID", + "format" : "pve-userid", + "maxLength" : 64, + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "or", + [ + "userid-param", + "self" + ], + [ + "userid-group", + [ + "User.Modify", + "Sys.Audit" + ] + ] + ] + }, + "protected" : 1, + "returns" : { + "additionalProperties" : 0, + "properties" : { + "realm" : { + "description" : "The type of TFA the users realm has set, if any.", + "enum" : [ + "oath", + "yubico" + ], + "optional" : 1, + "type" : "string" + }, + "user" : { + "description" : "The type of TFA the user has set, if any.", + "enum" : [ + "oath", + "u2f" + ], + "optional" : 1, + "type" : "string" + } + }, + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/access/users/{userid}/tfa", + "text" : "tfa" + } + ], "info" : { "DELETE" : { "description" : "Delete user.", @@ -25640,13 +35616,19 @@ var pveapi = [ "type" : "string" }, "email" : { + "format" : "email-opt", "optional" : 1, "type" : "string" }, "enable" : { + "default" : 1, + "description" : "Enable the account (default). You can set this to '0' to disable the account", + "optional" : 1, "type" : "boolean" }, "expire" : { + "description" : "Account expiration date (seconds since epoch). '0' means no expiration date.", + "minimum" : 0, "optional" : 1, "type" : "integer" }, @@ -25658,6 +35640,7 @@ var pveapi = [ "type" : "array" }, "keys" : { + "description" : "Keys for two factor auth (yubico).", "optional" : 1, "type" : "string" }, @@ -25665,7 +35648,8 @@ var pveapi = [ "optional" : 1, "type" : "string" } - } + }, + "type" : "object" } }, "PUT" : { @@ -25693,7 +35677,8 @@ var pveapi = [ "typetext" : "" }, "enable" : { - "description" : "Enable/disable the account.", + "default" : 1, + "description" : "Enable the account (default). You can set this to '0' to disable the account", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -25752,7 +35737,7 @@ var pveapi = [ } } }, - "leaf" : 1, + "leaf" : 0, "path" : "/access/users/{userid}", "text" : "{userid}" } @@ -25780,7 +35765,44 @@ var pveapi = [ "returns" : { "items" : { "properties" : { + "comment" : { + "optional" : 1, + "type" : "string" + }, + "email" : { + "format" : "email-opt", + "optional" : 1, + "type" : "string" + }, + "enable" : { + "default" : 1, + "description" : "Enable the account (default). You can set this to '0' to disable the account", + "optional" : 1, + "type" : "boolean" + }, + "expire" : { + "description" : "Account expiration date (seconds since epoch). '0' means no expiration date.", + "minimum" : 0, + "optional" : 1, + "type" : "integer" + }, + "firstname" : { + "optional" : 1, + "type" : "string" + }, + "keys" : { + "description" : "Keys for two factor auth (yubico).", + "optional" : 1, + "type" : "string" + }, + "lastname" : { + "optional" : 1, + "type" : "string" + }, "userid" : { + "description" : "User ID", + "format" : "pve-userid", + "maxLength" : 64, "type" : "string" } }, @@ -25815,7 +35837,7 @@ var pveapi = [ }, "enable" : { "default" : 1, - "description" : "Enable the account (default). You can set this to '0' to disable the accout", + "description" : "Enable the account (default). You can set this to '0' to disable the account", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -25961,6 +35983,9 @@ var pveapi = [ }, "members" : { "items" : { + "description" : "User ID", + "format" : "pve-userid", + "maxLength" : 64, "type" : "string" }, "type" : "array" @@ -26023,7 +36048,12 @@ var pveapi = [ "returns" : { "items" : { "properties" : { + "comment" : { + "optional" : 1, + "type" : "string" + }, "groupid" : { + "format" : "pve-groupid", "type" : "string" } }, @@ -26125,10 +36155,143 @@ var pveapi = [ "permissions" : { "user" : "all" }, - "returns" : {} + "returns" : { + "additionalProperties" : 0, + "properties" : { + "Datastore.Allocate" : { + "optional" : 1, + "type" : "boolean" + }, + "Datastore.AllocateSpace" : { + "optional" : 1, + "type" : "boolean" + }, + "Datastore.AllocateTemplate" : { + "optional" : 1, + "type" : "boolean" + }, + "Datastore.Audit" : { + "optional" : 1, + "type" : "boolean" + }, + "Group.Allocate" : { + "optional" : 1, + "type" : "boolean" + }, + "Permissions.Modify" : { + "optional" : 1, + "type" : "boolean" + }, + "Pool.Allocate" : { + "optional" : 1, + "type" : "boolean" + }, + "Realm.Allocate" : { + "optional" : 1, + "type" : "boolean" + }, + "Realm.AllocateUser" : { + "optional" : 1, + "type" : "boolean" + }, + "Sys.Audit" : { + "optional" : 1, + "type" : "boolean" + }, + "Sys.Console" : { + "optional" : 1, + "type" : "boolean" + }, + "Sys.Modify" : { + "optional" : 1, + "type" : "boolean" + }, + "Sys.PowerMgmt" : { + "optional" : 1, + "type" : "boolean" + }, + "Sys.Syslog" : { + "optional" : 1, + "type" : "boolean" + }, + "User.Modify" : { + "optional" : 1, + "type" : "boolean" + }, + "VM.Allocate" : { + "optional" : 1, + "type" : "boolean" + }, + "VM.Audit" : { + "optional" : 1, + "type" : "boolean" + }, + "VM.Backup" : { + "optional" : 1, + "type" : "boolean" + }, + "VM.Clone" : { + "optional" : 1, + "type" : "boolean" + }, + "VM.Config.CDROM" : { + "optional" : 1, + "type" : "boolean" + }, + "VM.Config.CPU" : { + "optional" : 1, + "type" : "boolean" + }, + "VM.Config.Disk" : { + "optional" : 1, + "type" : "boolean" + }, + "VM.Config.HWType" : { + "optional" : 1, + "type" : "boolean" + }, + "VM.Config.Memory" : { + "optional" : 1, + "type" : "boolean" + }, + "VM.Config.Network" : { + "optional" : 1, + "type" : "boolean" + }, + "VM.Config.Options" : { + "optional" : 1, + "type" : "boolean" + }, + "VM.Console" : { + "optional" : 1, + "type" : "boolean" + }, + "VM.Migrate" : { + "optional" : 1, + "type" : "boolean" + }, + "VM.Monitor" : { + "optional" : 1, + "type" : "boolean" + }, + "VM.PowerMgmt" : { + "optional" : 1, + "type" : "boolean" + }, + "VM.Snapshot" : { + "optional" : 1, + "type" : "boolean" + }, + "VM.Snapshot.Rollback" : { + "optional" : 1, + "type" : "boolean" + } + }, + "type" : "object" + } }, "PUT" : { - "description" : "Create new role.", + "description" : "Update an existing role.", "method" : "PUT", "name" : "update_role", "parameters" : { @@ -26142,6 +36305,7 @@ var pveapi = [ }, "privs" : { "format" : "pve-priv-list", + "optional" : 1, "type" : "string", "typetext" : "" }, @@ -26186,8 +36350,19 @@ var pveapi = [ "returns" : { "items" : { "properties" : { + "privs" : { + "format" : "pve-priv-list", + "optional" : 1, + "type" : "string" + }, "roleid" : { + "format" : "pve-roleid", "type" : "string" + }, + "special" : { + "default" : 0, + "optional" : 1, + "type" : "boolean" } }, "type" : "object" @@ -26258,9 +36433,13 @@ var pveapi = [ "additionalProperties" : 0, "properties" : { "path" : { + "description" : "Access control path", "type" : "string" }, "propagate" : { + "default" : 1, + "description" : "Allow to propagate (inherit) permissions.", + "optional" : 1, "type" : "boolean" }, "roleid" : { @@ -26527,7 +36706,7 @@ var pveapi = [ "maxLength" : 128, "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "type= [,digits=] [,id=] [,key=] [,step=] [,url=]" }, "user_attr" : { "description" : "LDAP user attribute name", @@ -26713,7 +36892,7 @@ var pveapi = [ "maxLength" : 128, "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "type= [,digits=] [,id=] [,key=] [,step=] [,url=]" }, "type" : { "description" : "Realm type.", @@ -26839,6 +37018,10 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "clustername" : { + "optional" : 1, + "type" : "string" + }, "ticket" : { "optional" : 1, "type" : "string" @@ -26860,7 +37043,7 @@ var pveapi = [ "PUT" : { "description" : "Change user password.", "method" : "PUT", - "name" : "change_passsword", + "name" : "change_password", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -26912,6 +37095,121 @@ var pveapi = [ "leaf" : 1, "path" : "/access/password", "text" : "password" + }, + { + "info" : { + "POST" : { + "description" : "Finish a u2f challenge.", + "method" : "POST", + "name" : "verify_tfa", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "response" : { + "description" : "The response to the current authentication challenge.", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "user" : "all" + }, + "protected" : 1, + "returns" : { + "properties" : { + "ticket" : { + "type" : "string" + } + }, + "type" : "object" + } + }, + "PUT" : { + "description" : "Change user u2f authentication.", + "method" : "PUT", + "name" : "change_tfa", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "action" : { + "description" : "The action to perform", + "enum" : [ + "delete", + "new", + "confirm" + ], + "type" : "string" + }, + "config" : { + "description" : "A TFA configuration. This must currently be of type TOTP of not set at all.", + "format" : "pve-tfa-config", + "maxLength" : 128, + "optional" : 1, + "type" : "string", + "typetext" : "type= [,digits=] [,id=] [,key=] [,step=] [,url=]" + }, + "key" : { + "description" : "When adding TOTP, the shared secret value.", + "optional" : 1, + "pattern" : "(?^:[A-Z2-7=]{16}|[A-Fa-f0-9]{40})", + "type" : "string" + }, + "password" : { + "description" : "The current password.", + "maxLength" : 64, + "minLength" : 5, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "response" : { + "description" : "Either the the response to the current u2f registration challenge, or, when adding TOTP, the currently valid TOTP value.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "userid" : { + "description" : "User ID", + "format" : "pve-userid", + "maxLength" : 64, + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "or", + [ + "userid-param", + "self" + ], + [ + "and", + [ + "userid-param", + "Realm.AllocateUser" + ], + [ + "userid-group", + [ + "User.Modify" + ] + ] + ] + ], + "description" : "A user can change their own u2f or totp token." + }, + "protected" : 1, + "returns" : { + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/access/tfa", + "text" : "tfa" } ], "info" : {