X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=api-viewer%2Fapidata.js;h=bde490469459bffec74545fe009dcdd34d5a0b86;hp=59754f0c942eb3827f8e63a6e02c00aa54785372;hb=c4808e75e00d27b1d90100900e5ca6d364f191df;hpb=561229878cc7e18ae9644af4e4fd4ca2f4c46f06 diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index 59754f0..bde4904 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -1,50 +1,44 @@ var pveapi = [ { - "leaf" : 0, - "text" : "cluster", "children" : [ { - "leaf" : 0, - "text" : "firewall", - "info" : { - "GET" : { - "name" : "index", - "method" : "GET", - "parameters" : { - "additionalProperties" : 0 - }, - "returns" : { - "items" : { - "type" : "object", - "properties" : {} - }, - "type" : "array", - "links" : [ - { - "href" : "{name}", - "rel" : "child" - } - ] - }, - "description" : "Directory index.", - "permissions" : { - "user" : "all" - } - } - }, "children" : [ { - "leaf" : 0, - "text" : "groups", - "path" : "/cluster/firewall/groups", "children" : [ { "children" : [ { - "leaf" : 1, - "text" : "{pos}", "info" : { - "PUT" : { + "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" : "" + }, + "group" : { + "description" : "Security Group name.", + "maxLength" : 18, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" + }, + "pos" : { + "description" : "Update rule at position .", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + } + } + }, "permissions" : { "check" : [ "perm", @@ -55,121 +49,179 @@ var pveapi = [ ] }, "protected" : 1, + "proxyto" : null, + "returns" : { + "type" : "null" + } + }, + "GET" : { + "description" : "Get single rule data.", + "method" : "GET", + "name" : "get_rule", "parameters" : { + "additionalProperties" : 0, "properties" : { - "iface" : { - "maxLength" : 20, - "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.", - "optional" : 1, + "group" : { + "description" : "Security Group name.", + "maxLength" : 18, "minLength" : 2, - "format" : "pve-iface", + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" }, - "digest" : { - "type" : "string", + "pos" : { + "description" : "Update rule at position .", + "minimum" : 0, "optional" : 1, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "maxLength" : 40 - }, - "source" : { + "type" : "integer", + "typetext" : " (0 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] + ] + }, + "proxyto" : null, + "returns" : { + "properties" : { + "pos" : { + "type" : "integer" + } + }, + "type" : "object" + } + }, + "PUT" : { + "description" : "Modify rule data.", + "method" : "PUT", + "name" : "update_rule", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "action" : { + "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", + "maxLength" : 20, + "minLength" : 2, "optional" : 1, - "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", + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" }, "comment" : { + "description" : "Descriptive comment.", "optional" : 1, - "type" : "string" - }, - "action" : { "type" : "string", - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, - "maxLength" : 20, - "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", - "optional" : 1 + "typetext" : "" }, - "pos" : { - "description" : "Update rule at position .", + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", "optional" : 1, - "type" : "integer", - "minimum" : 0 + "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", - "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.", - "optional" : 1 + "typetext" : "" }, - "type" : { - "enum" : [ - "in", - "out", - "group" - ], + "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" : "string", + "typetext" : "" }, - "proto" : { - "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.", + "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, - "format" : "pve-fw-protocol-spec", - "type" : "string" + "type" : "string", + "typetext" : "" }, "enable" : { - "type" : "integer", + "description" : "Flag to enable/disable a rule.", "minimum" : 0, - "optional" : 1 + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" }, - "moveto" : { + "group" : { + "description" : "Security Group name.", + "maxLength" : 18, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" + }, + "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" : "" + }, + "moveto" : { "description" : "Move rule to new position . Other arguments are ignored.", "minimum" : 0, - "type" : "integer" + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" }, - "dport" : { - "format" : "pve-fw-dport-spec", - "type" : "string", + "pos" : { + "description" : "Update rule at position .", + "minimum" : 0, "optional" : 1, - "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." + "type" : "integer", + "typetext" : " (0 - N)" }, - "delete" : { - "description" : "A list of settings you want to delete.", + "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, - "format" : "pve-configid-list", - "type" : "string" + "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", - "type" : "string", "optional" : 1, - "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." - }, - "group" : { - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "maxLength" : 20, - "description" : "Security Group name.", - "type" : "string" + "type" : "string", + "typetext" : "" }, - "macro" : { + "type" : { + "description" : "Rule type.", + "enum" : [ + "in", + "out", + "group" + ], "optional" : 1, - "maxLength" : 128, "type" : "string" } - }, - "additionalProperties" : 0 - }, - "proxyto" : null, - "description" : "Modify rule data.", - "returns" : { - "type" : "null" + } }, - "name" : "update_rule", - "method" : "PUT" - }, - "DELETE" : { - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -179,254 +231,205 @@ var pveapi = [ ] ] }, + "protected" : 1, "proxyto" : null, - "parameters" : { - "properties" : { - "group" : { - "maxLength" : 20, - "description" : "Security Group name.", - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, - "type" : "string" - }, - "pos" : { - "description" : "Update rule at position .", - "optional" : 1, - "minimum" : 0, - "type" : "integer" - }, - "digest" : { - "type" : "string", - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "maxLength" : 40, - "optional" : 1 - } - }, - "additionalProperties" : 0 - }, - "description" : "Delete rule.", - "method" : "DELETE", - "name" : "delete_rule", "returns" : { "type" : "null" } - }, - "GET" : { - "method" : "GET", - "name" : "get_rule", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "pos" : { - "minimum" : 0, - "type" : "integer", - "description" : "Update rule at position .", - "optional" : 1 - }, - "group" : { - "maxLength" : 20, - "description" : "Security Group name.", - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "type" : "string" - } - } - }, - "proxyto" : null, - "returns" : { - "properties" : { - "pos" : { - "type" : "integer" - } - }, - "type" : "object" - }, - "description" : "Get single rule data.", - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit" - ] - ] - } } }, - "path" : "/cluster/firewall/groups/{group}/{pos}" + "leaf" : 1, + "path" : "/cluster/firewall/groups/{group}/{pos}", + "text" : "{pos}" } ], "info" : { - "GET" : { + "DELETE" : { + "description" : "Delete security group.", + "method" : "DELETE", + "name" : "delete_security_group", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "group" : { + "description" : "Security Group name.", + "maxLength" : 18, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" + } + } + }, "permissions" : { "check" : [ "perm", "/", [ - "Sys.Audit" + "Sys.Modify" ] ] }, - "description" : "List rules.", - "method" : "GET", - "name" : "get_rules", + "protected" : 1, "returns" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "pos" : { - "type" : "integer" - } - } - }, - "links" : [ - { - "href" : "{pos}", - "rel" : "child" - } - ] - }, - "proxyto" : null, - "parameters" : { - "properties" : { - "group" : { - "maxLength" : 20, - "description" : "Security Group name.", - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, - "type" : "string" - } - }, - "additionalProperties" : 0 + "type" : "null" } }, - "DELETE" : { - "method" : "DELETE", - "name" : "delete_security_group", - "returns" : { - "type" : "null" - }, + "GET" : { + "description" : "List rules.", + "method" : "GET", + "name" : "get_rules", "parameters" : { "additionalProperties" : 0, "properties" : { "group" : { "description" : "Security Group name.", - "maxLength" : 20, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "maxLength" : 18, "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" } } }, - "protected" : 1, - "description" : "Delete security group.", "permissions" : { "check" : [ "perm", "/", [ - "Sys.Modify" + "Sys.Audit" ] ] + }, + "proxyto" : null, + "returns" : { + "items" : { + "properties" : { + "pos" : { + "type" : "integer" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{pos}", + "rel" : "child" + } + ], + "type" : "array" } }, "POST" : { + "description" : "Create new rule.", + "method" : "POST", + "name" : "create_rule", "parameters" : { "additionalProperties" : 0, "properties" : { - "group" : { - "type" : "string", - "maxLength" : 20, - "description" : "Security Group name.", - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+" - }, - "comment" : { - "type" : "string", - "optional" : 1 - }, "action" : { - "type" : "string", + "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", + "maxLength" : 20, "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "optional" : 0, - "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", - "maxLength" : 20 + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" }, - "pos" : { - "description" : "Update rule at position .", + "comment" : { + "description" : "Descriptive comment.", "optional" : 1, - "type" : "integer", - "minimum" : 0 + "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, - "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." + "type" : "string", + "typetext" : "" }, - "macro" : { + "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, - "maxLength" : 128 + "type" : "integer", + "typetext" : " (0 - N)" }, - "type" : { - "enum" : [ - "in", - "out", - "group" - ], - "optional" : 0, + "group" : { + "description" : "Security Group name.", + "maxLength" : 18, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" }, - "proto" : { - "type" : "string", - "format" : "pve-fw-protocol-spec", - "optional" : 1, - "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'." - }, "iface" : { - "minLength" : 2, - "maxLength" : 20, "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", - "format" : "pve-iface" + "typetext" : "" }, - "digest" : { - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", + "macro" : { + "description" : "Use predefined standard macro.", + "maxLength" : 128, "optional" : 1, - "maxLength" : 40, - "type" : "string" + "type" : "string", + "typetext" : "" }, - "enable" : { - "optional" : 1, + "pos" : { + "description" : "Update rule at position .", "minimum" : 0, - "type" : "integer" + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" }, - "dport" : { - "format" : "pve-fw-dport-spec", - "type" : "string", + "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, - "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." + "type" : "string", + "typetext" : "" }, "source" : { - "type" : "string", + "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, - "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." + "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", - "format" : "pve-fw-sport-spec" + "typetext" : "" + }, + "type" : { + "description" : "Rule type.", + "enum" : [ + "in", + "out", + "group" + ], + "optional" : 0, + "type" : "string" } } }, - "proxyto" : null, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -436,379 +439,174 @@ var pveapi = [ ] ] }, + "protected" : 1, + "proxyto" : null, "returns" : { "type" : "null" - }, - "method" : "POST", - "name" : "create_rule", - "description" : "Create new rule." + } } }, - "path" : "/cluster/firewall/groups/{group}", "leaf" : 0, + "path" : "/cluster/firewall/groups/{group}", "text" : "{group}" } ], "info" : { - "POST" : { - "protected" : 1, - "description" : "Create new security group.", + "GET" : { + "description" : "List security groups.", + "method" : "GET", + "name" : "list_security_groups", + "parameters" : { + "additionalProperties" : 0 + }, "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] + "user" : "all" }, - "returns" : { - "type" : "null" - }, - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "rename" : { - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, - "maxLength" : 20, - "optional" : 1, - "description" : "Rename/update an existing security group. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing group.", - "type" : "string" - }, - "digest" : { - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "optional" : 1, - "maxLength" : 40, - "type" : "string" - }, - "group" : { - "type" : "string", - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "maxLength" : 20, - "description" : "Security Group name." - }, - "comment" : { - "optional" : 1, - "type" : "string" - } - } - }, - "name" : "create_security_group", - "method" : "POST" - }, - "GET" : { "returns" : { "items" : { - "type" : "object", "properties" : { - "digest" : { - "type" : "string", - "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "optional" : 0 - }, "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" + }, "group" : { - "type" : "string", - "maxLength" : 20, "description" : "Security Group name.", + "maxLength" : 18, "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+" + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" } - } + }, + "type" : "object" }, - "type" : "array", - "links" : [ - { - "rel" : "child", - "href" : "{group}" - } - ] - }, - "parameters" : { - "additionalProperties" : 0 - }, - "name" : "list_security_groups", - "method" : "GET", - "description" : "List security groups.", - "permissions" : { - "user" : "all" - } - } - } - }, - { - "info" : { - "GET" : { - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit" - ] - ] - }, - "description" : "List rules.", - "method" : "GET", - "name" : "get_rules", - "returns" : { "links" : [ { - "rel" : "child", - "href" : "{pos}" + "href" : "{group}", + "rel" : "child" } ], - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "pos" : { - "type" : "integer" - } - } - } - }, - "proxyto" : null, - "parameters" : { - "additionalProperties" : 0 + "type" : "array" } }, "POST" : { - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "proxyto" : null, + "description" : "Create new security group.", + "method" : "POST", + "name" : "create_security_group", "parameters" : { "additionalProperties" : 0, "properties" : { - "macro" : { - "optional" : 1, - "maxLength" : 128, - "type" : "string" - }, - "type" : { - "optional" : 0, - "enum" : [ - "in", - "out", - "group" - ], - "type" : "string" - }, - "pos" : { - "type" : "integer", - "minimum" : 0, - "description" : "Update rule at position .", - "optional" : 1 - }, "comment" : { - "optional" : 1, - "type" : "string" - }, - "action" : { - "type" : "string", - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "optional" : 0, - "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", - "maxLength" : 20 - }, - "dest" : { - "optional" : 1, - "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", - "type" : "string" - }, - "source" : { - "format" : "pve-fw-addr-spec", - "type" : "string", - "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.", - "optional" : 1 - }, - "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.", "optional" : 1, "type" : "string", - "format" : "pve-fw-sport-spec" + "typetext" : "" }, "digest" : { - "type" : "string", - "optional" : 1, + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." - }, - "iface" : { - "type" : "string", - "format" : "pve-iface", - "minLength" : 2, - "maxLength" : 20, - "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.", - "optional" : 1 - }, - "proto" : { "optional" : 1, - "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.", "type" : "string", - "format" : "pve-fw-protocol-spec" + "typetext" : "" }, - "dport" : { - "format" : "pve-fw-dport-spec", - "type" : "string", - "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.", - "optional" : 1 + "group" : { + "description" : "Security Group name.", + "maxLength" : 18, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" }, - "enable" : { - "type" : "integer", - "minimum" : 0, - "optional" : 1 + "rename" : { + "description" : "Rename/update an existing security group. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing group.", + "maxLength" : 18, + "minLength" : 2, + "optional" : 1, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" } } }, - "description" : "Create new rule.", + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, "returns" : { "type" : "null" - }, - "name" : "create_rule", - "method" : "POST" + } } }, - "path" : "/cluster/firewall/rules", + "leaf" : 0, + "path" : "/cluster/firewall/groups", + "text" : "groups" + }, + { "children" : [ { - "leaf" : 1, - "text" : "{pos}", "info" : { - "PUT" : { + "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" - }, - "iface" : { - "optional" : 1, - "maxLength" : 20, - "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.", - "minLength" : 2, - "format" : "pve-iface", - "type" : "string" - }, - "proto" : { - "optional" : 1, - "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.", "type" : "string", - "format" : "pve-fw-protocol-spec" + "typetext" : "" }, - "dport" : { + "pos" : { + "description" : "Update rule at position .", + "minimum" : 0, "optional" : 1, - "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", - "type" : "string" - }, - "moveto" : { "type" : "integer", + "typetext" : " (0 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : null, + "returns" : { + "type" : "null" + } + }, + "GET" : { + "description" : "Get single rule data.", + "method" : "GET", + "name" : "get_rule", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "pos" : { + "description" : "Update rule at position .", "minimum" : 0, - "description" : "Move rule to new position . Other arguments are ignored.", - "optional" : 1 - }, - "enable" : { "optional" : 1, "type" : "integer", - "minimum" : 0 - }, - "delete" : { - "description" : "A list of settings you want to delete.", - "optional" : 1, - "type" : "string", - "format" : "pve-configid-list" - }, - "source" : { - "type" : "string", - "format" : "pve-fw-addr-spec", - "optional" : 1, - "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." - }, - "sport" : { - "format" : "pve-fw-sport-spec", - "type" : "string", - "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.", - "optional" : 1 - }, - "pos" : { - "description" : "Update rule at position .", - "optional" : 1, - "minimum" : 0, - "type" : "integer" - }, - "action" : { - "type" : "string", - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, - "maxLength" : 20, - "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", - "optional" : 1 - }, - "comment" : { - "optional" : 1, - "type" : "string" - }, - "dest" : { - "format" : "pve-fw-addr-spec", - "type" : "string", - "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.", - "optional" : 1 - }, - "macro" : { - "type" : "string", - "optional" : 1, - "maxLength" : 128 - }, - "type" : { - "type" : "string", - "optional" : 1, - "enum" : [ - "in", - "out", - "group" - ] + "typetext" : " (0 - N)" } - }, - "additionalProperties" : 0 - }, - "proxyto" : null, - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "returns" : { - "type" : "null" + } }, - "method" : "PUT", - "name" : "update_rule", - "description" : "Modify rule data." - }, - "GET" : { "permissions" : { "check" : [ "perm", @@ -818,18 +616,6 @@ var pveapi = [ ] ] }, - "description" : "Get single rule data.", - "parameters" : { - "properties" : { - "pos" : { - "type" : "integer", - "minimum" : 0, - "optional" : 1, - "description" : "Update rule at position ." - } - }, - "additionalProperties" : 0 - }, "proxyto" : null, "returns" : { "properties" : { @@ -838,29 +624,127 @@ var pveapi = [ } }, "type" : "object" - }, - "method" : "GET", - "name" : "get_rule" + } }, - "DELETE" : { + "PUT" : { + "description" : "Modify rule data.", + "method" : "PUT", + "name" : "update_rule", "parameters" : { "additionalProperties" : 0, "properties" : { - "pos" : { - "description" : "Update rule at position .", + "action" : { + "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", + "maxLength" : 20, + "minLength" : 2, "optional" : 1, - "type" : "integer", - "minimum" : 0 + "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" : "" + }, + "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)" + }, + "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" : 1, "type" : "string" } } }, - "proxyto" : null, "permissions" : { "check" : [ "perm", @@ -871,74 +755,25 @@ var pveapi = [ ] }, "protected" : 1, + "proxyto" : null, "returns" : { "type" : "null" - }, - "name" : "delete_rule", - "method" : "DELETE", - "description" : "Delete rule." + } } }, - "path" : "/cluster/firewall/rules/{pos}" + "leaf" : 1, + "path" : "/cluster/firewall/rules/{pos}", + "text" : "{pos}" } ], - "leaf" : 0, - "text" : "rules" - }, - { - "leaf" : 0, - "text" : "ipset", "info" : { - "POST" : { + "GET" : { + "description" : "List rules.", + "method" : "GET", + "name" : "get_rules", "parameters" : { - "properties" : { - "name" : { - "description" : "IP set name.", - "maxLength" : 64, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, - "type" : "string" - }, - "rename" : { - "type" : "string", - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, - "optional" : 1, - "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 - }, - "comment" : { - "optional" : 1, - "type" : "string" - }, - "digest" : { - "optional" : 1, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "maxLength" : 40, - "type" : "string" - } - }, "additionalProperties" : 0 }, - "returns" : { - "type" : "null" - }, - "name" : "create_ipset", - "method" : "POST", - "description" : "Create new IPSet", - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1 - }, - "GET" : { - "description" : "List IPSets", "permissions" : { "check" : [ "perm", @@ -948,185 +783,297 @@ var pveapi = [ ] ] }, + "proxyto" : null, "returns" : { "items" : { "properties" : { - "comment" : { - "optional" : 1, - "type" : "string" - }, - "digest" : { - "optional" : 0, - "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "type" : "string" - }, - "name" : { - "type" : "string", - "maxLength" : 64, - "description" : "IP set name.", - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+" + "pos" : { + "type" : "integer" } }, "type" : "object" }, - "type" : "array", "links" : [ { - "rel" : "child", - "href" : "{name}" + "href" : "{pos}", + "rel" : "child" } - ] - }, - "parameters" : { - "additionalProperties" : 0 - }, - "name" : "ipset_index", - "method" : "GET" - } - }, + ], + "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" : "" + }, + "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" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : null, + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 0, + "path" : "/cluster/firewall/rules", + "text" : "rules" + }, + { "children" : [ { - "leaf" : 0, - "text" : "{name}", "children" : [ { "info" : { - "GET" : { - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit" - ] - ] - }, - "description" : "Read IP or Network settings from IPSet.", - "method" : "GET", - "name" : "read_ip", - "returns" : { - "type" : "object" - }, + "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", - "description" : "Network/IP specification in CIDR format." + "typetext" : "" }, - "name" : { + "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\\-\\_]+", - "minLength" : 2 + "type" : "string" } } - } - }, - "DELETE" : { + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "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", - "description" : "Network/IP specification in CIDR format." - }, - "digest" : { - "optional" : 1, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "maxLength" : 40, - "type" : "string" + "typetext" : "" }, "name" : { "description" : "IP set name.", "maxLength" : 64, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" } - }, - "additionalProperties" : 0 + } }, - "method" : "DELETE", - "name" : "remove_ip", - "protected" : 1, - "description" : "Remove IP or Network from IPSet.", "permissions" : { "check" : [ "perm", "/", [ - "Sys.Modify" + "Sys.Audit" ] ] + }, + "protected" : 1, + "returns" : { + "type" : "object" } }, "PUT" : { "description" : "Update IP or Network settings", - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, + "method" : "PUT", + "name" : "update_ip", "parameters" : { + "additionalProperties" : 0, "properties" : { - "name" : { - "type" : "string", - "maxLength" : 64, - "description" : "IP set name.", - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2 - }, "cidr" : { - "type" : "string", + "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDRorAlias", - "description" : "Network/IP specification in CIDR format." - }, - "nomatch" : { - "optional" : 1, - "type" : "boolean" + "type" : "string", + "typetext" : "" }, "comment" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "digest" : { "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "optional" : 1, "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" + }, + "nomatch" : { + "optional" : 1, + "type" : "boolean", + "typetext" : "" } - }, - "additionalProperties" : 0 + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] }, + "protected" : 1, "returns" : { "type" : "null" - }, - "method" : "PUT", - "name" : "update_ip" + } } }, - "path" : "/cluster/firewall/ipset/{name}/{cidr}", "leaf" : 1, + "path" : "/cluster/firewall/ipset/{name}/{cidr}", "text" : "{cidr}" } ], - "path" : "/cluster/firewall/ipset/{name}", "info" : { "DELETE" : { + "description" : "Delete IPSet", "method" : "DELETE", "name" : "delete_ipset", "parameters" : { @@ -1135,15 +1082,12 @@ var pveapi = [ "name" : { "description" : "IP set name.", "maxLength" : 64, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" } } }, - "returns" : { - "type" : "null" - }, "permissions" : { "check" : [ "perm", @@ -1153,19 +1097,12 @@ var pveapi = [ ] ] }, - "description" : "Delete IPSet", - "protected" : 1 + "protected" : 1, + "returns" : { + "type" : "null" + } }, "GET" : { - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit" - ] - ] - }, "description" : "List IPSet content", "method" : "GET", "name" : "get_ipset", @@ -1173,168 +1110,87 @@ var pveapi = [ "additionalProperties" : 0, "properties" : { "name" : { - "maxLength" : 64, "description" : "IP set name.", + "maxLength" : 64, "minLength" : 2, "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" } } }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] + ] + }, "returns" : { - "links" : [ - { - "rel" : "child", - "href" : "{cidr}" - } - ], "items" : { "properties" : { "cidr" : { "type" : "string" }, + "comment" : { + "optional" : 1, + "type" : "string" + }, "digest" : { - "type" : "string", + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", "maxLength" : 40, "optional" : 0, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." - }, - "comment" : { - "optional" : 1, "type" : "string" }, "nomatch" : { - "type" : "boolean", - "optional" : 1 + "optional" : 1, + "type" : "boolean" } }, "type" : "object" }, + "links" : [ + { + "href" : "{cidr}", + "rel" : "child" + } + ], "type" : "array" } }, "POST" : { - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, "description" : "Add IP or Network to IPSet.", - "protected" : 1, "method" : "POST", "name" : "create_ip", "parameters" : { "additionalProperties" : 0, "properties" : { - "name" : { - "type" : "string", - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "description" : "IP set name.", - "maxLength" : 64 - }, - "comment" : { - "optional" : 1, - "type" : "string" - }, - "nomatch" : { - "optional" : 1, - "type" : "boolean" - }, "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDRorAlias", - "type" : "string" - } - } - }, - "returns" : { - "type" : "null" - } - } - } - } - ], - "path" : "/cluster/firewall/ipset" - }, - { - "text" : "aliases", - "leaf" : 0, - "children" : [ - { - "text" : "{name}", - "leaf" : 1, - "info" : { - "DELETE" : { - "protected" : 1, - "description" : "Remove IP or Network alias.", - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "returns" : { - "type" : "null" - }, - "parameters" : { - "properties" : { - "name" : { "type" : "string", - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "description" : "Alias name.", - "maxLength" : 64 + "typetext" : "" }, - "digest" : { - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "maxLength" : 40, + "comment" : { "optional" : 1, - "type" : "string" - } - }, - "additionalProperties" : 0 - }, - "method" : "DELETE", - "name" : "remove_alias" - }, - "GET" : { - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit" - ] - ] - }, - "description" : "Read alias.", - "parameters" : { - "additionalProperties" : 0, - "properties" : { + "type" : "string", + "typetext" : "" + }, "name" : { + "description" : "IP set name.", + "maxLength" : 64, "minLength" : 2, "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "maxLength" : 64, - "description" : "Alias name.", "type" : "string" + }, + "nomatch" : { + "optional" : 1, + "type" : "boolean", + "typetext" : "" } } }, - "returns" : { - "type" : "object" - }, - "name" : "read_alias", - "method" : "GET" - }, - "PUT" : { "permissions" : { "check" : [ "perm", @@ -1344,56 +1200,25 @@ var pveapi = [ ] ] }, - "description" : "Update IP or Network alias.", "protected" : 1, - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "name" : { - "maxLength" : 64, - "description" : "Alias name.", - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, - "type" : "string" - }, - "cidr" : { - "format" : "IPorCIDR", - "type" : "string", - "description" : "Network/IP specification in CIDR format." - }, - "rename" : { - "type" : "string", - "optional" : 1, - "maxLength" : 64, - "description" : "Rename an existing alias.", - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2 - }, - "comment" : { - "optional" : 1, - "type" : "string" - }, - "digest" : { - "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "optional" : 1, - "type" : "string" - } - } - }, "returns" : { "type" : "null" - }, - "name" : "update_alias", - "method" : "PUT" + } } }, - "path" : "/cluster/firewall/aliases/{name}" + "leaf" : 0, + "path" : "/cluster/firewall/ipset/{name}", + "text" : "{name}" } ], - "path" : "/cluster/firewall/aliases", "info" : { "GET" : { + "description" : "List IPSets", + "method" : "GET", + "name" : "ipset_index", + "parameters" : { + "additionalProperties" : 0 + }, "permissions" : { "check" : [ "perm", @@ -1403,136 +1228,74 @@ var pveapi = [ ] ] }, - "description" : "List aliases", - "method" : "GET", - "name" : "get_aliases", "returns" : { - "type" : "array", "items" : { "properties" : { - "name" : { - "type" : "string" - }, - "cidr" : { + "comment" : { + "optional" : 1, "type" : "string" }, "digest" : { - "optional" : 0, "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" }, - "comment" : { - "type" : "string", - "optional" : 1 + "name" : { + "description" : "IP set name.", + "maxLength" : 64, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" } }, "type" : "object" }, "links" : [ { - "rel" : "child", - "href" : "{name}" + "href" : "{name}", + "rel" : "child" } - ] - }, - "parameters" : { - "additionalProperties" : 0 + ], + "type" : "array" } }, "POST" : { - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "description" : "Create IP or Network Alias.", - "name" : "create_alias", + "description" : "Create new IPSet", "method" : "POST", - "returns" : { - "type" : "null" - }, + "name" : "create_ipset", "parameters" : { "additionalProperties" : 0, "properties" : { "comment" : { + "optional" : 1, "type" : "string", - "optional" : 1 + "typetext" : "" }, - "cidr" : { - "format" : "IPorCIDR", + "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", - "description" : "Network/IP specification in CIDR format." + "typetext" : "" }, "name" : { - "description" : "Alias name.", + "description" : "IP set name.", + "maxLength" : 64, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" + }, + "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" } } - } - } - } - }, - { - "info" : { - "GET" : { - "method" : "GET", - "name" : "get_options", - "parameters" : { - "additionalProperties" : 0 }, - "returns" : { - "properties" : { - "policy_in" : { - "enum" : [ - "ACCEPT", - "REJECT", - "DROP" - ], - "optional" : 1, - "description" : "Input policy.", - "type" : "string" - }, - "enable" : { - "description" : "Enable or disable the firewall cluster wide.", - "optional" : 1, - "minimum" : 0, - "type" : "integer" - }, - "policy_out" : { - "type" : "string", - "optional" : 1, - "description" : "Output policy.", - "enum" : [ - "ACCEPT", - "REJECT", - "DROP" - ] - } - }, - "type" : "object" - }, - "description" : "Get Firewall options.", - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit" - ] - ] - } - }, - "PUT" : { - "description" : "Set Firewall options.", "permissions" : { "check" : [ "perm", @@ -1543,100 +1306,155 @@ var pveapi = [ ] }, "protected" : 1, - "name" : "set_options", - "method" : "PUT", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "delete" : { - "description" : "A list of settings you want to delete.", - "optional" : 1, - "format" : "pve-configid-list", - "type" : "string" - }, - "policy_in" : { - "description" : "Input policy.", - "optional" : 1, - "enum" : [ - "ACCEPT", - "REJECT", - "DROP" - ], - "type" : "string" - }, - "digest" : { - "type" : "string", - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "maxLength" : 40, - "optional" : 1 - }, - "policy_out" : { - "type" : "string", - "enum" : [ - "ACCEPT", - "REJECT", - "DROP" - ], - "description" : "Output policy.", - "optional" : 1 - }, - "enable" : { - "minimum" : 0, - "type" : "integer", - "optional" : 1, - "description" : "Enable or disable the firewall cluster wide." - } - } - }, "returns" : { "type" : "null" } } }, - "path" : "/cluster/firewall/options", - "leaf" : 1, - "text" : "options" + "leaf" : 0, + "path" : "/cluster/firewall/ipset", + "text" : "ipset" }, { - "leaf" : 1, - "text" : "macros", - "path" : "/cluster/firewall/macros", - "info" : { - "GET" : { - "permissions" : { - "user" : "all" - }, - "description" : "List available macros", - "method" : "GET", - "name" : "get_macros", - "returns" : { - "items" : { - "properties" : { - "descr" : { - "description" : "More verbose description (if available).", - "type" : "string" - }, - "macro" : { - "type" : "string", - "description" : "Macro name." + "children" : [ + { + "info" : { + "DELETE" : { + "description" : "Remove IP or Network alias.", + "method" : "DELETE", + "name" : "remove_alias", + "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.", + "maxLength" : 64, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" + } } }, - "type" : "object" + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } }, - "type" : "array" + "GET" : { + "description" : "Read alias.", + "method" : "GET", + "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" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] + ] + }, + "returns" : { + "type" : "object" + } + }, + "PUT" : { + "description" : "Update IP or Network alias.", + "method" : "PUT", + "name" : "update_alias", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "cidr" : { + "description" : "Network/IP specification in CIDR format.", + "format" : "IPorCIDR", + "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" : "Alias name.", + "maxLength" : 64, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" + }, + "rename" : { + "description" : "Rename an existing alias.", + "maxLength" : 64, + "minLength" : 2, + "optional" : 1, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + } }, - "parameters" : { - "additionalProperties" : 0 - } + "leaf" : 1, + "path" : "/cluster/firewall/aliases/{name}", + "text" : "{name}" } - } - }, - { - "leaf" : 1, - "text" : "refs", - "path" : "/cluster/firewall/refs", + ], "info" : { "GET" : { + "description" : "List aliases", + "method" : "GET", + "name" : "get_aliases", + "parameters" : { + "additionalProperties" : 0 + }, "permissions" : { "check" : [ "perm", @@ -1646,91 +1464,64 @@ var pveapi = [ ] ] }, - "description" : "Lists possible IPSet/Alias reference which are allowed in source/dest properties.", - "method" : "GET", - "name" : "refs", "returns" : { "items" : { - "type" : "object", "properties" : { - "name" : { + "cidr" : { "type" : "string" }, - "ref" : { + "comment" : { + "optional" : 1, "type" : "string" }, - "type" : { - "type" : "string", - "enum" : [ - "alias", - "ipset" - ] + "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" }, - "comment" : { - "optional" : 1, + "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" : { - "type" : { + "cidr" : { + "description" : "Network/IP specification in CIDR format.", + "format" : "IPorCIDR", "type" : "string", - "enum" : [ - "alias", - "ipset" - ], + "typetext" : "" + }, + "comment" : { "optional" : 1, - "description" : "Only list references of specified type." - } - } - } - } - } - } - ], - "path" : "/cluster/firewall" - }, - { - "leaf" : 0, - "text" : "backup", - "children" : [ - { - "text" : "{id}", - "leaf" : 1, - "info" : { - "GET" : { - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "id" : { - "description" : "The job ID.", - "maxLength" : 50, + "type" : "string", + "typetext" : "" + }, + "name" : { + "description" : "Alias name.", + "maxLength" : 64, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" } } }, - "returns" : { - "type" : "object" - }, - "name" : "read_job", - "method" : "GET", - "description" : "Read vzdump backup job definition.", - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit" - ] - ] - } - }, - "DELETE" : { - "description" : "Delete vzdump backup job definition.", "permissions" : { "check" : [ "perm", @@ -1741,720 +1532,906 @@ var pveapi = [ ] }, "protected" : 1, - "method" : "DELETE", - "name" : "delete_job", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "id" : { - "type" : "string", - "maxLength" : 50, - "description" : "The job ID." - } - } - }, "returns" : { "type" : "null" } - }, - "PUT" : { - "protected" : 1, - "description" : "Update vzdump backup job definition.", + } + }, + "leaf" : 0, + "path" : "/cluster/firewall/aliases", + "text" : "aliases" + }, + { + "info" : { + "GET" : { + "description" : "Get Firewall options.", + "method" : "GET", + "name" : "get_options", + "parameters" : { + "additionalProperties" : 0 + }, "permissions" : { "check" : [ "perm", "/", [ - "Sys.Modify" + "Sys.Audit" ] ] }, - "name" : "update_job", - "method" : "PUT", "returns" : { - "type" : "null" - }, - "parameters" : { "properties" : { - "stopwait" : { - "type" : "integer", - "default" : 10, + "enable" : { + "description" : "Enable or disable the firewall cluster wide.", "minimum" : 0, - "description" : "Maximal time to wait until a guest system is stopped (minutes).", - "optional" : 1 - }, - "exclude-path" : { - "optional" : 1, - "description" : "Exclude certain files/directories (shell globs).", - "format" : "string-alist", - "type" : "string" - }, - "starttime" : { - "type" : "string", - "pattern" : "\\d{1,2}:\\d{1,2}", - "description" : "Job Start time.", - "typetext" : "HH:MM" - }, - "all" : { - "optional" : 1, - "description" : "Backup all known guest systems on this host.", - "type" : "boolean", - "default" : 0 - }, - "remove" : { "optional" : 1, - "description" : "Remove old backup files if there are more than 'maxfiles' backup files.", - "default" : 1, - "type" : "boolean" - }, - "storage" : { - "type" : "string", - "format" : "pve-storage-id", - "description" : "Store resulting file to this storage.", - "optional" : 1 + "type" : "integer" }, - "enabled" : { + "policy_in" : { + "description" : "Input policy.", + "enum" : [ + "ACCEPT", + "REJECT", + "DROP" + ], "optional" : 1, - "description" : "Enable or disable the job.", - "type" : "boolean", - "default" : "1" + "type" : "string" }, - "compress" : { - "description" : "Compress dump file.", - "optional" : 1, + "policy_out" : { + "description" : "Output policy.", "enum" : [ - "0", - "1", - "gzip", - "lzo" + "ACCEPT", + "REJECT", + "DROP" ], - "default" : "0", + "optional" : 1, "type" : "string" - }, - "size" : { + } + }, + "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, - "description" : "Unused, will be removed in a future release.", - "minimum" : 500, - "type" : "integer", - "default" : 1024 + "type" : "string", + "typetext" : "" }, - "bwlimit" : { + "digest" : { + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", + "maxLength" : 40, "optional" : 1, - "description" : "Limit I/O bandwidth (KBytes per second).", - "type" : "integer", - "default" : 0, - "minimum" : 0 - }, - "tmpdir" : { "type" : "string", - "description" : "Store temporary files to specified directory.", - "optional" : 1 + "typetext" : "" }, - "stop" : { + "enable" : { + "description" : "Enable or disable the firewall cluster wide.", + "minimum" : 0, "optional" : 1, - "description" : "Stop runnig backup jobs on this host.", - "type" : "boolean", - "default" : 0 - }, - "script" : { - "type" : "string", - "description" : "Use specified hook script.", - "optional" : 1 + "type" : "integer", + "typetext" : " (0 - N)" }, - "mailnotification" : { - "type" : "string", - "default" : "always", + "policy_in" : { + "description" : "Input policy.", "enum" : [ - "always", - "failure" + "ACCEPT", + "REJECT", + "DROP" ], - "description" : "Specify when to send an email", - "optional" : 1 - }, - "stdexcludes" : { - "optional" : 1, - "description" : "Exclude temporary files and logs.", - "type" : "boolean", - "default" : 1 - }, - "delete" : { - "description" : "A list of settings you want to delete.", "optional" : 1, - "format" : "pve-configid-list", "type" : "string" }, - "pigz" : { - "optional" : 1, - "description" : "Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.", - "type" : "integer", - "default" : 0 - }, - "maxfiles" : { + "policy_out" : { + "description" : "Output policy.", + "enum" : [ + "ACCEPT", + "REJECT", + "DROP" + ], "optional" : 1, - "description" : "Maximal number of backup files per guest system.", - "minimum" : 1, - "default" : 1, - "type" : "integer" - }, - "lockwait" : { - "description" : "Maximal time to wait for the global lock (minutes).", - "optional" : 1, - "minimum" : 0, - "default" : 180, - "type" : "integer" - }, - "vmid" : { - "description" : "The ID of the guest system you want to backup.", - "optional" : 1, - "type" : "string", - "format" : "pve-vmid-list" - }, - "dumpdir" : { - "type" : "string", - "description" : "Store resulting files to specified directory.", - "optional" : 1 - }, - "node" : { - "format" : "pve-node", - "type" : "string", - "optional" : 1, - "description" : "Only run if executed on this node." - }, - "dow" : { - "format" : "pve-day-of-week-list", - "type" : "string", - "optional" : 1, - "description" : "Day of week selection." - }, - "id" : { - "type" : "string", - "maxLength" : 50, - "description" : "The job ID." - }, - "ionice" : { - "minimum" : 0, - "maximum" : 8, - "default" : 7, - "type" : "integer", - "optional" : 1, - "description" : "Set CFQ ionice priority." - }, - "quiet" : { - "optional" : 1, - "description" : "Be quiet.", - "type" : "boolean", - "default" : 0 - }, - "mailto" : { - "description" : "Comma-separated list of email addresses that should receive email notifications.", - "optional" : 1, - "format" : "string-list", "type" : "string" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/cluster/firewall/options", + "text" : "options" + }, + { + "info" : { + "GET" : { + "description" : "List available macros", + "method" : "GET", + "name" : "get_macros", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : { + "descr" : { + "description" : "More verbose description (if available).", + "type" : "string" + }, + "macro" : { + "description" : "Macro name.", + "type" : "string" + } }, - "mode" : { - "optional" : 1, - "description" : "Backup mode.", + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/cluster/firewall/macros", + "text" : "macros" + }, + { + "info" : { + "GET" : { + "description" : "Lists possible IPSet/Alias reference which are allowed in source/dest properties.", + "method" : "GET", + "name" : "refs", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "type" : { + "description" : "Only list references of specified type.", "enum" : [ - "snapshot", - "suspend", - "stop" + "alias", + "ipset" ], - "default" : "snapshot", - "type" : "string" - }, - "exclude" : { - "description" : "Exclude specified guest systems (assumes --all)", "optional" : 1, - "format" : "pve-vmid-list", "type" : "string" } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] + ] + }, + "returns" : { + "items" : { + "properties" : { + "comment" : { + "optional" : 1, + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "ref" : { + "type" : "string" + }, + "type" : { + "enum" : [ + "alias", + "ipset" + ], + "type" : "string" + } + }, + "type" : "object" }, - "additionalProperties" : 0 + "type" : "array" } } }, - "path" : "/cluster/backup/{id}" + "leaf" : 1, + "path" : "/cluster/firewall/refs", + "text" : "refs" } ], - "path" : "/cluster/backup", "info" : { - "POST" : { + "GET" : { + "description" : "Directory index.", + "method" : "GET", + "name" : "index", "parameters" : { - "properties" : { - "starttime" : { - "type" : "string", - "pattern" : "\\d{1,2}:\\d{1,2}", - "typetext" : "HH:MM", - "description" : "Job Start time." + "additionalProperties" : 0 + }, + "permissions" : { + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/cluster/firewall", + "text" : "firewall" + }, + { + "children" : [ + { + "info" : { + "DELETE" : { + "description" : "Delete vzdump backup job definition.", + "method" : "DELETE", + "name" : "delete_job", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "id" : { + "description" : "The job ID.", + "maxLength" : 50, + "type" : "string", + "typetext" : "" + } + } }, - "exclude-path" : { - "type" : "string", - "format" : "string-alist", - "description" : "Exclude certain files/directories (shell globs).", - "optional" : 1 + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] }, - "remove" : { - "type" : "boolean", - "default" : 1, - "optional" : 1, - "description" : "Remove old backup files if there are more than 'maxfiles' backup files." + "protected" : 1, + "returns" : { + "type" : "null" + } + }, + "GET" : { + "description" : "Read vzdump backup job definition.", + "method" : "GET", + "name" : "read_job", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "id" : { + "description" : "The job ID.", + "maxLength" : 50, + "type" : "string", + "typetext" : "" + } + } }, - "all" : { - "default" : 0, - "type" : "boolean", - "optional" : 1, - "description" : "Backup all known guest systems on this host." + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] + ] }, - "stopwait" : { - "minimum" : 0, - "type" : "integer", - "default" : 10, - "description" : "Maximal time to wait until a guest system is stopped (minutes).", - "optional" : 1 - }, - "bwlimit" : { - "default" : 0, - "type" : "integer", - "minimum" : 0, - "optional" : 1, - "description" : "Limit I/O bandwidth (KBytes per second)." - }, - "tmpdir" : { - "type" : "string", - "description" : "Store temporary files to specified directory.", - "optional" : 1 - }, - "stop" : { - "default" : 0, - "type" : "boolean", - "optional" : 1, - "description" : "Stop runnig backup jobs on this host." - }, - "script" : { - "type" : "string", - "description" : "Use specified hook script.", - "optional" : 1 - }, - "compress" : { - "type" : "string", - "default" : "0", - "enum" : [ - "0", - "1", - "gzip", - "lzo" - ], - "description" : "Compress dump file.", - "optional" : 1 - }, - "storage" : { - "optional" : 1, - "description" : "Store resulting file to this storage.", - "format" : "pve-storage-id", - "type" : "string" - }, - "enabled" : { - "description" : "Enable or disable the job.", - "optional" : 1, - "type" : "boolean", - "default" : "1" - }, - "size" : { - "default" : 1024, - "type" : "integer", - "minimum" : 500, - "description" : "Unused, will be removed in a future release.", - "optional" : 1 - }, - "pigz" : { - "optional" : 1, - "description" : "Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.", - "type" : "integer", - "default" : 0 - }, - "lockwait" : { - "optional" : 1, - "description" : "Maximal time to wait for the global lock (minutes).", - "default" : 180, - "type" : "integer", - "minimum" : 0 - }, - "maxfiles" : { - "optional" : 1, - "description" : "Maximal number of backup files per guest system.", - "minimum" : 1, - "type" : "integer", - "default" : 1 - }, - "stdexcludes" : { - "type" : "boolean", - "default" : 1, - "description" : "Exclude temporary files and logs.", - "optional" : 1 - }, - "mailnotification" : { - "type" : "string", - "default" : "always", - "description" : "Specify when to send an email", - "optional" : 1, - "enum" : [ - "always", - "failure" - ] - }, - "node" : { - "description" : "Only run if executed on this node.", - "optional" : 1, - "type" : "string", - "format" : "pve-node" - }, - "ionice" : { - "description" : "Set CFQ ionice priority.", - "optional" : 1, - "minimum" : 0, - "type" : "integer", - "default" : 7, - "maximum" : 8 - }, - "quiet" : { - "description" : "Be quiet.", - "optional" : 1, - "type" : "boolean", - "default" : 0 - }, - "dow" : { - "description" : "Day of week selection.", - "optional" : 1, - "format" : "pve-day-of-week-list", - "default" : "mon,tue,wed,thu,fri,sat,sun", - "type" : "string" - }, - "dumpdir" : { - "type" : "string", - "description" : "Store resulting files to specified directory.", - "optional" : 1 - }, - "exclude" : { - "optional" : 1, - "description" : "Exclude specified guest systems (assumes --all)", - "type" : "string", - "format" : "pve-vmid-list" - }, - "mailto" : { - "type" : "string", - "format" : "string-list", - "description" : "Comma-separated list of email addresses that should receive email notifications.", - "optional" : 1 - }, - "mode" : { - "optional" : 1, - "description" : "Backup mode.", - "enum" : [ - "snapshot", - "suspend", - "stop" - ], - "default" : "snapshot", - "type" : "string" - }, - "vmid" : { - "optional" : 1, - "description" : "The ID of the guest system you want to backup.", - "format" : "pve-vmid-list", - "type" : "string" + "returns" : { + "type" : "object" } }, - "additionalProperties" : 0 - }, - "returns" : { - "type" : "null" - }, - "name" : "create_job", - "method" : "POST", - "description" : "Create new vzdump backup job.", - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1 - }, - "GET" : { - "returns" : { - "type" : "array", - "items" : { - "properties" : { - "id" : { - "type" : "string" - } - }, - "type" : "object" - }, - "links" : [ - { - "href" : "{id}", - "rel" : "child" - } - ] - }, - "parameters" : { - "additionalProperties" : 0 - }, - "name" : "index", - "method" : "GET", - "description" : "List vzdump backup schedule.", - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit" - ] - ] - } - } - } - }, - { - "info" : { - "GET" : { - "description" : "Directory index.", - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit" - ] - ] - }, - "returns" : { - "links" : [ - { - "rel" : "child", - "href" : "{id}" - } - ], - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - } - } - } - }, - "parameters" : { - "additionalProperties" : 0 - }, - "method" : "GET", - "name" : "index" - } - }, - "path" : "/cluster/ha", - "children" : [ - { - "path" : "/cluster/ha/resources", - "info" : { - "POST" : { - "name" : "create", - "method" : "POST", - "returns" : { - "type" : "null" - }, + "PUT" : { + "description" : "Update vzdump backup job definition.", + "method" : "PUT", + "name" : "update_job", "parameters" : { "additionalProperties" : 0, "properties" : { - "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).", - "typetext" : ":", - "type" : "string", - "format" : "pve-ha-resource-or-vm-id" - }, - "group" : { - "type" : "string", - "format" : "pve-configid", - "description" : "The HA group identifier.", - "optional" : 1 - }, - "comment" : { + "all" : { + "default" : 0, + "description" : "Backup all known guest systems on this host.", "optional" : 1, - "maxLength" : 4096, - "description" : "Description.", - "type" : "string" + "type" : "boolean", + "typetext" : "" }, - "max_relocate" : { + "bwlimit" : { + "default" : 0, + "description" : "Limit I/O bandwidth (KBytes per second).", + "minimum" : 0, "optional" : 1, - "description" : "Maximal number of service relocate tries when a service failes to start.", + "type" : "integer", + "typetext" : " (0 - N)" + }, + "compress" : { + "default" : "0", + "description" : "Compress dump file.", + "enum" : [ + "0", + "1", + "gzip", + "lzo" + ], + "optional" : 1, + "type" : "string" + }, + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "dow" : { + "description" : "Day of week selection.", + "format" : "pve-day-of-week-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "dumpdir" : { + "description" : "Store resulting files to specified directory.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "enabled" : { + "default" : "1", + "description" : "Enable or disable the job.", + "optional" : 1, + "type" : "boolean", + "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" : "" + }, + "id" : { + "description" : "The job ID.", + "maxLength" : 50, + "type" : "string", + "typetext" : "" + }, + "ionice" : { + "default" : 7, + "description" : "Set CFQ ionice priority.", + "maximum" : 8, "minimum" : 0, + "optional" : 1, "type" : "integer", - "default" : 1 + "typetext" : " (0 - 8)" }, - "type" : { + "lockwait" : { + "default" : 180, + "description" : "Maximal time to wait for the global lock (minutes).", + "minimum" : 0, "optional" : 1, - "description" : "Resource type.", + "type" : "integer", + "typetext" : " (0 - N)" + }, + "mailnotification" : { + "default" : "always", + "description" : "Specify when to send an email", "enum" : [ - "vm", - "ct" + "always", + "failure" ], + "optional" : 1, "type" : "string" }, - "state" : { - "default" : "enabled", + "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, - "description" : "Resource state.", + "type" : "integer", + "typetext" : " (1 - N)" + }, + "mode" : { + "default" : "snapshot", + "description" : "Backup mode.", "enum" : [ - "enabled", - "disabled" - ] + "snapshot", + "suspend", + "stop" + ], + "optional" : 1, + "type" : "string" }, - "max_restart" : { - "minimum" : 0, + "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" : "Maximal number of tries to restart the service on a node after its start failed.", - "optional" : 1 - } - }, - "type" : "object" - }, - "protected" : 1, - "description" : "Create a new HA resource.", - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Console" - ] - ] - } - }, - "GET" : { - "name" : "index", - "method" : "GET", - "parameters" : { - "properties" : { - "type" : { + "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", - "enum" : [ - "vm", - "ct" - ], + "typetext" : "" + }, + "size" : { + "default" : 1024, + "description" : "Unused, will be removed in a future release.", + "minimum" : 500, "optional" : 1, - "description" : "Only list resources of specific type" - } - }, - "additionalProperties" : 0 - }, - "returns" : { - "type" : "array", - "items" : { - "properties" : { - "sid" : { - "type" : "string" - } + "type" : "integer", + "typetext" : " (500 - N)" }, - "type" : "object" - }, - "links" : [ - { - "rel" : "child", - "href" : "{sid}" + "starttime" : { + "description" : "Job Start time.", + "pattern" : "\\d{1,2}:\\d{1,2}", + "type" : "string", + "typetext" : "HH:MM" + }, + "stdexcludes" : { + "default" : 1, + "description" : "Exclude temporary files and logs.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "stop" : { + "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).", + "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" : "" + }, + "vmid" : { + "description" : "The ID of the guest system you want to backup.", + "format" : "pve-vmid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" } - ] + } }, "permissions" : { "check" : [ "perm", "/", [ - "Sys.Audit" + "Sys.Modify" ] ] }, - "description" : "List HA resources." + "protected" : 1, + "returns" : { + "type" : "null" + } } }, - "children" : [ - { - "text" : "{sid}", - "leaf" : 0, - "children" : [ - { - "path" : "/cluster/ha/resources/{sid}/migrate", - "info" : { - "POST" : { - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Console" - ] - ] - }, - "description" : "Request resource migration (online) to another node.", - "returns" : { - "type" : "null" - }, - "parameters" : { - "properties" : { - "sid" : { - "typetext" : ":", - "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" - }, - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." - } - }, - "additionalProperties" : 0 - }, - "method" : "POST", - "name" : "migrate" - } - }, - "leaf" : 1, - "text" : "migrate" - }, + "leaf" : 1, + "path" : "/cluster/backup/{id}", + "text" : "{id}" + } + ], + "info" : { + "GET" : { + "description" : "List vzdump backup schedule.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] + ] + }, + "returns" : { + "items" : { + "properties" : { + "id" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{id}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "description" : "Create new vzdump backup job.", + "method" : "POST", + "name" : "create_job", + "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" + }, + "dow" : { + "default" : "mon,tue,wed,thu,fri,sat,sun", + "description" : "Day of week selection.", + "format" : "pve-day-of-week-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "dumpdir" : { + "description" : "Store resulting files to specified directory.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "enabled" : { + "default" : "1", + "description" : "Enable or disable the job.", + "optional" : 1, + "type" : "boolean", + "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" : "" + }, + "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)" + }, + "starttime" : { + "description" : "Job Start time.", + "pattern" : "\\d{1,2}:\\d{1,2}", + "type" : "string", + "typetext" : "HH:MM" + }, + "stdexcludes" : { + "default" : 1, + "description" : "Exclude temporary files and logs.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "stop" : { + "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).", + "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" : "" + }, + "vmid" : { + "description" : "The ID of the guest system you want to backup.", + "format" : "pve-vmid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ], + "description" : "The 'tmpdir', 'dumpdir' and 'script' parameters are additionally restricted to the 'root@pam' user." + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 0, + "path" : "/cluster/backup", + "text" : "backup" + }, + { + "children" : [ + { + "children" : [ + { + "children" : [ { - "leaf" : 1, - "text" : "relocate", "info" : { "POST" : { - "name" : "relocate", + "description" : "Request resource migration (online) to another node.", "method" : "POST", - "returns" : { - "type" : "null" - }, + "name" : "migrate", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" }, "sid" : { - "type" : "string", - "format" : "pve-ha-resource-or-vm-id", "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" : ":" } - }, - "additionalProperties" : 0 + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Console" + ] + ] }, "protected" : 1, + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/cluster/ha/resources/{sid}/migrate", + "text" : "migrate" + }, + { + "info" : { + "POST" : { + "description" : "Request resource relocatzion to another node. This stops the service on the old node, and restarts it on the target node.", + "method" : "POST", + "name" : "relocate", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "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" : ":" + } + } + }, "permissions" : { "check" : [ "perm", @@ -2464,81 +2441,33 @@ var pveapi = [ ] ] }, - "description" : "Request resource relocatzion to another node. This stops the service on the old node, and restarts it on the target node." + "protected" : 1, + "returns" : { + "type" : "null" + } } }, - "path" : "/cluster/ha/resources/{sid}/relocate" + "leaf" : 1, + "path" : "/cluster/ha/resources/{sid}/relocate", + "text" : "relocate" } ], "info" : { - "PUT" : { - "returns" : { - "type" : "null" - }, + "DELETE" : { + "description" : "Delete resource configuration.", + "method" : "DELETE", + "name" : "delete", "parameters" : { "additionalProperties" : 0, "properties" : { - "delete" : { - "format" : "pve-configid-list", - "type" : "string", - "description" : "A list of settings you want to delete.", - "optional" : 1, - "maxLength" : 4096 - }, - "digest" : { - "type" : "string", - "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "optional" : 1 - }, - "state" : { - "enum" : [ - "enabled", - "disabled" - ], - "description" : "Resource state.", - "optional" : 1, - "type" : "string", - "default" : "enabled" - }, - "max_restart" : { - "optional" : 1, - "description" : "Maximal number of tries to restart the service on a node after its start failed.", - "type" : "integer", - "default" : 1, - "minimum" : 0 - }, - "comment" : { - "type" : "string", - "description" : "Description.", - "maxLength" : 4096, - "optional" : 1 - }, "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).", - "typetext" : ":", "format" : "pve-ha-resource-or-vm-id", - "type" : "string" - }, - "group" : { - "format" : "pve-configid", "type" : "string", - "description" : "The HA group identifier.", - "optional" : 1 - }, - "max_relocate" : { - "default" : 1, - "type" : "integer", - "minimum" : 0, - "description" : "Maximal number of service relocate tries when a service failes to start.", - "optional" : 1 + "typetext" : ":" } - }, - "type" : "object" + } }, - "name" : "update", - "method" : "PUT", - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -2548,224 +2477,150 @@ var pveapi = [ ] ] }, - "description" : "Update resource configuration." + "protected" : 1, + "returns" : { + "type" : "null" + } }, "GET" : { "description" : "Read resource configuration.", - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit" - ] - ] - }, + "method" : "GET", + "name" : "read", "parameters" : { "additionalProperties" : 0, "properties" : { "sid" : { - "typetext" : ":", "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" + "type" : "string", + "typetext" : ":" } } }, - "returns" : {}, - "method" : "GET", - "name" : "read" - }, - "DELETE" : { "permissions" : { "check" : [ "perm", "/", [ - "Sys.Console" + "Sys.Audit" ] ] }, - "description" : "Delete resource configuration.", - "protected" : 1, - "method" : "DELETE", - "name" : "delete", - "parameters" : { - "properties" : { - "sid" : { - "typetext" : ":", - "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" - } - }, - "additionalProperties" : 0 - }, - "returns" : { - "type" : "null" - } - } - }, - "path" : "/cluster/ha/resources/{sid}" - } - ], - "leaf" : 0, - "text" : "resources" - }, - { - "children" : [ - { - "path" : "/cluster/ha/groups/{group}", - "info" : { + "returns" : {} + }, "PUT" : { - "protected" : 1, - "description" : "Update ha group configuration.", - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Console" - ] - ] - }, - "returns" : { - "type" : "null" - }, + "description" : "Update resource configuration.", + "method" : "PUT", + "name" : "update", "parameters" : { + "additionalProperties" : 0, "properties" : { - "restricted" : { - "description" : "Services on unrestricted groups may run on any cluster members if all group members are offline. But they will migrate back as soon as a group member comes online. One can implement a 'preferred node' behavior using an unrestricted group with one member.", - "optional" : 1, - "default" : 0, - "type" : "boolean" - }, - "nodes" : { - "description" : "List of cluster node names with optional priority. We use priority '0' as default. The CRM tries to run services on the node with highest priority (also see option 'nofailback').", + "comment" : { + "description" : "Description.", + "maxLength" : 4096, "optional" : 1, - "typetext" : "[:]{,[:]}*", - "format" : "pve-ha-group-node-list", - "type" : "string" - }, - "nofailback" : { - "type" : "boolean", - "default" : 0, - "description" : "The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.", - "optional" : 1 + "type" : "string", + "typetext" : "" }, "delete" : { - "optional" : 1, "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", "maxLength" : 4096, + "optional" : 1, "type" : "string", - "format" : "pve-configid-list" + "typetext" : "" }, - "comment" : { - "maxLength" : 4096, - "description" : "Description.", + "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" : "string", + "typetext" : "" }, "group" : { "description" : "The HA group identifier.", "format" : "pve-configid", - "type" : "string" + "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.", + "max_relocate" : { + "default" : 1, + "description" : "Maximal number of service relocate tries when a service failes to start.", + "minimum" : 0, "optional" : 1, - "maxLength" : 40, - "type" : "string" + "type" : "integer", + "typetext" : " (0 - N)" + }, + "max_restart" : { + "default" : 1, + "description" : "Maximal number of tries to restart the service on a node after its start failed.", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "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" : { + "default" : "started", + "description" : "Requested resource state.", + "enum" : [ + "started", + "stopped", + "enabled", + "disabled" + ], + "optional" : 1, + "type" : "string", + "verbose_description" : "Requested resource state. The CRM reads this state and acts accordingly.\nPlease note that `enabled` is just an alias for `started`.\n\n`started`;;\n\nThe CRM tries to start the resource. Service state is\nset to `started` after successful start. On node failures, or when start\nfails, it tries to recover the resource. If everything fails, service\nstate it set to `error`.\n\n`stopped`;;\n\nThe CRM tries to keep the resource in `stopped` state, but it\nstill tries to relocate the resources on node failures.\n\n`disabled`;;\n\nThe CRM tries to put the resource in `stopped` state, but does not try\nto relocate the resources on node failures. The main purpose of this\nstate is error recovery, because it is the only way to move a resource out\nof the `error` state.\n\n" } }, - "additionalProperties" : 0, "type" : "object" }, - "method" : "PUT", - "name" : "update" - }, - "GET" : { "permissions" : { "check" : [ "perm", "/", [ - "Sys.Audit" + "Sys.Console" ] ] }, - "description" : "Read ha group configuration.", - "method" : "GET", - "name" : "read", - "returns" : {}, - "parameters" : { - "properties" : { - "group" : { - "type" : "string", - "format" : "pve-configid", - "description" : "The HA group identifier." - } - }, - "additionalProperties" : 0 - } - }, - "DELETE" : { - "method" : "DELETE", - "name" : "delete", - "parameters" : { - "properties" : { - "group" : { - "description" : "The HA group identifier.", - "format" : "pve-configid", - "type" : "string" - } - }, - "additionalProperties" : 0 - }, + "protected" : 1, "returns" : { "type" : "null" - }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Console" - ] - ] - }, - "description" : "Delete ha group configuration.", - "protected" : 1 + } } }, - "leaf" : 1, - "text" : "{group}" + "leaf" : 0, + "path" : "/cluster/ha/resources/{sid}", + "text" : "{sid}" } ], "info" : { "GET" : { + "description" : "List HA resources.", + "method" : "GET", + "name" : "index", "parameters" : { - "additionalProperties" : 0 - }, - "returns" : { - "links" : [ - { - "rel" : "child", - "href" : "{group}" + "additionalProperties" : 0, + "properties" : { + "type" : { + "description" : "Only list resources of specific type", + "enum" : [ + "ct", + "vm" + ], + "optional" : 1, + "type" : "string" } - ], - "type" : "array", - "items" : { - "properties" : { - "group" : { - "type" : "string" - } - }, - "type" : "object" } }, - "name" : "index", - "method" : "GET", "permissions" : { "check" : [ "perm", @@ -2775,60 +2630,92 @@ var pveapi = [ ] ] }, - "description" : "Get HA groups." + "returns" : { + "items" : { + "properties" : { + "sid" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{sid}", + "rel" : "child" + } + ], + "type" : "array" + } }, "POST" : { - "returns" : { - "type" : "null" - }, + "description" : "Create a new HA resource.", + "method" : "POST", + "name" : "create", "parameters" : { - "type" : "object", + "additionalProperties" : 0, "properties" : { - "nofailback" : { - "type" : "boolean", - "default" : 0, + "comment" : { + "description" : "Description.", + "maxLength" : 4096, "optional" : 1, - "description" : "The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior." + "type" : "string", + "typetext" : "" }, - "type" : { - "description" : "Group type.", + "group" : { + "description" : "The HA group identifier.", + "format" : "pve-configid", "optional" : 1, - "enum" : [ - "group" - ], - "type" : "string" + "type" : "string", + "typetext" : "" }, - "restricted" : { - "default" : 0, - "type" : "boolean", - "description" : "Services on unrestricted groups may run on any cluster members if all group members are offline. But they will migrate back as soon as a group member comes online. One can implement a 'preferred node' behavior using an unrestricted group with one member.", - "optional" : 1 + "max_relocate" : { + "default" : 1, + "description" : "Maximal number of service relocate tries when a service failes to start.", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" }, - "nodes" : { - "format" : "pve-ha-group-node-list", + "max_restart" : { + "default" : 1, + "description" : "Maximal number of tries to restart the service on a node after its start failed.", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "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", - "description" : "List of cluster node names with optional priority. We use priority '0' as default. The CRM tries to run services on the node with highest priority (also see option 'nofailback').", - "typetext" : "[:]{,[:]}*", - "optional" : 0 + "typetext" : ":" }, - "group" : { - "description" : "The HA group identifier.", - "format" : "pve-configid", - "type" : "string" + "state" : { + "default" : "started", + "description" : "Requested resource state.", + "enum" : [ + "started", + "stopped", + "enabled", + "disabled" + ], + "optional" : 1, + "type" : "string", + "verbose_description" : "Requested resource state. The CRM reads this state and acts accordingly.\nPlease note that `enabled` is just an alias for `started`.\n\n`started`;;\n\nThe CRM tries to start the resource. Service state is\nset to `started` after successful start. On node failures, or when start\nfails, it tries to recover the resource. If everything fails, service\nstate it set to `error`.\n\n`stopped`;;\n\nThe CRM tries to keep the resource in `stopped` state, but it\nstill tries to relocate the resources on node failures.\n\n`disabled`;;\n\nThe CRM tries to put the resource in `stopped` state, but does not try\nto relocate the resources on node failures. The main purpose of this\nstate is error recovery, because it is the only way to move a resource out\nof the `error` state.\n\n" }, - "comment" : { - "maxLength" : 4096, - "description" : "Description.", + "type" : { + "description" : "Resource type.", + "enum" : [ + "ct", + "vm" + ], "optional" : 1, "type" : "string" } }, - "additionalProperties" : 0 + "type" : "object" }, - "method" : "POST", - "name" : "create", - "protected" : 1, - "description" : "Create a new HA group.", "permissions" : { "check" : [ "perm", @@ -2837,54 +2724,64 @@ var pveapi = [ "Sys.Console" ] ] + }, + "protected" : 1, + "returns" : { + "type" : "null" } } }, - "path" : "/cluster/ha/groups", - "text" : "groups", - "leaf" : 0 + "leaf" : 0, + "path" : "/cluster/ha/resources", + "text" : "resources" }, { - "text" : "status", - "leaf" : 0, "children" : [ { - "text" : "current", - "leaf" : 1, - "path" : "/cluster/ha/status/current", "info" : { - "GET" : { - "returns" : { - "type" : "array" - }, + "DELETE" : { + "description" : "Delete ha group configuration.", + "method" : "DELETE", + "name" : "delete", "parameters" : { - "additionalProperties" : 0 + "additionalProperties" : 0, + "properties" : { + "group" : { + "description" : "The HA group identifier.", + "format" : "pve-configid", + "type" : "string", + "typetext" : "" + } + } }, - "method" : "GET", - "name" : "status", - "description" : "Get HA manger status.", "permissions" : { "check" : [ "perm", "/", [ - "Sys.Audit" + "Sys.Console" ] ] + }, + "protected" : 1, + "returns" : { + "type" : "null" } - } - } - }, - { - "info" : { + }, "GET" : { + "description" : "Read ha group configuration.", "method" : "GET", - "name" : "manager_status", + "name" : "read", "parameters" : { - "additionalProperties" : 0 - }, - "returns" : { - "type" : "object" + "additionalProperties" : 0, + "properties" : { + "group" : { + "description" : "The HA group identifier.", + "format" : "pve-configid", + "type" : "string", + "typetext" : "" + } + } }, "permissions" : { "check" : [ @@ -2895,273 +2792,293 @@ var pveapi = [ ] ] }, - "description" : "Get full HA manger status, including LRM status." - } - }, - "path" : "/cluster/ha/status/manager_status", - "leaf" : 1, - "text" : "manager_status" - } - ], - "path" : "/cluster/ha/status", - "info" : { - "GET" : { - "description" : "Directory index.", - "permissions" : { - "user" : "all" - }, - "parameters" : { - "additionalProperties" : 0 - }, - "returns" : { - "type" : "array", - "items" : { - "properties" : {}, - "type" : "object" + "returns" : {} }, - "links" : [ - { - "rel" : "child", - "href" : "{name}" - } - ] - }, - "name" : "index", - "method" : "GET" - } - } - } - ], - "leaf" : 0, - "text" : "ha" - }, - { - "text" : "log", - "leaf" : 1, - "path" : "/cluster/log", - "info" : { - "GET" : { - "name" : "log", - "method" : "GET", - "returns" : { - "type" : "array", - "items" : { - "properties" : {}, - "type" : "object" - } - }, - "parameters" : { - "properties" : { - "max" : { - "description" : "Maximum number of entries.", - "optional" : 1, - "minimum" : 1, - "type" : "integer" - } - }, - "additionalProperties" : 0 - }, - "permissions" : { - "user" : "all" - }, - "description" : "Read cluster log" - } - } - }, - { - "path" : "/cluster/resources", - "info" : { - "GET" : { - "permissions" : { - "user" : "all" - }, - "description" : "Resources index (cluster wide).", - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "type" : "array" - }, - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "type" : { - "enum" : [ - "vm", - "storage", - "node" - ], - "optional" : 1, - "type" : "string" - } - } - }, - "name" : "resources", - "method" : "GET" - } - }, - "text" : "resources", - "leaf" : 1 - }, - { - "text" : "tasks", - "leaf" : 1, - "info" : { - "GET" : { - "parameters" : { - "additionalProperties" : 0 - }, - "returns" : { - "items" : { - "properties" : { - "upid" : { - "type" : "string" + "PUT" : { + "description" : "Update ha group configuration.", + "method" : "PUT", + "name" : "update", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "comment" : { + "description" : "Description.", + "maxLength" : 4096, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", + "maxLength" : 4096, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "digest" : { + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", + "maxLength" : 40, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "group" : { + "description" : "The HA group identifier.", + "format" : "pve-configid", + "type" : "string", + "typetext" : "" + }, + "nodes" : { + "description" : "List of cluster node names with optional priority.", + "format" : "pve-ha-group-node-list", + "optional" : 1, + "type" : "string", + "typetext" : "[:]{,[:]}*", + "verbose_description" : "List of cluster node members, where a priority can be given to each node. A resource bound to a group will run on the available nodes with the highest priority. If there are more nodes in the highest priority class, the services will get distributed to those nodes. The priorities have a relative meaning only." + }, + "nofailback" : { + "default" : 0, + "description" : "The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "restricted" : { + "default" : 0, + "description" : "Resources bound to restricted groups may only run on nodes defined by the group.", + "optional" : 1, + "type" : "boolean", + "typetext" : "", + "verbose_description" : "Resources bound to restricted groups may only run on nodes defined by the group. The resource will be placed in the stopped state if no group node member is online. Resources on unrestricted groups may run on any cluster node if all group members are offline, but they will migrate back as soon as a group member comes online. One can implement a 'preferred node' behavior using an unrestricted group with only one member." + } + }, + "type" : "object" + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Console" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } } }, - "type" : "object" - }, - "type" : "array" - }, - "method" : "GET", - "name" : "tasks", - "permissions" : { - "user" : "all" - }, - "description" : "List recent tasks (cluster wide)." - } - }, - "path" : "/cluster/tasks" - }, - { - "leaf" : 1, - "text" : "options", - "path" : "/cluster/options", - "info" : { - "PUT" : { - "returns" : { - "type" : "null" - }, - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "email_from" : { - "type" : "string", - "format" : "email-opt", - "description" : "Specify email address to send notification from (default is root@$hostname)", - "optional" : 1 - }, - "console" : { - "type" : "string", - "description" : "Select the default Console viewer. You can either use the builtin java applet (VNC), an external virt-viewer comtatible application (SPICE), or an HTML5 based viewer (noVNC).", - "optional" : 1, - "enum" : [ - "applet", - "vv", - "html5" - ] - }, - "keyboard" : { - "enum" : [ - "en-gb", - "de-ch", - "en-us", - "mk", - "fr-be", - "de", - "pt-br", - "sv", - "fr-ch", - "no", - "pt", - "hu", - "sl", - "lt", - "fi", - "it", - "nl", - "is", - "da", - "fr-ca", - "pl", - "fr", - "es", - "ja", - "tr" - ], - "description" : "Default keybord layout for vnc server.", - "optional" : 1, - "type" : "string" - }, - "migration_unsecure" : { - "description" : "Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration.", - "optional" : 1, - "type" : "boolean" - }, - "max_workers" : { - "minimum" : 1, - "type" : "integer", - "optional" : 1, - "description" : "Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager." - }, - "http_proxy" : { - "pattern" : "http://.*", - "description" : "Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')", - "optional" : 1, - "type" : "string" + "leaf" : 1, + "path" : "/cluster/ha/groups/{group}", + "text" : "{group}" + } + ], + "info" : { + "GET" : { + "description" : "Get HA groups.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0 }, - "fencing" : { - "type" : "string", - "default" : "watchdog", - "description" : "Set the fencing mode of the HA cluster. Hardware mode needs a valid configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two modes are used.\n\nWARNING: 'hardware' and 'both' are EXPERIMENTAL & WIP", - "optional" : 1, - "enum" : [ - "watchdog", - "hardware", - "both" + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] ] }, - "language" : { - "optional" : 1, - "description" : "Default GUI language.", - "enum" : [ - "en", - "de" + "returns" : { + "items" : { + "properties" : { + "group" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{group}", + "rel" : "child" + } ], - "type" : "string" - }, - "delete" : { - "description" : "A list of settings you want to delete.", - "optional" : 1, - "type" : "string", - "format" : "pve-configid-list" + "type" : "array" } - } - }, - "method" : "PUT", - "name" : "set_options", - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] + }, + "POST" : { + "description" : "Create a new HA group.", + "method" : "POST", + "name" : "create", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "comment" : { + "description" : "Description.", + "maxLength" : 4096, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "group" : { + "description" : "The HA group identifier.", + "format" : "pve-configid", + "type" : "string", + "typetext" : "" + }, + "nodes" : { + "description" : "List of cluster node names with optional priority.", + "format" : "pve-ha-group-node-list", + "optional" : 0, + "type" : "string", + "typetext" : "[:]{,[:]}*", + "verbose_description" : "List of cluster node members, where a priority can be given to each node. A resource bound to a group will run on the available nodes with the highest priority. If there are more nodes in the highest priority class, the services will get distributed to those nodes. The priorities have a relative meaning only." + }, + "nofailback" : { + "default" : 0, + "description" : "The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "restricted" : { + "default" : 0, + "description" : "Resources bound to restricted groups may only run on nodes defined by the group.", + "optional" : 1, + "type" : "boolean", + "typetext" : "", + "verbose_description" : "Resources bound to restricted groups may only run on nodes defined by the group. The resource will be placed in the stopped state if no group node member is online. Resources on unrestricted groups may run on any cluster node if all group members are offline, but they will migrate back as soon as a group member comes online. One can implement a 'preferred node' behavior using an unrestricted group with only one member." + }, + "type" : { + "description" : "Group type.", + "enum" : [ + "group" + ], + "optional" : 1, + "type" : "string" + } + }, + "type" : "object" + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Console" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + } }, - "description" : "Set datacenter options." + "leaf" : 0, + "path" : "/cluster/ha/groups", + "text" : "groups" }, + { + "children" : [ + { + "info" : { + "GET" : { + "description" : "Get HA manger status.", + "method" : "GET", + "name" : "status", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] + ] + }, + "returns" : { + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/cluster/ha/status/current", + "text" : "current" + }, + { + "info" : { + "GET" : { + "description" : "Get full HA manger status, including LRM status.", + "method" : "GET", + "name" : "manager_status", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] + ] + }, + "returns" : { + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/cluster/ha/status/manager_status", + "text" : "manager_status" + } + ], + "info" : { + "GET" : { + "description" : "Directory 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/ha/status", + "text" : "status" + } + ], + "info" : { "GET" : { + "description" : "Directory index.", "method" : "GET", - "name" : "get_options", + "name" : "index", "parameters" : { "additionalProperties" : 0 }, - "returns" : { - "type" : "object", - "properties" : {} - }, "permissions" : { "check" : [ "perm", @@ -3171,86 +3088,386 @@ var pveapi = [ ] ] }, - "description" : "Get datacenter options." - } - } - }, - { - "leaf" : 1, - "text" : "status", - "info" : { - "GET" : { "returns" : { - "type" : "array", "items" : { - "type" : "object", "properties" : { - "type" : { + "id" : { "type" : "string" } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{id}", + "rel" : "child" } - } - }, - "parameters" : { - "additionalProperties" : 0 - }, - "name" : "get_status", - "method" : "GET", - "protected" : 1, - "description" : "Get cluster status informations.", - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit" - ] - ] + ], + "type" : "array" } } }, - "path" : "/cluster/status" + "leaf" : 0, + "path" : "/cluster/ha", + "text" : "ha" }, { - "path" : "/cluster/nextid", "info" : { "GET" : { - "permissions" : { - "user" : "all" - }, - "description" : "Get next free VMID. If you pass an VMID it will raise an error if the ID is already used.", + "description" : "Read cluster log", + "method" : "GET", + "name" : "log", "parameters" : { "additionalProperties" : 0, "properties" : { - "vmid" : { + "max" : { + "description" : "Maximum number of entries.", "minimum" : 1, - "format" : "pve-vmid", + "optional" : 1, "type" : "integer", - "description" : "The (unique) ID of the VM.", - "optional" : 1 + "typetext" : " (1 - N)" } } }, + "permissions" : { + "user" : "all" + }, "returns" : { - "type" : "integer", - "description" : "The next free VMID." + "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" + } + } }, - "name" : "nextid", - "method" : "GET" + "permissions" : { + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "type" : "array" + } } }, - "text" : "nextid", - "leaf" : 1 - } + "leaf" : 1, + "path" : "/cluster/resources", + "text" : "resources" + }, + { + "info" : { + "GET" : { + "description" : "List recent tasks (cluster wide).", + "method" : "GET", + "name" : "tasks", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : { + "upid" : { + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/cluster/tasks", + "text" : "tasks" + }, + { + "info" : { + "GET" : { + "description" : "Get datacenter options.", + "method" : "GET", + "name" : "get_options", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] + ] + }, + "returns" : { + "properties" : {}, + "type" : "object" + } + }, + "PUT" : { + "description" : "Set datacenter options.", + "method" : "PUT", + "name" : "set_options", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "console" : { + "description" : "Select the default Console viewer. You can either use the builtin java applet (VNC), an external virt-viewer comtatible application (SPICE), or an HTML5 based viewer (noVNC).", + "enum" : [ + "applet", + "vv", + "html5" + ], + "optional" : 1, + "type" : "string" + }, + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "email_from" : { + "description" : "Specify email address to send notification from (default is root@$hostname)", + "format" : "email-opt", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "fencing" : { + "default" : "watchdog", + "description" : "Set the fencing mode of the HA cluster. Hardware mode needs a valid configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two modes are used.\n\nWARNING: 'hardware' and 'both' are EXPERIMENTAL & WIP", + "enum" : [ + "watchdog", + "hardware", + "both" + ], + "optional" : 1, + "type" : "string" + }, + "http_proxy" : { + "description" : "Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')", + "optional" : 1, + "pattern" : "http://.*", + "type" : "string" + }, + "keyboard" : { + "description" : "Default keybord layout for vnc server.", + "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" + }, + "language" : { + "description" : "Default GUI language.", + "enum" : [ + "en", + "de" + ], + "optional" : 1, + "type" : "string" + }, + "mac_prefix" : { + "description" : "Prefix for autogenerated MAC addresses.", + "optional" : 1, + "pattern" : "(?^i:[a-f0-9]{2}(?::[a-f0-9]{2}){0,2}:?)", + "type" : "string" + }, + "max_workers" : { + "description" : "Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, + "migration" : { + "description" : "For cluster wide migration settings.", + "format" : { + "network" : { + "description" : "CIDR of the (sub) network that is used for migration.", + "format" : "CIDR", + "format_description" : "CIDR", + "optional" : 1, + "type" : "string" + }, + "type" : { + "default" : "secure", + "default_key" : 1, + "description" : "Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.", + "enum" : [ + "secure", + "insecure" + ], + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[type=] [,network=]" + }, + "migration_unsecure" : { + "description" : "Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration. Deprecated, use the 'migration' property instead!", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/cluster/options", + "text" : "options" + }, + { + "info" : { + "GET" : { + "description" : "Get cluster status informations.", + "method" : "GET", + "name" : "get_status", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] + ] + }, + "protected" : 1, + "returns" : { + "items" : { + "properties" : { + "type" : { + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/cluster/status", + "text" : "status" + }, + { + "info" : { + "GET" : { + "description" : "Get next free VMID. If you pass an VMID it will raise an error if the ID is already used.", + "method" : "GET", + "name" : "nextid", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "user" : "all" + }, + "returns" : { + "description" : "The next free VMID.", + "type" : "integer" + } + } + }, + "leaf" : 1, + "path" : "/cluster/nextid", + "text" : "nextid" + } ], - "path" : "/cluster", "info" : { "GET" : { + "description" : "Cluster index.", + "method" : "GET", + "name" : "index", "parameters" : { "additionalProperties" : 0 }, + "permissions" : { + "user" : "all" + }, "returns" : { - "type" : "array", "items" : { "properties" : {}, "type" : "object" @@ -3260,159 +3477,64 @@ var pveapi = [ "href" : "{name}", "rel" : "child" } - ] - }, - "method" : "GET", - "name" : "index", - "description" : "Cluster index.", - "permissions" : { - "user" : "all" - } + ], + "type" : "array" + } } - } + }, + "leaf" : 0, + "path" : "/cluster", + "text" : "cluster" }, { - "leaf" : 0, - "text" : "nodes", - "path" : "/nodes", "children" : [ { - "leaf" : 0, - "text" : "{node}", - "path" : "/nodes/{node}", "children" : [ { - "text" : "qemu", - "leaf" : 0, - "path" : "/nodes/{node}/qemu", "children" : [ { - "path" : "/nodes/{node}/qemu/{vmid}", - "info" : { - "DELETE" : { - "description" : "Destroy the vm (also delete all used/owned volumes).", - "returns" : { - "type" : "string" - }, - "method" : "DELETE", - "name" : "destroy_vm", - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Allocate" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", - "parameters" : { - "properties" : { - "vmid" : { - "format" : "pve-vmid", - "type" : "integer", - "minimum" : 1, - "description" : "The (unique) ID of the VM." - }, - "skiplock" : { - "type" : "boolean", - "optional" : 1, - "description" : "Ignore locks - only root is allowed to use this option." - }, - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - } - }, - "additionalProperties" : 0 - } - }, - "GET" : { - "method" : "GET", - "name" : "vmdiridx", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "vmid" : { - "description" : "The (unique) ID of the VM.", - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1 - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" - } - } - }, - "proxyto" : "node", - "returns" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "subdir" : { - "type" : "string" - } - } - }, - "links" : [ - { - "href" : "{subdir}", - "rel" : "child" - } - ] - }, - "permissions" : { - "user" : "all" - }, - "description" : "Directory index" - } - }, "children" : [ { - "text" : "firewall", - "leaf" : 0, "children" : [ { "children" : [ { - "text" : "{pos}", - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/firewall/rules/{pos}", "info" : { "DELETE" : { - "proxyto" : null, + "description" : "Delete rule.", + "method" : "DELETE", + "name" : "delete_rule", "parameters" : { + "additionalProperties" : 0, "properties" : { - "vmid" : { - "minimum" : 1, - "format" : "pve-vmid", - "type" : "integer", - "description" : "The (unique) ID of the VM." + "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", - "format" : "pve-node" + "typetext" : "" }, "pos" : { "description" : "Update rule at position .", - "optional" : 1, "minimum" : 0, - "type" : "integer" - }, - "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" : "integer", + "typetext" : " (0 - N)" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, "permissions" : { "check" : [ @@ -3424,15 +3546,40 @@ var pveapi = [ ] }, "protected" : 1, + "proxyto" : null, "returns" : { "type" : "null" - }, - "name" : "delete_rule", - "method" : "DELETE", - "description" : "Delete rule." + } }, "GET" : { "description" : "Get single rule data.", + "method" : "GET", + "name" : "get_rule", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "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", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, "permissions" : { "check" : [ "perm", @@ -3442,158 +3589,148 @@ var pveapi = [ ] ] }, - "method" : "GET", - "name" : "get_rule", + "proxyto" : null, "returns" : { - "type" : "object", "properties" : { "pos" : { "type" : "integer" } - } - }, - "proxyto" : null, - "parameters" : { - "properties" : { - "vmid" : { - "minimum" : 1, - "format" : "pve-vmid", - "type" : "integer", - "description" : "The (unique) ID of the VM." - }, - "pos" : { - "type" : "integer", - "minimum" : 0, - "optional" : 1, - "description" : "Update rule at position ." - }, - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." - } }, - "additionalProperties" : 0 + "type" : "object" } }, "PUT" : { - "returns" : { - "type" : "null" - }, + "description" : "Modify rule data.", "method" : "PUT", "name" : "update_rule", - "description" : "Modify rule data.", "parameters" : { "additionalProperties" : 0, "properties" : { - "digest" : { - "type" : "string", - "optional" : 1, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "maxLength" : 40 - }, - "iface" : { + "action" : { + "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", + "maxLength" : 20, "minLength" : 2, - "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.", "optional" : 1, - "maxLength" : 20, - "type" : "string", - "format" : "pve-iface" + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" }, - "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.", + "comment" : { + "description" : "Descriptive comment.", "optional" : 1, "type" : "string", - "format" : "pve-fw-addr-spec" - }, - "pos" : { - "minimum" : 0, - "type" : "integer", - "optional" : 1, - "description" : "Update rule at position ." + "typetext" : "" }, - "action" : { - "type" : "string", + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", "optional" : 1, - "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", - "maxLength" : 20, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2 - }, - "comment" : { "type" : "string", - "optional" : 1 + "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.", - "optional" : 1, "format" : "pve-fw-addr-spec", - "type" : "string" - }, - "type" : { "optional" : 1, - "enum" : [ - "in", - "out", - "group" - ], - "type" : "string" + "type" : "string", + "typetext" : "" }, - "proto" : { + "digest" : { + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", + "maxLength" : 40, "optional" : 1, - "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.", - "format" : "pve-fw-protocol-spec", - "type" : "string" + "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.", - "optional" : 1, "format" : "pve-fw-dport-spec", - "type" : "string" + "optional" : 1, + "type" : "string", + "typetext" : "" }, "enable" : { - "type" : "integer", + "description" : "Flag to enable/disable a rule.", "minimum" : 0, - "optional" : 1 - }, - "moveto" : { - "minimum" : 0, - "type" : "integer", "optional" : 1, - "description" : "Move rule to new position . Other arguments are ignored." + "type" : "integer", + "typetext" : " (0 - N)" }, - "delete" : { - "format" : "pve-configid-list", - "type" : "string", + "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, - "description" : "A list of settings you want to delete." + "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.", + "macro" : { + "description" : "Use predefined standard macro.", + "maxLength" : 128, "optional" : 1, "type" : "string", - "format" : "pve-fw-sport-spec" + "typetext" : "" }, - "node" : { - "description" : "The cluster node name.", + "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" : "" + }, + "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" : 1, "type" : "string" }, "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", "minimum" : 1, "type" : "integer", - "format" : "pve-vmid", - "description" : "The (unique) ID of the VM." - }, - "macro" : { - "type" : "string", - "maxLength" : 128, - "optional" : 1 + "typetext" : " (1 - N)" } } }, - "proxyto" : null, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -3602,161 +3739,188 @@ var pveapi = [ "VM.Config.Network" ] ] + }, + "protected" : 1, + "proxyto" : null, + "returns" : { + "type" : "null" } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/firewall/rules/{pos}", + "text" : "{pos}" } ], - "path" : "/nodes/{node}/qemu/{vmid}/firewall/rules", "info" : { "GET" : { + "description" : "List rules.", "method" : "GET", "name" : "get_rules", - "proxyto" : null, "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { + "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", - "description" : "The cluster node name." + "typetext" : "" }, "vmid" : { - "minimum" : 1, + "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", + "minimum" : 1, "type" : "integer", - "description" : "The (unique) ID of the VM." + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] }, + "proxyto" : null, "returns" : { "items" : { - "type" : "object", "properties" : { "pos" : { "type" : "integer" } - } + }, + "type" : "object" }, - "type" : "array", "links" : [ { - "rel" : "child", - "href" : "{pos}" + "href" : "{pos}", + "rel" : "child" } - ] - }, - "description" : "List rules.", - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] + ], + "type" : "array" } }, "POST" : { + "description" : "Create new rule.", + "method" : "POST", + "name" : "create_rule", "parameters" : { "additionalProperties" : 0, "properties" : { - "comment" : { - "type" : "string", - "optional" : 1 - }, "action" : { - "maxLength" : 20, "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", + "maxLength" : 20, + "minLength" : 2, "optional" : 0, "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, "type" : "string" }, - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." - }, - "pos" : { - "type" : "integer", - "minimum" : 0, + "comment" : { + "description" : "Descriptive comment.", "optional" : 1, - "description" : "Update rule at position ." + "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", - "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.", - "optional" : 1 + "typetext" : "" }, - "type" : { - "enum" : [ - "in", - "out", - "group" - ], - "optional" : 0, - "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", + "typetext" : "" }, - "macro" : { + "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, - "maxLength" : 128, - "type" : "string" + "type" : "string", + "typetext" : "" }, - "vmid" : { - "minimum" : 1, + "enable" : { + "description" : "Flag to enable/disable a rule.", + "minimum" : 0, + "optional" : 1, "type" : "integer", - "format" : "pve-vmid", - "description" : "The (unique) ID of the VM." + "typetext" : " (0 - N)" }, - "proto" : { - "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.", + "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", - "format" : "pve-fw-protocol-spec" + "typetext" : "" }, - "iface" : { - "minLength" : 2, - "maxLength" : 20, - "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.", + "macro" : { + "description" : "Use predefined standard macro.", + "maxLength" : 128, "optional" : 1, "type" : "string", - "format" : "pve-iface" + "typetext" : "" }, - "digest" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "maxLength" : 40, - "optional" : 1 + "typetext" : "" }, - "enable" : { + "pos" : { + "description" : "Update rule at position .", "minimum" : 0, + "optional" : 1, "type" : "integer", - "optional" : 1 + "typetext" : " (0 - N)" }, - "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.", + "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, - "format" : "pve-fw-dport-spec", - "type" : "string" + "type" : "string", + "typetext" : "" }, "source" : { - "type" : "string", + "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, - "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." + "type" : "string", + "typetext" : "" }, "sport" : { - "optional" : 1, "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)" } } }, - "proxyto" : null, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -3766,355 +3930,358 @@ var pveapi = [ ] ] }, - "name" : "create_rule", - "method" : "POST", + "protected" : 1, + "proxyto" : null, "returns" : { "type" : "null" - }, - "description" : "Create new rule." + } } }, "leaf" : 0, + "path" : "/nodes/{node}/qemu/{vmid}/firewall/rules", "text" : "rules" }, { "children" : [ { - "path" : "/nodes/{node}/qemu/{vmid}/firewall/aliases/{name}", "info" : { "DELETE" : { - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Network" - ] - ] - }, "description" : "Remove IP or Network alias.", - "protected" : 1, + "method" : "DELETE", + "name" : "remove_alias", "parameters" : { "additionalProperties" : 0, "properties" : { - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." - }, "digest" : { - "maxLength" : 40, "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" : "string", + "typetext" : "" }, "name" : { - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "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", - "minimum" : 1 + "typetext" : " (1 - N)" } } }, - "returns" : { - "type" : "null" - }, - "method" : "DELETE", - "name" : "remove_alias" - }, - "GET" : { - "description" : "Read alias.", "permissions" : { "check" : [ "perm", "/vms/{vmid}", [ - "VM.Audit" + "VM.Config.Network" ] ] }, + "protected" : 1, + "returns" : { + "type" : "null" + } + }, + "GET" : { + "description" : "Read alias.", + "method" : "GET", + "name" : "read_alias", "parameters" : { + "additionalProperties" : 0, "properties" : { - "node" : { - "description" : "The cluster node name.", + "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", - "format" : "pve-node" + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", "minimum" : 1, "type" : "integer", - "format" : "pve-vmid" - }, - "name" : { - "maxLength" : 64, - "description" : "Alias name.", - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, - "type" : "string" + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 - }, - "returns" : { - "type" : "object" + } }, - "name" : "read_alias", - "method" : "GET" - }, - "PUT" : { - "protected" : 1, "permissions" : { "check" : [ "perm", "/vms/{vmid}", [ - "VM.Config.Network" + "VM.Audit" ] ] }, - "description" : "Update IP or Network alias.", "returns" : { - "type" : "null" - }, + "type" : "object" + } + }, + "PUT" : { + "description" : "Update IP or Network alias.", + "method" : "PUT", + "name" : "update_alias", "parameters" : { "additionalProperties" : 0, "properties" : { - "vmid" : { - "minimum" : 1, - "format" : "pve-vmid", - "type" : "integer", - "description" : "The (unique) ID of the VM." - }, - "name" : { + "cidr" : { + "description" : "Network/IP specification in CIDR format.", + "format" : "IPorCIDR", "type" : "string", - "maxLength" : 64, - "description" : "Alias name.", - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2 + "typetext" : "" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" + "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" - }, - "comment" : { "type" : "string", - "optional" : 1 + "typetext" : "" }, - "cidr" : { - "description" : "Network/IP specification in CIDR format.", + "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", - "format" : "IPorCIDR" + "typetext" : "" }, "rename" : { "description" : "Rename an existing alias.", - "optional" : 1, "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)" } } }, - "name" : "update_alias", - "method" : "PUT" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Config.Network" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } } }, "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/firewall/aliases/{name}", "text" : "{name}" } ], "info" : { - "POST" : { - "returns" : { - "type" : "null" - }, + "GET" : { + "description" : "List aliases", + "method" : "GET", + "name" : "get_aliases", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." - }, - "comment" : { - "optional" : 1, - "type" : "string" - }, - "cidr" : { "type" : "string", - "format" : "IPorCIDR", - "description" : "Network/IP specification in CIDR format." + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", - "minimum" : 1, "format" : "pve-vmid", - "type" : "integer" - }, - "name" : { - "maxLength" : 64, - "description" : "Alias name.", - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, - "type" : "string" + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "name" : "create_alias", - "method" : "POST", - "protected" : 1, "permissions" : { "check" : [ "perm", "/vms/{vmid}", [ - "VM.Config.Network" + "VM.Audit" ] ] }, - "description" : "Create IP or Network Alias." - }, - "GET" : { - "name" : "get_aliases", - "method" : "GET", "returns" : { "items" : { "properties" : { - "name" : { + "cidr" : { "type" : "string" }, "comment" : { - "type" : "string", - "optional" : 1 + "optional" : 1, + "type" : "string" }, "digest" : { - "maxLength" : 40, "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" }, - "cidr" : { + "name" : { "type" : "string" } }, "type" : "object" }, - "type" : "array", "links" : [ { "href" : "{name}", "rel" : "child" } - ] - }, + ], + "type" : "array" + } + }, + "POST" : { + "description" : "Create IP or Network Alias.", + "method" : "POST", + "name" : "create_alias", "parameters" : { + "additionalProperties" : 0, "properties" : { - "vmid" : { - "description" : "The (unique) ID of the VM.", - "minimum" : 1, - "format" : "pve-vmid", - "type" : "integer" + "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" + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "description" : "List aliases", "permissions" : { "check" : [ "perm", "/vms/{vmid}", [ - "VM.Audit" + "VM.Config.Network" ] ] + }, + "protected" : 1, + "returns" : { + "type" : "null" } } }, - "path" : "/nodes/{node}/qemu/{vmid}/firewall/aliases", "leaf" : 0, + "path" : "/nodes/{node}/qemu/{vmid}/firewall/aliases", "text" : "aliases" }, { - "path" : "/nodes/{node}/qemu/{vmid}/firewall/ipset", "children" : [ { - "leaf" : 0, - "text" : "{name}", - "path" : "/nodes/{node}/qemu/{vmid}/firewall/ipset/{name}", "children" : [ { - "text" : "{cidr}", - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/firewall/ipset/{name}/{cidr}", "info" : { - "PUT" : { - "name" : "update_ip", - "method" : "PUT", + "DELETE" : { + "description" : "Remove IP or Network from IPSet.", + "method" : "DELETE", + "name" : "remove_ip", "parameters" : { "additionalProperties" : 0, "properties" : { - "name" : { - "maxLength" : 64, - "description" : "IP set name.", - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "type" : "string" - }, - "vmid" : { - "format" : "pve-vmid", - "type" : "integer", - "minimum" : 1, - "description" : "The (unique) ID of the VM." - }, "cidr" : { + "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDRorAlias", "type" : "string", - "description" : "Network/IP specification in CIDR format." + "typetext" : "" }, - "comment" : { + "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" : "string", + "typetext" : "" }, - "nomatch" : { - "optional" : 1, - "type" : "boolean" + "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" + "type" : "string", + "typetext" : "" }, - "digest" : { - "optional" : 1, - "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "type" : "string" + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } } }, - "returns" : { - "type" : "null" - }, "permissions" : { "check" : [ "perm", @@ -4124,45 +4291,46 @@ var pveapi = [ ] ] }, - "description" : "Update IP or Network settings", - "protected" : 1 + "protected" : 1, + "returns" : { + "type" : "null" + } }, "GET" : { - "name" : "read_ip", + "description" : "Read IP or Network settings from IPSet.", "method" : "GET", - "returns" : { - "type" : "object" - }, + "name" : "read_ip", "parameters" : { + "additionalProperties" : 0, "properties" : { - "vmid" : { - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid", - "description" : "The (unique) ID of the VM." + "cidr" : { + "description" : "Network/IP specification in CIDR format.", + "format" : "IPorCIDRorAlias", + "type" : "string", + "typetext" : "" }, "name" : { - "maxLength" : 64, "description" : "IP set name.", - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "maxLength" : 64, "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" }, "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" }, - "cidr" : { - "description" : "Network/IP specification in CIDR format.", - "format" : "IPorCIDRorAlias", - "type" : "string" + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "protected" : 1, - "description" : "Read IP or Network settings from IPSet.", "permissions" : { "check" : [ "perm", @@ -4171,50 +4339,64 @@ var pveapi = [ "VM.Audit" ] ] + }, + "protected" : 1, + "returns" : { + "type" : "object" } }, - "DELETE" : { - "returns" : { - "type" : "null" - }, + "PUT" : { + "description" : "Update IP or Network settings", + "method" : "PUT", + "name" : "update_ip", "parameters" : { + "additionalProperties" : 0, "properties" : { - "vmid" : { - "format" : "pve-vmid", - "type" : "integer", - "minimum" : 1, - "description" : "The (unique) ID of the VM." + "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\\-\\_]+", - "maxLength" : 64, - "description" : "IP set name.", "type" : "string" }, "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" + "typetext" : "" }, - "digest" : { + "nomatch" : { "optional" : 1, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "maxLength" : 40, - "type" : "string" + "type" : "boolean", + "typetext" : "" }, - "cidr" : { - "description" : "Network/IP specification in CIDR format.", - "format" : "IPorCIDRorAlias", - "type" : "string" + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "method" : "DELETE", - "name" : "remove_ip", - "protected" : 1, - "description" : "Remove IP or Network from IPSet.", "permissions" : { "check" : [ "perm", @@ -4223,68 +4405,48 @@ var pveapi = [ "VM.Config.Network" ] ] + }, + "protected" : 1, + "returns" : { + "type" : "null" } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/firewall/ipset/{name}/{cidr}", + "text" : "{cidr}" } ], "info" : { - "POST" : { - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Network" - ] - ] - }, - "description" : "Add IP or Network to IPSet.", - "protected" : 1, - "name" : "create_ip", - "method" : "POST", + "DELETE" : { + "description" : "Delete IPSet", + "method" : "DELETE", + "name" : "delete_ipset", "parameters" : { + "additionalProperties" : 0, "properties" : { - "cidr" : { - "description" : "Network/IP specification in CIDR format.", - "type" : "string", - "format" : "IPorCIDRorAlias" + "name" : { + "description" : "IP set name.", + "maxLength" : 64, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" }, "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." - }, - "nomatch" : { - "optional" : 1, - "type" : "boolean" - }, - "comment" : { - "optional" : 1, - "type" : "string" - }, - "name" : { "type" : "string", - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "maxLength" : 64, - "description" : "IP set name." + "typetext" : "" }, "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", "minimum" : 1, "type" : "integer", - "format" : "pve-vmid", - "description" : "The (unique) ID of the VM." + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "returns" : { - "type" : "null" - } - }, - "DELETE" : { - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -4294,1522 +4456,2564 @@ var pveapi = [ ] ] }, - "description" : "Delete IPSet", - "method" : "DELETE", - "name" : "delete_ipset", + "protected" : 1, "returns" : { "type" : "null" - }, + } + }, + "GET" : { + "description" : "List IPSet content", + "method" : "GET", + "name" : "get_ipset", "parameters" : { + "additionalProperties" : 0, "properties" : { - "vmid" : { - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1, - "description" : "The (unique) ID of the VM." - }, "name" : { - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "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", - "description" : "The cluster node name." + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 - } - }, - "GET" : { + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, "returns" : { - "links" : [ - { - "href" : "{cidr}", - "rel" : "child" - } - ], "items" : { "properties" : { + "cidr" : { + "type" : "string" + }, "comment" : { "optional" : 1, "type" : "string" }, - "nomatch" : { - "type" : "boolean", - "optional" : 1 - }, "digest" : { - "maxLength" : 40, "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" }, - "cidr" : { - "type" : "string" + "nomatch" : { + "optional" : 1, + "type" : "boolean" } }, "type" : "object" }, + "links" : [ + { + "href" : "{cidr}", + "rel" : "child" + } + ], "type" : "array" - }, + } + }, + "POST" : { + "description" : "Add IP or Network to IPSet.", + "method" : "POST", + "name" : "create_ip", "parameters" : { "additionalProperties" : 0, "properties" : { - "node" : { + "cidr" : { + "description" : "Network/IP specification in CIDR format.", + "format" : "IPorCIDRorAlias", "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." + "typetext" : "" + }, + "comment" : { + "optional" : 1, + "type" : "string", + "typetext" : "" }, "name" : { - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "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", - "minimum" : 1 + "typetext" : " (1 - N)" } } }, - "method" : "GET", - "name" : "get_ipset", "permissions" : { "check" : [ "perm", "/vms/{vmid}", [ - "VM.Audit" + "VM.Config.Network" ] ] }, - "description" : "List IPSet content" + "protected" : 1, + "returns" : { + "type" : "null" + } } - } - } - ], + }, + "leaf" : 0, + "path" : "/nodes/{node}/qemu/{vmid}/firewall/ipset/{name}", + "text" : "{name}" + } + ], "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)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "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" : { - "name" : "create_ipset", + "description" : "Create new IPSet", "method" : "POST", - "returns" : { - "type" : "null" - }, + "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\\-\\_]+", - "description" : "IP set name.", - "maxLength" : 64 + "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}/qemu/{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", - "format" : "pve-vmid" + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "proxyto" : "node", + "returns" : { + "properties" : { + "dhcp" : { + "description" : "Enable DHCP.", + "optional" : 1, + "type" : "boolean" }, - "rename" : { - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "maxLength" : 64, - "description" : "Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet.", + "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" }, - "digest" : { - "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" : "" + }, + "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.Network" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{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)" + }, + "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, + "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" + } + }, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{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" : "" + }, + "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}/qemu/{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}/qemu/{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}/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" : "" + }, + "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" : "boolean", + "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.Audit" + ] + ] + }, + "proxyto" : "node", + "returns" : { + "properties" : { + "digest" : { + "description" : "SHA1 digest of configuration file. This can be used to prevent concurrent modifications.", + "type" : "string" + } + }, + "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 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" : "" + }, + "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)" + }, + "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)" + }, + "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" : "" + }, + "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" : { + "cputype" : { + "default" : "kvm64", + "default_key" : 1, + "description" : "Emulated CPU type.", + "enum" : [ + "486", + "athlon", + "Broadwell", + "Broadwell-noTSX", + "Conroe", + "core2duo", + "coreduo", + "Haswell", + "Haswell-noTSX", + "host", + "IvyBridge", + "kvm32", + "kvm64", + "Nehalem", + "Opteron_G1", + "Opteron_G2", + "Opteron_G3", + "Opteron_G4", + "Opteron_G5", + "Penryn", + "pentium", + "pentium2", + "pentium3", + "phenom", + "qemu32", + "qemu64", + "SandyBridge", + "Westmere" + ], + "type" : "string" + }, + "hidden" : { + "default" : 0, + "description" : "Do not identify as a KVM virtual machine.", "optional" : 1, - "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" - }, - "comment" : { - "type" : "string", - "optional" : 1 + "type" : "boolean" } }, - "additionalProperties" : 0 + "optional" : 1, + "type" : "string", + "typetext" : "[cputype=] [,hidden=<1|0>]" }, - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Network" - ] - ] + "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." }, - "description" : "Create new IPSet" - }, - "GET" : { - "method" : "GET", - "name" : "ipset_index", - "returns" : { - "links" : [ - { - "href" : "{name}", - "rel" : "child" - } + "cpuunits" : { + "default" : 1024, + "description" : "CPU weight for a VM.", + "maximum" : 500000, + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - 500000)", + "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.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0." + }, + "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).", + "optional" : 1, + "type" : "boolean", + "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>] [,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" ], - "items" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, - "description" : "IP set name.", - "maxLength" : 64 - }, - "digest" : { - "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "optional" : 0, - "type" : "string" - }, - "comment" : { - "type" : "string", - "optional" : 1 - } - } - }, - "type" : "array" + "optional" : 1, + "type" : "string" }, - "parameters" : { - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "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" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", + "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, - "format" : "pve-vmid", + "optional" : 1, "type" : "integer" - } - }, - "additionalProperties" : 0 - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "description" : "List IPSets" - } - }, - "leaf" : 0, - "text" : "ipset" - }, - { - "path" : "/nodes/{node}/qemu/{vmid}/firewall/options", - "info" : { - "GET" : { - "description" : "Get VM firewall options.", - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "proxyto" : "node", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "vmid" : { - "description" : "The (unique) ID of the VM.", + }, + "bps_rd" : { + "description" : "Maximum read speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", "minimum" : 1, - "format" : "pve-vmid", + "optional" : 1, "type" : "integer" }, - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - } - } - }, - "returns" : { - "properties" : { - "radv" : { - "description" : "Allow sending Router Advertisement.", + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "type" : "boolean" + "type" : "integer" }, - "log_level_out" : { - "description" : "Log level for outgoing traffic.", + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, + "type" : "integer" + }, + "cache" : { + "description" : "The drive's cache mode", "enum" : [ - "emerg", - "alert", - "crit", - "err", - "warning", - "notice", - "info", - "debug", - "nolog" + "none", + "writethrough", + "writeback", + "unsafe", + "directsync" ], + "optional" : 1, "type" : "string" }, - "log_level_in" : { + "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" : [ - "emerg", - "alert", - "crit", - "err", - "warning", - "notice", - "info", - "debug", - "nolog" + "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" ], - "description" : "Log level for incoming traffic.", "optional" : 1, "type" : "string" }, - "enable" : { - "type" : "boolean", + "heads" : { + "description" : "Force the drive's physical geometry to have a specific head count.", "optional" : 1, - "description" : "Enable/disable firewall rules." + "type" : "integer" }, - "dhcp" : { - "type" : "boolean", + "iops" : { + "description" : "Maximum r/w I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "description" : "Enable DHCP." + "type" : "integer" }, - "ndp" : { - "type" : "boolean", + "iops_max" : { + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", + "format_description" : "iops", "optional" : 1, - "description" : "Enable NDP." + "type" : "integer" }, - "ipfilter" : { - "type" : "boolean", + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "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." + "type" : "integer" }, - "macfilter" : { + "iops_rd" : { + "description" : "Maximum read I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "description" : "Enable/disable MAC address filter.", - "type" : "boolean" + "type" : "integer" }, - "policy_in" : { - "type" : "string", + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "Input policy.", - "enum" : [ - "ACCEPT", - "REJECT", - "DROP" - ] + "type" : "integer" }, - "policy_out" : { - "type" : "string", - "description" : "Output policy.", + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", + "format_description" : "iops", "optional" : 1, - "enum" : [ - "ACCEPT", - "REJECT", - "DROP" - ] - } - }, - "type" : "object" - }, - "method" : "GET", - "name" : "get_options" - }, - "PUT" : { - "method" : "PUT", - "name" : "set_options", - "returns" : { - "type" : "null" - }, - "description" : "Set Firewall options.", - "proxyto" : "node", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "log_level_out" : { - "type" : "string", - "description" : "Log level for outgoing traffic.", + "type" : "integer" + }, + "iops_wr" : { + "description" : "Maximum write I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "enum" : [ - "emerg", - "alert", - "crit", - "err", - "warning", - "notice", - "info", - "debug", - "nolog" - ] + "type" : "integer" }, - "delete" : { - "format" : "pve-configid-list", - "type" : "string", + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "A list of settings you want to delete." + "type" : "integer" }, - "radv" : { - "type" : "boolean", - "description" : "Allow sending Router Advertisement.", - "optional" : 1 + "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" }, - "log_level_in" : { - "type" : "string", - "enum" : [ - "emerg", - "alert", - "crit", - "err", - "warning", - "notice", - "info", - "debug", - "nolog" - ], - "description" : "Log level for incoming traffic.", - "optional" : 1 + "mbps" : { + "description" : "Maximum r/w speed in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" }, - "enable" : { - "type" : "boolean", + "mbps_max" : { + "description" : "Maximum unthrottled r/w pool in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Enable/disable firewall rules." + "type" : "number" }, - "digest" : { + "mbps_rd" : { + "description" : "Maximum read speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "type" : "string" + "type" : "number" }, - "macfilter" : { - "type" : "boolean", - "description" : "Enable/disable MAC address filter.", - "optional" : 1 + "mbps_rd_max" : { + "description" : "Maximum unthrottled read pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" }, - "policy_in" : { - "type" : "string", - "description" : "Input policy.", + "mbps_wr" : { + "description" : "Maximum write speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "enum" : [ - "ACCEPT", - "REJECT", - "DROP" - ] + "type" : "number" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "type" : "integer", - "minimum" : 1 + "mbps_wr_max" : { + "description" : "Maximum unthrottled write pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" }, - "dhcp" : { - "type" : "boolean", + "media" : { + "default" : "disk", + "description" : "The drive's media type.", + "enum" : [ + "cdrom", + "disk" + ], "optional" : 1, - "description" : "Enable DHCP." + "type" : "string" }, - "ndp" : { + "model" : { + "description" : "The drive's reported model name, url-encoded, up to 40 bytes long.", + "format" : "urlencoded", + "format_description" : "model", + "maxLength" : 120, "optional" : 1, - "description" : "Enable NDP.", - "type" : "boolean" + "type" : "string" }, - "ipfilter" : { + "rerror" : { + "description" : "Read error action.", + "enum" : [ + "ignore", + "report", + "stop" + ], "optional" : 1, - "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.", - "type" : "boolean" + "type" : "string" }, - "node" : { - "description" : "The cluster node name.", - "type" : "string", - "format" : "pve-node" + "secs" : { + "description" : "Force the drive's physical geometry to have a specific sector count.", + "optional" : 1, + "type" : "integer" }, - "policy_out" : { + "serial" : { + "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", + "format" : "urlencoded", + "format_description" : "serial", + "maxLength" : 60, "optional" : 1, - "description" : "Output policy.", - "enum" : [ - "ACCEPT", - "REJECT", - "DROP" - ], "type" : "string" - } - } - }, - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Network" - ] - ] - } - } - }, - "text" : "options", - "leaf" : 1 - }, - { - "leaf" : 1, - "text" : "log", - "info" : { - "GET" : { - "returns" : { - "type" : "array", - "items" : { - "properties" : { - "n" : { - "description" : "Line number", - "type" : "integer" - }, - "t" : { - "type" : "string", - "description" : "Line text" - } }, - "type" : "object" - } - }, - "method" : "GET", - "name" : "log", - "description" : "Read firewall log", - "proxyto" : "node", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "type" : "integer", - "minimum" : 1 + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", + "optional" : 1, + "type" : "string" }, - "start" : { + "snapshot" : { + "description" : "Whether the drive should be included when making snapshots.", "optional" : 1, - "minimum" : 0, - "type" : "integer" + "type" : "boolean" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "trans" : { + "description" : "Force disk geometry bios translation mode.", + "enum" : [ + "none", + "lba", + "auto" + ], + "optional" : 1, "type" : "string" }, - "limit" : { - "type" : "integer", - "minimum" : 0, - "optional" : 1 - } - } - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Console" - ] - ] - }, - "protected" : 1 - } - }, - "path" : "/nodes/{node}/qemu/{vmid}/firewall/log" - }, - { - "info" : { - "GET" : { - "parameters" : { - "properties" : { - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." + "volume" : { + "alias" : "file" }, - "type" : { - "type" : "string", - "optional" : 1, - "description" : "Only list references of specified type.", + "werror" : { + "description" : "Write error action.", "enum" : [ - "alias", - "ipset" - ] - }, - "vmid" : { - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid", - "description" : "The (unique) ID of the VM." + "enospc", + "ignore", + "report", + "stop" + ], + "optional" : 1, + "type" : "string" } }, - "additionalProperties" : 0 + "optional" : 1, + "type" : "string", + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, - "returns" : { - "type" : "array", - "items" : { - "properties" : { - "comment" : { - "optional" : 1, - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "type" : { - "type" : "string", - "enum" : [ - "alias", - "ipset" - ] - } - }, - "type" : "object" - } + "keyboard" : { + "default" : "en-us", + "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.", + "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" }, - "name" : "refs", - "method" : "GET", - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] + "kvm" : { + "default" : 1, + "description" : "Enable/disable KVM hardware virtualization.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, - "description" : "Lists possible IPSet/Alias reference which are allowed in source/dest properties." - } - }, - "path" : "/nodes/{node}/qemu/{vmid}/firewall/refs", - "leaf" : 1, - "text" : "refs" - } - ], - "path" : "/nodes/{node}/qemu/{vmid}/firewall", - "info" : { - "GET" : { - "method" : "GET", - "name" : "index", - "returns" : { - "links" : [ - { - "href" : "{name}", - "rel" : "child" - } - ], - "items" : { - "type" : "object", - "properties" : {} - }, - "type" : "array" - }, - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "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" : [ + "migrate", + "backup", + "snapshot", + "rollback" + ], + "optional" : 1, "type" : "string" }, - "vmid" : { + "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" + }, + "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", - "format" : "pve-vmid", - "minimum" : 1, - "description" : "The (unique) ID of the VM." - } - } - }, - "description" : "Directory index.", - "permissions" : { - "user" : "all" - } - } - } - }, - { - "text" : "rrd", - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/rrd", - "info" : { - "GET" : { - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "ds" : { - "format" : "pve-configid-list", + "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" : "" + }, + "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" + } + }, + "optional" : 1, "type" : "string", - "description" : "The list of datasources you want to display." + "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", - "description" : "The cluster node name." - }, - "timeframe" : { - "type" : "string", - "enum" : [ - "hour", - "day", - "week", - "month", - "year" - ], - "description" : "Specify the time frame you are interested in." + "typetext" : "" }, - "cf" : { - "enum" : [ - "AVERAGE", - "MAX" - ], - "description" : "The RRD consolidation function", + "numa" : { + "default" : 0, + "description" : "Enable/disable NUMA.", "optional" : 1, - "type" : "string" + "type" : "boolean", + "typetext" : "" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid" - } - } - }, - "returns" : { - "type" : "object", - "properties" : { - "filename" : { - "type" : "string" - } - } - }, - "method" : "GET", - "name" : "rrd", - "description" : "Read VM RRD statistics (returns PNG)", - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "protected" : 1 - } - } - }, - { - "info" : { - "GET" : { - "name" : "rrddata", - "method" : "GET", - "returns" : { - "items" : { - "type" : "object", - "properties" : {} - }, - "type" : "array" - }, - "parameters" : { - "properties" : { - "node" : { - "format" : "pve-node", + "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", - "description" : "The cluster node name." + "typetext" : "cpus= [,hostnodes=] [,memory=] [,policy=]" }, - "timeframe" : { - "type" : "string", - "description" : "Specify the time frame you are interested in.", - "enum" : [ - "hour", - "day", - "week", - "month", - "year" - ] + "onboot" : { + "default" : 0, + "description" : "Specifies whether a VM will be started during system bootup.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, - "cf" : { - "type" : "string", + "ostype" : { + "description" : "Specify guest operating system.", "enum" : [ - "AVERAGE", - "MAX" + "other", + "wxp", + "w2k", + "w2k3", + "w2k8", + "wvista", + "win7", + "win8", + "l24", + "l26", + "solaris" ], "optional" : 1, - "description" : "The RRD consolidation function" - }, - "vmid" : { - "minimum" : 1, - "format" : "pve-vmid", - "type" : "integer", - "description" : "The (unique) ID of the VM." - } - }, - "additionalProperties" : 0 - }, - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "description" : "Read VM RRD statistics" - } - }, - "path" : "/nodes/{node}/qemu/{vmid}/rrddata", - "leaf" : 1, - "text" : "rrddata" - }, - { - "path" : "/nodes/{node}/qemu/{vmid}/config", - "info" : { - "PUT" : { - "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", - "parameters" : { - "properties" : { - "lock" : { "type" : "string", - "description" : "Lock/unlock the VM.", + "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\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, - "enum" : [ - "migrate", - "backup", - "snapshot", - "rollback" - ] + "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" }, - "numa" : { + "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", - "description" : "Enable/disable NUMA.", - "optional" : 1 + "typetext" : "" }, - "virtio[n]" : { - "description" : "Use volume as VIRTIO hard disk (n is 0 to 15).", + "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" : { - "mbps_wr" : { - "type" : "number", - "description" : "Maximum write speed speed in megabytes per second.", + "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" : { + "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" : { + "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, - "format_description" : "mbps" + "type" : "string" }, "cyls" : { - "type" : "integer", "description" : "Force the drive's physical geometry to have a specific cylinder count.", - "format_description" : "count", - "optional" : 1 - }, - "secs" : { - "format_description" : "count", "optional" : 1, - "description" : "Force the drive's physical geometry to have a specific sector count.", "type" : "integer" }, - "heads" : { + "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.", - "format_description" : "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" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", + "format_description" : "iops", + "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" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", + "format_description" : "iops", + "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" : { - "type" : "number", + "description" : "Maximum read speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Maximum read speed speed in megabytes per second.", - "format_description" : "mbps" + "type" : "number" }, - "backup" : { + "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" + }, + "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" : "string" + }, + "snapshot" : { + "description" : "Whether the drive should be included when making snapshots.", + "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_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + }, + "scsi[n]" : { + "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).", + "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.", - "format_description" : "on|off", + "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" : { - "type" : "integer", + "description" : "Maximum read speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "Maximum read speed speed in bytes per second.", - "format_description" : "bps" + "type" : "integer" }, - "format" : { + "cache" : { + "description" : "The drive's cache mode", "enum" : [ - "raw", - "cow", - "qcow", - "qed", - "qcow2", - "vmdk", - "cloop" + "none", + "writethrough", + "writeback", + "unsafe", + "directsync" ], "optional" : 1, - "description" : "The drive's backing file's data format.", - "format_description" : "drive format", "type" : "string" }, - "media" : { - "enum" : [ - "cdrom", - "disk" - ], - "format_description" : "cdrom|disk", + "cyls" : { + "description" : "Force the drive's physical geometry to have a specific cylinder count.", "optional" : 1, - "description" : "The drive's media type.", - "default" : "disk", - "type" : "string" + "type" : "integer" }, "detect_zeroes" : { "description" : "Controls whether to detect and try to optimize writes of zeroes.", "optional" : 1, "type" : "boolean" }, - "iops_wr" : { - "optional" : 1, - "description" : "Maximum write I/O speed in operations per second.", - "format_description" : "iops", - "type" : "integer" - }, - "mbps_max" : { - "type" : "number", - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", - "optional" : 1, - "format_description" : "mbps" - }, - "serial" : { - "type" : "string", - "format" : "urlencoded", - "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", - "format_description" : "serial", - "optional" : 1, - "maxLength" : 60 - }, "discard" : { - "format_description" : "ignore|on", - "optional" : 1, "description" : "Controls whether to pass discard/trim requests to the underlying storage.", "enum" : [ "ignore", "on" ], + "optional" : 1, "type" : "string" }, "file" : { - "type" : "string", - "format" : "pve-volume-id-or-qm-path", "default_key" : 1, + "description" : "The drive's backing volume.", + "format" : "pve-volume-id-or-qm-path", "format_description" : "volume", - "description" : "The drive's backing volume." + "type" : "string" }, - "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "format" : { + "description" : "The drive's backing file's data format.", + "enum" : [ + "raw", + "cow", + "qcow", + "qed", + "qcow2", + "vmdk", + "cloop" + ], "optional" : 1, - "format_description" : "mbps", - "type" : "number" + "type" : "string" }, - "bps_wr" : { - "type" : "integer", + "heads" : { + "description" : "Force the drive's physical geometry to have a specific head count.", "optional" : 1, - "format_description" : "bps", - "description" : "Maximum write speed speed in bytes per second." + "type" : "integer" }, "iops" : { - "type" : "integer", + "description" : "Maximum r/w I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "description" : "Maximum r/w I/O speed in operations per second.", - "format_description" : "iops" + "type" : "integer" }, - "size" : { - "description" : "Disk size. This is purely informational and has no effect.", + "iops_max" : { + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", + "format_description" : "iops", "optional" : 1, - "format" : "disk-size", - "type" : "string" + "type" : "integer" }, - "iothread" : { - "format_description" : "off|on", - "description" : "Whether to use iothreads for this drive", + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "type" : "boolean" + "type" : "integer" }, - "iops_wr_max" : { - "type" : "integer", - "optional" : 1, + "iops_rd" : { + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", - "description" : "Maximum unthrottled write I/O pool speed in operations per second." - }, - "mbps_rd_max" : { - "type" : "number", - "format_description" : "mbps", - "description" : "Maximum unthrottled read pool speed in megabytes per second.", - "optional" : 1 + "optional" : 1, + "type" : "integer" }, - "aio" : { - "enum" : [ - "native", - "threads" - ], + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "native|threads", - "description" : "AIO type to use.", - "type" : "string" + "type" : "integer" }, - "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, - "bps" : { - "format_description" : "bps", + "iops_wr" : { + "description" : "Maximum write I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "description" : "Maximum r/w speed speed in bytes per second.", "type" : "integer" }, - "mbps_wr_max" : { - "format_description" : "mbps", - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "type" : "number" + "type" : "integer" }, - "cache" : { - "enum" : [ - "none", - "writethrough", - "writeback", - "unsafe", - "directsync" - ], + "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", + "format_description" : "iops", "optional" : 1, - "format_description" : "none|writethrough|writeback|unsafe|directsync", - "description" : "The drive's cache mode", - "type" : "string" + "type" : "integer" }, - "snapshot" : { - "type" : "boolean", + "iothread" : { + "description" : "Whether to use iothreads for this drive", "optional" : 1, - "format_description" : "on|off", - "description" : "Whether the drive should be included when making snapshots." + "type" : "boolean" }, - "rerror" : { - "type" : "string", + "mbps" : { + "description" : "Maximum r/w speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Read error action.", - "format_description" : "ignore|report|stop", - "enum" : [ - "ignore", - "report", - "stop" - ] + "type" : "number" }, - "trans" : { - "enum" : [ - "none", - "lba", - "auto" - ], - "format_description" : "none|lba|auto", + "mbps_max" : { + "description" : "Maximum unthrottled r/w pool in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Force disk geometry bios translation mode.", - "type" : "string" + "type" : "number" }, - "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "mbps_rd" : { + "description" : "Maximum read speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "format_description" : "iops", - "type" : "integer" - }, - "volume" : { - "alias" : "file" + "type" : "number" }, - "werror" : { + "mbps_rd_max" : { + "description" : "Maximum unthrottled read pool in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "format_description" : "enospc|ignore|report|stop", - "description" : "Write error action.", - "enum" : [ - "enospc", - "ignore", - "report", - "stop" - ], - "type" : "string" + "type" : "number" }, - "iops_rd" : { - "type" : "integer", - "description" : "Maximum read I/O speed in operations per second.", - "optional" : 1, - "format_description" : "iops" - } - }, - "type" : "string" - }, - "bios" : { - "type" : "string", - "default" : "seabios", - "optional" : 1, - "description" : "Select BIOS implementation.", - "enum" : [ - "seabios", - "ovmf" - ] - }, - "agent" : { - "optional" : 1, - "description" : "Enable/disable Qemu GuestAgent.", - "default" : 0, - "type" : "boolean" - }, - "parallel[n]" : { - "optional" : 1, - "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\nExperimental: user reported problems with this option.\n", - "pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+", - "type" : "string" - }, - "tablet" : { - "optional" : 1, - "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).", - "type" : "boolean", - "default" : 1 - }, - "smp" : { - "optional" : 1, - "description" : "The number of CPUs. Please use option -sockets instead.", - "minimum" : 1, - "type" : "integer", - "default" : 1 - }, - "usb[n]" : { - "format" : { - "usb3" : { - "type" : "boolean", + "mbps_wr" : { + "description" : "Maximum write speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Specifies whether if given host option is a USB3 device or port", - "format_description" : "yes|no" + "type" : "number" }, - "host" : { - "description" : "The Host USB device or port or the value spice", - "format_description" : "HOSTUSBDEVICE|spice", - "default_key" : 1, - "format" : "pve-qm-usb-device", - "type" : "string" - } - }, - "type" : "string", - "description" : "Configure an USB device (n is 0 to 4). This can be used to\npass-through usb devices to the guest. 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\nThe 'usb3' option determines whether the device is a USB3 device or not (this does currently not work reliably with spice redirection and is then ignored).\n\n", - "optional" : 1 - }, - "tdf" : { - "optional" : 1, - "description" : "Enable/disable time drift fix.", - "default" : 0, - "type" : "boolean" - }, - "cdrom" : { - "format" : "pve-qm-drive", - "type" : "string", - "optional" : 1, - "description" : "This is an alias for option -ide2", - "typetext" : "volume" - }, - "sockets" : { - "type" : "integer", - "default" : 1, - "minimum" : 1, - "optional" : 1, - "description" : "The number of CPU sockets." - }, - "serial[n]" : { - "description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a host serial device (i.e. /dev/ttyS0), or create a unix socket on the host 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\nExperimental: user reported problems with this option.\n", - "optional" : 1, - "pattern" : "(/dev/.+|socket)", - "type" : "string" - }, - "ide[n]" : { - "format" : { "mbps_wr_max" : { - "type" : "number", + "description" : "Maximum unthrottled write pool in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Maximum unthrottled write pool speed in megabytes per second.", - "format_description" : "mbps" + "type" : "number" }, - "bps" : { - "format_description" : "bps", - "description" : "Maximum r/w speed speed in bytes per second.", + "media" : { + "default" : "disk", + "description" : "The drive's media type.", + "enum" : [ + "cdrom", + "disk" + ], "optional" : 1, - "type" : "integer" + "type" : "string" }, - "snapshot" : { - "type" : "boolean", + "queues" : { + "description" : "Number of queues.", + "minimum" : 2, "optional" : 1, - "format_description" : "on|off", - "description" : "Whether the drive should be included when making snapshots." + "type" : "integer" }, - "cache" : { - "type" : "string", - "enum" : [ - "none", - "writethrough", - "writeback", - "unsafe", - "directsync" - ], + "secs" : { + "description" : "Force the drive's physical geometry to have a specific sector count.", "optional" : 1, - "description" : "The drive's cache mode", - "format_description" : "none|writethrough|writeback|unsafe|directsync" + "type" : "integer" }, - "werror" : { - "type" : "string", - "enum" : [ - "enospc", - "ignore", - "report", - "stop" - ], - "description" : "Write error action.", + "serial" : { + "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", + "format" : "urlencoded", + "format_description" : "serial", + "maxLength" : 60, "optional" : 1, - "format_description" : "enospc|ignore|report|stop" + "type" : "string" }, - "iops_rd" : { - "type" : "integer", - "format_description" : "iops", + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", "optional" : 1, - "description" : "Maximum read I/O speed in operations per second." + "type" : "string" }, - "rerror" : { - "type" : "string", + "snapshot" : { + "description" : "Whether the drive should be included when making snapshots.", "optional" : 1, - "description" : "Read error action.", - "format_description" : "ignore|report|stop", - "enum" : [ - "ignore", - "report", - "stop" - ] + "type" : "boolean" }, "trans" : { - "type" : "string", - "optional" : 1, - "format_description" : "none|lba|auto", "description" : "Force disk geometry bios translation mode.", "enum" : [ "none", "lba", "auto" - ] + ], + "optional" : 1, + "type" : "string" }, "volume" : { "alias" : "file" }, - "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", - "optional" : 1, - "format_description" : "iops", - "type" : "integer" - }, - "mbps" : { - "format_description" : "mbps", - "optional" : 1, - "description" : "Maximum r/w speed speed in megabytes per second.", - "type" : "number" - }, - "bps_wr" : { - "type" : "integer", - "description" : "Maximum write speed speed in bytes per second.", - "format_description" : "bps", - "optional" : 1 - }, - "iops" : { - "type" : "integer", - "description" : "Maximum r/w I/O speed in operations per second.", - "optional" : 1, - "format_description" : "iops" - }, - "discard" : { - "type" : "string", + "werror" : { + "description" : "Write error action.", "enum" : [ + "enospc", "ignore", - "on" + "report", + "stop" ], "optional" : 1, - "format_description" : "ignore|on", - "description" : "Controls whether to pass discard/trim requests to the underlying storage." - }, - "serial" : { - "maxLength" : 60, - "optional" : 1, - "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", - "format_description" : "serial", - "format" : "urlencoded", "type" : "string" - }, - "mbps_max" : { - "type" : "number", - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", - "optional" : 1, - "format_description" : "mbps" - }, - "file" : { - "format_description" : "volume", - "description" : "The drive's backing volume.", + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + }, + "scsihw" : { + "default" : "lsi", + "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, - "format" : "pve-volume-id-or-qm-path", + "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" }, - "mbps_rd_max" : { + "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, - "format_description" : "mbps", - "description" : "Maximum unthrottled read pool speed in megabytes per second.", - "type" : "number" - }, + "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).", + "format" : { "aio" : { - "type" : "string", + "description" : "AIO type to use.", "enum" : [ "native", - "threads" - ], - "description" : "AIO type to use.", - "format_description" : "native|threads", - "optional" : 1 - }, - "iops_max" : { + "threads" + ], "optional" : 1, - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", - "format_description" : "iops", - "type" : "integer" + "type" : "string" }, - "size" : { - "format" : "disk-size", - "type" : "string", + "backup" : { + "description" : "Whether the drive should be included when making backups.", "optional" : 1, - "description" : "Disk size. This is purely informational and has no effect." + "type" : "boolean" }, - "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "bps" : { + "description" : "Maximum r/w speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "format_description" : "iops", "type" : "integer" }, - "bps_rd" : { - "type" : "integer", - "optional" : 1, - "description" : "Maximum read speed speed in bytes per second.", - "format_description" : "bps" - }, - "backup" : { + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "Whether the drive should be included when making backups.", - "format_description" : "on|off", - "type" : "boolean" + "type" : "integer" }, - "model" : { - "type" : "string", - "format" : "urlencoded", - "description" : "The drive's reported model name, url-encoded, up to 40 bytes long.", + "bps_rd" : { + "description" : "Maximum read speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "maxLength" : 120, - "format_description" : "model" + "type" : "integer" }, - "media" : { - "format_description" : "cdrom|disk", + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "The drive's media type.", - "enum" : [ - "cdrom", - "disk" - ], - "type" : "string", - "default" : "disk" + "type" : "integer" }, - "detect_zeroes" : { - "type" : "boolean", + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "description" : "Controls whether to detect and try to optimize writes of zeroes." + "type" : "integer" }, - "iops_wr" : { - "type" : "integer", + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "Maximum write I/O speed in operations per second.", - "format_description" : "iops" + "type" : "integer" }, - "format" : { + "cache" : { + "description" : "The drive's cache mode", "enum" : [ - "raw", - "cow", - "qcow", - "qed", - "qcow2", - "vmdk", - "cloop" + "none", + "writethrough", + "writeback", + "unsafe", + "directsync" ], "optional" : 1, - "description" : "The drive's backing file's data format.", - "format_description" : "drive format", "type" : "string" }, "cyls" : { - "format_description" : "count", - "optional" : 1, "description" : "Force the drive's physical geometry to have a specific cylinder count.", - "type" : "integer" - }, - "mbps_wr" : { - "type" : "number", - "format_description" : "mbps", - "optional" : 1, - "description" : "Maximum write speed speed in megabytes per second." - }, - "heads" : { "optional" : 1, - "description" : "Force the drive's physical geometry to have a specific head count.", - "format_description" : "count", "type" : "integer" }, - "mbps_rd" : { - "optional" : 1, - "description" : "Maximum read speed speed in megabytes per second.", - "format_description" : "mbps", - "type" : "number" - }, - "secs" : { - "type" : "integer", - "optional" : 1, - "format_description" : "count", - "description" : "Force the drive's physical geometry to have a specific sector count." - } - }, - "type" : "string", - "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3).", - "optional" : 1 - }, - "cpuunits" : { - "default" : 1000, - "maximum" : 500000, - "type" : "integer", - "minimum" : 0, - "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.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0.", - "optional" : 1 - }, - "cpulimit" : { - "minimum" : 0, - "maximum" : 128, - "type" : "number", - "default" : 0, - "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.", - "optional" : 1 - }, - "args" : { - "type" : "string", - "description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n", - "optional" : 1 - }, - "protection" : { - "default" : 0, - "type" : "boolean", - "description" : "Sets the protection flag of the VM. This will prevent the remove operation.", - "optional" : 1 - }, - "machine" : { - "type" : "string", - "optional" : 1, - "maxLength" : 40, - "description" : "Specific the Qemu machine type.", - "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?)" - }, - "reboot" : { - "default" : 1, - "type" : "boolean", - "description" : "Allow reboot. If set to '0' the VM exit on reboot.", - "optional" : 1 - }, - "hotplug" : { - "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'.", - "optional" : 1, - "format" : "pve-hotplug-features", - "default" : "network,disk,usb", - "type" : "string" - }, - "migrate_speed" : { - "optional" : 1, - "description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit.", - "type" : "integer", - "default" : 0, - "minimum" : 0 - }, - "sata[n]" : { - "format" : { - "secs" : { - "type" : "integer", - "format_description" : "count", - "description" : "Force the drive's physical geometry to have a specific sector count.", - "optional" : 1 - }, - "mbps_rd" : { - "type" : "number", - "description" : "Maximum read speed speed in megabytes per second.", - "optional" : 1, - "format_description" : "mbps" - }, - "heads" : { - "format_description" : "count", + "detect_zeroes" : { + "description" : "Controls whether to detect and try to optimize writes of zeroes.", "optional" : 1, - "description" : "Force the drive's physical geometry to have a specific head count.", - "type" : "integer" + "type" : "boolean" }, - "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", - "format_description" : "mbps", + "discard" : { + "description" : "Controls whether to pass discard/trim requests to the underlying storage.", + "enum" : [ + "ignore", + "on" + ], "optional" : 1, - "type" : "number" + "type" : "string" }, - "cyls" : { - "description" : "Force the drive's physical geometry to have a specific cylinder count.", - "optional" : 1, - "format_description" : "count", - "type" : "integer" + "file" : { + "default_key" : 1, + "description" : "The drive's backing volume.", + "format" : "pve-volume-id-or-qm-path", + "format_description" : "volume", + "type" : "string" }, "format" : { - "format_description" : "drive format", "description" : "The drive's backing file's data format.", - "optional" : 1, "enum" : [ "raw", "cow", @@ -5819,1190 +7023,1149 @@ var pveapi = [ "vmdk", "cloop" ], + "optional" : 1, "type" : "string" }, - "detect_zeroes" : { + "heads" : { + "description" : "Force the drive's physical geometry to have a specific head count.", "optional" : 1, - "description" : "Controls whether to detect and try to optimize writes of zeroes.", - "type" : "boolean" + "type" : "integer" }, - "iops_wr" : { - "type" : "integer", + "iops" : { + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, - "description" : "Maximum write I/O speed in operations per second." + "type" : "integer" }, - "media" : { - "enum" : [ - "cdrom", - "disk" - ], - "description" : "The drive's media type.", + "iops_max" : { + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", + "format_description" : "iops", "optional" : 1, - "format_description" : "cdrom|disk", - "default" : "disk", - "type" : "string" - }, - "backup" : { - "type" : "boolean", - "format_description" : "on|off", - "description" : "Whether the drive should be included when making backups.", - "optional" : 1 + "type" : "integer" }, - "bps_rd" : { - "type" : "integer", + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "Maximum read speed speed in bytes per second.", - "format_description" : "bps" + "type" : "integer" }, - "iops_wr_max" : { - "type" : "integer", - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "iops_rd" : { + "description" : "Maximum read I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "format_description" : "iops" + "type" : "integer" }, - "size" : { - "description" : "Disk size. This is purely informational and has no effect.", + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format" : "disk-size", - "type" : "string" + "type" : "integer" }, - "iops_max" : { - "type" : "integer", - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", - "optional" : 1 + "optional" : 1, + "type" : "integer" }, - "aio" : { + "iops_wr" : { + "description" : "Maximum write I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "format_description" : "native|threads", - "description" : "AIO type to use.", - "enum" : [ - "native", - "threads" - ], - "type" : "string" + "type" : "integer" }, - "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "mbps", - "type" : "number" + "type" : "integer" }, - "file" : { - "default_key" : 1, - "description" : "The drive's backing volume.", - "format_description" : "volume", - "type" : "string", - "format" : "pve-volume-id-or-qm-path" + "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" }, - "serial" : { - "type" : "string", - "format" : "urlencoded", - "format_description" : "serial", + "iothread" : { + "description" : "Whether to use iothreads for this drive", "optional" : 1, - "maxLength" : 60, - "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long." + "type" : "boolean" }, - "discard" : { - "type" : "string", + "mbps" : { + "description" : "Maximum r/w speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Controls whether to pass discard/trim requests to the underlying storage.", - "format_description" : "ignore|on", - "enum" : [ - "ignore", - "on" - ] + "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", - "optional" : 1, + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", + "optional" : 1, "type" : "number" }, - "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "mbps_rd" : { + "description" : "Maximum read speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "format_description" : "iops", - "type" : "integer" + "type" : "number" }, - "mbps" : { - "type" : "number", + "mbps_rd_max" : { + "description" : "Maximum unthrottled read pool in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Maximum r/w speed speed in megabytes per second.", - "format_description" : "mbps" + "type" : "number" }, - "bps_wr" : { - "type" : "integer", + "mbps_wr" : { + "description" : "Maximum write speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Maximum write speed speed in bytes per second.", - "format_description" : "bps" + "type" : "number" }, - "iops_rd_max" : { - "type" : "integer", + "mbps_wr_max" : { + "description" : "Maximum unthrottled write pool in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", - "format_description" : "iops" - }, - "volume" : { - "alias" : "file" + "type" : "number" }, - "trans" : { - "format_description" : "none|lba|auto", - "optional" : 1, - "description" : "Force disk geometry bios translation mode.", + "media" : { + "default" : "disk", + "description" : "The drive's media type.", "enum" : [ - "none", - "lba", - "auto" + "cdrom", + "disk" ], + "optional" : 1, "type" : "string" }, "rerror" : { - "optional" : 1, "description" : "Read error action.", - "format_description" : "ignore|report|stop", "enum" : [ "ignore", "report", "stop" ], + "optional" : 1, "type" : "string" }, - "iops_rd" : { - "type" : "integer", + "secs" : { + "description" : "Force the drive's physical geometry to have a specific sector count.", "optional" : 1, - "description" : "Maximum read I/O speed in operations per second.", - "format_description" : "iops" + "type" : "integer" }, - "werror" : { - "type" : "string", - "format_description" : "enospc|ignore|report|stop", + "serial" : { + "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", + "format" : "urlencoded", + "format_description" : "serial", + "maxLength" : 60, "optional" : 1, - "description" : "Write error action.", - "enum" : [ - "enospc", - "ignore", - "report", - "stop" - ] + "type" : "string" }, - "cache" : { - "enum" : [ - "none", - "writethrough", - "writeback", - "unsafe", - "directsync" - ], + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", "optional" : 1, - "description" : "The drive's cache mode", - "format_description" : "none|writethrough|writeback|unsafe|directsync", "type" : "string" }, "snapshot" : { - "optional" : 1, - "format_description" : "on|off", "description" : "Whether the drive should be included when making snapshots.", + "optional" : 1, "type" : "boolean" }, - "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "trans" : { + "description" : "Force disk geometry bios translation mode.", + "enum" : [ + "none", + "lba", + "auto" + ], "optional" : 1, - "format_description" : "mbps", - "type" : "number" + "type" : "string" }, - "bps" : { - "type" : "integer", + "volume" : { + "alias" : "file" + }, + "werror" : { + "description" : "Write error action.", + "enum" : [ + "enospc", + "ignore", + "report", + "stop" + ], "optional" : 1, - "format_description" : "bps", - "description" : "Maximum r/w speed speed in bytes per second." + "type" : "string" } }, + "optional" : 1, "type" : "string", - "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).", - "optional" : 1 + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, - "bootdisk" : { - "type" : "string", - "format" : "pve-qm-bootdisk", - "pattern" : "(ide|sata|scsi|virtio)\\d+", - "description" : "Enable booting from specified disk.", - "optional" : 1 + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" }, - "kvm" : { - "default" : 1, - "type" : "boolean", + "watchdog" : { + "description" : "Create a virtual hardware watchdog device.", + "format" : "pve-qm-watchdog", "optional" : 1, - "description" : "Enable/disable KVM hardware virtualization." - }, - "hostpci[n]" : { - "format" : "pve-qm-hostpci", "type" : "string", - "description" : "Map host pci devices. HOSTPCIDEVICE syntax is:\n\n'bus:dev.func' (hexadecimal numbers)\n\nYou can us the 'lspci' command to list existing pci devices.\n\nThe 'rombar' option determines whether or not the device's ROM will be visible in the guest's memory map (default is 'on').\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\nExperimental: user reported problems with this option.\n", - "optional" : 1 - }, - "ostype" : { + "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, - "description" : "Used to enable special optimization/features for specific\noperating systems:\n\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\nl24 => Linux 2.4 Kernel\nl26 => Linux 2.6/3.X Kernel\nsolaris => solaris/opensolaris/openindiania kernel\n\nother|l24|l26|solaris ... no special behaviour\nwxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch\n", - "enum" : [ - "other", - "wxp", - "w2k", - "w2k3", - "w2k8", - "wvista", - "win7", - "win8", - "l24", - "l26", - "solaris" - ], - "type" : "string" - }, - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - }, - "unused[n]" : { - "format" : "pve-volume-id", - "type" : "string", - "description" : "Reference to unused volumes.", - "optional" : 1 + "type" : "boolean", + "typetext" : "" }, - "template" : { + "agent" : { "default" : 0, + "description" : "Enable/disable Qemu GuestAgent.", + "optional" : 1, "type" : "boolean", - "description" : "Enable/disable Template.", - "optional" : 1 + "typetext" : "" }, - "watchdog" : { - "type" : "string", - "format" : "pve-qm-watchdog", + "args" : { + "description" : "Arbitrary arguments passed to kvm.", "optional" : 1, - "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)" - }, - "digest" : { "type" : "string", - "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "optional" : 1 + "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" }, - "vcpus" : { - "optional" : 1, - "description" : "Number of hotplugged vcpus.", - "type" : "integer", + "autostart" : { "default" : 0, - "minimum" : 1 - }, - "migrate_downtime" : { - "description" : "Set maximum tolerated downtime (in seconds) for migrations.", + "description" : "Automatic restart after crash (currently ignored).", "optional" : 1, - "type" : "number", - "default" : 0.1, - "minimum" : 0 + "type" : "boolean", + "typetext" : "" }, - "cores" : { - "type" : "integer", - "default" : 1, - "minimum" : 1, + "balloon" : { + "description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.", + "minimum" : 0, "optional" : 1, - "description" : "The number of cores per socket." + "type" : "integer", + "typetext" : " (0 - N)" }, - "net[n]" : { - "format" : "pve-qm-net", - "type" : "string", + "bios" : { + "default" : "seabios", + "description" : "Select BIOS implementation.", + "enum" : [ + "seabios", + "ovmf" + ], "optional" : 1, - "description" : "Specify network devices.\n\nMODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3\n\nXX:XX:XX:XX:XX:XX should be an unique MAC address. This is\nautomatically generated if not specified.\n\nThe bridge parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called 'vmbr0'.\n\nOption 'rate' is used to limit traffic bandwidth from and to this interface. It is specified as floating point number, unit is 'Megabytes per second'.\n\nIf you specify no bridge, we create a kvm 'user' (NATed) network device, which provides DHCP and DNS services. The following addresses are used:\n\n10.0.2.2 Gateway\n10.0.2.3 DNS Server\n10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n\n" + "type" : "string" }, - "keyboard" : { - "description" : "Keybord layout for vnc server. Default is read from the datacenter configuration file.", + "boot" : { + "default" : "cdn", + "description" : "Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).", "optional" : 1, - "enum" : [ - "en-gb", - "de-ch", - "en-us", - "mk", - "fr-be", - "de", - "pt-br", - "sv", - "fr-ch", - "no", - "pt", - "hu", - "sl", - "lt", - "fi", - "it", - "nl", - "is", - "da", - "fr-ca", - "pl", - "fr", - "es", - "ja", - "tr" - ], - "default" : "en-us", + "pattern" : "[acdn]{1,4}", "type" : "string" }, - "freeze" : { - "type" : "boolean", + "bootdisk" : { + "description" : "Enable booting from specified disk.", + "format" : "pve-qm-bootdisk", "optional" : 1, - "description" : "Freeze CPU at startup (use 'c' monitor command to start execution)." + "pattern" : "(ide|sata|scsi|virtio)\\d+", + "type" : "string" }, - "numa[n]" : { + "cdrom" : { + "description" : "This is an alias for option -ide2", + "format" : "pve-qm-ide", "optional" : 1, - "description" : "numa topology", - "format" : { - "hostnodes" : { - "format_description" : "id[-id];...", - "description" : "host numa nodes to use", - "optional" : 1, - "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", - "type" : "string" - }, - "policy" : { - "description" : "numa allocation policy.", - "format_description" : "preferred|bind|interleave", - "optional" : 1, - "enum" : [ - "preferred", - "bind", - "interleave" - ], - "type" : "string" - }, - "memory" : { - "type" : "number", - "description" : "Amount of memory this numa node provides.", - "format_description" : "mb", - "optional" : 1 - }, - "cpus" : { - "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", - "description" : "CPUs accessing this numa node.", - "format_description" : "id[-id];...", - "type" : "string" - } - }, - "type" : "string" + "type" : "string", + "typetext" : "" }, - "force" : { - "requires" : "delete", - "type" : "boolean", + "cores" : { + "default" : 1, + "description" : "The number of cores per socket.", + "minimum" : 1, "optional" : 1, - "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." + "type" : "integer", + "typetext" : " (1 - N)" }, "cpu" : { - "optional" : 1, "description" : "Emulated CPU type.", "format" : { "cputype" : { + "default" : "kvm64", + "default_key" : 1, + "description" : "Emulated CPU type.", "enum" : [ "486", "athlon", - "pentium", - "pentium2", - "pentium3", - "coreduo", + "Broadwell", + "Broadwell-noTSX", + "Conroe", "core2duo", + "coreduo", + "Haswell", + "Haswell-noTSX", + "host", + "IvyBridge", "kvm32", "kvm64", - "qemu32", - "qemu64", - "phenom", - "Conroe", - "Penryn", "Nehalem", - "Westmere", - "SandyBridge", - "IvyBridge", - "Haswell", - "Haswell-noTSX", - "Broadwell", - "Broadwell-noTSX", "Opteron_G1", "Opteron_G2", "Opteron_G3", "Opteron_G4", "Opteron_G5", - "host" + "Penryn", + "pentium", + "pentium2", + "pentium3", + "phenom", + "qemu32", + "qemu64", + "SandyBridge", + "Westmere" ], - "default_key" : 1, - "format_description" : "cputype", - "description" : "Emulated CPU type.", - "default" : "kvm64", "type" : "string" }, "hidden" : { - "optional" : 1, + "default" : 0, "description" : "Do not identify as a KVM virtual machine.", - "type" : "boolean", - "default" : 0 + "optional" : 1, + "type" : "boolean" } }, - "type" : "string" + "optional" : 1, + "type" : "string", + "typetext" : "[cputype=] [,hidden=<1|0>]" }, - "autostart" : { - "type" : "boolean", + "cpulimit" : { "default" : 0, + "description" : "Limit of CPU usage.", + "maximum" : 128, + "minimum" : 0, "optional" : 1, - "description" : "Automatic restart after crash (currently ignored)." + "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." }, - "vga" : { + "cpuunits" : { + "default" : 1024, + "description" : "CPU weight for a VM.", + "maximum" : 500000, + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - 500000)", + "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.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0." + }, + "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, - "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.", - "enum" : [ - "std", - "cirrus", - "vmware", - "qxl", - "serial0", - "serial1", - "serial2", - "serial3", - "qxl2", - "qxl3", - "qxl4" - ] + "type" : "string", + "typetext" : "" }, - "startdate" : { - "pattern" : "(now|\\d{4}-\\d{1,2}-\\d{1,2}(T\\d{1,2}:\\d{1,2}:\\d{1,2})?)", + "digest" : { + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", + "maxLength" : 40, "optional" : 1, - "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'.", - "typetext" : "(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)", - "default" : "now", - "type" : "string" + "type" : "string", + "typetext" : "" }, - "acpi" : { + "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", - "default" : 1, - "description" : "Enable/disable ACPI.", - "optional" : 1 + "typetext" : "" }, - "scsi[n]" : { + "freeze" : { + "description" : "Freeze CPU at startup (use 'c' monitor command to start execution).", + "optional" : 1, + "type" : "boolean", + "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>] [,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" : { - "cache" : { + "aio" : { + "description" : "AIO type to use.", "enum" : [ - "none", - "writethrough", - "writeback", - "unsafe", - "directsync" + "native", + "threads" ], - "format_description" : "none|writethrough|writeback|unsafe|directsync", - "description" : "The drive's cache mode", "optional" : 1, "type" : "string" }, - "snapshot" : { + "backup" : { + "description" : "Whether the drive should be included when making backups.", "optional" : 1, - "description" : "Whether the drive should be included when making snapshots.", - "format_description" : "on|off", "type" : "boolean" }, "bps" : { - "optional" : 1, + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", - "description" : "Maximum r/w speed speed in bytes per second.", + "optional" : 1, "type" : "integer" }, - "mbps_wr_max" : { - "format_description" : "mbps", + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "Maximum unthrottled write pool speed in megabytes per second.", - "type" : "number" - }, - "iops_rd" : { - "type" : "integer", - "format_description" : "iops", - "description" : "Maximum read I/O speed in operations per second.", - "optional" : 1 + "type" : "integer" }, - "werror" : { - "description" : "Write error action.", - "format_description" : "enospc|ignore|report|stop", + "bps_rd" : { + "description" : "Maximum read speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "enum" : [ - "enospc", - "ignore", - "report", - "stop" - ], - "type" : "string" + "type" : "integer" }, - "iops_rd_max" : { + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", - "format_description" : "iops", "type" : "integer" }, - "volume" : { - "alias" : "file" + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" }, - "trans" : { + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "none|lba|auto", - "description" : "Force disk geometry bios translation mode.", + "type" : "integer" + }, + "cache" : { + "description" : "The drive's cache mode", "enum" : [ "none", - "lba", - "auto" + "writethrough", + "writeback", + "unsafe", + "directsync" ], + "optional" : 1, "type" : "string" }, - "iops" : { + "cyls" : { + "description" : "Force the drive's physical geometry to have a specific cylinder count.", "optional" : 1, - "description" : "Maximum r/w I/O speed in operations per second.", - "format_description" : "iops", "type" : "integer" }, - "mbps" : { - "type" : "number", - "description" : "Maximum r/w speed speed in megabytes per second.", + "detect_zeroes" : { + "description" : "Controls whether to detect and try to optimize writes of zeroes.", "optional" : 1, - "format_description" : "mbps" + "type" : "boolean" }, - "bps_wr" : { - "type" : "integer", - "format_description" : "bps", + "discard" : { + "description" : "Controls whether to pass discard/trim requests to the underlying storage.", + "enum" : [ + "ignore", + "on" + ], "optional" : 1, - "description" : "Maximum write speed speed in bytes per second." + "type" : "string" }, "file" : { + "default_key" : 1, + "description" : "The drive's backing volume.", "format" : "pve-volume-id-or-qm-path", - "type" : "string", "format_description" : "volume", - "description" : "The drive's backing volume.", - "default_key" : 1 + "type" : "string" }, - "discard" : { + "format" : { + "description" : "The drive's backing file's data format.", "enum" : [ - "ignore", - "on" + "raw", + "cow", + "qcow", + "qed", + "qcow2", + "vmdk", + "cloop" ], "optional" : 1, - "format_description" : "ignore|on", - "description" : "Controls whether to pass discard/trim requests to the underlying storage.", "type" : "string" }, - "serial" : { - "format_description" : "serial", + "heads" : { + "description" : "Force the drive's physical geometry to have a specific head count.", "optional" : 1, - "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", - "maxLength" : 60, - "type" : "string", - "format" : "urlencoded" + "type" : "integer" }, - "mbps_max" : { - "type" : "number", - "format_description" : "mbps", + "iops" : { + "description" : "Maximum r/w I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "description" : "Maximum unthrottled r/w pool speed in megabytes per second." + "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, - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "type" : "integer" + }, + "iops_rd" : { + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", + "optional" : 1, "type" : "integer" }, - "aio" : { - "type" : "string", + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "native|threads", - "description" : "AIO type to use.", - "enum" : [ - "native", - "threads" - ] + "type" : "integer" }, - "queues" : { - "type" : "integer", - "minimum" : 2, - "format_description" : "nbqueues", - "description" : "Number of queues.", - "optional" : 1 + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" }, - "mbps_rd_max" : { - "type" : "number", + "iops_wr" : { + "description" : "Maximum write I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "format_description" : "mbps", - "description" : "Maximum unthrottled read pool speed in megabytes per second." + "type" : "integer" + }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" }, "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", "optional" : 1, "type" : "integer" }, - "iothread" : { - "type" : "boolean", - "description" : "Whether to use iothreads for this drive", + "mbps" : { + "description" : "Maximum r/w speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "format_description" : "off|on" + "type" : "number" }, - "size" : { - "description" : "Disk size. This is purely informational and has no effect.", + "mbps_max" : { + "description" : "Maximum unthrottled r/w pool in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "type" : "string", - "format" : "disk-size" + "type" : "number" }, - "bps_rd" : { - "type" : "integer", + "mbps_rd" : { + "description" : "Maximum read speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Maximum read speed speed in bytes per second.", - "format_description" : "bps" + "type" : "number" }, - "backup" : { - "description" : "Whether the drive should be included when making backups.", + "mbps_rd_max" : { + "description" : "Maximum unthrottled read pool in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "format_description" : "on|off", - "type" : "boolean" + "type" : "number" }, - "detect_zeroes" : { + "mbps_wr" : { + "description" : "Maximum write speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Controls whether to detect and try to optimize writes of zeroes.", - "type" : "boolean" + "type" : "number" }, - "iops_wr" : { - "type" : "integer", + "mbps_wr_max" : { + "description" : "Maximum unthrottled write pool in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Maximum write I/O speed in operations per second.", - "format_description" : "iops" + "type" : "number" }, "media" : { - "optional" : 1, + "default" : "disk", "description" : "The drive's media type.", - "format_description" : "cdrom|disk", "enum" : [ "cdrom", "disk" ], - "type" : "string", - "default" : "disk" + "optional" : 1, + "type" : "string" }, - "format" : { + "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" + }, + "rerror" : { + "description" : "Read error action.", "enum" : [ - "raw", - "cow", - "qcow", - "qed", - "qcow2", - "vmdk", - "cloop" + "ignore", + "report", + "stop" ], - "description" : "The drive's backing file's data format.", "optional" : 1, - "format_description" : "drive format", "type" : "string" }, - "cyls" : { - "format_description" : "count", + "secs" : { + "description" : "Force the drive's physical geometry to have a specific sector count.", "optional" : 1, - "description" : "Force the drive's physical geometry to have a specific cylinder count.", "type" : "integer" }, - "mbps_wr" : { - "type" : "number", + "serial" : { + "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", + "format" : "urlencoded", + "format_description" : "serial", + "maxLength" : 60, "optional" : 1, - "format_description" : "mbps", - "description" : "Maximum write speed speed in megabytes per second." + "type" : "string" }, - "mbps_rd" : { - "type" : "number", + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", "optional" : 1, - "description" : "Maximum read speed speed in megabytes per second.", - "format_description" : "mbps" + "type" : "string" }, - "heads" : { - "type" : "integer", - "format_description" : "count", + "snapshot" : { + "description" : "Whether the drive should be included when making snapshots.", "optional" : 1, - "description" : "Force the drive's physical geometry to have a specific head count." + "type" : "boolean" }, - "secs" : { + "trans" : { + "description" : "Force disk geometry bios translation mode.", + "enum" : [ + "none", + "lba", + "auto" + ], "optional" : 1, - "description" : "Force the drive's physical geometry to have a specific sector count.", - "format_description" : "count", - "type" : "integer" + "type" : "string" + }, + "volume" : { + "alias" : "file" + }, + "werror" : { + "description" : "Write error action.", + "enum" : [ + "enospc", + "ignore", + "report", + "stop" + ], + "optional" : 1, + "type" : "string" } }, - "type" : "string", - "optional" : 1, - "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13)." - }, - "shares" : { - "type" : "integer", - "default" : 1000, - "maximum" : 50000, - "minimum" : 0, - "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", - "optional" : 1 - }, - "smbios1" : { - "optional" : 1, - "maxLength" : 256, - "description" : "Specify SMBIOS type 1 fields.", - "type" : "string", - "format" : "pve-qm-smbios1" - }, - "delete" : { - "description" : "A list of settings you want to delete.", "optional" : 1, "type" : "string", - "format" : "pve-configid-list" - }, - "memory" : { - "optional" : 1, - "description" : "Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.", - "minimum" : 16, - "default" : 512, - "type" : "integer" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, - "description" : { - "type" : "string", + "keyboard" : { + "default" : "en-us", + "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.", + "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, - "description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file." + "type" : "string" }, - "onboot" : { + "kvm" : { + "default" : 1, + "description" : "Enable/disable KVM hardware virtualization.", "optional" : 1, - "description" : "Specifies whether a VM will be started during system bootup.", "type" : "boolean", - "default" : 0 + "typetext" : "" }, "localtime" : { - "type" : "boolean", "description" : "Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.", - "optional" : 1 - }, - "boot" : { - "default" : "cdn", - "type" : "string", - "description" : "Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).", - "optional" : 1, - "pattern" : "[acdn]{1,4}" - }, - "startup" : { "optional" : 1, - "typetext" : "[[order=]\\d+] [,up=\\d+] [,down=\\d+] ", - "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", - "type" : "string" - }, - "skiplock" : { "type" : "boolean", - "description" : "Ignore locks - only root is allowed to use this option.", - "optional" : 1 + "typetext" : "" }, - "scsihw" : { - "default" : "lsi", - "type" : "string", - "description" : "scsi controller model", - "optional" : 1, + "lock" : { + "description" : "Lock/unlock the VM.", "enum" : [ - "lsi", - "lsi53c810", - "virtio-scsi-pci", - "virtio-scsi-single", - "megasas", - "pvscsi" - ] - }, - "name" : { + "migrate", + "backup", + "snapshot", + "rollback" + ], "optional" : 1, - "description" : "Set a name for the VM. Only used on the configuration web interface.", - "format" : "dns-name", "type" : "string" }, - "balloon" : { - "description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.", + "machine" : { + "description" : "Specific the Qemu machine type.", + "maxLength" : 40, "optional" : 1, - "type" : "integer", - "minimum" : 0 - }, - "vmid" : { - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1, - "description" : "The (unique) ID of the VM." + "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?)", + "type" : "string" }, - "revert" : { - "description" : "Revert a pending change.", + "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" : "string", - "format" : "pve-configid-list" - } - }, - "additionalProperties" : 0 - }, - "description" : "Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation.", - "returns" : { - "type" : "null" - }, - "method" : "PUT", - "name" : "update_vm" - }, - "POST" : { - "parameters" : { - "properties" : { - "tdf" : { - "default" : 0, - "type" : "boolean", - "description" : "Enable/disable time drift fix.", - "optional" : 1 + "type" : "integer", + "typetext" : " (16 - N)" }, - "cdrom" : { - "description" : "This is an alias for option -ide2", - "typetext" : "volume", + "migrate_downtime" : { + "default" : 0.1, + "description" : "Set maximum tolerated downtime (in seconds) for migrations.", + "minimum" : 0, "optional" : 1, - "type" : "string", - "format" : "pve-qm-drive" + "type" : "number", + "typetext" : " (0 - N)" }, - "sockets" : { - "description" : "The number of CPU sockets.", + "migrate_speed" : { + "default" : 0, + "description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit.", + "minimum" : 0, "optional" : 1, - "minimum" : 1, "type" : "integer", - "default" : 1 + "typetext" : " (0 - N)" }, - "serial[n]" : { - "description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a host serial device (i.e. /dev/ttyS0), or create a unix socket on the host 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\nExperimental: user reported problems with this option.\n", + "name" : { + "description" : "Set a name for the VM. Only used on the configuration web interface.", + "format" : "dns-name", "optional" : 1, - "pattern" : "(/dev/.+|socket)", - "type" : "string" - }, - "ide[n]" : { "type" : "string", + "typetext" : "" + }, + "net[n]" : { + "description" : "Specify network devices.", "format" : { - "cache" : { - "type" : "string", + "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, - "format_description" : "none|writethrough|writeback|unsafe|directsync", - "description" : "The drive's cache mode", - "enum" : [ - "none", - "writethrough", - "writeback", - "unsafe", - "directsync" - ] + "type" : "string" }, - "snapshot" : { - "type" : "boolean", - "optional" : 1, - "description" : "Whether the drive should be included when making snapshots.", - "format_description" : "on|off" + "e1000" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "mbps_wr_max" : { - "type" : "number", - "format_description" : "mbps", - "optional" : 1, - "description" : "Maximum unthrottled write pool speed in megabytes per second." + "e1000-82540em" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "bps" : { - "format_description" : "bps", - "description" : "Maximum r/w speed speed in bytes per second.", - "optional" : 1, - "type" : "integer" + "e1000-82544gc" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "trans" : { - "type" : "string", - "enum" : [ - "none", - "lba", - "auto" - ], - "optional" : 1, - "format_description" : "none|lba|auto", - "description" : "Force disk geometry bios translation mode." + "e1000-82545em" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "firewall" : { + "description" : "Whether this interface should be protected by the firewall.", "optional" : 1, - "format_description" : "iops", - "type" : "integer" + "type" : "boolean" }, - "volume" : { - "alias" : "file" + "i82551" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "rerror" : { - "optional" : 1, - "description" : "Read error action.", - "format_description" : "ignore|report|stop", - "enum" : [ - "ignore", - "report", - "stop" - ], - "type" : "string" + "i82557b" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "iops_rd" : { - "format_description" : "iops", - "description" : "Maximum read I/O speed in operations per second.", + "i82559er" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "link_down" : { + "description" : "Whether this interface should be disconnected (like pulling the plug).", "optional" : 1, - "type" : "integer" + "type" : "boolean" }, - "werror" : { - "description" : "Write error action.", + "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, - "format_description" : "enospc|ignore|report|stop", - "enum" : [ - "enospc", - "ignore", - "report", - "stop" - ], + "pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})", "type" : "string" }, - "discard" : { + "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" ], - "optional" : 1, - "description" : "Controls whether to pass discard/trim requests to the underlying storage.", - "format_description" : "ignore|on", "type" : "string" }, - "serial" : { - "format" : "urlencoded", - "type" : "string", - "optional" : 1, - "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", - "format_description" : "serial", - "maxLength" : 60 + "ne2k_isa" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", - "format_description" : "mbps", - "optional" : 1, - "type" : "number" + "ne2k_pci" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "file" : { - "type" : "string", - "format" : "pve-volume-id-or-qm-path", - "default_key" : 1, - "format_description" : "volume", - "description" : "The drive's backing volume." + "pcnet" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "queues" : { + "description" : "Number of packet queues to be used on the device.", + "maximum" : 16, + "minimum" : 0, "optional" : 1, - "format_description" : "bps", "type" : "integer" }, - "mbps" : { - "type" : "number", + "rate" : { + "description" : "Rate limit in mbps (megabytes per second) as floating point number.", + "minimum" : 0, "optional" : 1, - "format_description" : "mbps", - "description" : "Maximum r/w speed speed in megabytes per second." + "type" : "number" }, - "iops" : { - "format_description" : "iops", - "optional" : 1, - "description" : "Maximum r/w I/O speed in operations per second.", - "type" : "integer" + "rtl8139" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "iops_wr_max" : { - "format_description" : "iops", - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "tag" : { + "description" : "VLAN tag to apply to packets on this interface.", + "maximum" : 4094, + "minimum" : 1, "optional" : 1, "type" : "integer" }, - "size" : { - "type" : "string", - "format" : "disk-size", + "trunks" : { + "description" : "VLAN trunks to pass through this interface.", + "format_description" : "vlanid[;vlanid...]", "optional" : 1, - "description" : "Disk size. This is purely informational and has no effect." + "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", + "type" : "string" }, - "iops_max" : { - "type" : "integer", - "format_description" : "iops", - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", - "optional" : 1 + "virtio" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "mbps_rd_max" : { - "type" : "number", - "format_description" : "mbps", + "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, - "description" : "Maximum unthrottled read pool speed in megabytes per second." + "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", + "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\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" : { - "type" : "string", + "description" : "AIO type to use.", "enum" : [ "native", "threads" ], "optional" : 1, - "description" : "AIO type to use.", - "format_description" : "native|threads" + "type" : "string" }, "backup" : { - "type" : "boolean", "description" : "Whether the drive should be included when making backups.", "optional" : 1, - "format_description" : "on|off" + "type" : "boolean" }, - "bps_rd" : { - "type" : "integer", + "bps" : { + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", - "description" : "Maximum read speed speed in bytes per second.", - "optional" : 1 + "optional" : 1, + "type" : "integer" }, - "format" : { - "type" : "string", - "enum" : [ - "raw", - "cow", - "qcow", - "qed", - "qcow2", - "vmdk", - "cloop" - ], + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "drive format", - "description" : "The drive's backing file's data format." + "type" : "integer" }, - "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "bps_rd" : { + "description" : "Maximum read speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "format_description" : "iops", "type" : "integer" }, - "detect_zeroes" : { - "description" : "Controls whether to detect and try to optimize writes of zeroes.", + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "type" : "boolean" + "type" : "integer" }, - "model" : { - "format" : "urlencoded", - "type" : "string", - "format_description" : "model", - "description" : "The drive's reported model name, url-encoded, up to 40 bytes long.", - "maxLength" : 120, - "optional" : 1 + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" }, - "media" : { + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "cdrom|disk", - "description" : "The drive's media type.", + "type" : "integer" + }, + "cache" : { + "description" : "The drive's cache mode", "enum" : [ - "cdrom", - "disk" + "none", + "writethrough", + "writeback", + "unsafe", + "directsync" ], - "type" : "string", - "default" : "disk" - }, - "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", - "format_description" : "mbps", "optional" : 1, - "type" : "number" + "type" : "string" }, "cyls" : { - "type" : "integer", "description" : "Force the drive's physical geometry to have a specific cylinder count.", "optional" : 1, - "format_description" : "count" - }, - "secs" : { - "type" : "integer", - "optional" : 1, - "description" : "Force the drive's physical geometry to have a specific sector count.", - "format_description" : "count" - }, - "heads" : { - "type" : "integer", - "format_description" : "count", - "description" : "Force the drive's physical geometry to have a specific head count.", - "optional" : 1 - }, - "mbps_rd" : { - "optional" : 1, - "description" : "Maximum read speed speed in megabytes per second.", - "format_description" : "mbps", - "type" : "number" - } - }, - "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3).", - "optional" : 1 - }, - "cpuunits" : { - "optional" : 1, - "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.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0.", - "default" : 1000, - "maximum" : 500000, - "type" : "integer", - "minimum" : 0 - }, - "cpulimit" : { - "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.", - "optional" : 1, - "default" : 0, - "type" : "number", - "maximum" : 128, - "minimum" : 0 - }, - "lock" : { - "type" : "string", - "enum" : [ - "migrate", - "backup", - "snapshot", - "rollback" - ], - "optional" : 1, - "description" : "Lock/unlock the VM." - }, - "numa" : { - "type" : "boolean", - "default" : 0, - "optional" : 1, - "description" : "Enable/disable NUMA." - }, - "virtio[n]" : { - "format" : { - "bps_rd" : { - "type" : "integer", - "format_description" : "bps", - "optional" : 1, - "description" : "Maximum read speed speed in bytes per second." - }, - "backup" : { - "description" : "Whether the drive should be included when making backups.", - "optional" : 1, - "format_description" : "on|off", - "type" : "boolean" + "type" : "integer" }, "detect_zeroes" : { - "type" : "boolean", "description" : "Controls whether to detect and try to optimize writes of zeroes.", - "optional" : 1 - }, - "iops_wr" : { - "format_description" : "iops", "optional" : 1, - "description" : "Maximum write I/O speed in operations per second.", - "type" : "integer" + "type" : "boolean" }, - "media" : { - "default" : "disk", - "type" : "string", - "optional" : 1, - "format_description" : "cdrom|disk", - "description" : "The drive's media type.", + "discard" : { + "description" : "Controls whether to pass discard/trim requests to the underlying storage.", "enum" : [ - "cdrom", - "disk" - ] + "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", @@ -7012,381 +8175,238 @@ var pveapi = [ "vmdk", "cloop" ], - "description" : "The drive's backing file's data format.", "optional" : 1, - "format_description" : "drive format", "type" : "string" }, - "cyls" : { - "type" : "integer", - "format_description" : "count", - "description" : "Force the drive's physical geometry to have a specific cylinder count.", - "optional" : 1 - }, - "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "heads" : { + "description" : "Force the drive's physical geometry to have a specific head count.", "optional" : 1, - "format_description" : "mbps", - "type" : "number" + "type" : "integer" }, - "mbps_rd" : { - "type" : "number", + "iops" : { + "description" : "Maximum r/w I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "format_description" : "mbps", - "description" : "Maximum read speed speed in megabytes per second." + "type" : "integer" }, - "heads" : { - "description" : "Force the drive's physical geometry to have a specific head count.", - "format_description" : "count", + "iops_max" : { + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", + "format_description" : "iops", "optional" : 1, "type" : "integer" }, - "secs" : { - "type" : "integer", - "description" : "Force the drive's physical geometry to have a specific sector count.", + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "count" + "type" : "integer" }, - "snapshot" : { - "type" : "boolean", + "iops_rd" : { + "description" : "Maximum read I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "format_description" : "on|off", - "description" : "Whether the drive should be included when making snapshots." + "type" : "integer" }, - "cache" : { - "type" : "string", + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "none|writethrough|writeback|unsafe|directsync", - "description" : "The drive's cache mode", - "enum" : [ - "none", - "writethrough", - "writeback", - "unsafe", - "directsync" - ] + "type" : "integer" }, - "mbps_wr_max" : { - "type" : "number", - "format_description" : "mbps", + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", + "format_description" : "iops", "optional" : 1, - "description" : "Maximum unthrottled write pool speed in megabytes per second." + "type" : "integer" }, - "bps" : { - "format_description" : "bps", - "description" : "Maximum r/w speed speed in bytes per second.", + "iops_wr" : { + "description" : "Maximum write I/O in operations per second.", + "format_description" : "iops", "optional" : 1, "type" : "integer" }, - "iops_rd" : { - "type" : "integer", + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, + "type" : "integer" + }, + "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", - "description" : "Maximum read I/O speed in operations per second." + "optional" : 1, + "type" : "integer" }, - "werror" : { - "type" : "string", + "mbps" : { + "description" : "Maximum r/w speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "format_description" : "enospc|ignore|report|stop", - "description" : "Write error action.", - "enum" : [ - "enospc", - "ignore", - "report", - "stop" - ] + "type" : "number" }, - "volume" : { - "alias" : "file" + "mbps_max" : { + "description" : "Maximum unthrottled r/w pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" }, - "iops_rd_max" : { - "type" : "integer", + "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, - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", - "format_description" : "iops" + "type" : "number" }, - "trans" : { + "media" : { + "default" : "disk", + "description" : "The drive's media type.", "enum" : [ - "none", - "lba", - "auto" + "cdrom", + "disk" ], "optional" : 1, - "description" : "Force disk geometry bios translation mode.", - "format_description" : "none|lba|auto", "type" : "string" }, "rerror" : { - "optional" : 1, "description" : "Read error action.", - "format_description" : "ignore|report|stop", "enum" : [ "ignore", "report", "stop" ], + "optional" : 1, "type" : "string" }, - "iops" : { - "type" : "integer", + "secs" : { + "description" : "Force the drive's physical geometry to have a specific sector count.", "optional" : 1, - "description" : "Maximum r/w I/O speed in operations per second.", - "format_description" : "iops" + "type" : "integer" }, - "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "serial" : { + "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", + "format" : "urlencoded", + "format_description" : "serial", + "maxLength" : 60, "optional" : 1, - "format_description" : "mbps", - "type" : "number" - }, - "bps_wr" : { - "type" : "integer", - "description" : "Maximum write speed speed in bytes per second.", - "format_description" : "bps", - "optional" : 1 - }, - "file" : { - "description" : "The drive's backing volume.", - "format_description" : "volume", - "default_key" : 1, - "format" : "pve-volume-id-or-qm-path", "type" : "string" }, - "serial" : { - "format" : "urlencoded", - "type" : "string", + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", "optional" : 1, - "maxLength" : 60, - "format_description" : "serial", - "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long." + "type" : "string" }, - "mbps_max" : { + "snapshot" : { + "description" : "Whether the drive should be included when making snapshots.", "optional" : 1, - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", - "format_description" : "mbps", - "type" : "number" + "type" : "boolean" }, - "discard" : { - "type" : "string", - "format_description" : "ignore|on", + "trans" : { + "description" : "Force disk geometry bios translation mode.", + "enum" : [ + "none", + "lba", + "auto" + ], "optional" : 1, - "description" : "Controls whether to pass discard/trim requests to the underlying storage.", + "type" : "string" + }, + "volume" : { + "alias" : "file" + }, + "werror" : { + "description" : "Write error action.", "enum" : [ + "enospc", "ignore", - "on" - ] - }, - "iops_max" : { + "report", + "stop" + ], "optional" : 1, - "format_description" : "iops", - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", - "type" : "integer" - }, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + }, + "scsi[n]" : { + "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).", + "format" : { "aio" : { "description" : "AIO type to use.", - "optional" : 1, - "format_description" : "native|threads", "enum" : [ "native", "threads" ], + "optional" : 1, "type" : "string" }, - "mbps_rd_max" : { - "format_description" : "mbps", + "backup" : { + "description" : "Whether the drive should be included when making backups.", "optional" : 1, - "description" : "Maximum unthrottled read pool speed in megabytes per second.", - "type" : "number" + "type" : "boolean" }, - "iops_wr_max" : { + "bps" : { + "description" : "Maximum r/w speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", - "format_description" : "iops", "type" : "integer" }, - "iothread" : { - "format_description" : "off|on", - "description" : "Whether to use iothreads for this drive", + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "type" : "boolean" + "type" : "integer" }, - "size" : { + "bps_rd" : { + "description" : "Maximum read speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "description" : "Disk size. This is purely informational and has no effect.", - "type" : "string", - "format" : "disk-size" - } - }, - "type" : "string", - "description" : "Use volume as VIRTIO hard disk (n is 0 to 15).", - "optional" : 1 - }, - "bios" : { - "type" : "string", - "default" : "seabios", - "enum" : [ - "seabios", - "ovmf" - ], - "optional" : 1, - "description" : "Select BIOS implementation." - }, - "agent" : { - "default" : 0, - "type" : "boolean", - "description" : "Enable/disable Qemu GuestAgent.", - "optional" : 1 - }, - "parallel[n]" : { - "pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+", - "optional" : 1, - "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\nExperimental: user reported problems with this option.\n", - "type" : "string" - }, - "tablet" : { - "type" : "boolean", - "default" : 1, - "optional" : 1, - "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)." - }, - "usb[n]" : { - "format" : { - "host" : { - "format" : "pve-qm-usb-device", - "type" : "string", - "format_description" : "HOSTUSBDEVICE|spice", - "description" : "The Host USB device or port or the value spice", - "default_key" : 1 + "type" : "integer" }, - "usb3" : { + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "Specifies whether if given host option is a USB3 device or port", - "format_description" : "yes|no", - "type" : "boolean" - } - }, - "type" : "string", - "description" : "Configure an USB device (n is 0 to 4). This can be used to\npass-through usb devices to the guest. 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\nThe 'usb3' option determines whether the device is a USB3 device or not (this does currently not work reliably with spice redirection and is then ignored).\n\n", - "optional" : 1 - }, - "smp" : { - "type" : "integer", - "default" : 1, - "minimum" : 1, - "description" : "The number of CPUs. Please use option -sockets instead.", - "optional" : 1 - }, - "hostpci[n]" : { - "format" : "pve-qm-hostpci", - "type" : "string", - "optional" : 1, - "description" : "Map host pci devices. HOSTPCIDEVICE syntax is:\n\n'bus:dev.func' (hexadecimal numbers)\n\nYou can us the 'lspci' command to list existing pci devices.\n\nThe 'rombar' option determines whether or not the device's ROM will be visible in the guest's memory map (default is 'on').\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\nExperimental: user reported problems with this option.\n" - }, - "kvm" : { - "type" : "boolean", - "default" : 1, - "optional" : 1, - "description" : "Enable/disable KVM hardware virtualization." - }, - "node" : { - "description" : "The cluster node name.", - "type" : "string", - "format" : "pve-node" - }, - "ostype" : { - "type" : "string", - "enum" : [ - "other", - "wxp", - "w2k", - "w2k3", - "w2k8", - "wvista", - "win7", - "win8", - "l24", - "l26", - "solaris" - ], - "description" : "Used to enable special optimization/features for specific\noperating systems:\n\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\nl24 => Linux 2.4 Kernel\nl26 => Linux 2.6/3.X Kernel\nsolaris => solaris/opensolaris/openindiania kernel\n\nother|l24|l26|solaris ... no special behaviour\nwxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch\n", - "optional" : 1 - }, - "unused[n]" : { - "format" : "pve-volume-id", - "type" : "string", - "optional" : 1, - "description" : "Reference to unused volumes." - }, - "template" : { - "type" : "boolean", - "default" : 0, - "description" : "Enable/disable Template.", - "optional" : 1 - }, - "watchdog" : { - "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)", - "optional" : 1, - "type" : "string", - "format" : "pve-qm-watchdog" - }, - "args" : { - "type" : "string", - "description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n", - "optional" : 1 - }, - "protection" : { - "description" : "Sets the protection flag of the VM. This will prevent the remove operation.", - "optional" : 1, - "type" : "boolean", - "default" : 0 - }, - "reboot" : { - "optional" : 1, - "description" : "Allow reboot. If set to '0' the VM exit on reboot.", - "type" : "boolean", - "default" : 1 - }, - "hotplug" : { - "optional" : 1, - "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'.", - "type" : "string", - "default" : "network,disk,usb", - "format" : "pve-hotplug-features" - }, - "machine" : { - "description" : "Specific the Qemu machine type.", - "optional" : 1, - "maxLength" : 40, - "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?)", - "type" : "string" - }, - "migrate_speed" : { - "type" : "integer", - "default" : 0, - "minimum" : 0, - "optional" : 1, - "description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit." - }, - "background_delay" : { - "type" : "integer", - "maximum" : 30, - "minimum" : 1, - "optional" : 1, - "description" : "Time to wait for the task to finish. We return 'null' if the task finish within that time." - }, - "sata[n]" : { - "type" : "string", - "format" : { - "snapshot" : { - "type" : "boolean", - "format_description" : "on|off", - "description" : "Whether the drive should be included when making snapshots.", - "optional" : 1 + "type" : "integer" + }, + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" }, "cache" : { - "type" : "string", - "format_description" : "none|writethrough|writeback|unsafe|directsync", - "optional" : 1, "description" : "The drive's cache mode", "enum" : [ "none", @@ -7394,494 +8414,358 @@ var pveapi = [ "writeback", "unsafe", "directsync" - ] - }, - "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", - "format_description" : "bps", + ], "optional" : 1, - "type" : "integer" + "type" : "string" }, - "mbps_wr_max" : { - "type" : "number", + "cyls" : { + "description" : "Force the drive's physical geometry to have a specific cylinder count.", "optional" : 1, - "format_description" : "mbps", - "description" : "Maximum unthrottled write pool speed in megabytes per second." + "type" : "integer" }, - "iops_rd" : { - "type" : "integer", + "detect_zeroes" : { + "description" : "Controls whether to detect and try to optimize writes of zeroes.", "optional" : 1, - "format_description" : "iops", - "description" : "Maximum read I/O speed in operations per second." + "type" : "boolean" }, - "werror" : { - "description" : "Write error action.", - "optional" : 1, - "format_description" : "enospc|ignore|report|stop", + "discard" : { + "description" : "Controls whether to pass discard/trim requests to the underlying storage.", "enum" : [ - "enospc", "ignore", - "report", - "stop" + "on" ], + "optional" : 1, "type" : "string" }, - "volume" : { - "alias" : "file" - }, - "iops_rd_max" : { - "type" : "integer", - "optional" : 1, - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", - "format_description" : "iops" + "file" : { + "default_key" : 1, + "description" : "The drive's backing volume.", + "format" : "pve-volume-id-or-qm-path", + "format_description" : "volume", + "type" : "string" }, - "trans" : { - "type" : "string", + "format" : { + "description" : "The drive's backing file's data format.", "enum" : [ - "none", - "lba", - "auto" + "raw", + "cow", + "qcow", + "qed", + "qcow2", + "vmdk", + "cloop" ], - "format_description" : "none|lba|auto", - "description" : "Force disk geometry bios translation mode.", - "optional" : 1 + "optional" : 1, + "type" : "string" }, - "rerror" : { - "type" : "string", - "description" : "Read error action.", + "heads" : { + "description" : "Force the drive's physical geometry to have a specific head count.", "optional" : 1, - "format_description" : "ignore|report|stop", - "enum" : [ - "ignore", - "report", - "stop" - ] + "type" : "integer" }, "iops" : { - "type" : "integer", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", - "description" : "Maximum r/w I/O speed in operations per second.", - "optional" : 1 + "optional" : 1, + "type" : "integer" }, - "bps_wr" : { - "type" : "integer", - "description" : "Maximum write speed speed in bytes per second.", - "format_description" : "bps", - "optional" : 1 + "iops_max" : { + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" }, - "mbps" : { - "type" : "number", - "description" : "Maximum r/w speed speed in megabytes per second.", - "format_description" : "mbps", - "optional" : 1 + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" }, - "file" : { - "default_key" : 1, - "description" : "The drive's backing volume.", - "format_description" : "volume", - "type" : "string", - "format" : "pve-volume-id-or-qm-path" + "iops_rd" : { + "description" : "Maximum read I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" }, - "serial" : { - "maxLength" : 60, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "serial", - "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", - "format" : "urlencoded", - "type" : "string" + "type" : "integer" }, - "mbps_max" : { - "format_description" : "mbps", - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", + "format_description" : "iops", "optional" : 1, - "type" : "number" + "type" : "integer" }, - "discard" : { - "enum" : [ - "ignore", - "on" - ], + "iops_wr" : { + "description" : "Maximum write I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "description" : "Controls whether to pass discard/trim requests to the underlying storage.", - "format_description" : "ignore|on", - "type" : "string" + "type" : "integer" }, - "iops_max" : { - "type" : "integer", + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", - "format_description" : "iops" + "type" : "integer" }, - "aio" : { - "type" : "string", - "enum" : [ - "native", - "threads" - ], + "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", + "format_description" : "iops", "optional" : 1, - "format_description" : "native|threads", - "description" : "AIO type to use." + "type" : "integer" }, - "mbps_rd_max" : { + "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", - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "optional" : 1, "type" : "number" }, - "iops_wr_max" : { + "mbps_max" : { + "description" : "Maximum unthrottled r/w pool in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "format_description" : "iops", - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", - "type" : "integer" + "type" : "number" }, - "size" : { - "type" : "string", - "format" : "disk-size", + "mbps_rd" : { + "description" : "Maximum read speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Disk size. This is purely informational and has no effect." + "type" : "number" }, - "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "mbps_rd_max" : { + "description" : "Maximum unthrottled read pool in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "format_description" : "bps", - "type" : "integer" + "type" : "number" }, - "backup" : { - "type" : "boolean", - "description" : "Whether the drive should be included when making backups.", + "mbps_wr" : { + "description" : "Maximum write speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "format_description" : "on|off" - }, - "detect_zeroes" : { - "type" : "boolean", - "description" : "Controls whether to detect and try to optimize writes of zeroes.", - "optional" : 1 + "type" : "number" }, - "iops_wr" : { - "type" : "integer", + "mbps_wr_max" : { + "description" : "Maximum unthrottled write pool in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Maximum write I/O speed in operations per second.", - "format_description" : "iops" + "type" : "number" }, "media" : { - "format_description" : "cdrom|disk", - "optional" : 1, + "default" : "disk", "description" : "The drive's media type.", "enum" : [ "cdrom", "disk" ], - "default" : "disk", + "optional" : 1, "type" : "string" }, - "format" : { - "description" : "The drive's backing file's data format.", - "format_description" : "drive format", + "queues" : { + "description" : "Number of queues.", + "minimum" : 2, "optional" : 1, - "enum" : [ - "raw", - "cow", - "qcow", - "qed", - "qcow2", - "vmdk", - "cloop" - ], - "type" : "string" + "type" : "integer" }, - "cyls" : { - "format_description" : "count", + "secs" : { + "description" : "Force the drive's physical geometry to have a specific sector count.", "optional" : 1, - "description" : "Force the drive's physical geometry to have a specific cylinder count.", "type" : "integer" }, - "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "serial" : { + "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", + "format" : "urlencoded", + "format_description" : "serial", + "maxLength" : 60, "optional" : 1, - "format_description" : "mbps", - "type" : "number" + "type" : "string" }, - "mbps_rd" : { - "type" : "number", + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", "optional" : 1, - "format_description" : "mbps", - "description" : "Maximum read speed speed in megabytes per second." + "type" : "string" }, - "heads" : { - "description" : "Force the drive's physical geometry to have a specific head count.", + "snapshot" : { + "description" : "Whether the drive should be included when making snapshots.", "optional" : 1, - "format_description" : "count", - "type" : "integer" + "type" : "boolean" }, - "secs" : { - "type" : "integer", + "trans" : { + "description" : "Force disk geometry bios translation mode.", + "enum" : [ + "none", + "lba", + "auto" + ], "optional" : 1, - "description" : "Force the drive's physical geometry to have a specific sector count.", - "format_description" : "count" - } - }, - "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).", - "optional" : 1 - }, - "bootdisk" : { - "type" : "string", - "format" : "pve-qm-bootdisk", - "pattern" : "(ide|sata|scsi|virtio)\\d+", - "optional" : 1, - "description" : "Enable booting from specified disk." - }, - "migrate_downtime" : { - "minimum" : 0, - "type" : "number", - "default" : 0.1, - "description" : "Set maximum tolerated downtime (in seconds) for migrations.", - "optional" : 1 - }, - "cores" : { - "minimum" : 1, - "type" : "integer", - "default" : 1, - "optional" : 1, - "description" : "The number of cores per socket." - }, - "net[n]" : { - "description" : "Specify network devices.\n\nMODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3\n\nXX:XX:XX:XX:XX:XX should be an unique MAC address. This is\nautomatically generated if not specified.\n\nThe bridge parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called 'vmbr0'.\n\nOption 'rate' is used to limit traffic bandwidth from and to this interface. It is specified as floating point number, unit is 'Megabytes per second'.\n\nIf you specify no bridge, we create a kvm 'user' (NATed) network device, which provides DHCP and DNS services. The following addresses are used:\n\n10.0.2.2 Gateway\n10.0.2.3 DNS Server\n10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n\n", + "type" : "string" + }, + "volume" : { + "alias" : "file" + }, + "werror" : { + "description" : "Write error action.", + "enum" : [ + "enospc", + "ignore", + "report", + "stop" + ], + "optional" : 1, + "type" : "string" + } + }, "optional" : 1, "type" : "string", - "format" : "pve-qm-net" - }, - "freeze" : { - "type" : "boolean", - "optional" : 1, - "description" : "Freeze CPU at startup (use 'c' monitor command to start execution)." + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, - "keyboard" : { - "optional" : 1, - "description" : "Keybord layout for vnc server. Default is read from the datacenter configuration file.", + "scsihw" : { + "default" : "lsi", + "description" : "SCSI controller model", "enum" : [ - "en-gb", - "de-ch", - "en-us", - "mk", - "fr-be", - "de", - "pt-br", - "sv", - "fr-ch", - "no", - "pt", - "hu", - "sl", - "lt", - "fi", - "it", - "nl", - "is", - "da", - "fr-ca", - "pl", - "fr", - "es", - "ja", - "tr" + "lsi", + "lsi53c810", + "virtio-scsi-pci", + "virtio-scsi-single", + "megasas", + "pvscsi" ], - "default" : "en-us", - "type" : "string" - }, - "digest" : { "optional" : 1, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "maxLength" : 40, "type" : "string" }, - "vcpus" : { - "description" : "Number of hotplugged vcpus.", + "serial[n]" : { + "description" : "Create a serial device inside the VM (n is 0 to 3)", "optional" : 1, - "default" : 0, - "type" : "integer", - "minimum" : 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" }, - "memory" : { - "description" : "Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.", + "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, - "minimum" : 16, "type" : "integer", - "default" : 512 + "typetext" : " (0 - 50000)" }, - "localtime" : { - "type" : "boolean", + "skiplock" : { + "description" : "Ignore locks - only root is allowed to use this option.", "optional" : 1, - "description" : "Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS." - }, - "onboot" : { - "default" : 0, "type" : "boolean", - "description" : "Specifies whether a VM will be started during system bootup.", - "optional" : 1 + "typetext" : "" }, - "description" : { + "smbios1" : { + "description" : "Specify SMBIOS type 1 fields.", + "format" : "pve-qm-smbios1", + "maxLength" : 256, "optional" : 1, - "description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.", - "type" : "string" - }, - "startup" : { - "format" : "pve-startup-order", "type" : "string", - "typetext" : "[[order=]\\d+] [,up=\\d+] [,down=\\d+] ", - "optional" : 1, - "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." + "typetext" : "[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]" }, - "boot" : { - "pattern" : "[acdn]{1,4}", - "description" : "Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).", + "smp" : { + "default" : 1, + "description" : "The number of CPUs. Please use option -sockets instead.", + "minimum" : 1, "optional" : 1, - "default" : "cdn", - "type" : "string" + "type" : "integer", + "typetext" : " (1 - N)" }, - "skiplock" : { + "sockets" : { + "default" : 1, + "description" : "The number of CPU sockets.", + "minimum" : 1, "optional" : 1, - "description" : "Ignore locks - only root is allowed to use this option.", - "type" : "boolean" + "type" : "integer", + "typetext" : " (1 - N)" }, - "name" : { + "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, - "description" : "Set a name for the VM. Only used on the configuration web interface.", - "format" : "dns-name", - "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)" }, - "scsihw" : { - "enum" : [ - "lsi", - "lsi53c810", - "virtio-scsi-pci", - "virtio-scsi-single", - "megasas", - "pvscsi" - ], + "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, - "description" : "scsi controller model", "type" : "string", - "default" : "lsi" - }, - "balloon" : { - "type" : "integer", - "minimum" : 0, - "description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.", - "optional" : 1 + "typetext" : "[[order=]\\d+] [,up=\\d+] [,down=\\d+] " }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "minimum" : 1, - "format" : "pve-vmid", - "type" : "integer" + "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)." }, - "revert" : { + "tdf" : { + "default" : 0, + "description" : "Enable/disable time drift fix.", "optional" : 1, - "description" : "Revert a pending change.", - "format" : "pve-configid-list", - "type" : "string" + "type" : "boolean", + "typetext" : "" }, - "force" : { - "requires" : "delete", + "template" : { + "default" : 0, + "description" : "Enable/disable Template.", + "optional" : 1, "type" : "boolean", - "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 + "typetext" : "" }, - "numa[n]" : { - "description" : "numa topology", + "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" : { - "cpus" : { - "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", - "description" : "CPUs accessing this numa node.", - "format_description" : "id[-id];...", + "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" }, - "memory" : { - "type" : "number", - "optional" : 1, - "description" : "Amount of memory this numa node provides.", - "format_description" : "mb" - }, - "hostnodes" : { - "type" : "string", - "description" : "host numa nodes to use", - "format_description" : "id[-id];...", - "optional" : 1, - "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)" - }, - "policy" : { - "enum" : [ - "preferred", - "bind", - "interleave" - ], + "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, - "format_description" : "preferred|bind|interleave", - "description" : "numa allocation policy.", - "type" : "string" + "type" : "boolean" } - } - }, - "cpu" : { + }, "optional" : 1, - "description" : "Emulated CPU type.", "type" : "string", - "format" : { - "cputype" : { - "type" : "string", - "default" : "kvm64", - "enum" : [ - "486", - "athlon", - "pentium", - "pentium2", - "pentium3", - "coreduo", - "core2duo", - "kvm32", - "kvm64", - "qemu32", - "qemu64", - "phenom", - "Conroe", - "Penryn", - "Nehalem", - "Westmere", - "SandyBridge", - "IvyBridge", - "Haswell", - "Haswell-noTSX", - "Broadwell", - "Broadwell-noTSX", - "Opteron_G1", - "Opteron_G2", - "Opteron_G3", - "Opteron_G4", - "Opteron_G5", - "host" - ], - "format_description" : "cputype", - "description" : "Emulated CPU type.", - "default_key" : 1 - }, - "hidden" : { - "optional" : 1, - "description" : "Do not identify as a KVM virtual machine.", - "type" : "boolean", - "default" : 0 - } - } + "typetext" : "[host=] [,usb3=<1|0>]" }, - "autostart" : { + "vcpus" : { + "default" : 0, + "description" : "Number of hotplugged vcpus.", + "minimum" : 1, "optional" : 1, - "description" : "Automatic restart after crash (currently ignored).", - "type" : "boolean", - "default" : 0 + "type" : "integer", + "typetext" : " (1 - N)" }, "vga" : { - "type" : "string", + "description" : "Select the VGA type.", "enum" : [ "std", "cirrus", @@ -7896,58 +8780,104 @@ var pveapi = [ "qxl4" ], "optional" : 1, - "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." - }, - "startdate" : { - "default" : "now", "type" : "string", - "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'.", - "typetext" : "(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)", - "optional" : 1, - "pattern" : "(now|\\d{4}-\\d{1,2}-\\d{1,2}(T\\d{1,2}:\\d{1,2}:\\d{1,2})?)" - }, - "acpi" : { - "optional" : 1, - "description" : "Enable/disable ACPI.", - "type" : "boolean", - "default" : 1 + "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." }, - "scsi[n]" : { + "virtio[n]" : { + "description" : "Use volume as VIRTIO hard disk (n is 0 to 15).", "format" : { - "secs" : { - "format_description" : "count", - "description" : "Force the drive's physical geometry to have a specific sector count.", + "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" }, - "heads" : { - "type" : "integer", + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "count", - "description" : "Force the drive's physical geometry to have a specific head count." + "type" : "integer" }, - "mbps_rd" : { + "bps_rd" : { + "description" : "Maximum read speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "description" : "Maximum read speed speed in megabytes per second.", - "format_description" : "mbps", - "type" : "number" + "type" : "integer" }, - "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "mbps", - "type" : "number" + "type" : "integer" + }, + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "cache" : { + "description" : "The drive's cache mode", + "enum" : [ + "none", + "writethrough", + "writeback", + "unsafe", + "directsync" + ], + "optional" : 1, + "type" : "string" }, "cyls" : { - "type" : "integer", + "description" : "Force the drive's physical geometry to have a specific cylinder count.", "optional" : 1, - "format_description" : "count", - "description" : "Force the drive's physical geometry to have a specific cylinder count." + "type" : "integer" }, - "format" : { - "type" : "string", + "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, - "format_description" : "drive format", + "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", @@ -7957,237 +8887,204 @@ var pveapi = [ "qcow2", "vmdk", "cloop" - ] - }, - "iops_wr" : { - "format_description" : "iops", + ], "optional" : 1, - "description" : "Maximum write I/O speed in operations per second.", - "type" : "integer" + "type" : "string" }, - "detect_zeroes" : { - "type" : "boolean", + "heads" : { + "description" : "Force the drive's physical geometry to have a specific head count.", "optional" : 1, - "description" : "Controls whether to detect and try to optimize writes of zeroes." + "type" : "integer" }, - "media" : { - "type" : "string", - "default" : "disk", - "format_description" : "cdrom|disk", - "description" : "The drive's media type.", + "iops" : { + "description" : "Maximum r/w I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "enum" : [ - "cdrom", - "disk" - ] + "type" : "integer" }, - "backup" : { - "type" : "boolean", - "description" : "Whether the drive should be included when making backups.", + "iops_max" : { + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", + "format_description" : "iops", "optional" : 1, - "format_description" : "on|off" + "type" : "integer" }, - "bps_rd" : { - "type" : "integer", + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "Maximum read speed speed in bytes per second.", - "format_description" : "bps" + "type" : "integer" }, - "iops_wr_max" : { - "type" : "integer", - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "iops_rd" : { + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", - "optional" : 1 - }, - "size" : { "optional" : 1, - "description" : "Disk size. This is purely informational and has no effect.", - "type" : "string", - "format" : "disk-size" + "type" : "integer" }, - "iothread" : { - "type" : "boolean", + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "Whether to use iothreads for this drive", - "format_description" : "off|on" + "type" : "integer" }, - "iops_max" : { - "type" : "integer", + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second." + "type" : "integer" }, - "mbps_rd_max" : { - "format_description" : "mbps", - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "iops_wr" : { + "description" : "Maximum write I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "type" : "number" + "type" : "integer" }, - "aio" : { - "type" : "string", - "enum" : [ - "native", - "threads" - ], + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "native|threads", - "description" : "AIO type to use." + "type" : "integer" }, - "queues" : { - "minimum" : 2, - "type" : "integer", + "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", + "format_description" : "iops", "optional" : 1, - "format_description" : "nbqueues", - "description" : "Number of queues." + "type" : "integer" }, - "discard" : { - "type" : "string", - "enum" : [ - "ignore", - "on" - ], + "iothread" : { + "description" : "Whether to use iothreads for this drive", "optional" : 1, - "format_description" : "ignore|on", - "description" : "Controls whether to pass discard/trim requests to the underlying storage." + "type" : "boolean" }, - "serial" : { + "mbps" : { + "description" : "Maximum r/w speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "format_description" : "serial", - "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", - "maxLength" : 60, - "type" : "string", - "format" : "urlencoded" + "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", - "optional" : 1, + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", + "optional" : 1, "type" : "number" }, - "file" : { - "description" : "The drive's backing volume.", - "format_description" : "volume", - "default_key" : 1, - "format" : "pve-volume-id-or-qm-path", - "type" : "string" - }, - "mbps" : { - "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", - "description" : "Maximum r/w speed speed in megabytes per second." + "optional" : 1, + "type" : "number" }, - "bps_wr" : { - "format_description" : "bps", - "description" : "Maximum write speed speed in bytes per second.", + "mbps_wr" : { + "description" : "Maximum write speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "type" : "integer" + "type" : "number" }, - "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "mbps_wr_max" : { + "description" : "Maximum unthrottled write pool in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "format_description" : "iops", - "type" : "integer" + "type" : "number" }, - "trans" : { + "media" : { + "default" : "disk", + "description" : "The drive's media type.", "enum" : [ - "none", - "lba", - "auto" + "cdrom", + "disk" ], "optional" : 1, - "description" : "Force disk geometry bios translation mode.", - "format_description" : "none|lba|auto", "type" : "string" }, - "volume" : { - "alias" : "file" + "rerror" : { + "description" : "Read error action.", + "enum" : [ + "ignore", + "report", + "stop" + ], + "optional" : 1, + "type" : "string" }, - "iops_rd_max" : { + "secs" : { + "description" : "Force the drive's physical geometry to have a specific sector count.", "optional" : 1, - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", - "format_description" : "iops", "type" : "integer" }, - "iops_rd" : { - "format_description" : "iops", - "description" : "Maximum read I/O speed in operations per second.", + "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" : "integer" + "type" : "string" }, - "werror" : { - "enum" : [ - "enospc", - "ignore", - "report", - "stop" - ], - "format_description" : "enospc|ignore|report|stop", + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", "optional" : 1, - "description" : "Write error action.", "type" : "string" }, - "cache" : { + "snapshot" : { + "description" : "Whether the drive should be included when making snapshots.", + "optional" : 1, + "type" : "boolean" + }, + "trans" : { + "description" : "Force disk geometry bios translation mode.", "enum" : [ "none", - "writethrough", - "writeback", - "unsafe", - "directsync" + "lba", + "auto" ], - "format_description" : "none|writethrough|writeback|unsafe|directsync", "optional" : 1, - "description" : "The drive's cache mode", "type" : "string" }, - "snapshot" : { - "type" : "boolean", - "optional" : 1, - "description" : "Whether the drive should be included when making snapshots.", - "format_description" : "on|off" - }, - "bps" : { - "type" : "integer", - "optional" : 1, - "description" : "Maximum r/w speed speed in bytes per second.", - "format_description" : "bps" + "volume" : { + "alias" : "file" }, - "mbps_wr_max" : { - "type" : "number", - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "werror" : { + "description" : "Write error action.", + "enum" : [ + "enospc", + "ignore", + "report", + "stop" + ], "optional" : 1, - "format_description" : "mbps" + "type" : "string" } }, - "type" : "string", "optional" : 1, - "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13)." - }, - "delete" : { "type" : "string", - "format" : "pve-configid-list", - "optional" : 1, - "description" : "A list of settings you want to delete." + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, - "shares" : { - "minimum" : 0, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, "type" : "integer", - "maximum" : 50000, - "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", - "optional" : 1 + "typetext" : " (1 - N)" }, - "smbios1" : { - "type" : "string", - "format" : "pve-qm-smbios1", + "watchdog" : { + "description" : "Create a virtual hardware watchdog device.", + "format" : "pve-qm-watchdog", "optional" : 1, - "description" : "Specify SMBIOS type 1 fields.", - "maxLength" : 256 + "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)" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", "permissions" : { "check" : [ "perm", @@ -8206,331 +9103,299 @@ var pveapi = [ ] }, "protected" : 1, - "method" : "POST", - "name" : "update_vm_async", - "returns" : { - "optional" : 1, - "type" : "string" - }, - "description" : "Set virtual machine options (asynchrounous API)." - }, - "GET" : { - "description" : "Get current virtual machine configuration. This does not include pending configuration changes (see 'pending' API).", - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "method" : "GET", - "name" : "vm_config", "proxyto" : "node", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "current" : { - "type" : "boolean", - "default" : 0, - "optional" : 1, - "description" : "Get current values (instead of pending values)." - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1 - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" - } - } - }, "returns" : { - "properties" : { - "digest" : { - "type" : "string", - "description" : "SHA1 digest of configuration file. This can be used to prevent concurrent modifications." - } - }, - "type" : "object" + "type" : "null" } } }, - "text" : "config", - "leaf" : 1 + "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", - "description" : "The cluster node name." + "typetext" : "" }, "vmid" : { - "type" : "integer", + "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "description" : "The (unique) ID of the VM." + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] }, "proxyto" : "node", "returns" : { - "type" : "array", "items" : { "properties" : { "delete" : { - "optional" : 1, "description" : "Indicates a pending delete request if present and not 0. The value 2 indicates a force-delete request.", "maximum" : 2, - "type" : "integer", - "minimum" : 0 + "minimum" : 0, + "optional" : 1, + "type" : "integer" }, "key" : { - "type" : "string", - "description" : "Configuration option name." + "description" : "Configuration option name.", + "type" : "string" }, - "value" : { - "type" : "string", + "pending" : { + "description" : "Pending value.", "optional" : 1, - "description" : "Current value." + "type" : "string" }, - "pending" : { - "type" : "string", + "value" : { + "description" : "Current value.", "optional" : 1, - "description" : "Pending value." + "type" : "string" } }, "type" : "object" - } - }, - "name" : "vm_pending", - "method" : "GET", - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "description" : "Get virtual machine configuration, including pending changes." + }, + "type" : "array" + } } }, + "leaf" : 1, "path" : "/nodes/{node}/qemu/{vmid}/pending", - "text" : "pending", - "leaf" : 1 + "text" : "pending" }, { - "leaf" : 1, - "text" : "unlink", - "path" : "/nodes/{node}/qemu/{vmid}/unlink", "info" : { "PUT" : { "description" : "Unlink/delete disk images.", - "returns" : { - "type" : "null" - }, "method" : "PUT", "name" : "unlink", - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Disk" - ] - ] - }, - "protected" : 1, "parameters" : { + "additionalProperties" : 0, "properties" : { - "idlist" : { - "description" : "A list of disk IDs you want to delete.", - "type" : "string", - "format" : "pve-configid-list" - }, - "vmid" : { - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid", - "description" : "The (unique) ID of the VM." - }, "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" + "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", - "description" : "The cluster node name." + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node" - } - } - }, - { - "path" : "/nodes/{node}/qemu/{vmid}/vncproxy", - "info" : { - "POST" : { "permissions" : { "check" : [ "perm", "/vms/{vmid}", [ - "VM.Console" + "VM.Config.Disk" ] ] }, - "description" : "Creates a TCP VNC proxy connections.", "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" : { - "type" : "integer", + "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "description" : "The (unique) ID of the VM." + "type" : "integer", + "typetext" : " (1 - N)" }, "websocket" : { "description" : "starts websockify instead of vncproxy", "optional" : 1, - "type" : "boolean" - }, - "node" : { - "description" : "The cluster node name.", - "type" : "string", - "format" : "pve-node" + "type" : "boolean", + "typetext" : "" } } }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Console" + ] + ] + }, + "protected" : 1, "returns" : { + "additionalProperties" : 0, "properties" : { - "upid" : { + "cert" : { "type" : "string" }, + "port" : { + "type" : "integer" + }, "ticket" : { "type" : "string" }, - "user" : { + "upid" : { "type" : "string" }, - "port" : { - "type" : "integer" - }, - "cert" : { + "user" : { "type" : "string" } - }, - "additionalProperties" : 0 + } } } }, - "text" : "vncproxy", - "leaf" : 1 + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/vncproxy", + "text" : "vncproxy" }, { - "leaf" : 1, - "text" : "vncwebsocket", "info" : { "GET" : { - "method" : "GET", - "name" : "vncwebsocket", - "returns" : { - "type" : "object", - "properties" : { - "port" : { - "type" : "string" - } - } - }, + "description" : "Opens a weksocket for VNC traffic.", + "method" : "GET", + "name" : "vncwebsocket", "parameters" : { + "additionalProperties" : 0, "properties" : { - "vmid" : { - "description" : "The (unique) ID of the VM.", - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid" + "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", - "maximum" : 5999 + "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" - }, - "node" : { "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, "permissions" : { - "description" : "You also need to pass a valid ticket (vncticket).", "check" : [ "perm", "/vms/{vmid}", [ "VM.Console" ] - ] + ], + "description" : "You also need to pass a valid ticket (vncticket)." }, - "description" : "Opens a weksocket for VNC traffic." + "returns" : { + "properties" : { + "port" : { + "type" : "string" + } + }, + "type" : "object" + } } }, - "path" : "/nodes/{node}/qemu/{vmid}/vncwebsocket" + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/vncwebsocket", + "text" : "vncwebsocket" }, { "info" : { "POST" : { "description" : "Returns a SPICE configuration to connect to the VM.", - "returns" : { + "method" : "POST", + "name" : "spiceproxy", + "parameters" : { + "additionalProperties" : 0, "properties" : { - "tls-port" : { - "type" : "integer" - }, - "password" : { - "type" : "string" - }, - "type" : { - "type" : "string" - }, - "host" : { - "type" : "string" + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, "proxy" : { - "type" : "string" + "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)" } - }, - "additionalProperties" : 1, - "description" : "Returned values can be directly passed to the 'remote-viewer' application." + } }, - "name" : "spiceproxy", - "method" : "POST", - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -8540,62 +9405,60 @@ var pveapi = [ ] ] }, - "parameters" : { - "additionalProperties" : 0, + "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" : { - "format" : "address", - "type" : "string", - "optional" : 1, - "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)." + "type" : "string" }, - "vmid" : { - "format" : "pve-vmid", - "type" : "integer", - "minimum" : 1, - "description" : "The (unique) ID of the VM." + "tls-port" : { + "type" : "integer" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "type" : { "type" : "string" } } - }, - "proxyto" : "node" + } } }, - "path" : "/nodes/{node}/qemu/{vmid}/spiceproxy", "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/spiceproxy", "text" : "spiceproxy" }, { - "text" : "status", - "leaf" : 0, - "path" : "/nodes/{node}/qemu/{vmid}/status", "children" : [ { - "leaf" : 1, - "text" : "current", - "path" : "/nodes/{node}/qemu/{vmid}/status/current", "info" : { "GET" : { - "proxyto" : "node", + "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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", "minimum" : 1, "type" : "integer", - "format" : "pve-vmid" + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, "permissions" : { "check" : [ @@ -8607,68 +9470,83 @@ var pveapi = [ ] }, "protected" : 1, + "proxyto" : "node", "returns" : { "type" : "object" - }, - "name" : "vm_status", - "method" : "GET", - "description" : "Get virtual machine status." + } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/status/current", + "text" : "current" }, { - "text" : "start", - "leaf" : 1, "info" : { "POST" : { + "description" : "Start virtual machine.", "method" : "POST", "name" : "vm_start", - "returns" : { - "type" : "string" - }, - "description" : "Start virtual machine.", - "proxyto" : "node", "parameters" : { + "additionalProperties" : 0, "properties" : { - "skiplock" : { - "type" : "boolean", - "optional" : 1, - "description" : "Ignore locks - only root is allowed to use this option." - }, "machine" : { - "type" : "string", - "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?)", "description" : "Specific the Qemu machine type.", "maxLength" : 40, - "optional" : 1 + "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", + "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", - "format" : "pve-node" + "typetext" : "" }, - "stateuri" : { + "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, - "type" : "string" + "optional" : 1, + "type" : "string", + "typetext" : "" }, "vmid" : { + "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", - "type" : "integer", "minimum" : 1, - "description" : "The (unique) ID of the VM." - }, - "migratedfrom" : { - "description" : "The cluster node name.", - "optional" : 1, - "type" : "string", - "format" : "pve-node" + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -8677,79 +9555,119 @@ var pveapi = [ "VM.PowerMgmt" ] ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" } } }, - "path" : "/nodes/{node}/qemu/{vmid}/status/start" + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/status/start", + "text" : "start" }, { - "path" : "/nodes/{node}/qemu/{vmid}/status/stop", "info" : { "POST" : { - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.PowerMgmt" - ] - ] - }, - "protected" : 1, + "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" : { - "type" : "boolean", "default" : 0, + "description" : "Do not deactivate storage volumes.", "optional" : 1, - "description" : "Do not decativate storage volumes." - }, - "vmid" : { - "minimum" : 1, - "format" : "pve-vmid", - "type" : "integer", - "description" : "The (unique) ID of the VM." + "type" : "boolean", + "typetext" : "" }, "migratedfrom" : { + "description" : "The cluster node name.", "format" : "pve-node", + "optional" : 1, "type" : "string", - "description" : "The cluster node name.", - "optional" : 1 + "typetext" : "" }, "node" : { + "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", - "description" : "The cluster node name." + "typetext" : "" }, "skiplock" : { "description" : "Ignore locks - only root is allowed to use this option.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "timeout" : { + "description" : "Wait maximal timeout seconds.", "minimum" : 0, - "type" : "integer", "optional" : 1, - "description" : "Wait maximal timeout seconds." + "type" : "integer", + "typetext" : " (0 - N)" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.PowerMgmt" + ] + ] }, + "protected" : 1, "proxyto" : "node", - "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", "returns" : { "type" : "string" - }, - "method" : "POST", - "name" : "vm_stop" + } } }, "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", @@ -8761,89 +9679,66 @@ var pveapi = [ }, "protected" : 1, "proxyto" : "node", - "parameters" : { - "properties" : { - "vmid" : { - "description" : "The (unique) ID of the VM.", - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1 - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" - }, - "skiplock" : { - "type" : "boolean", - "description" : "Ignore locks - only root is allowed to use this option.", - "optional" : 1 - } - }, - "additionalProperties" : 0 - }, - "description" : "Reset virtual machine.", - "method" : "POST", - "name" : "vm_reset", "returns" : { "type" : "string" } } }, - "path" : "/nodes/{node}/qemu/{vmid}/status/reset", "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/status/reset", "text" : "reset" }, { - "path" : "/nodes/{node}/qemu/{vmid}/status/shutdown", "info" : { "POST" : { - "returns" : { - "type" : "string" - }, + "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", - "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.", "parameters" : { + "additionalProperties" : 0, "properties" : { - "timeout" : { + "forceStop" : { + "default" : 0, + "description" : "Make sure the VM stops.", "optional" : 1, - "description" : "Wait maximal timeout seconds.", - "minimum" : 0, - "type" : "integer" + "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", - "format" : "pve-node" + "typetext" : "" }, "skiplock" : { - "type" : "boolean", "description" : "Ignore locks - only root is allowed to use this option.", - "optional" : 1 - }, - "forceStop" : { "optional" : 1, - "description" : "Make sure the VM stops.", - "default" : 0, - "type" : "boolean" - }, - "keepActive" : { "type" : "boolean", - "default" : 0, + "typetext" : "" + }, + "timeout" : { + "description" : "Wait maximal timeout seconds.", + "minimum" : 0, "optional" : 1, - "description" : "Do not decativate storage volumes." + "type" : "integer", + "typetext" : " (0 - N)" }, "vmid" : { "description" : "The (unique) ID of the VM.", - "type" : "integer", "format" : "pve-vmid", - "minimum" : 1 + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", "permissions" : { "check" : [ "perm", @@ -8853,21 +9748,46 @@ var pveapi = [ ] ] }, - "protected" : 1 + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } } }, "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/status/shutdown", "text" : "shutdown" }, { - "path" : "/nodes/{node}/qemu/{vmid}/status/suspend", "info" : { "POST" : { "description" : "Suspend virtual machine.", "method" : "POST", "name" : "vm_suspend", - "returns" : { - "type" : "string" + "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" : [ @@ -8880,60 +9800,47 @@ var pveapi = [ }, "protected" : 1, "proxyto" : "node", - "parameters" : { - "properties" : { - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "type" : "integer", - "minimum" : 1 - }, - "skiplock" : { - "type" : "boolean", - "description" : "Ignore locks - only root is allowed to use this option.", - "optional" : 1 - }, - "node" : { - "description" : "The cluster node name.", - "type" : "string", - "format" : "pve-node" - } - }, - "additionalProperties" : 0 + "returns" : { + "type" : "string" } } }, - "text" : "suspend", - "leaf" : 1 + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/status/suspend", + "text" : "suspend" }, { - "text" : "resume", - "leaf" : 1, "info" : { "POST" : { - "proxyto" : "node", + "description" : "Resume virtual machine.", + "method" : "POST", + "name" : "vm_resume", "parameters" : { "additionalProperties" : 0, "properties" : { - "vmid" : { - "minimum" : 1, - "format" : "pve-vmid", - "type" : "integer", - "description" : "The (unique) ID of the VM." - }, - "skiplock" : { + "nocheck" : { "optional" : 1, - "description" : "Ignore locks - only root is allowed to use this option.", - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, - "nocheck" : { + "skiplock" : { + "description" : "Ignore locks - only root is allowed to use this option.", + "optional" : 1, "type" : "boolean", - "optional" : 1 + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -8947,270 +9854,286 @@ var pveapi = [ ] }, "protected" : 1, + "proxyto" : "node", "returns" : { "type" : "string" - }, - "method" : "POST", - "name" : "vm_resume", - "description" : "Resume virtual machine." + } } }, - "path" : "/nodes/{node}/qemu/{vmid}/status/resume" + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/status/resume", + "text" : "resume" } ], "info" : { "GET" : { - "permissions" : { - "user" : "all" - }, "description" : "Directory index", "method" : "GET", "name" : "vmcmdidx", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" }, "vmid" : { - "type" : "integer", + "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "description" : "The (unique) ID of the VM." + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } + }, + "permissions" : { + "user" : "all" }, "proxyto" : "node", "returns" : { "items" : { - "type" : "object", "properties" : { "subdir" : { "type" : "string" } - } + }, + "type" : "object" }, - "type" : "array", "links" : [ { - "rel" : "child", - "href" : "{subdir}" + "href" : "{subdir}", + "rel" : "child" } - ] + ], + "type" : "array" } } - } + }, + "leaf" : 0, + "path" : "/nodes/{node}/qemu/{vmid}/status", + "text" : "status" }, { - "leaf" : 1, - "text" : "sendkey", - "path" : "/nodes/{node}/qemu/{vmid}/sendkey", "info" : { "PUT" : { - "returns" : { - "type" : "null" - }, - "name" : "vm_sendkey", - "method" : "PUT", "description" : "Send key event to virtual machine.", + "method" : "PUT", + "name" : "vm_sendkey", "parameters" : { + "additionalProperties" : 0, "properties" : { - "vmid" : { - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1, - "description" : "The (unique) ID of the VM." - }, "key" : { + "description" : "The key (qemu monitor encoding).", "type" : "string", - "description" : "The key (qemu monitor encoding)." + "typetext" : "" }, "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" + "typetext" : "" }, "skiplock" : { "description" : "Ignore locks - only root is allowed to use this option.", "optional" : 1, - "type" : "boolean" + "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)" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", - "protected" : 1, "permissions" : { "check" : [ "perm", "/vms/{vmid}", [ - "VM.Console" + "VM.Audit" ] ] - } - } - } - }, - { - "text" : "feature", - "leaf" : 1, - "info" : { - "GET" : { - "description" : "Check if feature for virtual machine is available.", - "name" : "vm_feature", - "method" : "GET", + }, + "protected" : 1, + "proxyto" : "node", "returns" : { "properties" : { + "hasFeature" : { + "type" : "boolean" + }, "nodes" : { "items" : { "type" : "string" }, "type" : "array" - }, - "hasFeature" : { - "type" : "boolean" } }, "type" : "object" - }, - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "proxyto" : "node", - "parameters" : { - "properties" : { - "vmid" : { - "description" : "The (unique) ID of the VM.", - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid" - }, - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." - }, - "feature" : { - "type" : "string", - "enum" : [ - "snapshot", - "clone", - "copy" - ], - "description" : "Feature to check." - }, - "snapname" : { - "optional" : 1, - "maxLength" : 40, - "description" : "The name of the snapshot.", - "type" : "string", - "format" : "pve-configid" - } - }, - "additionalProperties" : 0 } } }, - "path" : "/nodes/{node}/qemu/{vmid}/feature" + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/feature", + "text" : "feature" }, { - "path" : "/nodes/{node}/qemu/{vmid}/clone", "info" : { "POST" : { - "returns" : { - "type" : "string" - }, - "name" : "clone_vm", - "method" : "POST", "description" : "Create a copy of virtual machine/template.", - "proxyto" : "node", + "method" : "POST", + "name" : "clone_vm", "parameters" : { "additionalProperties" : 0, "properties" : { - "snapname" : { - "type" : "string", - "format" : "pve-configid", - "maxLength" : 40, - "description" : "The name of the snapshot.", - "optional" : 1 - }, - "full" : { - "optional" : 1, - "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.", - "default" : 0, - "type" : "boolean" - }, - "target" : { - "description" : "Target node. Only allowed if the original VM is on shared storage.", + "description" : { + "description" : "Description for the new VM.", "optional" : 1, - "format" : "pve-node", - "type" : "string" - }, - "pool" : { - "format" : "pve-poolid", "type" : "string", - "description" : "Add the new VM to the specified pool.", - "optional" : 1 + "typetext" : "" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "format" : { + "description" : "Target format for file storage.", + "enum" : [ + "raw", + "qcow2", + "vmdk" + ], + "optional" : 1, + "requires" : "full", "type" : "string" }, - "description" : { - "description" : "Description for the new VM.", + "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.", "optional" : 1, - "type" : "string" + "type" : "boolean", + "typetext" : "" }, "name" : { "description" : "Set a name for the new VM.", - "optional" : 1, "format" : "dns-name", - "type" : "string" + "optional" : 1, + "type" : "string", + "typetext" : "" }, "newid" : { "description" : "VMID for the clone.", - "type" : "integer", "format" : "pve-vmid", - "minimum" : 1 + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" }, - "format" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "requires" : "full", - "enum" : [ - "raw", - "qcow2", - "vmdk" - ], - "description" : "Target format for file storage.", - "optional" : 1 + "typetext" : "" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1 + "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.", - "optional" : 1, "format" : "pve-storage-id", + "optional" : 1, "requires" : "full", - "type" : "string" + "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)" } } }, - "protected" : 1, "permissions" : { "check" : [ "and", @@ -9242,72 +10165,42 @@ var pveapi = [ ] ], "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" }, { - "leaf" : 1, - "text" : "move_disk", - "path" : "/nodes/{node}/qemu/{vmid}/move_disk", "info" : { "POST" : { - "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", + "description" : "Move volume to different storage.", + "method" : "POST", + "name" : "move_vm_disk", "parameters" : { "additionalProperties" : 0, "properties" : { "delete" : { - "type" : "boolean", "default" : 0, "description" : "Delete the original disk after successful copy. By default the original disk is kept as unused disk.", - "optional" : 1 - }, - "format" : { - "type" : "string", - "description" : "Target Format.", "optional" : 1, - "enum" : [ - "raw", - "qcow2", - "vmdk" - ] - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "format" : "pve-vmid", - "type" : "integer", - "minimum" : 1 + "type" : "boolean", + "typetext" : "" }, - "storage" : { - "description" : "Target storage.", - "format" : "pve-storage-id", - "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", + "typetext" : "" }, "disk" : { - "type" : "string", "description" : "The disk you want to move.", "enum" : [ "ide0", @@ -9349,71 +10242,132 @@ var pveapi = [ "sata2", "sata3", "sata4", - "sata5" - ] + "sata5", + "efidisk0" + ], + "type" : "string" }, - "digest" : { - "maxLength" : 40, + "format" : { + "description" : "Target Format.", + "enum" : [ + "raw", + "qcow2", + "vmdk" + ], "optional" : 1, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", "type" : "string" }, "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "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)" } } }, - "description" : "Move volume to different storage.", - "method" : "POST", - "name" : "move_vm_disk", + "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", - "description" : "the task ID." + "description" : "the task ID.", + "type" : "string" } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/move_disk", + "text" : "move_disk" }, { - "text" : "migrate", - "leaf" : 1, - "path" : "/nodes/{node}/qemu/{vmid}/migrate", "info" : { "POST" : { - "proxyto" : "node", + "description" : "Migrate virtual machine. Creates a new migration task.", + "method" : "POST", + "name" : "migrate_vm", "parameters" : { "additionalProperties" : 0, "properties" : { - "vmid" : { - "description" : "The (unique) ID of the VM.", - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid" + "force" : { + "description" : "Allow to migrate VMs which use local devices. Only root may use this option.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, - "online" : { + "migration_network" : { + "description" : "CIDR of the (sub) network that is used for migration.", + "format" : "CIDR", "optional" : 1, - "description" : "Use online/live migration.", - "type" : "boolean" + "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" + "type" : "string", + "typetext" : "" }, - "force" : { - "type" : "boolean", + "online" : { + "description" : "Use online/live migration.", "optional" : 1, - "description" : "Allow to migrate VMs which use local devices. Only root may use this option." + "type" : "boolean", + "typetext" : "" }, "target" : { "description" : "Target node.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -9423,47 +10377,47 @@ var pveapi = [ ] ] }, + "protected" : 1, + "proxyto" : "node", "returns" : { "description" : "the task ID.", "type" : "string" - }, - "name" : "migrate_vm", - "method" : "POST", - "description" : "Migrate virtual machine. Creates a new migration task." + } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/migrate", + "text" : "migrate" }, { "info" : { "POST" : { + "description" : "Execute Qemu monitor commands.", "method" : "POST", "name" : "monitor", - "returns" : { - "type" : "string" - }, - "description" : "Execute Qemu monitor commands.", - "proxyto" : "node", "parameters" : { + "additionalProperties" : 0, "properties" : { + "command" : { + "description" : "The monitor command.", + "type" : "string", + "typetext" : "" + }, "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" - }, - "command" : { - "description" : "The monitor command.", - "type" : "string" + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", - "minimum" : 1, "format" : "pve-vmid", - "type" : "integer" + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -9472,41 +10426,33 @@ var pveapi = [ "VM.Monitor" ] ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" } } }, + "leaf" : 1, "path" : "/nodes/{node}/qemu/{vmid}/monitor", - "text" : "monitor", - "leaf" : 1 + "text" : "monitor" }, { - "leaf" : 1, - "text" : "resize", - "path" : "/nodes/{node}/qemu/{vmid}/resize", "info" : { "PUT" : { - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Disk" - ] - ] - }, - "protected" : 1, + "description" : "Extend volume size.", + "method" : "PUT", + "name" : "resize_vm", "parameters" : { + "additionalProperties" : 0, "properties" : { - "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.", - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1 + "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.", @@ -9550,108 +10496,34 @@ var pveapi = [ "sata2", "sata3", "sata4", - "sata5" + "sata5", + "efidisk0" ], "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" - }, "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" + "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" - } - }, - "additionalProperties" : 0 - }, - "proxyto" : "node", - "description" : "Extend volume size.", - "returns" : { - "type" : "null" - }, - "name" : "resize_vm", - "method" : "PUT" - } - } - }, - { - "info" : { - "POST" : { - "description" : "Snapshot a VM.", - "method" : "POST", - "name" : "snapshot", - "returns" : { - "type" : "string", - "description" : "the task ID." - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Snapshot" - ] - ] - }, - "protected" : 1, - "parameters" : { - "properties" : { - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - }, - "description" : { - "type" : "string", - "description" : "A textual description or comment.", - "optional" : 1 - }, - "vmstate" : { "type" : "boolean", - "optional" : 1, - "description" : "Save the vmstate" - }, - "snapname" : { - "format" : "pve-configid", - "type" : "string", - "maxLength" : 40, - "description" : "The name of the snapshot." + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", - "type" : "integer", "format" : "pve-vmid", - "minimum" : 1 - } - }, - "additionalProperties" : 0 - }, - "proxyto" : "node" - }, - "GET" : { - "proxyto" : "node", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", "minimum" : 1, "type" : "integer", - "format" : "pve-vmid" + "typetext" : " (1 - N)" } } }, @@ -9660,66 +10532,56 @@ var pveapi = [ "perm", "/vms/{vmid}", [ - "VM.Audit" + "VM.Config.Disk" ] ] }, "protected" : 1, + "proxyto" : "node", "returns" : { - "links" : [ - { - "href" : "{name}", - "rel" : "child" - } - ], - "type" : "array", - "items" : { - "type" : "object", - "properties" : {} - } - }, - "name" : "snapshot_list", - "method" : "GET", - "description" : "List all snapshots." + "type" : "null" + } } }, - "path" : "/nodes/{node}/qemu/{vmid}/snapshot", + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/resize", + "text" : "resize" + }, + { "children" : [ { "children" : [ { - "text" : "config", - "leaf" : 1, "info" : { "GET" : { + "description" : "Get snapshot configuration", "method" : "GET", "name" : "get_snapshot_config", - "proxyto" : "node", "parameters" : { "additionalProperties" : 0, "properties" : { - "vmid" : { - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid", - "description" : "The (unique) ID of the VM." + "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", - "format" : "pve-configid" + "typetext" : "" }, - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } } }, - "returns" : { - "type" : "object" - }, "permissions" : { "check" : [ "perm", @@ -9729,86 +10591,97 @@ var pveapi = [ ] ] }, - "description" : "Get snapshot configuration" + "proxyto" : "node", + "returns" : { + "type" : "object" + } }, "PUT" : { "description" : "Update snapshot metadata.", - "returns" : { - "type" : "null" - }, - "name" : "update_snapshot_config", "method" : "PUT", - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Snapshot" - ] - ] - }, + "name" : "update_snapshot_config", "parameters" : { + "additionalProperties" : 0, "properties" : { - "vmid" : { - "description" : "The (unique) ID of the VM.", - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1 + "description" : { + "description" : "A textual description or comment.", + "optional" : 1, + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" - }, - "description" : { - "type" : "string", - "description" : "A textual description or comment.", - "optional" : 1 + "typetext" : "" }, "snapname" : { "description" : "The name of the snapshot.", + "format" : "pve-configid", "maxLength" : 40, "type" : "string", - "format" : "pve-configid" + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Snapshot" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } } }, - "path" : "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config" + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config", + "text" : "config" }, { - "leaf" : 1, - "text" : "rollback", "info" : { "POST" : { - "proxyto" : "node", + "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", - "description" : "The cluster node name." + "typetext" : "" }, "snapname" : { - "type" : "string", + "description" : "The name of the snapshot.", "format" : "pve-configid", "maxLength" : 40, - "description" : "The name of the snapshot." + "type" : "string", + "typetext" : "" }, "vmid" : { - "type" : "integer", + "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "description" : "The (unique) ID of the VM." + "type" : "integer", + "typetext" : " (1 - N)" } } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -9818,65 +10691,55 @@ var pveapi = [ ] ] }, + "protected" : 1, + "proxyto" : "node", "returns" : { "description" : "the task ID.", "type" : "string" - }, - "method" : "POST", - "name" : "rollback", - "description" : "Rollback VM state to specified snapshot." + } } }, - "path" : "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}/rollback" + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}/rollback", + "text" : "rollback" } ], - "path" : "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}", "info" : { - "GET" : { + "DELETE" : { + "description" : "Delete a VM snapshot.", + "method" : "DELETE", + "name" : "delsnapshot", "parameters" : { + "additionalProperties" : 0, "properties" : { - "snapname" : { - "format" : "pve-configid", - "type" : "string", - "description" : "The name of the snapshot.", - "maxLength" : 40 + "force" : { + "description" : "For removal from config file, even if removing disk snapshots fails.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" + }, + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "type" : "string", + "typetext" : "" }, "vmid" : { - "type" : "integer", + "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "description" : "The (unique) ID of the VM." - } - }, - "additionalProperties" : 0 - }, - "returns" : { - "type" : "array", - "items" : { - "properties" : {}, - "type" : "object" - }, - "links" : [ - { - "rel" : "child", - "href" : "{cmd}" + "type" : "integer", + "typetext" : " (1 - N)" } - ] - }, - "name" : "snapshot_cmd_idx", - "method" : "GET", - "permissions" : { - "user" : "all" + } }, - "description" : "" - }, - "DELETE" : { - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -9886,81 +10749,185 @@ var pveapi = [ ] ] }, + "protected" : 1, "proxyto" : "node", + "returns" : { + "description" : "the task ID.", + "type" : "string" + } + }, + "GET" : { + "description" : "", + "method" : "GET", + "name" : "snapshot_cmd_idx", "parameters" : { "additionalProperties" : 0, "properties" : { - "vmid" : { - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid", - "description" : "The (unique) ID of the VM." - }, - "force" : { - "type" : "boolean", - "optional" : 1, - "description" : "For removal from config file, even if removing disk snapshots fails." + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, "snapname" : { - "type" : "string", + "description" : "The name of the snapshot.", "format" : "pve-configid", "maxLength" : 40, - "description" : "The name of the snapshot." + "type" : "string", + "typetext" : "" }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } } }, - "description" : "Delete a VM snapshot.", + "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" : "string", - "description" : "the task ID." + "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)" }, - "method" : "DELETE", - "name" : "delsnapshot" + "vmstate" : { + "description" : "Save the vmstate", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + } } }, - "leaf" : 0, - "text" : "{snapname}" - } - ], - "text" : "snapshot", - "leaf" : 0 - }, - { - "text" : "template", - "leaf" : 1, - "info" : { - "POST" : { - "description" : "Create a Template.", - "method" : "POST", - "name" : "template", - "returns" : { - "type" : "null" - }, "permissions" : { "check" : [ "perm", "/vms/{vmid}", [ - "VM.Allocate" + "VM.Snapshot" ] - ], - "description" : "You need 'VM.Allocate' permissions on /vms/{vmid}" + ] }, "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" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" - }, "disk" : { - "optional" : 1, "description" : "If you want to convert only 1 disk to base image.", "enum" : [ "ide0", @@ -10002,297 +10969,484 @@ var pveapi = [ "sata2", "sata3", "sata4", - "sata5" + "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", - "type" : "integer", "minimum" : 1, - "description" : "The (unique) ID of the VM." + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Allocate" + ] + ], + "description" : "You need 'VM.Allocate' permissions on /vms/{vmid}" }, - "proxyto" : "node" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } } }, - "path" : "/nodes/{node}/qemu/{vmid}/template" + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/template", + "text" : "template" } ], - "text" : "{vmid}", - "leaf" : 0 + "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" : { - "POST" : { - "returns" : { - "type" : "string" + "GET" : { + "description" : "Virtual machine index (per node).", + "method" : "GET", + "name" : "vmlist", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "full" : { + "description" : "Determine the full status of active VMs.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } }, - "name" : "create_vm", - "method" : "POST", + "permissions" : { + "description" : "Only list VMs 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 virtual machine.", + "method" : "POST", + "name" : "create_vm", "parameters" : { "additionalProperties" : 0, "properties" : { - "memory" : { - "description" : "Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.", + "acpi" : { + "default" : 1, + "description" : "Enable/disable ACPI.", "optional" : 1, - "minimum" : 16, - "type" : "integer", - "default" : 512 + "type" : "boolean", + "typetext" : "" }, - "boot" : { - "pattern" : "[acdn]{1,4}", + "agent" : { + "default" : 0, + "description" : "Enable/disable Qemu GuestAgent.", "optional" : 1, - "description" : "Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).", - "default" : "cdn", - "type" : "string" + "type" : "boolean", + "typetext" : "" }, - "startup" : { + "archive" : { + "description" : "The backup file.", + "maxLength" : 255, "optional" : 1, - "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.", - "typetext" : "[[order=]\\d+] [,up=\\d+] [,down=\\d+] ", "type" : "string", - "format" : "pve-startup-order" + "typetext" : "" }, - "onboot" : { - "default" : 0, - "type" : "boolean", + "args" : { + "description" : "Arbitrary arguments passed to kvm.", "optional" : 1, - "description" : "Specifies whether a VM will be started during system bootup." - }, - "localtime" : { - "type" : "boolean", - "description" : "Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.", - "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" }, - "description" : { + "autostart" : { + "default" : 0, + "description" : "Automatic restart after crash (currently ignored).", "optional" : 1, - "description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.", - "type" : "string" - }, - "balloon" : { - "type" : "integer", - "minimum" : 0, - "description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.", - "optional" : 1 - }, - "name" : { - "format" : "dns-name", - "type" : "string", - "description" : "Set a name for the VM. Only used on the configuration web interface.", - "optional" : 1 + "type" : "boolean", + "typetext" : "" }, - "scsihw" : { - "type" : "string", - "default" : "lsi", - "description" : "scsi controller model", + "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)" + }, + "bios" : { + "default" : "seabios", + "description" : "Select BIOS implementation.", "enum" : [ - "lsi", - "lsi53c810", - "virtio-scsi-pci", - "virtio-scsi-single", - "megasas", - "pvscsi" - ] + "seabios", + "ovmf" + ], + "optional" : 1, + "type" : "string" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1 + "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" }, - "numa[n]" : { + "bootdisk" : { + "description" : "Enable booting from specified disk.", + "format" : "pve-qm-bootdisk", "optional" : 1, - "description" : "numa topology", - "format" : { - "cpus" : { - "description" : "CPUs accessing this numa node.", - "format_description" : "id[-id];...", - "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", - "type" : "string" - }, - "memory" : { - "optional" : 1, - "format_description" : "mb", - "description" : "Amount of memory this numa node provides.", - "type" : "number" - }, - "hostnodes" : { - "type" : "string", - "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", - "format_description" : "id[-id];...", - "optional" : 1, - "description" : "host numa nodes to use" - }, - "policy" : { - "type" : "string", - "enum" : [ - "preferred", - "bind", - "interleave" - ], - "description" : "numa allocation policy.", - "optional" : 1, - "format_description" : "preferred|bind|interleave" - } - }, + "pattern" : "(ide|sata|scsi|virtio)\\d+", "type" : "string" }, - "force" : { + "cdrom" : { + "description" : "This is an alias for option -ide2", + "format" : "pve-qm-ide", "optional" : 1, - "description" : "Allow to overwrite existing VM.", - "requires" : "archive", - "type" : "boolean" + "type" : "string", + "typetext" : "" }, - "autostart" : { - "default" : 0, - "type" : "boolean", + "cores" : { + "default" : 1, + "description" : "The number of cores per socket.", + "minimum" : 1, "optional" : 1, - "description" : "Automatic restart after crash (currently ignored)." + "type" : "integer", + "typetext" : " (1 - N)" }, "cpu" : { - "optional" : 1, "description" : "Emulated CPU type.", - "type" : "string", "format" : { - "hidden" : { - "default" : 0, - "type" : "boolean", - "optional" : 1, - "description" : "Do not identify as a KVM virtual machine." - }, "cputype" : { - "type" : "string", "default" : "kvm64", + "default_key" : 1, + "description" : "Emulated CPU type.", "enum" : [ "486", "athlon", - "pentium", - "pentium2", - "pentium3", - "coreduo", + "Broadwell", + "Broadwell-noTSX", + "Conroe", "core2duo", + "coreduo", + "Haswell", + "Haswell-noTSX", + "host", + "IvyBridge", "kvm32", "kvm64", - "qemu32", - "qemu64", - "phenom", - "Conroe", - "Penryn", "Nehalem", - "Westmere", - "SandyBridge", - "IvyBridge", - "Haswell", - "Haswell-noTSX", - "Broadwell", - "Broadwell-noTSX", "Opteron_G1", "Opteron_G2", "Opteron_G3", "Opteron_G4", "Opteron_G5", - "host" + "Penryn", + "pentium", + "pentium2", + "pentium3", + "phenom", + "qemu32", + "qemu64", + "SandyBridge", + "Westmere" ], - "description" : "Emulated CPU type.", - "format_description" : "cputype", - "default_key" : 1 + "type" : "string" + }, + "hidden" : { + "default" : 0, + "description" : "Do not identify as a KVM virtual machine.", + "optional" : 1, + "type" : "boolean" } - } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[cputype=] [,hidden=<1|0>]" }, - "acpi" : { - "description" : "Enable/disable ACPI.", + "cpulimit" : { + "default" : 0, + "description" : "Limit of CPU usage.", + "maximum" : 128, + "minimum" : 0, "optional" : 1, - "default" : 1, - "type" : "boolean" + "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." }, - "startdate" : { + "cpuunits" : { + "default" : 1024, + "description" : "CPU weight for a VM.", + "maximum" : 500000, + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - 500000)", + "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.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0." + }, + "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", - "default" : "now", - "typetext" : "(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)", - "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'.", + "typetext" : "" + }, + "force" : { + "description" : "Allow to overwrite existing VM.", + "optional" : 1, + "requires" : "archive", + "type" : "boolean", + "typetext" : "" + }, + "freeze" : { + "description" : "Freeze CPU at startup (use 'c' monitor command to start execution).", "optional" : 1, - "pattern" : "(now|\\d{4}-\\d{1,2}-\\d{1,2}(T\\d{1,2}:\\d{1,2}:\\d{1,2})?)" + "type" : "boolean", + "typetext" : "" }, - "vga" : { + "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>] [,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, - "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.", - "enum" : [ - "std", - "cirrus", - "vmware", - "qxl", - "serial0", - "serial1", - "serial2", - "serial3", - "qxl2", - "qxl3", - "qxl4" - ] + "type" : "string", + "typetext" : "" }, - "scsi[n]" : { - "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).", + "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" : { - "heads" : { - "type" : "integer", + "aio" : { + "description" : "AIO type to use.", + "enum" : [ + "native", + "threads" + ], "optional" : 1, - "description" : "Force the drive's physical geometry to have a specific head count.", - "format_description" : "count" + "type" : "string" }, - "mbps_rd" : { - "type" : "number", - "format_description" : "mbps", - "description" : "Maximum read speed speed in megabytes per second.", - "optional" : 1 + "backup" : { + "description" : "Whether the drive should be included when making backups.", + "optional" : 1, + "type" : "boolean" }, - "secs" : { - "type" : "integer", - "description" : "Force the drive's physical geometry to have a specific sector count.", + "bps" : { + "description" : "Maximum r/w speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "format_description" : "count" + "type" : "integer" }, - "cyls" : { - "type" : "integer", - "format_description" : "count", + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "Force the drive's physical geometry to have a specific cylinder count." + "type" : "integer" }, - "mbps_wr" : { + "bps_rd" : { + "description" : "Maximum read speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "description" : "Maximum write speed speed in megabytes per second.", - "format_description" : "mbps", - "type" : "number" + "type" : "integer" }, - "detect_zeroes" : { + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "Controls whether to detect and try to optimize writes of zeroes.", - "type" : "boolean" + "type" : "integer" }, - "iops_wr" : { - "type" : "integer", + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "format_description" : "iops", - "description" : "Maximum write I/O speed in operations per second." + "type" : "integer" + }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "cache" : { + "description" : "The drive's cache mode", + "enum" : [ + "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" }, - "media" : { + "discard" : { + "description" : "Controls whether to pass discard/trim requests to the underlying storage.", "enum" : [ - "cdrom", - "disk" + "ignore", + "on" ], - "format_description" : "cdrom|disk", "optional" : 1, - "description" : "The drive's media type.", - "type" : "string", - "default" : "disk" + "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", @@ -10302,297 +11456,472 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "drive format", - "description" : "The drive's backing file's data format.", "optional" : 1, "type" : "string" }, - "bps_rd" : { - "type" : "integer", - "description" : "Maximum read speed speed in bytes per second.", + "heads" : { + "description" : "Force the drive's physical geometry to have a specific head count.", "optional" : 1, - "format_description" : "bps" + "type" : "integer" }, - "backup" : { - "description" : "Whether the drive should be included when making backups.", + "iops" : { + "description" : "Maximum r/w I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "format_description" : "on|off", - "type" : "boolean" + "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" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", + "format_description" : "iops", + "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" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", "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", - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "optional" : 1, "type" : "number" }, - "aio" : { - "type" : "string", + "mbps_wr_max" : { + "description" : "Maximum unthrottled write pool in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "AIO type to use.", - "format_description" : "native|threads", + "type" : "number" + }, + "media" : { + "default" : "disk", + "description" : "The drive's media type.", "enum" : [ - "native", - "threads" - ] + "cdrom", + "disk" + ], + "optional" : 1, + "type" : "string" }, - "queues" : { - "minimum" : 2, - "type" : "integer", - "format_description" : "nbqueues", + "model" : { + "description" : "The drive's reported model name, url-encoded, up to 40 bytes long.", + "format" : "urlencoded", + "format_description" : "model", + "maxLength" : 120, "optional" : 1, - "description" : "Number of queues." + "type" : "string" }, - "iops_wr_max" : { - "type" : "integer", - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "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, - "format_description" : "iops" + "type" : "string" }, "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", + "optional" : 1, + "type" : "string" + }, + "snapshot" : { + "description" : "Whether the drive should be included when making snapshots.", + "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_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + }, + "keyboard" : { + "default" : "en-us", + "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.", + "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" : [ + "migrate", + "backup", + "snapshot", + "rollback" + ], + "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" + }, + "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" : "" + }, + "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, - "description" : "Disk size. This is purely informational and has no effect.", - "format" : "disk-size", "type" : "string" }, - "iothread" : { - "type" : "boolean", - "description" : "Whether to use iothreads for this drive", - "format_description" : "off|on", - "optional" : 1 + "e1000" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "mbps" : { - "type" : "number", - "optional" : 1, - "description" : "Maximum r/w speed speed in megabytes per second.", - "format_description" : "mbps" + "e1000-82540em" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", - "optional" : 1, - "format_description" : "bps", - "type" : "integer" + "e1000-82544gc" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "iops" : { - "format_description" : "iops", - "description" : "Maximum r/w I/O speed in operations per second.", - "optional" : 1, - "type" : "integer" + "e1000-82545em" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", - "format_description" : "mbps", + "firewall" : { + "description" : "Whether this interface should be protected by the firewall.", "optional" : 1, - "type" : "number" + "type" : "boolean" }, - "serial" : { - "type" : "string", - "format" : "urlencoded", - "format_description" : "serial", - "optional" : 1, - "maxLength" : 60, - "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long." + "i82551" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "discard" : { - "enum" : [ - "ignore", - "on" - ], - "description" : "Controls whether to pass discard/trim requests to the underlying storage.", - "optional" : 1, - "format_description" : "ignore|on", - "type" : "string" + "i82557b" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "file" : { - "format" : "pve-volume-id-or-qm-path", - "type" : "string", - "format_description" : "volume", - "description" : "The drive's backing volume.", - "default_key" : 1 + "i82559er" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "iops_rd" : { - "type" : "integer", + "link_down" : { + "description" : "Whether this interface should be disconnected (like pulling the plug).", "optional" : 1, - "format_description" : "iops", - "description" : "Maximum read I/O speed in operations per second." + "type" : "boolean" }, - "werror" : { - "enum" : [ - "enospc", - "ignore", - "report", - "stop" - ], + "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, - "format_description" : "enospc|ignore|report|stop", - "description" : "Write error action.", + "pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})", "type" : "string" }, - "trans" : { - "format_description" : "none|lba|auto", - "optional" : 1, - "description" : "Force disk geometry bios translation mode.", + "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" : [ - "none", - "lba", - "auto" + "rtl8139", + "ne2k_pci", + "e1000", + "pcnet", + "virtio", + "ne2k_isa", + "i82551", + "i82557b", + "i82559er", + "vmxnet3", + "e1000-82540em", + "e1000-82544gc", + "e1000-82545em" ], "type" : "string" }, - "volume" : { - "alias" : "file" + "ne2k_isa" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "iops_rd_max" : { - "type" : "integer", + "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, - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", - "format_description" : "iops" + "type" : "integer" }, - "cache" : { - "type" : "string", + "rate" : { + "description" : "Rate limit in mbps (megabytes per second) as floating point number.", + "minimum" : 0, "optional" : 1, - "description" : "The drive's cache mode", - "format_description" : "none|writethrough|writeback|unsafe|directsync", - "enum" : [ - "none", - "writethrough", - "writeback", - "unsafe", - "directsync" - ] + "type" : "number" }, - "snapshot" : { - "type" : "boolean", - "description" : "Whether the drive should be included when making snapshots.", - "format_description" : "on|off", - "optional" : 1 + "rtl8139" : { + "alias" : "macaddr", + "keyAlias" : "model" }, - "mbps_wr_max" : { - "type" : "number", + "tag" : { + "description" : "VLAN tag to apply to packets on this interface.", + "maximum" : 4094, + "minimum" : 1, "optional" : 1, - "description" : "Maximum unthrottled write pool speed in megabytes per second.", - "format_description" : "mbps" + "type" : "integer" }, - "bps" : { - "format_description" : "bps", + "trunks" : { + "description" : "VLAN trunks to pass through this interface.", + "format_description" : "vlanid[;vlanid...]", "optional" : 1, - "description" : "Maximum r/w speed speed in bytes per second.", - "type" : "integer" + "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", + "type" : "string" + }, + "virtio" : { + "alias" : "macaddr", + "keyAlias" : "model" + }, + "vmxnet3" : { + "alias" : "macaddr", + "keyAlias" : "model" } }, - "type" : "string" - }, - "shares" : { - "optional" : 1, - "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", - "minimum" : 0, - "maximum" : 50000, - "default" : 1000, - "type" : "integer" - }, - "smbios1" : { - "description" : "Specify SMBIOS type 1 fields.", - "optional" : 1, - "maxLength" : 256, - "type" : "string", - "format" : "pve-qm-smbios1" - }, - "cores" : { - "type" : "integer", - "default" : 1, - "minimum" : 1, - "description" : "The number of cores per socket.", - "optional" : 1 - }, - "migrate_downtime" : { - "description" : "Set maximum tolerated downtime (in seconds) for migrations.", "optional" : 1, - "minimum" : 0, - "default" : 0.1, - "type" : "number" - }, - "keyboard" : { "type" : "string", - "default" : "en-us", - "enum" : [ - "en-gb", - "de-ch", - "en-us", - "mk", - "fr-be", - "de", - "pt-br", - "sv", - "fr-ch", - "no", - "pt", - "hu", - "sl", - "lt", - "fi", - "it", - "nl", - "is", - "da", - "fr-ca", - "pl", - "fr", - "es", - "ja", - "tr" - ], - "optional" : 1, - "description" : "Keybord layout for vnc server. Default is read from the datacenter configuration file." - }, - "freeze" : { - "type" : "boolean", - "description" : "Freeze CPU at startup (use 'c' monitor command to start execution).", - "optional" : 1 + "typetext" : "[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]" }, - "net[n]" : { - "format" : "pve-qm-net", + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "optional" : 1, - "description" : "Specify network devices.\n\nMODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3\n\nXX:XX:XX:XX:XX:XX should be an unique MAC address. This is\nautomatically generated if not specified.\n\nThe bridge parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called 'vmbr0'.\n\nOption 'rate' is used to limit traffic bandwidth from and to this interface. It is specified as floating point number, unit is 'Megabytes per second'.\n\nIf you specify no bridge, we create a kvm 'user' (NATed) network device, which provides DHCP and DNS services. The following addresses are used:\n\n10.0.2.2 Gateway\n10.0.2.3 DNS Server\n10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n\n" + "typetext" : "" }, - "vcpus" : { - "minimum" : 1, + "numa" : { "default" : 0, - "type" : "integer", - "optional" : 1, - "description" : "Number of hotplugged vcpus." - }, - "pool" : { + "description" : "Enable/disable NUMA.", "optional" : 1, - "description" : "Add the VM to the specified pool.", - "format" : "pve-poolid", - "type" : "string" + "type" : "boolean", + "typetext" : "" }, - "archive" : { - "maxLength" : 255, + "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, - "description" : "The backup file.", - "type" : "string" + "type" : "string", + "typetext" : "cpus= [,hostnodes=] [,memory=] [,policy=]" }, - "hostpci[n]" : { - "description" : "Map host pci devices. HOSTPCIDEVICE syntax is:\n\n'bus:dev.func' (hexadecimal numbers)\n\nYou can us the 'lspci' command to list existing pci devices.\n\nThe 'rombar' option determines whether or not the device's ROM will be visible in the guest's memory map (default is 'on').\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\nExperimental: user reported problems with this option.\n", + "onboot" : { + "default" : 0, + "description" : "Specifies whether a VM will be started during system bootup.", "optional" : 1, - "format" : "pve-qm-hostpci", - "type" : "string" - }, - "kvm" : { - "default" : 1, "type" : "boolean", - "optional" : 1, - "description" : "Enable/disable KVM hardware virtualization." + "typetext" : "" }, "ostype" : { - "type" : "string", + "description" : "Specify guest operating system.", "enum" : [ "other", "wxp", @@ -10606,93 +11935,96 @@ var pveapi = [ "l26", "solaris" ], - "description" : "Used to enable special optimization/features for specific\noperating systems:\n\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\nl24 => Linux 2.4 Kernel\nl26 => Linux 2.6/3.X Kernel\nsolaris => solaris/opensolaris/openindiania kernel\n\nother|l24|l26|solaris ... no special behaviour\nwxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch\n", - "optional" : 1 - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" - }, - "unused[n]" : { - "format" : "pve-volume-id", - "type" : "string", - "description" : "Reference to unused volumes.", - "optional" : 1 - }, - "watchdog" : { - "type" : "string", - "format" : "pve-qm-watchdog", - "optional" : 1, - "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)" - }, - "template" : { - "default" : 0, - "type" : "boolean", - "description" : "Enable/disable Template.", - "optional" : 1 - }, - "reboot" : { - "optional" : 1, - "description" : "Allow reboot. If set to '0' the VM exit on reboot.", - "type" : "boolean", - "default" : 1 - }, - "machine" : { - "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?)", - "description" : "Specific the Qemu machine type.", - "maxLength" : 40, "optional" : 1, - "type" : "string" + "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\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" }, - "hotplug" : { - "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'.", + "parallel[n]" : { + "description" : "Map host parallel devices (n is 0 to 2).", "optional" : 1, + "pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+", "type" : "string", - "default" : "network,disk,usb", - "format" : "pve-hotplug-features" - }, - "protection" : { - "type" : "boolean", - "default" : 0, - "description" : "Sets the protection flag of the VM. This will prevent the remove operation.", - "optional" : 1 + "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" }, - "args" : { - "description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n", + "pool" : { + "description" : "Add the VM to the specified pool.", + "format" : "pve-poolid", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, - "migrate_speed" : { - "minimum" : 0, + "protection" : { "default" : 0, - "type" : "integer", + "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.", "optional" : 1, - "description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit." + "type" : "boolean", + "typetext" : "" }, - "bootdisk" : { - "pattern" : "(ide|sata|scsi|virtio)\\d+", + "reboot" : { + "default" : 1, + "description" : "Allow reboot. If set to '0' the VM exit on reboot.", "optional" : 1, - "description" : "Enable booting from specified disk.", - "type" : "string", - "format" : "pve-qm-bootdisk" + "type" : "boolean", + "typetext" : "" }, "sata[n]" : { - "type" : "string", + "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 speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "bps_rd" : { + "description" : "Maximum read speed in bytes per second.", + "format_description" : "bps", + "optional" : 1, + "type" : "integer" + }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, + "type" : "integer" + }, + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", + "optional" : 1, "type" : "integer" }, - "mbps_wr_max" : { - "format_description" : "mbps", - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "type" : "number" + "type" : "integer" }, "cache" : { + "description" : "The drive's cache mode", "enum" : [ "none", "writethrough", @@ -10700,304 +12032,317 @@ var pveapi = [ "unsafe", "directsync" ], - "format_description" : "none|writethrough|writeback|unsafe|directsync", - "description" : "The drive's cache mode", "optional" : 1, "type" : "string" }, - "snapshot" : { - "format_description" : "on|off", + "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, - "description" : "Whether the drive should be included when making snapshots.", "type" : "boolean" }, - "rerror" : { + "discard" : { + "description" : "Controls whether to pass discard/trim requests to the underlying storage.", "enum" : [ "ignore", - "report", - "stop" + "on" ], - "format_description" : "ignore|report|stop", - "description" : "Read error action.", "optional" : 1, "type" : "string" }, - "trans" : { + "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" : [ - "none", - "lba", - "auto" + "raw", + "cow", + "qcow", + "qed", + "qcow2", + "vmdk", + "cloop" ], - "description" : "Force disk geometry bios translation mode.", - "format_description" : "none|lba|auto", "optional" : 1, "type" : "string" }, - "volume" : { - "alias" : "file" + "heads" : { + "description" : "Force the drive's physical geometry to have a specific head count.", + "optional" : 1, + "type" : "integer" }, - "iops_rd_max" : { - "type" : "integer", + "iops" : { + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", - "optional" : 1 + "optional" : 1, + "type" : "integer" }, - "werror" : { - "format_description" : "enospc|ignore|report|stop", - "description" : "Write error action.", + "iops_max" : { + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", + "format_description" : "iops", "optional" : 1, - "enum" : [ - "enospc", - "ignore", - "report", - "stop" - ], - "type" : "string" + "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" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "Maximum read I/O speed in operations per second.", + "type" : "integer" + }, + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", + "optional" : 1, "type" : "integer" }, - "serial" : { - "format" : "urlencoded", - "type" : "string", + "iops_wr" : { + "description" : "Maximum write I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "format_description" : "serial", - "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", - "maxLength" : 60 + "type" : "integer" + }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, + "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" + }, + "mbps" : { + "description" : "Maximum r/w speed in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" }, "mbps_max" : { - "type" : "number", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", - "format_description" : "mbps" + "type" : "number" }, - "discard" : { + "mbps_rd" : { + "description" : "Maximum read speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "format_description" : "ignore|on", - "description" : "Controls whether to pass discard/trim requests to the underlying storage.", - "enum" : [ - "ignore", - "on" - ], - "type" : "string" + "type" : "number" }, - "file" : { - "type" : "string", - "format" : "pve-volume-id-or-qm-path", - "default_key" : 1, - "format_description" : "volume", - "description" : "The drive's backing volume." + "mbps_rd_max" : { + "description" : "Maximum unthrottled read pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" }, - "mbps" : { + "mbps_wr" : { + "description" : "Maximum write speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Maximum r/w speed speed in megabytes per second.", + "type" : "number" + }, + "mbps_wr_max" : { + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", + "optional" : 1, "type" : "number" }, - "bps_wr" : { - "format_description" : "bps", - "description" : "Maximum write speed speed in bytes per second.", + "media" : { + "default" : "disk", + "description" : "The drive's media type.", + "enum" : [ + "cdrom", + "disk" + ], "optional" : 1, - "type" : "integer" + "type" : "string" }, - "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "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, - "format_description" : "iops", "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" : { - "type" : "string", + "description" : "Disk size. This is purely informational and has no effect.", "format" : "disk-size", + "format_description" : "DiskSize", "optional" : 1, - "description" : "Disk size. This is purely informational and has no effect." + "type" : "string" }, - "iops_wr_max" : { - "type" : "integer", - "format_description" : "iops", + "snapshot" : { + "description" : "Whether the drive should be included when making snapshots.", "optional" : 1, - "description" : "Maximum unthrottled write I/O pool speed in operations per second." + "type" : "boolean" }, - "mbps_rd_max" : { + "trans" : { + "description" : "Force disk geometry bios translation mode.", + "enum" : [ + "none", + "lba", + "auto" + ], "optional" : 1, - "format_description" : "mbps", - "description" : "Maximum unthrottled read pool speed in megabytes per second.", - "type" : "number" + "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_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + }, + "scsi[n]" : { + "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).", + "format" : { "aio" : { - "optional" : 1, "description" : "AIO type to use.", - "format_description" : "native|threads", "enum" : [ "native", "threads" ], - "type" : "string" - }, - "iops_max" : { - "type" : "integer", - "format_description" : "iops", "optional" : 1, - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second." + "type" : "string" }, "backup" : { - "type" : "boolean", - "format_description" : "on|off", "description" : "Whether the drive should be included when making backups.", - "optional" : 1 - }, - "bps_rd" : { - "optional" : 1, - "format_description" : "bps", - "description" : "Maximum read speed speed in bytes per second.", - "type" : "integer" - }, - "format" : { - "enum" : [ - "raw", - "cow", - "qcow", - "qed", - "qcow2", - "vmdk", - "cloop" - ], - "description" : "The drive's backing file's data format.", "optional" : 1, - "format_description" : "drive format", - "type" : "string" + "type" : "boolean" }, - "media" : { - "type" : "string", - "default" : "disk", - "enum" : [ - "cdrom", - "disk" - ], - "description" : "The drive's media type.", + "bps" : { + "description" : "Maximum r/w speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "format_description" : "cdrom|disk" - }, - "detect_zeroes" : { - "type" : "boolean", - "description" : "Controls whether to detect and try to optimize writes of zeroes.", - "optional" : 1 + "type" : "integer" }, - "iops_wr" : { - "format_description" : "iops", - "description" : "Maximum write I/O speed in operations per second.", + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, "type" : "integer" }, - "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "bps_rd" : { + "description" : "Maximum read speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "format_description" : "mbps", - "type" : "number" + "type" : "integer" }, - "cyls" : { - "format_description" : "count", + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "Force the drive's physical geometry to have a specific cylinder count.", "type" : "integer" }, - "secs" : { - "type" : "integer", + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "description" : "Force the drive's physical geometry to have a specific sector count.", - "format_description" : "count" + "type" : "integer" }, - "heads" : { - "description" : "Force the drive's physical geometry to have a specific head count.", + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "count", "type" : "integer" }, - "mbps_rd" : { - "type" : "number", - "format_description" : "mbps", + "cache" : { + "description" : "The drive's cache mode", + "enum" : [ + "none", + "writethrough", + "writeback", + "unsafe", + "directsync" + ], "optional" : 1, - "description" : "Maximum read speed speed in megabytes per second." - } - }, - "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).", - "optional" : 1 - }, - "cdrom" : { - "description" : "This is an alias for option -ide2", - "typetext" : "volume", - "optional" : 1, - "type" : "string", - "format" : "pve-qm-drive" - }, - "tdf" : { - "description" : "Enable/disable time drift fix.", - "optional" : 1, - "type" : "boolean", - "default" : 0 - }, - "serial[n]" : { - "type" : "string", - "pattern" : "(/dev/.+|socket)", - "description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a host serial device (i.e. /dev/ttyS0), or create a unix socket on the host 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\nExperimental: user reported problems with this option.\n", - "optional" : 1 - }, - "sockets" : { - "description" : "The number of CPU sockets.", - "optional" : 1, - "type" : "integer", - "default" : 1, - "minimum" : 1 - }, - "ide[n]" : { - "format" : { - "bps_rd" : { + "type" : "string" + }, + "cyls" : { + "description" : "Force the drive's physical geometry to have a specific cylinder count.", "optional" : 1, - "format_description" : "bps", - "description" : "Maximum read speed speed in bytes per second.", "type" : "integer" }, - "backup" : { + "detect_zeroes" : { + "description" : "Controls whether to detect and try to optimize writes of zeroes.", "optional" : 1, - "format_description" : "on|off", - "description" : "Whether the drive should be included when making backups.", "type" : "boolean" }, - "model" : { - "type" : "string", - "format" : "urlencoded", - "optional" : 1, - "maxLength" : 120, - "description" : "The drive's reported model name, url-encoded, up to 40 bytes long.", - "format_description" : "model" - }, - "media" : { - "type" : "string", - "default" : "disk", + "discard" : { + "description" : "Controls whether to pass discard/trim requests to the underlying storage.", "enum" : [ - "cdrom", - "disk" + "ignore", + "on" ], - "format_description" : "cdrom|disk", - "optional" : 1, - "description" : "The drive's media type." - }, - "iops_wr" : { - "format_description" : "iops", - "description" : "Maximum write I/O speed in operations per second.", "optional" : 1, - "type" : "integer" + "type" : "string" }, - "detect_zeroes" : { - "type" : "boolean", - "description" : "Controls whether to detect and try to optimize writes of zeroes.", - "optional" : 1 + "file" : { + "default_key" : 1, + "description" : "The drive's backing volume.", + "format" : "pve-volume-id-or-qm-path", + "format_description" : "volume", + "type" : "string" }, "format" : { - "type" : "string", + "description" : "The drive's backing file's data format.", "enum" : [ "raw", "cow", @@ -11007,297 +12352,438 @@ var pveapi = [ "vmdk", "cloop" ], - "description" : "The drive's backing file's data format.", - "format_description" : "drive format", - "optional" : 1 + "optional" : 1, + "type" : "string" }, - "cyls" : { - "format_description" : "count", - "description" : "Force the drive's physical geometry to have a specific cylinder count.", + "heads" : { + "description" : "Force the drive's physical geometry to have a specific head count.", "optional" : 1, "type" : "integer" }, - "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", - "format_description" : "mbps", + "iops" : { + "description" : "Maximum r/w I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "type" : "number" + "type" : "integer" }, - "heads" : { - "format_description" : "count", - "description" : "Force the drive's physical geometry to have a specific head count.", + "iops_max" : { + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", + "format_description" : "iops", "optional" : 1, "type" : "integer" }, - "mbps_rd" : { - "type" : "number", - "description" : "Maximum read speed speed in megabytes per second.", - "format_description" : "mbps", - "optional" : 1 - }, - "secs" : { - "type" : "integer", - "description" : "Force the drive's physical geometry to have a specific sector count.", + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "count" + "type" : "integer" }, - "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "iops_rd" : { + "description" : "Maximum read I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "format_description" : "bps", "type" : "integer" }, - "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "mbps", - "type" : "number" + "type" : "integer" }, - "snapshot" : { - "format_description" : "on|off", + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", + "format_description" : "iops", "optional" : 1, - "description" : "Whether the drive should be included when making snapshots.", - "type" : "boolean" + "type" : "integer" }, - "cache" : { - "type" : "string", - "format_description" : "none|writethrough|writeback|unsafe|directsync", - "description" : "The drive's cache mode", + "iops_wr" : { + "description" : "Maximum write I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "enum" : [ - "none", - "writethrough", - "writeback", - "unsafe", - "directsync" - ] + "type" : "integer" }, - "werror" : { + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "enospc|ignore|report|stop", - "description" : "Write error action.", - "enum" : [ - "enospc", - "ignore", - "report", - "stop" - ], - "type" : "string" + "type" : "integer" }, - "iops_rd" : { + "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", - "description" : "Maximum read I/O speed in operations per second.", "optional" : 1, "type" : "integer" }, - "rerror" : { - "type" : "string", - "description" : "Read error action.", + "iothread" : { + "description" : "Whether to use iothreads for this drive", "optional" : 1, - "format_description" : "ignore|report|stop", - "enum" : [ - "ignore", - "report", - "stop" - ] + "type" : "boolean" }, - "trans" : { - "enum" : [ - "none", - "lba", - "auto" - ], + "mbps" : { + "description" : "Maximum r/w speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "format_description" : "none|lba|auto", - "description" : "Force disk geometry bios translation mode.", - "type" : "string" + "type" : "number" }, - "volume" : { - "alias" : "file" + "mbps_max" : { + "description" : "Maximum unthrottled r/w pool in megabytes per second.", + "format_description" : "mbps", + "optional" : 1, + "type" : "number" }, - "iops_rd_max" : { - "type" : "integer", + "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, - "format_description" : "iops", - "description" : "Maximum unthrottled read I/O pool speed in operations per second." + "type" : "number" }, - "mbps" : { + "mbps_wr_max" : { + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, - "description" : "Maximum r/w speed speed in megabytes per second.", "type" : "number" }, - "bps_wr" : { + "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, - "description" : "Maximum write speed speed in bytes per second.", - "format_description" : "bps", "type" : "integer" }, - "iops" : { - "type" : "integer", - "description" : "Maximum r/w I/O speed in operations per second.", + "secs" : { + "description" : "Force the drive's physical geometry to have a specific sector count.", "optional" : 1, - "format_description" : "iops" + "type" : "integer" }, "serial" : { - "format" : "urlencoded", - "type" : "string", "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", + "format" : "urlencoded", "format_description" : "serial", + "maxLength" : 60, "optional" : 1, - "maxLength" : 60 - }, - "discard" : { - "enum" : [ - "ignore", - "on" - ], - "description" : "Controls whether to pass discard/trim requests to the underlying storage.", - "optional" : 1, - "format_description" : "ignore|on", "type" : "string" }, - "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", "optional" : 1, - "format_description" : "mbps", - "type" : "number" - }, - "file" : { - "type" : "string", - "format" : "pve-volume-id-or-qm-path", - "default_key" : 1, - "format_description" : "volume", - "description" : "The drive's backing volume." + "type" : "string" }, - "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "snapshot" : { + "description" : "Whether the drive should be included when making snapshots.", "optional" : 1, - "format_description" : "mbps", - "type" : "number" + "type" : "boolean" }, - "aio" : { - "optional" : 1, - "format_description" : "native|threads", - "description" : "AIO type to use.", + "trans" : { + "description" : "Force disk geometry bios translation mode.", "enum" : [ - "native", - "threads" + "none", + "lba", + "auto" ], - "type" : "string" - }, - "iops_max" : { - "type" : "integer", "optional" : 1, - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", - "format_description" : "iops" + "type" : "string" }, - "size" : { - "type" : "string", - "format" : "disk-size", - "description" : "Disk size. This is purely informational and has no effect.", - "optional" : 1 + "volume" : { + "alias" : "file" }, - "iops_wr_max" : { - "format_description" : "iops", + "werror" : { + "description" : "Write error action.", + "enum" : [ + "enospc", + "ignore", + "report", + "stop" + ], "optional" : 1, - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", - "type" : "integer" + "type" : "string" } }, + "optional" : 1, "type" : "string", - "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3).", - "optional" : 1 + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, - "cpuunits" : { + "scsihw" : { + "default" : "lsi", + "description" : "SCSI controller model", + "enum" : [ + "lsi", + "lsi53c810", + "virtio-scsi-pci", + "virtio-scsi-single", + "megasas", + "pvscsi" + ], "optional" : 1, - "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.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0.", + "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", - "default" : 1000, - "maximum" : 500000 + "typetext" : " (0 - 50000)" }, - "cpulimit" : { + "smbios1" : { + "description" : "Specify SMBIOS type 1 fields.", + "format" : "pve-qm-smbios1", + "maxLength" : 256, "optional" : 1, - "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.", - "minimum" : 0, - "default" : 0, - "type" : "number", - "maximum" : 128 + "type" : "string", + "typetext" : "[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]" }, - "storage" : { + "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+] " + }, + "storage" : { "description" : "Default storage.", "format" : "pve-storage-id", - "type" : "string" + "optional" : 1, + "type" : "string", + "typetext" : "" }, - "unique" : { + "tablet" : { + "default" : 1, + "description" : "Enable/disable the USB tablet device.", + "optional" : 1, "type" : "boolean", - "requires" : "archive", - "description" : "Assign a unique random ethernet address.", - "optional" : 1 + "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)." }, - "numa" : { + "tdf" : { + "default" : 0, + "description" : "Enable/disable time drift fix.", + "optional" : 1, "type" : "boolean", + "typetext" : "" + }, + "template" : { "default" : 0, - "description" : "Enable/disable NUMA.", - "optional" : 1 + "description" : "Enable/disable Template.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, - "lock" : { + "unique" : { + "description" : "Assign a unique random ethernet address.", + "optional" : 1, + "requires" : "archive", + "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, - "description" : "Lock/unlock the VM.", - "enum" : [ - "migrate", - "backup", - "snapshot", - "rollback" - ] + "type" : "integer", + "typetext" : " (1 - N)" }, - "agent" : { + "vga" : { + "description" : "Select the VGA type.", + "enum" : [ + "std", + "cirrus", + "vmware", + "qxl", + "serial0", + "serial1", + "serial2", + "serial3", + "qxl2", + "qxl3", + "qxl4" + ], "optional" : 1, - "description" : "Enable/disable Qemu GuestAgent.", - "type" : "boolean", - "default" : 0 + "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]" : { - "type" : "string", + "description" : "Use volume as VIRTIO hard disk (n is 0 to 15).", "format" : { - "secs" : { - "type" : "integer", - "format_description" : "count", + "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, - "description" : "Force the drive's physical geometry to have a specific sector count." + "type" : "integer" }, - "heads" : { - "type" : "integer", + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "description" : "Force the drive's physical geometry to have a specific head count.", - "format_description" : "count" + "type" : "integer" }, - "mbps_rd" : { - "type" : "number", - "format_description" : "mbps", + "bps_wr" : { + "description" : "Maximum write speed in bytes per second.", + "format_description" : "bps", "optional" : 1, - "description" : "Maximum read speed speed in megabytes per second." + "type" : "integer" }, - "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "mbps", - "type" : "number" + "type" : "integer" }, - "cyls" : { + "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.", - "format_description" : "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" : { - "type" : "string", "description" : "The drive's backing file's data format.", - "optional" : 1, - "format_description" : "drive format", "enum" : [ "raw", "cow", @@ -11306,491 +12792,549 @@ var pveapi = [ "qcow2", "vmdk", "cloop" - ] - }, - "media" : { - "optional" : 1, - "format_description" : "cdrom|disk", - "description" : "The drive's media type.", - "enum" : [ - "cdrom", - "disk" ], - "default" : "disk", + "optional" : 1, "type" : "string" }, - "iops_wr" : { - "format_description" : "iops", + "heads" : { + "description" : "Force the drive's physical geometry to have a specific head count.", "optional" : 1, - "description" : "Maximum write I/O speed in operations per second.", "type" : "integer" }, - "detect_zeroes" : { - "type" : "boolean", + "iops" : { + "description" : "Maximum r/w I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "description" : "Controls whether to detect and try to optimize writes of zeroes." + "type" : "integer" }, - "backup" : { - "type" : "boolean", - "description" : "Whether the drive should be included when making backups.", - "format_description" : "on|off", - "optional" : 1 + "iops_max" : { + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" }, - "bps_rd" : { - "type" : "integer", - "format_description" : "bps", - "description" : "Maximum read speed speed in bytes per second.", - "optional" : 1 + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" }, - "size" : { - "type" : "string", - "format" : "disk-size", + "iops_rd" : { + "description" : "Maximum read I/O in operations per second.", + "format_description" : "iops", "optional" : 1, - "description" : "Disk size. This is purely informational and has no effect." + "type" : "integer" }, - "iothread" : { - "description" : "Whether to use iothreads for this drive", + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "format_description" : "off|on", - "type" : "boolean" + "type" : "integer" }, - "iops_wr_max" : { - "type" : "integer", + "iops_rd_max" : { + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", - "optional" : 1 + "optional" : 1, + "type" : "integer" }, - "mbps_rd_max" : { - "type" : "number", - "description" : "Maximum unthrottled read pool speed in megabytes per second.", - "format_description" : "mbps", - "optional" : 1 + "iops_wr" : { + "description" : "Maximum write I/O in operations per second.", + "format_description" : "iops", + "optional" : 1, + "type" : "integer" }, - "aio" : { - "type" : "string", - "description" : "AIO type to use.", - "format_description" : "native|threads", + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, "optional" : 1, - "enum" : [ - "native", - "threads" - ] + "type" : "integer" }, - "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "iops_wr_max" : { + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, - "discard" : { + "iothread" : { + "description" : "Whether to use iothreads for this drive", "optional" : 1, - "description" : "Controls whether to pass discard/trim requests to the underlying storage.", - "format_description" : "ignore|on", - "enum" : [ - "ignore", - "on" - ], - "type" : "string" + "type" : "boolean" }, - "serial" : { - "format_description" : "serial", + "mbps" : { + "description" : "Maximum r/w speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "maxLength" : 60, - "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", - "format" : "urlencoded", - "type" : "string" + "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", - "optional" : 1, + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", + "optional" : 1, "type" : "number" }, - "file" : { - "type" : "string", - "format" : "pve-volume-id-or-qm-path", - "default_key" : 1, - "description" : "The drive's backing volume.", - "format_description" : "volume" - }, - "bps_wr" : { - "format_description" : "bps", + "mbps_rd" : { + "description" : "Maximum read speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Maximum write speed speed in bytes per second.", - "type" : "integer" + "type" : "number" }, - "mbps" : { - "type" : "number", + "mbps_rd_max" : { + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", - "description" : "Maximum r/w speed speed in megabytes per second.", - "optional" : 1 + "optional" : 1, + "type" : "number" }, - "iops" : { - "type" : "integer", + "mbps_wr" : { + "description" : "Maximum write speed in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "description" : "Maximum r/w I/O speed in operations per second.", - "format_description" : "iops" + "type" : "number" }, - "rerror" : { - "description" : "Read error action.", + "mbps_wr_max" : { + "description" : "Maximum unthrottled write pool in megabytes per second.", + "format_description" : "mbps", "optional" : 1, - "format_description" : "ignore|report|stop", - "enum" : [ - "ignore", - "report", - "stop" - ], - "type" : "string" + "type" : "number" }, - "trans" : { + "media" : { + "default" : "disk", + "description" : "The drive's media type.", "enum" : [ - "none", - "lba", - "auto" + "cdrom", + "disk" ], - "format_description" : "none|lba|auto", - "description" : "Force disk geometry bios translation mode.", "optional" : 1, "type" : "string" }, - "volume" : { - "alias" : "file" - }, - "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", - "optional" : 1, - "format_description" : "iops", - "type" : "integer" - }, - "werror" : { + "rerror" : { + "description" : "Read error action.", "enum" : [ - "enospc", "ignore", "report", "stop" ], - "description" : "Write error action.", - "format_description" : "enospc|ignore|report|stop", "optional" : 1, "type" : "string" }, - "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", - "format_description" : "iops", + "secs" : { + "description" : "Force the drive's physical geometry to have a specific sector count.", "optional" : 1, "type" : "integer" }, - "mbps_wr_max" : { - "type" : "number", + "serial" : { + "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.", + "format" : "urlencoded", + "format_description" : "serial", + "maxLength" : 60, "optional" : 1, - "description" : "Maximum unthrottled write pool speed in megabytes per second.", - "format_description" : "mbps" - }, - "bps" : { - "type" : "integer", - "format_description" : "bps", - "description" : "Maximum r/w speed speed in bytes per second.", - "optional" : 1 + "type" : "string" }, - "cache" : { - "type" : "string", - "enum" : [ - "none", - "writethrough", - "writeback", - "unsafe", - "directsync" - ], - "description" : "The drive's cache mode", + "size" : { + "description" : "Disk size. This is purely informational and has no effect.", + "format" : "disk-size", + "format_description" : "DiskSize", "optional" : 1, - "format_description" : "none|writethrough|writeback|unsafe|directsync" + "type" : "string" }, "snapshot" : { - "optional" : 1, - "format_description" : "on|off", "description" : "Whether the drive should be included when making snapshots.", + "optional" : 1, "type" : "boolean" - } - }, - "description" : "Use volume as VIRTIO hard disk (n is 0 to 15).", - "optional" : 1 - }, - "bios" : { - "optional" : 1, - "description" : "Select BIOS implementation.", - "enum" : [ - "seabios", - "ovmf" - ], - "default" : "seabios", - "type" : "string" - }, - "parallel[n]" : { - "optional" : 1, - "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\nExperimental: user reported problems with this option.\n", - "pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+", - "type" : "string" - }, - "usb[n]" : { - "format" : { - "usb3" : { - "description" : "Specifies whether if given host option is a USB3 device or port", + }, + "trans" : { + "description" : "Force disk geometry bios translation mode.", + "enum" : [ + "none", + "lba", + "auto" + ], "optional" : 1, - "format_description" : "yes|no", - "type" : "boolean" + "type" : "string" }, - "host" : { - "description" : "The Host USB device or port or the value spice", - "format_description" : "HOSTUSBDEVICE|spice", - "default_key" : 1, - "format" : "pve-qm-usb-device", + "volume" : { + "alias" : "file" + }, + "werror" : { + "description" : "Write error action.", + "enum" : [ + "enospc", + "ignore", + "report", + "stop" + ], + "optional" : 1, "type" : "string" } }, - "type" : "string", "optional" : 1, - "description" : "Configure an USB device (n is 0 to 4). This can be used to\npass-through usb devices to the guest. 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\nThe 'usb3' option determines whether the device is a USB3 device or not (this does currently not work reliably with spice redirection and is then ignored).\n\n" + "type" : "string", + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, - "smp" : { + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", "minimum" : 1, - "default" : 1, "type" : "integer", - "description" : "The number of CPUs. Please use option -sockets instead.", - "optional" : 1 + "typetext" : " (1 - N)" }, - "tablet" : { - "optional" : 1, - "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).", - "default" : 1, - "type" : "boolean" - } - } - }, - "proxyto" : "node", - "protected" : 1, - "permissions" : { - "user" : "all", - "description" : "You need 'VM.Allocate' permissions on /vms/{vmid} or on the VM pool /pool/{pool}. For restore (option 'archive'), it is enough if the user has 'VM.Backup' permission and the VM already exists. If you create disks you need 'Datastore.AllocateSpace' on any used storage." - } - }, - "GET" : { - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "full" : { + "watchdog" : { + "description" : "Create a virtual hardware watchdog device.", + "format" : "pve-qm-watchdog", "optional" : 1, - "description" : "Determine the full status of active VMs.", - "type" : "boolean" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" + "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)" } } }, - "proxyto" : "node", - "protected" : 1, "permissions" : { - "description" : "Only list VMs where you have VM.Audit permissons on /vms/.", + "description" : "You need 'VM.Allocate' permissions on /vms/{vmid} or on the VM pool /pool/{pool}. For restore (option 'archive'), it is enough if the user has 'VM.Backup' permission and the VM already exists. If you create disks you need 'Datastore.AllocateSpace' on any used storage.", "user" : "all" }, + "protected" : 1, + "proxyto" : "node", "returns" : { - "links" : [ - { - "rel" : "child", - "href" : "{vmid}" - } - ], - "items" : { - "properties" : {}, - "type" : "object" - }, - "type" : "array" - }, - "name" : "vmlist", - "method" : "GET", - "description" : "Virtual machine index (per node)." + "type" : "string" + } } - } + }, + "leaf" : 0, + "path" : "/nodes/{node}/qemu", + "text" : "qemu" }, { "children" : [ { - "leaf" : 0, - "text" : "{vmid}", "children" : [ { - "leaf" : 1, - "text" : "config", - "path" : "/nodes/{node}/lxc/{vmid}/config", "info" : { + "GET" : { + "description" : "Get container configuration.", + "method" : "GET", + "name" : "vm_config", + "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" : { + "digest" : { + "description" : "SHA1 digest of configuration file. This can be used to prevent concurrent modifications.", + "type" : "string" + } + }, + "type" : "object" + } + }, "PUT" : { + "description" : "Set container options.", + "method" : "PUT", + "name" : "update_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, - "description" : "Attach a console device (/dev/console) to the container." + "type" : "integer", + "typetext" : " (1 - 128)" }, "cpulimit" : { - "minimum" : 0, - "maximum" : 128, - "type" : "number", "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.", - "optional" : 1 + "maximum" : 128, + "minimum" : 0, + "optional" : 1, + "type" : "number", + "typetext" : " (0 - 128)" }, "cpuunits" : { - "minimum" : 0, - "type" : "integer", "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)" + }, + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", "optional" : 1, - "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." + "type" : "string", + "typetext" : "" }, - "net[n]" : { - "description" : "Specifies network interfaces for the container.", + "description" : { + "description" : "Container description. Only used on the configuration web interface.", + "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" : "" + }, + "hostname" : { + "description" : "Set a host name for the container.", + "format" : "dns-name", + "maxLength" : 255, + "optional" : 1, + "type" : "string", + "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" : { - "ip6" : { - "format" : "pve-ipv6-config", + "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", - "description" : "IPv6 address in CIDR format.", + "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" + }, + "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>] [,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, - "format_description" : "IPv6Format/CIDR" + "pattern" : "[-_.\\w\\d]+", + "type" : "string" }, "firewall" : { - "type" : "boolean", + "description" : "Controls whether this interface's firewall rules should be used.", "optional" : 1, - "format_description" : "[1|0]", - "description" : "Controls whether this interface's firewall rules should be used." + "type" : "boolean" }, - "mtu" : { - "type" : "integer", - "minimum" : 64, - "format_description" : "Number", + "gw" : { + "description" : "Default gateway for IPv4 traffic.", + "format" : "ipv4", + "format_description" : "GatewayIPv4", "optional" : 1, - "description" : "Maximum transfer unit of the interface. (lxc.network.mtu)" + "type" : "string" }, "gw6" : { - "optional" : 1, - "format_description" : "GatewayIPv6", "description" : "Default gateway for IPv6 traffic.", "format" : "ipv6", + "format_description" : "GatewayIPv6", + "optional" : 1, "type" : "string" }, "hwaddr" : { - "type" : "string", - "pattern" : "(?^i:(?:[a-f0-9]{2}:){5}[a-f0-9]{2})", - "description" : "Bridge to attach the network device to. (lxc.network.hwaddr)", - "optional" : 1, - "format_description" : "MAC" - }, - "gw" : { - "format_description" : "GatewayIPv4", - "description" : "Default gateway for IPv4 traffic.", + "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", "optional" : 1, - "type" : "string", - "format" : "ipv4" + "pattern" : "(?^i:(?:[a-f0-9]{2}:){5}[a-f0-9]{2})", + "type" : "string" }, "ip" : { - "format" : "pve-ipv4-config", - "type" : "string", "description" : "IPv4 address in CIDR format.", + "format" : "pve-ipv4-config", "format_description" : "IPv4Format/CIDR", - "optional" : 1 + "optional" : 1, + "type" : "string" }, - "tag" : { + "ip6" : { + "description" : "IPv6 address in CIDR format.", + "format" : "pve-ipv6-config", + "format_description" : "IPv6Format/CIDR", "optional" : 1, - "description" : "VLAN tag for this interface.", - "format_description" : "VlanNo", - "minimum" : "2", - "type" : "integer", - "maximum" : "4094" + "type" : "string" }, - "rate" : { - "type" : "number", - "description" : "Apply rate limiting to the interface", - "format_description" : "mbps", - "optional" : 1 + "mtu" : { + "description" : "Maximum transfer unit of the interface. (lxc.network.mtu)", + "minimum" : 64, + "optional" : 1, + "type" : "integer" }, "name" : { - "type" : "string", + "description" : "Name of the network device as seen from inside the container. (lxc.network.name)", + "format_description" : "string", "pattern" : "[-_.\\w\\d]+", - "format_description" : "String", - "description" : "Name of the network device as seen from inside the container. (lxc.network.name)" + "type" : "string" }, - "bridge" : { - "pattern" : "[-_.\\w\\d]+", + "rate" : { + "description" : "Apply rate limiting to the interface", + "format_description" : "mbps", "optional" : 1, - "description" : "Bridge to attach the network device to.", - "format_description" : "vmbr", - "type" : "string" + "type" : "number" }, - "trunks" : { - "type" : "string", + "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...]", - "pattern" : "(?^:\\d+(?:;\\d+)*)" + "optional" : 1, + "pattern" : "(?^:\\d+(?:;\\d+)*)", + "type" : "string" }, "type" : { "description" : "Network interface type.", - "optional" : 1, "enum" : [ "veth" ], + "optional" : 1, "type" : "string" } }, - "type" : "string" - }, - "digest" : { - "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "optional" : 1, - "type" : "string" - }, - "lock" : { - "enum" : [ - "migrate", - "backup", - "snapshot", - "rollback" - ], "optional" : 1, - "description" : "Lock/unlock the VM.", - "type" : "string" - }, - "swap" : { - "minimum" : 0, - "type" : "integer", - "default" : 512, - "description" : "Amount of SWAP for the VM in MB.", - "optional" : 1 + "type" : "string", + "typetext" : "name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]" }, - "description" : { - "description" : "Container description. Only used on the configuration web interface.", - "optional" : 1, - "type" : "string" + "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, - "default" : 0, - "type" : "boolean" - }, - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." + "type" : "boolean", + "typetext" : "" }, "ostype" : { - "type" : "string", "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.", - "optional" : 1, "enum" : [ "debian", "ubuntu", @@ -11799,208 +13343,124 @@ var pveapi = [ "opensuse", "archlinux", "alpine", + "gentoo", "unmanaged" - ] - }, - "tty" : { - "minimum" : 0, - "default" : 2, - "maximum" : 6, - "type" : "integer", - "description" : "Specify the number of tty available to the container", - "optional" : 1 - }, - "hostname" : { - "description" : "Set a host name for the container.", - "optional" : 1, - "maxLength" : 255, - "type" : "string", - "format" : "dns-name" - }, - "startup" : { - "typetext" : "[[order=]\\d+] [,up=\\d+] [,down=\\d+] ", + ], "optional" : 1, - "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", "type" : "string" }, - "memory" : { - "description" : "Amount of RAM for the VM in MB.", - "optional" : 1, - "type" : "integer", - "default" : 512, - "minimum" : 16 - }, - "cmode" : { - "type" : "string", - "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).", + "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, - "enum" : [ - "shell", - "console", - "tty" - ] + "type" : "boolean", + "typetext" : "" }, - "mp[n]" : { - "optional" : 1, - "description" : "Use volume as container mount point (experimental feature).", - "type" : "string", + "rootfs" : { + "description" : "Use volume as container root.", "format" : { "acl" : { - "type" : "boolean", + "description" : "Explicitly enable or disable ACL support.", "optional" : 1, - "format_description" : "acl", - "description" : "Explicitly enable or disable ACL support." + "type" : "boolean" }, - "ro" : { - "type" : "boolean", + "quota" : { + "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)", "optional" : 1, - "description" : "Read-only mountpoint (not supported with bind mounts)", - "format_description" : "ro" - }, - "mp" : { - "format" : "pve-lxc-mp-string", - "type" : "string", - "format_description" : "Path", - "description" : "Path to the mountpoint as seen from inside the container." + "type" : "boolean" }, - "backup" : { + "ro" : { + "description" : "Read-only mount point", "optional" : 1, - "description" : "Whether to include the mountpoint in backups.", - "format_description" : "[1|0]", "type" : "boolean" }, - "volume" : { - "description" : "Volume, device or directory to mount into the container.", - "format_description" : "volume", - "default_key" : 1, - "format" : "pve-lxc-mp-string", - "type" : "string" + "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).", - "optional" : 1, - "format_description" : "DiskSize", "format" : "disk-size", - "type" : "string" - }, - "quota" : { - "type" : "boolean", - "format_description" : "[0|1]", - "optional" : 1, - "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)" - } - } - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "minimum" : 1, - "format" : "pve-vmid", - "type" : "integer" - }, - "template" : { - "type" : "boolean", - "default" : 0, - "optional" : 1, - "description" : "Enable/disable Template." - }, - "nameserver" : { - "type" : "string", - "format" : "address-list", - "optional" : 1, - "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." - }, - "arch" : { - "type" : "string", - "default" : "amd64", - "optional" : 1, - "description" : "OS architecture type.", - "enum" : [ - "amd64", - "i386" - ] - }, - "unused[n]" : { - "format" : "pve-volume-id", - "type" : "string", - "description" : "Reference to unused volumes.", - "optional" : 1 - }, - "protection" : { - "type" : "boolean", - "default" : 0, - "description" : "Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.", - "optional" : 1 - }, - "rootfs" : { - "type" : "string", - "format" : { - "backup" : { - "type" : "boolean", - "description" : "Whether to include the mountpoint in backups.", + "format_description" : "DiskSize", "optional" : 1, - "format_description" : "[1|0]" + "type" : "string" }, "volume" : { - "description" : "Volume, device or directory to mount into the container.", - "format_description" : "volume", "default_key" : 1, + "description" : "Volume, device or directory to mount into the container.", "format" : "pve-lxc-mp-string", + "format_description" : "volume", "type" : "string" - }, - "size" : { - "optional" : 1, - "description" : "Volume size (read only value).", - "format_description" : "DiskSize", - "type" : "string", - "format" : "disk-size" - }, - "quota" : { - "format_description" : "[0|1]", - "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)", - "optional" : 1, - "type" : "boolean" - }, - "acl" : { - "description" : "Explicitly enable or disable ACL support.", - "format_description" : "acl", - "optional" : 1, - "type" : "boolean" - }, - "ro" : { - "type" : "boolean", - "description" : "Read-only mountpoint (not supported with bind mounts)", - "optional" : 1, - "format_description" : "ro" } }, "optional" : 1, - "description" : "Use volume as container root." + "type" : "string", + "typetext" : "[volume=] [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]" + }, + "searchdomain" : { + "description" : "Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.", + "format" : "dns-name-list", + "optional" : 1, + "type" : "string", + "typetext" : "" }, - "unprivileged" : { + "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", + "typetext" : " (0 - N)" + }, + "template" : { + "default" : 0, + "description" : "Enable/disable Template.", "optional" : 1, - "description" : "Makes the container run as unprivileged user. (Should not be modified manually.)", "type" : "boolean", - "default" : 0 + "typetext" : "" }, - "delete" : { - "description" : "A list of settings you want to delete.", + "tty" : { + "default" : 2, + "description" : "Specify the number of tty available to the container", + "maximum" : 6, + "minimum" : 0, "optional" : 1, - "format" : "pve-configid-list", - "type" : "string" + "type" : "integer", + "typetext" : " (0 - 6)" }, - "searchdomain" : { - "format" : "dns-name-list", - "type" : "string", + "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, - "description" : "Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver." + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -12016,131 +13476,287 @@ var pveapi = [ 1 ] }, + "protected" : 1, + "proxyto" : "node", "returns" : { "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/config", + "text" : "config" + }, + { + "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" + } + } }, - "method" : "PUT", - "name" : "update_vm", - "description" : "Set container options." + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/status/current", + "text" : "current" }, - "GET" : { - "method" : "GET", - "name" : "vm_config", - "returns" : { - "type" : "object", - "properties" : { - "digest" : { - "type" : "string", - "description" : "SHA1 digest of configuration file. This can be used to prevent concurrent modifications." + { + "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" } } }, - "proxyto" : "node", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "vmid" : { - "format" : "pve-vmid", - "type" : "integer", - "minimum" : 1, - "description" : "The (unique) ID of the VM." + "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)" + } + } }, - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.PowerMgmt" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" } } }, - "description" : "Get container configuration.", - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - } - } - } - }, - { - "path" : "/nodes/{node}/lxc/{vmid}/status", - "children" : [ + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/status/stop", + "text" : "stop" + }, { "info" : { - "GET" : { - "protected" : 1, + "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", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, "permissions" : { "check" : [ "perm", "/vms/{vmid}", [ - "VM.Audit" + "VM.PowerMgmt" ] ] }, + "protected" : 1, "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/status/shutdown", + "text" : "shutdown" + }, + { + "info" : { + "POST" : { + "description" : "Suspend the container.", + "method" : "POST", + "name" : "vm_suspend", "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", - "minimum" : 1 - }, - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." + "typetext" : " (1 - N)" } } }, - "description" : "Get virtual machine status.", - "method" : "GET", - "name" : "vm_status", + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.PowerMgmt" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", "returns" : { - "type" : "object" + "type" : "string" } } }, - "path" : "/nodes/{node}/lxc/{vmid}/status/current", "leaf" : 1, - "text" : "current" + "path" : "/nodes/{node}/lxc/{vmid}/status/suspend", + "text" : "suspend" }, { - "text" : "start", - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/status/start", "info" : { "POST" : { - "name" : "vm_start", + "description" : "Resume the container.", "method" : "POST", - "returns" : { - "type" : "string" - }, - "description" : "Start the container.", - "proxyto" : "node", + "name" : "vm_resume", "parameters" : { "additionalProperties" : 0, "properties" : { - "skiplock" : { - "type" : "boolean", - "optional" : 1, - "description" : "Ignore locks - only root is allowed to use this option." - }, "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" + "typetext" : "" }, "vmid" : { - "type" : "integer", + "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "description" : "The (unique) ID of the VM." + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -12153,298 +13769,364 @@ var pveapi = [ ] ] }, - "protected" : 1 + "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" : [ { - "path" : "/nodes/{node}/lxc/{vmid}/status/stop", - "info" : { - "POST" : { - "method" : "POST", - "name" : "vm_stop", - "returns" : { - "type" : "string" + "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" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "the task ID.", + "type" : "string" + } + } }, - "description" : "Stop the container. This will abruptly stop all processes running in the container.", - "proxyto" : "node", - "parameters" : { - "properties" : { - "node" : { - "description" : "The cluster node name.", - "type" : "string", - "format" : "pve-node" + "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" + ] + ] + }, + "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)" + } + } }, - "skiplock" : { - "type" : "boolean", - "optional" : 1, - "description" : "Ignore locks - only root is allowed to use this option." + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Snapshot" + ] + ] }, - "vmid" : { - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1, - "description" : "The (unique) ID of the VM." + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" } - }, - "additionalProperties" : 0 - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.PowerMgmt" - ] - ] + } }, - "protected" : 1 + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config", + "text" : "config" } - }, - "leaf" : 1, - "text" : "stop" - }, - { - "path" : "/nodes/{node}/lxc/{vmid}/status/shutdown", + ], "info" : { - "POST" : { - "description" : "Shutdown the container. This will trigger a clean shutdown of the container, see lxc-stop(1) for details.", - "name" : "vm_shutdown", - "method" : "POST", - "returns" : { - "type" : "string" - }, - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.PowerMgmt" - ] - ] - }, - "proxyto" : "node", + "DELETE" : { + "description" : "Delete a LXC snapshot.", + "method" : "DELETE", + "name" : "delsnapshot", "parameters" : { "additionalProperties" : 0, "properties" : { - "timeout" : { - "description" : "Wait maximal timeout seconds.", + "force" : { + "description" : "For removal from config file, even if removing disk snapshots fails.", "optional" : 1, - "type" : "integer", - "default" : 60, - "minimum" : 0 + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, - "forceStop" : { - "type" : "boolean", - "default" : 0, - "description" : "Make sure the Container stops.", - "optional" : 1 + "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", - "type" : "integer", "minimum" : 1, - "description" : "The (unique) ID of the VM." + "type" : "integer", + "typetext" : " (1 - N)" } } - } - } - }, - "leaf" : 1, - "text" : "shutdown" - }, - { - "info" : { - "POST" : { - "protected" : 1, + }, "permissions" : { "check" : [ "perm", "/vms/{vmid}", [ - "VM.PowerMgmt" + "VM.Snapshot" ] ] }, + "protected" : 1, "proxyto" : "node", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." - }, - "vmid" : { - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid", - "description" : "The (unique) ID of the VM." - } - } - }, - "description" : "Suspend the container.", "returns" : { + "description" : "the task ID.", "type" : "string" - }, - "method" : "POST", - "name" : "vm_suspend" - } - }, - "path" : "/nodes/{node}/lxc/{vmid}/status/suspend", - "text" : "suspend", - "leaf" : 1 - }, - { - "info" : { - "POST" : { + } + }, + "GET" : { + "description" : "", + "method" : "GET", + "name" : "snapshot_cmd_idx", "parameters" : { "additionalProperties" : 0, "properties" : { "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "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", - "format" : "pve-vmid" + "typetext" : " (1 - N)" } } }, - "proxyto" : "node", "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.PowerMgmt" - ] - ] + "user" : "all" }, - "protected" : 1, "returns" : { - "type" : "string" - }, - "name" : "vm_resume", - "method" : "POST", - "description" : "Resume the container." + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{cmd}", + "rel" : "child" + } + ], + "type" : "array" + } } }, - "path" : "/nodes/{node}/lxc/{vmid}/status/resume", - "text" : "resume", - "leaf" : 1 + "leaf" : 0, + "path" : "/nodes/{node}/lxc/{vmid}/snapshot/{snapname}", + "text" : "{snapname}" } ], "info" : { "GET" : { - "description" : "Directory index", - "permissions" : { - "user" : "all" - }, - "name" : "vmcmdidx", + "description" : "List all snapshots.", "method" : "GET", - "proxyto" : "node", + "name" : "list", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { + "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", - "description" : "The cluster node name." + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", "minimum" : 1, "type" : "integer", - "format" : "pve-vmid" - } - }, - "additionalProperties" : 0 - }, - "returns" : { - "items" : { - "type" : "object", - "properties" : { - "subdir" : { - "type" : "string" - } - } - }, - "type" : "array", - "links" : [ - { - "href" : "{subdir}", - "rel" : "child" + "typetext" : " (1 - N)" } - ] - } - } - }, - "leaf" : 0, - "text" : "status" - }, - { - "info" : { - "POST" : { - "description" : "Snapshot a container.", - "returns" : { - "type" : "string", - "description" : "the task ID." + } }, - "name" : "snapshot", - "method" : "POST", - "protected" : 1, "permissions" : { "check" : [ "perm", "/vms/{vmid}", [ - "VM.Snapshot" + "VM.Audit" ] ] }, - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "vmid" : { - "minimum" : 1, - "format" : "pve-vmid", - "type" : "integer", - "description" : "The (unique) ID of the VM." - }, - "snapname" : { - "maxLength" : 40, - "description" : "The name of the snapshot.", - "format" : "pve-configid", - "type" : "string" - }, - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." - }, - "description" : { - "optional" : 1, - "description" : "A textual description or comment.", - "type" : "string" - } - } - }, - "proxyto" : "node" - }, - "GET" : { - "name" : "list", - "method" : "GET", + "protected" : 1, + "proxyto" : "node", "returns" : { - "type" : "array", "items" : { "properties" : {}, "type" : "object" @@ -12454,451 +14136,303 @@ var pveapi = [ "href" : "{name}", "rel" : "child" } - ] - }, - "description" : "List all snapshots.", + ], + "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", - "description" : "The cluster node name." + "typetext" : "" + }, + "snapname" : { + "description" : "The name of the snapshot.", + "format" : "pve-configid", + "maxLength" : 40, + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", - "type" : "integer", "format" : "pve-vmid", - "minimum" : 1 + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", - "protected" : 1, "permissions" : { "check" : [ "perm", "/vms/{vmid}", [ - "VM.Audit" + "VM.Snapshot" ] ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "the task ID.", + "type" : "string" } } }, + "leaf" : 0, + "path" : "/nodes/{node}/lxc/{vmid}/snapshot", + "text" : "snapshot" + }, + { "children" : [ { - "info" : { - "DELETE" : { - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Snapshot" - ] - ] - }, - "proxyto" : "node", - "parameters" : { - "properties" : { - "node" : { - "description" : "The cluster node name.", - "type" : "string", - "format" : "pve-node" - }, - "force" : { - "description" : "For removal from config file, even if removing disk snapshots fails.", - "optional" : 1, - "type" : "boolean" - }, - "snapname" : { - "description" : "The name of the snapshot.", - "maxLength" : 40, - "type" : "string", - "format" : "pve-configid" - }, - "vmid" : { - "minimum" : 1, - "format" : "pve-vmid", - "type" : "integer", - "description" : "The (unique) ID of the VM." - } - }, - "additionalProperties" : 0 - }, - "description" : "Delete a LXC snapshot.", - "name" : "delsnapshot", - "method" : "DELETE", - "returns" : { - "type" : "string", - "description" : "the task ID." - } - }, - "GET" : { - "description" : "", - "permissions" : { - "user" : "all" - }, - "method" : "GET", - "name" : "snapshot_cmd_idx", - "returns" : { - "links" : [ - { - "rel" : "child", - "href" : "{cmd}" - } - ], - "type" : "array", - "items" : { - "properties" : {}, - "type" : "object" - } - }, - "parameters" : { - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" - }, - "snapname" : { - "format" : "pve-configid", - "type" : "string", - "maxLength" : 40, - "description" : "The name of the snapshot." - }, - "vmid" : { - "minimum" : 1, - "format" : "pve-vmid", - "type" : "integer", - "description" : "The (unique) ID of the VM." - } - }, - "additionalProperties" : 0 - } - } - }, - "path" : "/nodes/{node}/lxc/{vmid}/snapshot/{snapname}", "children" : [ { - "leaf" : 1, - "text" : "rollback", - "info" : { - "POST" : { - "description" : "Rollback LXC state to specified snapshot.", - "name" : "rollback", - "method" : "POST", - "returns" : { - "description" : "the task ID.", - "type" : "string" - }, - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Snapshot" - ] - ] - }, - "parameters" : { - "properties" : { - "node" : { - "description" : "The cluster node name.", - "type" : "string", - "format" : "pve-node" - }, - "snapname" : { - "maxLength" : 40, - "description" : "The name of the snapshot.", - "format" : "pve-configid", - "type" : "string" - }, - "vmid" : { - "minimum" : 1, - "format" : "pve-vmid", - "type" : "integer", - "description" : "The (unique) ID of the VM." - } - }, - "additionalProperties" : 0 - }, - "proxyto" : "node" - } - }, - "path" : "/nodes/{node}/lxc/{vmid}/snapshot/{snapname}/rollback" - }, - { - "leaf" : 1, - "text" : "config", "info" : { - "GET" : { - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Snapshot" - ] - ] - }, - "description" : "Get snapshot configuration", - "method" : "GET", - "name" : "get_snapshot_config", - "returns" : { - "type" : "object" - }, + "DELETE" : { + "description" : "Delete rule.", + "method" : "DELETE", + "name" : "delete_rule", "parameters" : { "additionalProperties" : 0, "properties" : { - "snapname" : { - "format" : "pve-configid", - "type" : "string", + "digest" : { + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", "maxLength" : 40, - "description" : "The name of the snapshot." + "optional" : 1, + "type" : "string", + "typetext" : "" }, "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "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", + "minimum" : 1, "type" : "integer", - "minimum" : 1 + "typetext" : " (1 - N)" } } }, - "proxyto" : "node" - }, - "PUT" : { - "description" : "Update snapshot metadata.", - "name" : "update_snapshot_config", - "method" : "PUT", - "returns" : { - "type" : "null" - }, - "protected" : 1, "permissions" : { "check" : [ "perm", "/vms/{vmid}", [ - "VM.Snapshot" + "VM.Config.Network" ] ] }, + "protected" : 1, + "proxyto" : null, + "returns" : { + "type" : "null" + } + }, + "GET" : { + "description" : "Get single rule data.", + "method" : "GET", + "name" : "get_rule", "parameters" : { "additionalProperties" : 0, "properties" : { - "snapname" : { - "description" : "The name of the snapshot.", - "maxLength" : 40, - "type" : "string", - "format" : "pve-configid" - }, - "description" : { - "type" : "string", - "description" : "A textual description or comment.", - "optional" : 1 - }, "node" : { - "description" : "The cluster node name.", - "type" : "string", - "format" : "pve-node" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid" - } - } - }, - "proxyto" : "node" - } - }, - "path" : "/nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config" - } - ], - "leaf" : 0, - "text" : "{snapname}" - } - ], - "path" : "/nodes/{node}/lxc/{vmid}/snapshot", - "text" : "snapshot", - "leaf" : 0 - }, - { - "children" : [ - { - "path" : "/nodes/{node}/lxc/{vmid}/firewall/rules", - "children" : [ - { - "info" : { - "PUT" : { - "description" : "Modify rule data.", - "returns" : { - "type" : "null" + "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", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } }, - "name" : "update_rule", - "method" : "PUT", "permissions" : { "check" : [ "perm", "/vms/{vmid}", [ - "VM.Config.Network" + "VM.Audit" ] ] }, - "protected" : 1, + "proxyto" : null, + "returns" : { + "properties" : { + "pos" : { + "type" : "integer" + } + }, + "type" : "object" + } + }, + "PUT" : { + "description" : "Modify rule data.", + "method" : "PUT", + "name" : "update_rule", "parameters" : { "additionalProperties" : 0, "properties" : { - "dest" : { - "format" : "pve-fw-addr-spec", - "type" : "string", - "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.", - "optional" : 1 - }, "action" : { "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", - "optional" : 1, "maxLength" : 20, "minLength" : 2, + "optional" : 1, "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" }, "comment" : { - "type" : "string", - "optional" : 1 - }, - "pos" : { - "type" : "integer", - "minimum" : 0, + "description" : "Descriptive comment.", "optional" : 1, - "description" : "Update rule at position ." + "type" : "string", + "typetext" : "" }, - "type" : { - "enum" : [ - "in", - "out", - "group" - ], + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, - "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.", - "maxLength" : 20, + "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, - "minLength" : 2, - "format" : "pve-iface", - "type" : "string" + "type" : "string", + "typetext" : "" }, "digest" : { - "type" : "string", + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", "maxLength" : 40, "optional" : 1, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." + "type" : "string", + "typetext" : "" }, - "source" : { + "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, - "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.", "type" : "string", - "format" : "pve-fw-addr-spec" + "typetext" : "" }, - "node" : { - "format" : "pve-node", + "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", - "description" : "The cluster node name." + "typetext" : "" }, "macro" : { - "type" : "string", + "description" : "Use predefined standard macro.", "maxLength" : 128, - "optional" : 1 - }, - "vmid" : { - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid", - "description" : "The (unique) ID of the VM." - }, - "enable" : { "optional" : 1, - "minimum" : 0, - "type" : "integer" + "type" : "string", + "typetext" : "" }, "moveto" : { - "optional" : 1, "description" : "Move rule to new position . Other arguments are ignored.", + "minimum" : 0, + "optional" : 1, "type" : "integer", - "minimum" : 0 + "typetext" : " (0 - N)" }, - "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.", + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "pos" : { + "description" : "Update rule at position .", + "minimum" : 0, "optional" : 1, - "format" : "pve-fw-dport-spec", - "type" : "string" + "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", - "format" : "pve-fw-protocol-spec" + "typetext" : "" }, - "sport" : { + "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", - "type" : "string" - }, - "delete" : { - "description" : "A list of settings you want to delete.", "optional" : 1, "type" : "string", - "format" : "pve-configid-list" - } - } - }, - "proxyto" : null - }, - "DELETE" : { - "parameters" : { - "additionalProperties" : 0, - "properties" : { + "typetext" : "" + }, + "type" : { + "description" : "Rule type.", + "enum" : [ + "in", + "out", + "group" + ], + "optional" : 1, + "type" : "string" + }, "vmid" : { "description" : "The (unique) ID of the VM.", - "type" : "integer", "format" : "pve-vmid", - "minimum" : 1 - }, - "digest" : { - "type" : "string", - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "maxLength" : 40, - "optional" : 1 - }, - "pos" : { + "minimum" : 1, "type" : "integer", - "minimum" : 0, - "description" : "Update rule at position .", - "optional" : 1 - }, - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." + "typetext" : " (1 - N)" } } }, - "proxyto" : null, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -12908,276 +14442,187 @@ var pveapi = [ ] ] }, - "method" : "DELETE", - "name" : "delete_rule", - "returns" : { - "type" : "null" - }, - "description" : "Delete rule." - }, - "GET" : { - "description" : "Get single rule data.", - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, + "protected" : 1, "proxyto" : null, - "parameters" : { - "properties" : { - "vmid" : { - "description" : "The (unique) ID of the VM.", - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid" - }, - "pos" : { - "description" : "Update rule at position .", - "optional" : 1, - "minimum" : 0, - "type" : "integer" - }, - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - } - }, - "additionalProperties" : 0 - }, "returns" : { - "properties" : { - "pos" : { - "type" : "integer" - } - }, - "type" : "object" - }, - "method" : "GET", - "name" : "get_rule" + "type" : "null" + } } }, - "path" : "/nodes/{node}/lxc/{vmid}/firewall/rules/{pos}", "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/rules/{pos}", "text" : "{pos}" } ], "info" : { + "GET" : { + "description" : "List rules.", + "method" : "GET", + "name" : "get_rules", + "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" : null, + "returns" : { + "items" : { + "properties" : { + "pos" : { + "type" : "integer" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{pos}", + "rel" : "child" + } + ], + "type" : "array" + } + }, "POST" : { "description" : "Create new rule.", "method" : "POST", "name" : "create_rule", - "returns" : { - "type" : "null" - }, - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Network" - ] - ] - }, - "proxyto" : null, "parameters" : { + "additionalProperties" : 0, "properties" : { - "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.", - "optional" : 1, - "type" : "string", - "format" : "pve-fw-addr-spec" - }, - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - }, - "pos" : { - "type" : "integer", - "minimum" : 0, - "description" : "Update rule at position .", - "optional" : 1 - }, "action" : { - "type" : "string", - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", + "maxLength" : 20, "minLength" : 2, "optional" : 0, - "maxLength" : 20, - "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name." + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "type" : "string" }, "comment" : { + "description" : "Descriptive comment.", + "optional" : 1, "type" : "string", - "optional" : 1 - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid" + "typetext" : "" }, - "type" : { + "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", - "enum" : [ - "in", - "out", - "group" - ], - "optional" : 0 + "typetext" : "" }, - "macro" : { + "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", - "maxLength" : 128, - "optional" : 1 + "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.", - "optional" : 1, "format" : "pve-fw-dport-spec", - "type" : "string" + "optional" : 1, + "type" : "string", + "typetext" : "" }, "enable" : { - "type" : "integer", + "description" : "Flag to enable/disable a rule.", "minimum" : 0, - "optional" : 1 - }, - "digest" : { "optional" : 1, - "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "type" : "string" + "type" : "integer", + "typetext" : " (0 - N)" }, "iface" : { - "type" : "string", + "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", - "minLength" : 2, "maxLength" : 20, + "minLength" : 2, "optional" : 1, - "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." + "type" : "string", + "typetext" : "" }, - "proto" : { + "macro" : { + "description" : "Use predefined standard macro.", + "maxLength" : 128, + "optional" : 1, "type" : "string", - "format" : "pve-fw-protocol-spec", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "pos" : { + "description" : "Update rule at position .", + "minimum" : 0, "optional" : 1, - "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'." + "type" : "integer", + "typetext" : " (0 - N)" }, - "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.", + "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", - "format" : "pve-fw-sport-spec" + "typetext" : "" }, "source" : { - "optional" : 1, "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", - "type" : "string" - } - }, - "additionalProperties" : 0 - } - }, - "GET" : { - "returns" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "pos" : { - "type" : "integer" - } - } - }, - "links" : [ - { - "rel" : "child", - "href" : "{pos}" - } - ] - }, - "proxyto" : null, - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "format" : "pve-node", + "optional" : 1, "type" : "string", - "description" : "The cluster node name." + "typetext" : "" }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "minimum" : 1, - "format" : "pve-vmid", - "type" : "integer" - } - } - }, - "method" : "GET", - "name" : "get_rules", - "description" : "List rules.", - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - } - } - }, - "leaf" : 0, - "text" : "rules" - }, - { - "leaf" : 0, - "text" : "aliases", - "info" : { - "POST" : { - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "name" : { + "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", - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "maxLength" : 64, - "description" : "Alias name." + "typetext" : "" + }, + "type" : { + "description" : "Rule type.", + "enum" : [ + "in", + "out", + "group" + ], + "optional" : 0, + "type" : "string" }, "vmid" : { - "type" : "integer", + "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "description" : "The (unique) ID of the VM." - }, - "cidr" : { - "type" : "string", - "format" : "IPorCIDR", - "description" : "Network/IP specification in CIDR format." - }, - "comment" : { - "optional" : 1, - "type" : "string" - }, - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." + "type" : "integer", + "typetext" : " (1 - N)" } } }, - "returns" : { - "type" : "null" - }, - "method" : "POST", - "name" : "create_alias", - "description" : "Create IP or Network Alias.", "permissions" : { "check" : [ "perm", @@ -13187,216 +14632,168 @@ var pveapi = [ ] ] }, - "protected" : 1 - }, - "GET" : { - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "description" : "List aliases", - "parameters" : { - "properties" : { - "vmid" : { - "description" : "The (unique) ID of the VM.", - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" - } - }, - "additionalProperties" : 0 - }, + "protected" : 1, + "proxyto" : null, "returns" : { - "type" : "array", - "items" : { - "properties" : { - "cidr" : { - "type" : "string" - }, - "digest" : { - "type" : "string", - "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "optional" : 0 - }, - "comment" : { - "type" : "string", - "optional" : 1 - }, - "name" : { - "type" : "string" - } - }, - "type" : "object" - }, - "links" : [ - { - "rel" : "child", - "href" : "{name}" - } - ] - }, - "name" : "get_aliases", - "method" : "GET" + "type" : "null" + } } }, + "leaf" : 0, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/rules", + "text" : "rules" + }, + { "children" : [ { - "text" : "{name}", - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/firewall/aliases/{name}", "info" : { "DELETE" : { "description" : "Remove IP or Network alias.", - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Network" - ] - ] - }, - "protected" : 1, + "method" : "DELETE", + "name" : "remove_alias", "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.", + "maxLength" : 64, + "minLength" : 2, + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" }, "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" }, "vmid" : { + "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", - "type" : "integer", "minimum" : 1, - "description" : "The (unique) ID of the VM." - }, - "name" : { - "type" : "string", - "maxLength" : 64, - "description" : "Alias name.", - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+" + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 - }, - "returns" : { - "type" : "null" + } }, - "method" : "DELETE", - "name" : "remove_alias" - }, - "GET" : { - "description" : "Read alias.", "permissions" : { "check" : [ "perm", "/vms/{vmid}", [ - "VM.Audit" + "VM.Config.Network" ] ] }, + "protected" : 1, "returns" : { - "type" : "object" - }, + "type" : "null" + } + }, + "GET" : { + "description" : "Read alias.", + "method" : "GET", + "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" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", - "minimum" : 1, "format" : "pve-vmid", - "type" : "integer" - }, - "name" : { - "description" : "Alias name.", - "maxLength" : 64, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, - "type" : "string" + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "name" : "read_alias", - "method" : "GET" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "returns" : { + "type" : "object" + } }, "PUT" : { - "name" : "update_alias", + "description" : "Update IP or Network alias.", "method" : "PUT", - "returns" : { - "type" : "null" - }, + "name" : "update_alias", "parameters" : { "additionalProperties" : 0, "properties" : { - "vmid" : { - "format" : "pve-vmid", - "type" : "integer", - "minimum" : 1, - "description" : "The (unique) ID of the VM." + "cidr" : { + "description" : "Network/IP specification in CIDR format.", + "format" : "IPorCIDR", + "type" : "string", + "typetext" : "" }, - "name" : { - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "maxLength" : 64, - "description" : "Alias name.", - "type" : "string" + "comment" : { + "optional" : 1, + "type" : "string", + "typetext" : "" }, "digest" : { - "type" : "string", "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", + "maxLength" : 40, "optional" : 1, - "maxLength" : 40 + "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" - }, - "comment" : { - "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "rename" : { - "type" : "string", + "description" : "Rename an existing alias.", + "maxLength" : 64, "minLength" : 2, + "optional" : 1, "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "maxLength" : 64, - "description" : "Rename an existing alias.", - "optional" : 1 + "type" : "string" }, - "cidr" : { - "format" : "IPorCIDR", - "type" : "string", - "description" : "Network/IP specification in CIDR format." + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } } }, - "protected" : 1, - "description" : "Update IP or Network alias.", "permissions" : { "check" : [ "perm", @@ -13405,78 +14802,41 @@ var pveapi = [ "VM.Config.Network" ] ] + }, + "protected" : 1, + "returns" : { + "type" : "null" } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/aliases/{name}", + "text" : "{name}" } ], - "path" : "/nodes/{node}/lxc/{vmid}/firewall/aliases" - }, - { - "text" : "ipset", - "leaf" : 0, "info" : { - "POST" : { - "name" : "create_ipset", - "method" : "POST", + "GET" : { + "description" : "List aliases", + "method" : "GET", + "name" : "get_aliases", "parameters" : { + "additionalProperties" : 0, "properties" : { - "vmid" : { - "minimum" : 1, - "format" : "pve-vmid", - "type" : "integer", - "description" : "The (unique) ID of the VM." - }, - "name" : { - "description" : "IP set name.", - "maxLength" : 64, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, - "type" : "string" - }, "node" : { + "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", - "description" : "The cluster node name." - }, - "digest" : { - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "optional" : 1, - "maxLength" : 40, - "type" : "string" + "typetext" : "" }, - "comment" : { - "optional" : 1, - "type" : "string" - }, - "rename" : { - "type" : "string", - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "maxLength" : 64, - "optional" : 1, - "description" : "Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet." + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 - }, - "returns" : { - "type" : "null" - }, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Network" - ] - ] + } }, - "description" : "Create new IPSet", - "protected" : 1 - }, - "GET" : { - "description" : "List IPSets", "permissions" : { "check" : [ "perm", @@ -13486,214 +14846,259 @@ var pveapi = [ ] ] }, + "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" + }, + "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", - "description" : "The cluster node name." + "typetext" : "" }, "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", "minimum" : 1, "type" : "integer", - "format" : "pve-vmid", - "description" : "The (unique) ID of the VM." + "typetext" : " (1 - N)" } } }, - "returns" : { - "items" : { - "type" : "object", - "properties" : { - "name" : { - "description" : "IP set name.", - "maxLength" : 64, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, - "type" : "string" - }, - "comment" : { - "optional" : 1, - "type" : "string" - }, - "digest" : { - "type" : "string", - "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "optional" : 0 - } - } - }, - "type" : "array", - "links" : [ - { - "rel" : "child", - "href" : "{name}" - } + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Config.Network" + ] ] }, - "method" : "GET", - "name" : "ipset_index" + "protected" : 1, + "returns" : { + "type" : "null" + } } }, - "path" : "/nodes/{node}/lxc/{vmid}/firewall/ipset", + "leaf" : 0, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/aliases", + "text" : "aliases" + }, + { "children" : [ { - "text" : "{name}", - "leaf" : 0, - "path" : "/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}", "children" : [ { "info" : { "DELETE" : { - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Network" - ] - ] - }, "description" : "Remove IP or Network from IPSet.", - "protected" : 1, - "name" : "remove_ip", "method" : "DELETE", + "name" : "remove_ip", "parameters" : { "additionalProperties" : 0, "properties" : { "cidr" : { - "type" : "string", + "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDRorAlias", - "description" : "Network/IP specification in CIDR format." - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "digest" : { - "optional" : 1, "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", "maxLength" : 40, - "type" : "string" + "optional" : 1, + "type" : "string", + "typetext" : "" }, "name" : { - "type" : "string", - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, + "description" : "IP set name.", "maxLength" : 64, - "description" : "IP set name." + "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", - "type" : "integer", "minimum" : 1, - "description" : "The (unique) ID of the VM." + "type" : "integer", + "typetext" : " (1 - N)" } } }, - "returns" : { - "type" : "null" - } - }, - "GET" : { "permissions" : { "check" : [ "perm", "/vms/{vmid}", [ - "VM.Audit" + "VM.Config.Network" ] ] }, - "description" : "Read IP or Network settings from IPSet.", "protected" : 1, - "name" : "read_ip", + "returns" : { + "type" : "null" + } + }, + "GET" : { + "description" : "Read IP or Network settings from IPSet.", "method" : "GET", + "name" : "read_ip", "parameters" : { "additionalProperties" : 0, "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" - }, "cidr" : { "description" : "Network/IP specification in CIDR format.", + "format" : "IPorCIDRorAlias", "type" : "string", - "format" : "IPorCIDRorAlias" - }, - "vmid" : { - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1, - "description" : "The (unique) ID of the VM." + "typetext" : "" }, "name" : { - "maxLength" : 64, "description" : "IP set name.", - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", + "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", - "returns" : { - "type" : "null" - }, "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, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "minLength" : 2, - "type" : "string" - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1 - }, - "cidr" : { - "description" : "Network/IP specification in CIDR format.", - "format" : "IPorCIDRorAlias", + "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" - }, - "digest" : { - "type" : "string", - "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "optional" : 1 - }, - "comment" : { "type" : "string", - "optional" : 1 + "typetext" : "" }, "nomatch" : { "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } } }, - "protected" : 1, - "description" : "Update IP or Network settings", "permissions" : { "check" : [ "perm", @@ -13702,84 +15107,48 @@ var pveapi = [ "VM.Config.Network" ] ] + }, + "protected" : 1, + "returns" : { + "type" : "null" } } }, - "path" : "/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr}", "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr}", "text" : "{cidr}" } ], "info" : { - "GET" : { - "name" : "get_ipset", - "method" : "GET", - "returns" : { - "links" : [ - { - "rel" : "child", - "href" : "{cidr}" - } - ], - "items" : { - "properties" : { - "cidr" : { - "type" : "string" - }, - "digest" : { - "maxLength" : 40, - "optional" : 0, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "type" : "string" - }, - "nomatch" : { - "optional" : 1, - "type" : "boolean" - }, - "comment" : { - "optional" : 1, - "type" : "string" - } - }, - "type" : "object" - }, - "type" : "array" - }, + "DELETE" : { + "description" : "Delete IPSet", + "method" : "DELETE", + "name" : "delete_ipset", "parameters" : { "additionalProperties" : 0, "properties" : { - "node" : { - "description" : "The cluster node name.", - "type" : "string", - "format" : "pve-node" - }, - "vmid" : { - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1, - "description" : "The (unique) ID of the VM." - }, "name" : { - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, "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" - ] - ] - }, - "description" : "List IPSet content" - }, - "DELETE" : { "permissions" : { "check" : [ "perm", @@ -13789,81 +15158,126 @@ var pveapi = [ ] ] }, - "description" : "Delete IPSet", "protected" : 1, + "returns" : { + "type" : "null" + } + }, + "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", - "format" : "pve-node" + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", "minimum" : 1, "type" : "integer", - "format" : "pve-vmid" - }, - "name" : { - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, - "description" : "IP set name.", - "maxLength" : 64, - "type" : "string" + "typetext" : " (1 - N)" } } }, - "returns" : { - "type" : "null" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] }, - "method" : "DELETE", - "name" : "delete_ipset" + "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" + } }, "POST" : { - "returns" : { - "type" : "null" - }, + "description" : "Add IP or Network to IPSet.", + "method" : "POST", + "name" : "create_ip", "parameters" : { "additionalProperties" : 0, "properties" : { - "name" : { - "type" : "string", - "description" : "IP set name.", - "maxLength" : 64, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2 - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "minimum" : 1, - "format" : "pve-vmid", - "type" : "integer" - }, "cidr" : { - "type" : "string", + "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDRorAlias", - "description" : "Network/IP specification in CIDR format." - }, - "nomatch" : { - "type" : "boolean", - "optional" : 1 + "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", - "description" : "The cluster node name." + "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)" } } }, - "method" : "POST", - "name" : "create_ip", - "protected" : 1, - "description" : "Add IP or Network to IPSet.", "permissions" : { "check" : [ "perm", @@ -13872,70 +15286,195 @@ var pveapi = [ "VM.Config.Network" ] ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}", + "text" : "{name}" + } + ], + "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)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "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)" } } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Config.Network" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" } } - ] + }, + "leaf" : 0, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/ipset", + "text" : "ipset" }, { - "leaf" : 1, - "text" : "options", "info" : { - "PUT" : { - "name" : "set_options", - "method" : "PUT", - "returns" : { - "type" : "null" - }, - "description" : "Set Firewall options.", + "GET" : { + "description" : "Get VM firewall options.", + "method" : "GET", + "name" : "get_options", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." - }, - "policy_out" : { "type" : "string", - "description" : "Output policy.", - "optional" : 1, - "enum" : [ - "ACCEPT", - "REJECT", - "DROP" - ] - }, - "macfilter" : { - "description" : "Enable/disable MAC address filter.", - "optional" : 1, - "type" : "boolean" - }, - "policy_in" : { - "enum" : [ - "ACCEPT", - "REJECT", - "DROP" - ], - "optional" : 1, - "description" : "Input policy.", - "type" : "string" + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", - "minimum" : 1, "format" : "pve-vmid", - "type" : "integer" - }, + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "proxyto" : "node", + "returns" : { + "properties" : { "dhcp" : { - "optional" : 1, "description" : "Enable DHCP.", + "optional" : 1, "type" : "boolean" }, - "ndp" : { - "type" : "boolean", - "description" : "Enable NDP.", - "optional" : 1 + "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.", @@ -13943,7 +15482,6 @@ var pveapi = [ "type" : "boolean" }, "log_level_in" : { - "optional" : 1, "description" : "Log level for incoming traffic.", "enum" : [ "emerg", @@ -13956,21 +15494,11 @@ var pveapi = [ "debug", "nolog" ], - "type" : "string" - }, - "enable" : { - "type" : "boolean", - "optional" : 1, - "description" : "Enable/disable firewall rules." - }, - "digest" : { "optional" : 1, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "maxLength" : 40, "type" : "string" }, "log_level_out" : { - "type" : "string", + "description" : "Log level for outgoing traffic.", "enum" : [ "emerg", "alert", @@ -13982,97 +15510,89 @@ var pveapi = [ "debug", "nolog" ], - "description" : "Log level for outgoing traffic.", - "optional" : 1 + "optional" : 1, + "type" : "string" }, - "radv" : { - "description" : "Allow sending Router Advertisement.", + "macfilter" : { + "description" : "Enable/disable MAC address filter.", "optional" : 1, "type" : "boolean" }, - "delete" : { - "type" : "string", - "format" : "pve-configid-list", + "ndp" : { + "description" : "Enable NDP.", "optional" : 1, - "description" : "A list of settings you want to delete." - } - }, - "additionalProperties" : 0 - }, - "proxyto" : "node", - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Network" - ] - ] - }, - "protected" : 1 - }, - "GET" : { - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, - "description" : "Get VM firewall options.", - "method" : "GET", - "name" : "get_options", - "returns" : { - "properties" : { - "policy_out" : { + "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" }, - "ipfilter" : { - "type" : "boolean", + "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, - "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." + "type" : "string", + "typetext" : "" }, "dhcp" : { "description" : "Enable DHCP.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, - "ndp" : { + "digest" : { + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", + "maxLength" : 40, "optional" : 1, - "description" : "Enable NDP.", - "type" : "boolean" - }, - "policy_in" : { "type" : "string", - "enum" : [ - "ACCEPT", - "REJECT", - "DROP" - ], - "description" : "Input policy.", - "optional" : 1 - }, - "macfilter" : { - "type" : "boolean", - "optional" : 1, - "description" : "Enable/disable MAC address filter." + "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, - "description" : "Enable/disable firewall rules." + "type" : "boolean", + "typetext" : "" }, "log_level_in" : { - "type" : "string", + "description" : "Log level for incoming traffic.", "enum" : [ "emerg", "alert", @@ -14084,15 +15604,11 @@ var pveapi = [ "debug", "nolog" ], - "description" : "Log level for incoming traffic.", - "optional" : 1 - }, - "radv" : { "optional" : 1, - "description" : "Allow sending Router Advertisement.", - "type" : "boolean" + "type" : "string" }, "log_level_out" : { + "description" : "Log level for outgoing traffic.", "enum" : [ "emerg", "alert", @@ -14105,84 +15621,117 @@ var pveapi = [ "nolog" ], "optional" : 1, - "description" : "Log level for outgoing traffic.", "type" : "string" - } - }, - "type" : "object" - }, - "proxyto" : "node", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "vmid" : { - "format" : "pve-vmid", - "type" : "integer", - "minimum" : 1, - "description" : "The (unique) ID of the VM." + }, + "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", - "description" : "The cluster node name." + "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.Network" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" } } }, - "path" : "/nodes/{node}/lxc/{vmid}/firewall/options" + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/options", + "text" : "options" }, { - "path" : "/nodes/{node}/lxc/{vmid}/firewall/log", "info" : { "GET" : { - "name" : "log", - "method" : "GET", - "returns" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "t" : { - "description" : "Line text", - "type" : "string" - }, - "n" : { - "description" : "Line number", - "type" : "integer" - } - } - } - }, "description" : "Read firewall log", - "proxyto" : "node", + "method" : "GET", + "name" : "log", "parameters" : { "additionalProperties" : 0, "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" - }, "limit" : { "minimum" : 0, + "optional" : 1, "type" : "integer", - "optional" : 1 + "typetext" : " (0 - N)" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, "start" : { - "type" : "integer", "minimum" : 0, - "optional" : 1 + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" }, "vmid" : { "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", "minimum" : 1, "type" : "integer", - "format" : "pve-vmid" + "typetext" : " (1 - N)" } } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -14191,166 +15740,177 @@ var pveapi = [ "VM.Console" ] ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "n" : { + "description" : "Line number", + "type" : "integer" + }, + "t" : { + "description" : "Line text", + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" } } }, - "text" : "log", - "leaf" : 1 + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/log", + "text" : "log" }, { - "text" : "refs", - "leaf" : 1, "info" : { "GET" : { - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, "description" : "Lists possible IPSet/Alias reference which are allowed in source/dest properties.", "method" : "GET", "name" : "refs", "parameters" : { + "additionalProperties" : 0, "properties" : { - "type" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", + "typetext" : "" + }, + "type" : { + "description" : "Only list references of specified type.", "enum" : [ "alias", "ipset" ], - "description" : "Only list references of specified type.", - "optional" : 1 + "optional" : 1, + "type" : "string" }, "vmid" : { - "minimum" : 1, + "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", + "minimum" : 1, "type" : "integer", - "description" : "The (unique) ID of the VM." - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] }, "returns" : { - "type" : "array", "items" : { - "type" : "object", "properties" : { + "comment" : { + "optional" : 1, + "type" : "string" + }, "name" : { "type" : "string" }, "type" : { - "type" : "string", "enum" : [ "alias", "ipset" - ] - }, - "comment" : { - "type" : "string", - "optional" : 1 + ], + "type" : "string" } - } - } + }, + "type" : "object" + }, + "type" : "array" } } }, - "path" : "/nodes/{node}/lxc/{vmid}/firewall/refs" + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/firewall/refs", + "text" : "refs" } ], - "path" : "/nodes/{node}/lxc/{vmid}/firewall", "info" : { "GET" : { - "permissions" : { - "user" : "all" - }, "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", - "format" : "pve-vmid" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } + }, + "permissions" : { + "user" : "all" }, "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, "links" : [ { "href" : "{name}", "rel" : "child" } ], - "type" : "array", - "items" : { - "properties" : {}, - "type" : "object" - } + "type" : "array" } } }, - "text" : "firewall", - "leaf" : 0 + "leaf" : 0, + "path" : "/nodes/{node}/lxc/{vmid}/firewall", + "text" : "firewall" }, { - "text" : "rrd", - "leaf" : 1, - "path" : "/nodes/{node}/lxc/{vmid}/rrd", "info" : { "GET" : { - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Audit" - ] - ] - }, "description" : "Read VM RRD statistics (returns PNG)", - "returns" : { - "type" : "object", - "properties" : { - "filename" : { - "type" : "string" - } - } - }, + "method" : "GET", + "name" : "rrd", "parameters" : { + "additionalProperties" : 0, "properties" : { - "vmid" : { - "description" : "The (unique) ID of the VM.", - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1 - }, "cf" : { - "optional" : 1, "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" : [ @@ -14362,31 +15922,63 @@ var pveapi = [ ], "type" : "string" }, - "node" : { - "description" : "The cluster node name.", - "type" : "string", - "format" : "pve-node" - }, - "ds" : { - "format" : "pve-configid-list", - "type" : "string", - "description" : "The list of datasources you want to display." + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "method" : "GET", - "name" : "rrd" + "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" }, { - "text" : "rrddata", - "leaf" : 1, "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" : [ @@ -14394,42 +15986,19 @@ var pveapi = [ "day", "week", "month", - "year" - ], - "type" : "string" - }, - "cf" : { - "enum" : [ - "AVERAGE", - "MAX" + "year" ], - "optional" : 1, - "description" : "The RRD consolidation function", "type" : "string" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", + "minimum" : 1, "type" : "integer", - "minimum" : 1 - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 - }, - "returns" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : {} } }, - "method" : "GET", - "name" : "rrddata", "permissions" : { "check" : [ "perm", @@ -14439,160 +16008,178 @@ var pveapi = [ ] ] }, - "description" : "Read VM RRD statistics", - "protected" : 1 + "protected" : 1, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "type" : "array" + } } }, - "path" : "/nodes/{node}/lxc/{vmid}/rrddata" + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/rrddata", + "text" : "rrddata" }, { "info" : { "POST" : { "description" : "Creates a TCP VNC proxy connections.", - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Console" - ] - ] - }, - "protected" : 1, - "name" : "vncproxy", "method" : "POST", + "name" : "vncproxy", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" - }, - "websocket" : { - "description" : "use websocket instead of standard VNC.", - "optional" : 1, - "type" : "boolean" + "type" : "string", + "typetext" : "" }, "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", "minimum" : 1, "type" : "integer", - "format" : "pve-vmid", - "description" : "The (unique) ID of the VM." + "typetext" : " (1 - N)" + }, + "websocket" : { + "description" : "use websocket instead of standard VNC.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" } - }, - "additionalProperties" : 0 + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Console" + ] + ] }, + "protected" : 1, "returns" : { + "additionalProperties" : 0, "properties" : { - "upid" : { + "cert" : { "type" : "string" }, + "port" : { + "type" : "integer" + }, "ticket" : { "type" : "string" }, - "user" : { + "upid" : { "type" : "string" }, - "cert" : { + "user" : { "type" : "string" - }, - "port" : { - "type" : "integer" } - }, - "additionalProperties" : 0 + } } } }, - "path" : "/nodes/{node}/lxc/{vmid}/vncproxy", "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/vncproxy", "text" : "vncproxy" }, { - "path" : "/nodes/{node}/lxc/{vmid}/vncwebsocket", "info" : { "GET" : { - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Console" - ] - ], - "description" : "You also need to pass a valid ticket (vncticket)." - }, "description" : "Opens a weksocket for VNC traffic.", + "method" : "GET", + "name" : "vncwebsocket", "parameters" : { "additionalProperties" : 0, "properties" : { - "vmid" : { - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1, - "description" : "The (unique) ID of the VM." + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, "port" : { + "description" : "Port number returned by previous vncproxy call.", "maximum" : 5999, - "type" : "integer", "minimum" : 5900, - "description" : "Port number returned by previous vncproxy call." + "type" : "integer", + "typetext" : " (5900 - 5999)" }, - "node" : { - "description" : "The cluster node name.", - "type" : "string", - "format" : "pve-node" + "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" + "type" : "string", + "typetext" : "" } } }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Console" + ] + ], + "description" : "You also need to pass a valid ticket (vncticket)." + }, "returns" : { - "type" : "object", "properties" : { "port" : { "type" : "string" } - } - }, - "method" : "GET", - "name" : "vncwebsocket" + }, + "type" : "object" + } } }, - "text" : "vncwebsocket", - "leaf" : 1 + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/vncwebsocket", + "text" : "vncwebsocket" }, { - "path" : "/nodes/{node}/lxc/{vmid}/spiceproxy", "info" : { "POST" : { - "proxyto" : "node", + "description" : "Returns a SPICE configuration to connect to the CT.", + "method" : "POST", + "name" : "spiceproxy", "parameters" : { "additionalProperties" : 0, "properties" : { - "vmid" : { - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1, - "description" : "The (unique) ID of the VM." + "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", - "format" : "address" + "typetext" : "" }, - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -14602,9 +16189,13 @@ var pveapi = [ ] ] }, + "protected" : 1, + "proxyto" : "node", "returns" : { + "additionalProperties" : 1, + "description" : "Returned values can be directly passed to the 'remote-viewer' application.", "properties" : { - "type" : { + "host" : { "type" : "string" }, "password" : { @@ -14613,61 +16204,62 @@ var pveapi = [ "proxy" : { "type" : "string" }, - "host" : { - "type" : "string" - }, "tls-port" : { "type" : "integer" + }, + "type" : { + "type" : "string" } - }, - "additionalProperties" : 1, - "description" : "Returned values can be directly passed to the 'remote-viewer' application." - }, - "method" : "POST", - "name" : "spiceproxy", - "description" : "Returns a SPICE configuration to connect to the CT." + } + } } }, - "text" : "spiceproxy", - "leaf" : 1 + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/spiceproxy", + "text" : "spiceproxy" }, { - "text" : "migrate", - "leaf" : 1, "info" : { "POST" : { + "description" : "Migrate the container to another node. Creates a new migration task.", + "method" : "POST", + "name" : "migrate_vm", "parameters" : { + "additionalProperties" : 0, "properties" : { - "vmid" : { - "description" : "The (unique) ID of the VM.", - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid" - }, - "online" : { + "force" : { + "description" : "Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.", "optional" : 1, - "description" : "Use online/live migration.", - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "node" : { + "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", - "description" : "The cluster node name." + "typetext" : "" }, - "force" : { - "type" : "boolean", + "online" : { + "description" : "Use online/live migration.", "optional" : 1, - "description" : "Force migration despite local bind / device mounts. WARNING: identical bind / device mounts need to be available on the target node." + "type" : "boolean", + "typetext" : "" }, "target" : { - "type" : "string", + "description" : "Target node.", "format" : "pve-node", - "description" : "Target node." + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", "permissions" : { "check" : [ "perm", @@ -14678,43 +16270,26 @@ var pveapi = [ ] }, "protected" : 1, + "proxyto" : "node", "returns" : { "description" : "the task ID.", "type" : "string" - }, - "name" : "migrate_vm", - "method" : "POST", - "description" : "Migrate the container to another node. Creates a new migration task." + } } }, - "path" : "/nodes/{node}/lxc/{vmid}/migrate" + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/migrate", + "text" : "migrate" }, { - "text" : "feature", - "leaf" : 1, "info" : { "GET" : { + "description" : "Check if feature for virtual machine is available.", "method" : "GET", "name" : "vm_feature", - "returns" : { - "properties" : { - "hasFeature" : { - "type" : "boolean" - } - }, - "type" : "object" - }, - "description" : "Check if feature for virtual machine is available.", - "proxyto" : "node", "parameters" : { + "additionalProperties" : 0, "properties" : { - "snapname" : { - "maxLength" : 40, - "description" : "The name of the snapshot.", - "optional" : 1, - "type" : "string", - "format" : "pve-configid" - }, "feature" : { "description" : "Feature to check.", "enum" : [ @@ -14725,16 +16300,25 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "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", - "format" : "pve-vmid", - "description" : "The (unique) ID of the VM." + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, "permissions" : { "check" : [ @@ -14745,73 +16329,154 @@ var pveapi = [ ] ] }, - "protected" : 1 + "protected" : 1, + "proxyto" : "node", + "returns" : { + "properties" : { + "hasFeature" : { + "type" : "boolean" + } + }, + "type" : "object" + } } }, - "path" : "/nodes/{node}/lxc/{vmid}/feature" + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/feature", + "text" : "feature" }, { - "path" : "/nodes/{node}/lxc/{vmid}/template", "info" : { "POST" : { - "returns" : { - "type" : "null" - }, - "name" : "template", - "method" : "POST", "description" : "Create a Template.", - "proxyto" : "node", + "method" : "POST", + "name" : "template", "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" : "" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", + "minimum" : 1, "type" : "integer", - "minimum" : 1 - }, - "experimental" : { - "type" : "boolean", - "default" : 0, - "description" : "The template feature is experimental, set this flag if you know what you are doing." + "typetext" : " (1 - N)" } } }, - "protected" : 1, "permissions" : { - "description" : "You need 'VM.Allocate' permissions on /vms/{vmid}", "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" }, { - "leaf" : 1, - "text" : "clone", - "path" : "/nodes/{node}/lxc/{vmid}/clone", "info" : { "POST" : { "description" : "Create a container clone/copy", - "name" : "clone_vm", "method" : "POST", - "returns" : { - "type" : "string" + "name" : "clone_vm", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "description" : { + "description" : "Description for the new CT.", + "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", + "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 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" : { - "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.", "check" : [ "and", [ @@ -14840,127 +16505,38 @@ var pveapi = [ "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", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "storage" : { - "requires" : "full", - "type" : "string", - "format" : "pve-storage-id", - "description" : "Target storage for full clone.", - "optional" : 1 - }, - "vmid" : { - "description" : "The (unique) ID of the VM.", - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid" - }, - "newid" : { - "description" : "VMID for the clone.", - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1 - }, - "experimental" : { - "description" : "The clone feature is experimental, set this flag if you know what you are doing.", - "type" : "boolean", - "default" : 0 - }, - "description" : { - "optional" : 1, - "description" : "Description for the new CT.", - "type" : "string" - }, - "hostname" : { - "description" : "Set a hostname for the new CT.", - "optional" : 1, - "type" : "string", - "format" : "dns-name" - }, - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - }, - "pool" : { - "optional" : 1, - "description" : "Add the new CT to the specified pool.", - "format" : "pve-poolid", - "type" : "string" - }, - "snapname" : { - "optional" : 1, - "description" : "The name of the snapshot.", - "maxLength" : 40, - "type" : "string", - "format" : "pve-configid" - }, - "full" : { - "optional" : 1, - "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.", - "default" : 0, - "type" : "boolean" - } - } + "returns" : { + "type" : "string" } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/clone", + "text" : "clone" }, { - "text" : "resize", - "leaf" : 1, "info" : { "PUT" : { - "description" : "Resize a container mountpoint.", - "returns" : { - "description" : "the task ID.", - "type" : "string" - }, + "description" : "Resize a container mount point.", "method" : "PUT", "name" : "resize_vm", - "permissions" : { - "check" : [ - "perm", - "/vms/{vmid}", - [ - "VM.Config.Disk" - ], - "any", - 1 - ] - }, - "protected" : 1, "parameters" : { + "additionalProperties" : 0, "properties" : { - "vmid" : { - "format" : "pve-vmid", - "type" : "integer", - "minimum" : 1, - "description" : "The (unique) ID of the VM." - }, - "size" : { - "pattern" : "\\+?\\d+(\\.\\d+)?[KMGT]?", - "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.", - "type" : "string" - }, "digest" : { - "type" : "string", + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", "maxLength" : 40, "optional" : 1, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." - }, - "node" : { "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." + "typetext" : "" }, "disk" : { - "type" : "string", + "description" : "The disk you want to resize.", "enum" : [ "rootfs", "mp0", @@ -14974,43 +16550,75 @@ var pveapi = [ "mp8", "mp9" ], - "description" : "The disk you want to resize." + "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, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node" + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Config.Disk" + ], + "any", + 1 + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "description" : "the task ID.", + "type" : "string" + } } }, - "path" : "/nodes/{node}/lxc/{vmid}/resize" + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/resize", + "text" : "resize" } ], "info" : { "DELETE" : { - "name" : "destroy_vm", - "method" : "DELETE", - "returns" : { - "type" : "string" - }, "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" : { - "minimum" : 1, + "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", + "minimum" : 1, "type" : "integer", - "description" : "The (unique) ID of the VM." - }, - "node" : { - "description" : "The cluster node name.", - "type" : "string", - "format" : "pve-node" + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -15019,405 +16627,385 @@ var pveapi = [ "VM.Allocate" ] ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" } }, "GET" : { - "returns" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "subdir" : { - "type" : "string" - } - } - }, - "links" : [ - { - "href" : "{subdir}", - "rel" : "child" - } - ] - }, - "proxyto" : "node", + "description" : "Directory index", + "method" : "GET", + "name" : "vmdiridx", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", - "type" : "integer", "format" : "pve-vmid", - "minimum" : 1 + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "method" : "GET", - "name" : "vmdiridx", - "description" : "Directory index", "permissions" : { "user" : "all" + }, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "subdir" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{subdir}", + "rel" : "child" + } + ], + "type" : "array" } } }, - "path" : "/nodes/{node}/lxc/{vmid}" + "leaf" : 0, + "path" : "/nodes/{node}/lxc/{vmid}", + "text" : "{vmid}" } ], - "path" : "/nodes/{node}/lxc", "info" : { "GET" : { - "permissions" : { - "description" : "Only list CTs where you have VM.Audit permissons on /vms/.", - "user" : "all" - }, - "protected" : 1, + "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" + "type" : "string", + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, + "permissions" : { + "description" : "Only list CTs where you have VM.Audit permissons on /vms/.", + "user" : "all" + }, + "protected" : 1, "proxyto" : "node", - "description" : "LXC container index (per node).", - "method" : "GET", - "name" : "vmlist", "returns" : { "items" : { - "type" : "object", - "properties" : {} + "properties" : {}, + "type" : "object" }, - "type" : "array", "links" : [ { - "rel" : "child", - "href" : "{vmid}" + "href" : "{vmid}", + "rel" : "child" } - ] + ], + "type" : "array" } }, "POST" : { - "protected" : 1, - "permissions" : { - "user" : "all", - "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." - }, + "description" : "Create or restore a container.", + "method" : "POST", + "name" : "create_vm", "parameters" : { + "additionalProperties" : 0, "properties" : { - "net[n]" : { - "format" : { - "gw6" : { - "type" : "string", - "format" : "ipv6", - "description" : "Default gateway for IPv6 traffic.", - "format_description" : "GatewayIPv6", - "optional" : 1 - }, - "hwaddr" : { - "type" : "string", - "optional" : 1, - "description" : "Bridge to attach the network device to. (lxc.network.hwaddr)", - "format_description" : "MAC", - "pattern" : "(?^i:(?:[a-f0-9]{2}:){5}[a-f0-9]{2})" - }, - "gw" : { - "type" : "string", - "format" : "ipv4", - "format_description" : "GatewayIPv4", - "optional" : 1, - "description" : "Default gateway for IPv4 traffic." - }, - "ip" : { - "format_description" : "IPv4Format/CIDR", - "optional" : 1, - "description" : "IPv4 address in CIDR format.", - "type" : "string", - "format" : "pve-ipv4-config" - }, - "rate" : { - "type" : "number", - "format_description" : "mbps", - "description" : "Apply rate limiting to the interface", - "optional" : 1 - }, - "tag" : { - "type" : "integer", - "maximum" : "4094", - "minimum" : "2", - "format_description" : "VlanNo", - "description" : "VLAN tag for this interface.", - "optional" : 1 - }, - "name" : { - "description" : "Name of the network device as seen from inside the container. (lxc.network.name)", - "format_description" : "String", - "pattern" : "[-_.\\w\\d]+", - "type" : "string" - }, - "bridge" : { - "type" : "string", - "format_description" : "vmbr", - "description" : "Bridge to attach the network device to.", - "optional" : 1, - "pattern" : "[-_.\\w\\d]+" - }, - "trunks" : { - "type" : "string", - "format_description" : "vlanid[;vlanid...]", - "description" : "VLAN ids to pass through the interface", - "optional" : 1, - "pattern" : "(?^:\\d+(?:;\\d+)*)" - }, - "type" : { - "type" : "string", - "enum" : [ - "veth" - ], - "optional" : 1, - "description" : "Network interface type." - }, - "ip6" : { - "format_description" : "IPv6Format/CIDR", - "optional" : 1, - "description" : "IPv6 address in CIDR format.", - "format" : "pve-ipv6-config", - "type" : "string" - }, - "firewall" : { - "format_description" : "[1|0]", - "optional" : 1, - "description" : "Controls whether this interface's firewall rules should be used.", - "type" : "boolean" - }, - "mtu" : { - "type" : "integer", - "minimum" : 64, - "format_description" : "Number", - "optional" : 1, - "description" : "Maximum transfer unit of the interface. (lxc.network.mtu)" - } - }, - "type" : "string", - "optional" : 1, - "description" : "Specifies network interfaces for the container." - }, - "swap" : { - "type" : "integer", - "default" : 512, - "minimum" : 0, - "optional" : 1, - "description" : "Amount of SWAP for the VM in MB." - }, - "pool" : { - "optional" : 1, - "description" : "Add the VM to the specified pool.", - "format" : "pve-poolid", - "type" : "string" - }, - "mp[n]" : { - "optional" : 1, - "description" : "Use volume as container mount point (experimental feature).", - "format" : { - "quota" : { - "type" : "boolean", - "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)", - "format_description" : "[0|1]", - "optional" : 1 - }, - "size" : { - "format" : "disk-size", - "type" : "string", - "description" : "Volume size (read only value).", - "format_description" : "DiskSize", - "optional" : 1 - }, - "backup" : { - "type" : "boolean", - "description" : "Whether to include the mountpoint in backups.", - "format_description" : "[1|0]", - "optional" : 1 - }, - "volume" : { - "format" : "pve-lxc-mp-string", - "type" : "string", - "format_description" : "volume", - "description" : "Volume, device or directory to mount into the container.", - "default_key" : 1 - }, - "mp" : { - "description" : "Path to the mountpoint as seen from inside the container.", - "format_description" : "Path", - "type" : "string", - "format" : "pve-lxc-mp-string" - }, - "ro" : { - "type" : "boolean", - "description" : "Read-only mountpoint (not supported with bind mounts)", - "optional" : 1, - "format_description" : "ro" - }, - "acl" : { - "type" : "boolean", - "optional" : 1, - "format_description" : "acl", - "description" : "Explicitly enable or disable ACL support." - } - }, - "type" : "string" - }, - "vmid" : { - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1, - "description" : "The (unique) ID of the VM." - }, - "description" : { - "description" : "Container description. Only used on the configuration web interface.", - "optional" : 1, - "type" : "string" - }, - "tty" : { - "minimum" : 0, - "maximum" : 6, - "type" : "integer", - "default" : 2, - "description" : "Specify the number of tty available to the container", - "optional" : 1 - }, - "onboot" : { - "default" : 0, - "type" : "boolean", - "optional" : 1, - "description" : "Specifies whether a VM will be started during system bootup." - }, - "ostemplate" : { - "type" : "string", - "description" : "The OS template or backup file.", - "maxLength" : 255 - }, - "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.", - "typetext" : "[[order=]\\d+] [,up=\\d+] [,down=\\d+] ", + "arch" : { + "default" : "amd64", + "description" : "OS architecture type.", + "enum" : [ + "amd64", + "i386" + ], "optional" : 1, - "type" : "string", - "format" : "pve-startup-order" + "type" : "string" }, - "memory" : { - "default" : 512, - "type" : "integer", - "minimum" : 16, + "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, - "description" : "Amount of RAM for the VM in MB." + "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.", + "console" : { + "default" : 1, + "description" : "Attach a console device (/dev/console) to the container.", "optional" : 1, - "type" : "string", - "format" : "dns-name-list" - }, - "ignore-unpack-errors" : { "type" : "boolean", - "optional" : 1, - "description" : "Ignore errors when extracting the template." - }, - "force" : { - "optional" : 1, - "description" : "Allow to overwrite existing container.", - "type" : "boolean" + "typetext" : "" }, - "restore" : { - "optional" : 1, - "description" : "Mark this as restore task.", - "type" : "boolean" - }, - "unprivileged" : { + "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, - "description" : "Makes the container run as unprivileged user. (Should not be modified manually.)", - "default" : 0, - "type" : "boolean" + "type" : "integer", + "typetext" : " (1 - 128)" }, "cpulimit" : { "default" : 0, - "type" : "number", + "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, - "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." - }, - "storage" : { - "type" : "string", - "default" : "local", - "format" : "pve-storage-id", - "description" : "Default Storage.", - "optional" : 1 + "type" : "number", + "typetext" : " (0 - 128)" }, "cpuunits" : { - "optional" : 1, + "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, - "default" : 1024, + "optional" : 1, "type" : "integer", - "maximum" : 500000 + "typetext" : " (0 - 500000)" }, - "console" : { - "description" : "Attach a console device (/dev/console) to the container.", + "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", - "default" : 1 + "typetext" : "" }, "lock" : { + "description" : "Lock/unlock the VM.", "enum" : [ "migrate", "backup", "snapshot", "rollback" ], - "description" : "Lock/unlock the VM.", "optional" : 1, "type" : "string" }, - "template" : { + "memory" : { + "default" : 512, + "description" : "Amount of RAM for the VM in MB.", + "minimum" : 16, "optional" : 1, - "description" : "Enable/disable Template.", - "default" : 0, - "type" : "boolean" + "type" : "integer", + "typetext" : " (16 - N)" }, - "password" : { - "minLength" : 5, + "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" + }, + "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, - "description" : "Sets root password inside container.", - "type" : "string" - }, - "unused[n]" : { - "format" : "pve-volume-id", "type" : "string", + "typetext" : "[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]" + }, + "nameserver" : { + "description" : "Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.", + "format" : "address-list", "optional" : 1, - "description" : "Reference to unused volumes." + "type" : "string", + "typetext" : "" }, - "arch" : { - "enum" : [ - "amd64", - "i386" - ], - "description" : "OS architecture type.", + "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", + "optional" : 1, + "pattern" : "(?^i:(?:[a-f0-9]{2}:){5}[a-f0-9]{2})", + "type" : "string" + }, + "ip" : { + "description" : "IPv4 address in CIDR format.", + "format" : "pve-ipv4-config", + "format_description" : "IPv4Format/CIDR", + "optional" : 1, + "type" : "string" + }, + "ip6" : { + "description" : "IPv6 address in CIDR format.", + "format" : "pve-ipv6-config", + "format_description" : "IPv6Format/CIDR", + "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", - "default" : "amd64" + "typetext" : "name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]" }, - "nameserver" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "address-list", - "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.", - "optional" : 1 + "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", @@ -15426,144 +17014,201 @@ var pveapi = [ "opensuse", "archlinux", "alpine", + "gentoo", "unmanaged" ], - "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.", "optional" : 1, "type" : "string" }, - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." - }, - "hostname" : { - "format" : "dns-name", - "type" : "string", + "password" : { + "description" : "Sets root password inside container.", + "minLength" : 5, "optional" : 1, - "maxLength" : 255, - "description" : "Set a host name for the container." - }, - "ssh-public-keys" : { "type" : "string", - "optional" : 1, - "description" : "Setup public SSH keys (one key per line, OpenSSH format)." + "typetext" : "" }, - "cmode" : { - "default" : "tty", - "type" : "string", - "enum" : [ - "shell", - "console", - "tty" - ], + "pool" : { + "description" : "Add the VM to the specified pool.", + "format" : "pve-poolid", "optional" : 1, - "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)." + "type" : "string", + "typetext" : "" }, "protection" : { - "optional" : 1, + "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", - "default" : 0 + "typetext" : "" }, - "rootfs" : { + "restore" : { + "description" : "Mark this as restore task.", "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "rootfs" : { "description" : "Use volume as container root.", - "type" : "string", "format" : { - "ro" : { - "optional" : 1, - "description" : "Read-only mountpoint (not supported with bind mounts)", - "format_description" : "ro", - "type" : "boolean" - }, "acl" : { - "format_description" : "acl", "description" : "Explicitly enable or disable ACL support.", "optional" : 1, "type" : "boolean" }, - "volume" : { - "default_key" : 1, - "description" : "Volume, device or directory to mount into the container.", - "format_description" : "volume", - "type" : "string", - "format" : "pve-lxc-mp-string" + "quota" : { + "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)", + "optional" : 1, + "type" : "boolean" }, - "backup" : { - "format_description" : "[1|0]", - "description" : "Whether to include the mountpoint in backups.", + "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" : { - "format_description" : "DiskSize", "description" : "Volume size (read only value).", + "format" : "disk-size", + "format_description" : "DiskSize", "optional" : 1, - "type" : "string", - "format" : "disk-size" + "type" : "string" }, - "quota" : { - "type" : "boolean", - "format_description" : "[0|1]", - "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)", - "optional" : 1 + "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>] [,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" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, + "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", - "description" : "Create or restore a container.", - "method" : "POST", - "name" : "create_vm", "returns" : { "type" : "string" } } }, - "text" : "lxc", - "leaf" : 0 + "leaf" : 0, + "path" : "/nodes/{node}/lxc", + "text" : "lxc" }, { - "text" : "ceph", - "leaf" : 0, "children" : [ { - "leaf" : 0, - "text" : "osd", "children" : [ { - "text" : "{osdid}", - "leaf" : 0, "children" : [ { - "path" : "/nodes/{node}/ceph/osd/{osdid}/in", "info" : { "POST" : { - "returns" : { - "type" : "null" - }, + "description" : "ceph osd in", "method" : "POST", "name" : "in", - "description" : "ceph osd in", - "proxyto" : "node", "parameters" : { "additionalProperties" : 0, "properties" : { - "osdid" : { - "type" : "integer", - "description" : "OSD ID" - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" + }, + "osdid" : { + "description" : "OSD ID", + "type" : "integer", + "typetext" : "" } } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -15572,23 +17217,40 @@ var pveapi = [ "Sys.Modify" ] ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" } } }, "leaf" : 1, + "path" : "/nodes/{node}/ceph/osd/{osdid}/in", "text" : "in" }, { - "text" : "out", - "leaf" : 1, "info" : { "POST" : { "description" : "ceph osd out", - "returns" : { - "type" : "null" - }, "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", @@ -15600,81 +17262,72 @@ var pveapi = [ }, "protected" : 1, "proxyto" : "node", - "parameters" : { - "properties" : { - "osdid" : { - "type" : "integer", - "description" : "OSD ID" - }, - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." - } - }, - "additionalProperties" : 0 + "returns" : { + "type" : "null" } } }, - "path" : "/nodes/{node}/ceph/osd/{osdid}/out" + "leaf" : 1, + "path" : "/nodes/{node}/ceph/osd/{osdid}/out", + "text" : "out" } ], "info" : { "DELETE" : { - "protected" : 1, "description" : "Destroy OSD", - "returns" : { - "type" : "string" - }, + "method" : "DELETE", + "name" : "destroyosd", "parameters" : { "additionalProperties" : 0, "properties" : { - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - }, "cleanup" : { - "type" : "boolean", "default" : 0, + "description" : "If set, we remove partition table entries.", "optional" : 1, - "description" : "If set, we remove partition table entries." + "type" : "boolean", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, "osdid" : { + "description" : "OSD ID", "type" : "integer", - "description" : "OSD ID" + "typetext" : "" } } }, + "protected" : 1, "proxyto" : "node", - "name" : "destroyosd", - "method" : "DELETE" + "returns" : { + "type" : "string" + } } }, - "path" : "/nodes/{node}/ceph/osd/{osdid}" + "leaf" : 0, + "path" : "/nodes/{node}/ceph/osd/{osdid}", + "text" : "{osdid}" } ], - "path" : "/nodes/{node}/ceph/osd", "info" : { "GET" : { - "name" : "index", - "method" : "GET", - "returns" : { - "type" : "object" - }, "description" : "Get Ceph osd list/tree.", + "method" : "GET", + "name" : "index", "parameters" : { "additionalProperties" : 0, "properties" : { "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" } } }, - "proxyto" : "node", - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -15686,75 +17339,87 @@ var pveapi = [ "any", 1 ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "object" } }, "POST" : { - "protected" : 1, "description" : "Create OSD", - "returns" : { - "type" : "string" - }, + "method" : "POST", + "name" : "createosd", "parameters" : { "additionalProperties" : 0, "properties" : { - "fstype" : { + "dev" : { + "description" : "Block device name.", "type" : "string", + "typetext" : "" + }, + "fstype" : { "default" : "xfs", + "description" : "File system type.", "enum" : [ "xfs", "ext4", "btrfs" ], "optional" : 1, - "description" : "File system type." - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", "type" : "string" }, - "dev" : { - "type" : "string", - "description" : "Block device name." - }, "journal_dev" : { "description" : "Block device name for journal.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" } } }, + "protected" : 1, "proxyto" : "node", - "method" : "POST", - "name" : "createosd" + "returns" : { + "type" : "string" + } } - } + }, + "leaf" : 0, + "path" : "/nodes/{node}/ceph/osd", + "text" : "osd" }, { - "path" : "/nodes/{node}/ceph/disks", "info" : { "GET" : { - "proxyto" : "node", + "description" : "List local disks.", + "method" : "GET", + "name" : "disks", "parameters" : { + "additionalProperties" : 0, "properties" : { - "type" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", + "typetext" : "" + }, + "type" : { "description" : "Only list specific types of disks.", - "optional" : 1, "enum" : [ "unused", "journal_disks" - ] - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + ], + "optional" : 1, "type" : "string" } - }, - "additionalProperties" : 0 + } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -15767,54 +17432,67 @@ var pveapi = [ 1 ] }, + "protected" : 1, + "proxyto" : "node", "returns" : { "items" : { - "type" : "object", "properties" : { - "used" : { - "optional" : 1, + "dev" : { "type" : "string" }, - "size" : { - "type" : "integer" - }, - "vendor" : { - "type" : "string", - "optional" : 1 - }, "gpt" : { "type" : "boolean" }, "model" : { - "type" : "string", - "optional" : 1 + "optional" : 1, + "type" : "string" + }, + "osdid" : { + "type" : "integer" }, "serial" : { - "type" : "string", - "optional" : 1 + "optional" : 1, + "type" : "string" }, - "osdid" : { + "size" : { "type" : "integer" }, - "dev" : { + "used" : { + "optional" : 1, + "type" : "string" + }, + "vendor" : { + "optional" : 1, "type" : "string" } - } + }, + "type" : "object" }, "type" : "array" - }, - "method" : "GET", - "name" : "disks", - "description" : "List local disks." + } } }, "leaf" : 1, + "path" : "/nodes/{node}/ceph/disks", "text" : "disks" }, { - "path" : "/nodes/{node}/ceph/config", "info" : { "GET" : { + "description" : "Get Ceph configuration.", + "method" : "GET", + "name" : "config", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, "permissions" : { "check" : [ "perm", @@ -15827,67 +17505,73 @@ var pveapi = [ 1 ] }, - "description" : "Get Ceph configuration.", "returns" : { "type" : "string" - }, - "parameters" : { - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" - } - }, - "additionalProperties" : 0 - }, - "method" : "GET", - "name" : "config" + } } }, "leaf" : 1, + "path" : "/nodes/{node}/ceph/config", "text" : "config" }, { - "info" : { - "POST" : { - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "parameters" : { - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", + "children" : [ + { + "info" : { + "DELETE" : { + "description" : "Destroy Ceph monitor.", + "method" : "DELETE", + "name" : "destroymon", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "monid" : { + "description" : "Monitor ID", + "type" : "integer", + "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" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", - "description" : "Create Ceph Monitor", - "method" : "POST", - "name" : "createmon", - "returns" : { - "type" : "string" - } - }, + "leaf" : 1, + "path" : "/nodes/{node}/ceph/mon/{monid}", + "text" : "{monid}" + } + ], + "info" : { "GET" : { - "proxyto" : "node", + "description" : "Get Ceph monitor list.", + "method" : "GET", + "name" : "listmon", "parameters" : { "additionalProperties" : 0, "properties" : { "node" : { + "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", - "description" : "The cluster node name." + "typetext" : "" } } }, @@ -15904,123 +17588,106 @@ var pveapi = [ ] }, "protected" : 1, + "proxyto" : "node", "returns" : { - "links" : [ - { - "rel" : "child", - "href" : "{name}" - } - ], - "type" : "array", "items" : { - "type" : "object", "properties" : { - "name" : { + "addr" : { "type" : "string" }, - "addr" : { + "name" : { "type" : "string" } - } - } - }, - "method" : "GET", - "name" : "listmon", - "description" : "Get Ceph monitor list." - } - }, - "children" : [ - { - "info" : { - "DELETE" : { - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." - }, - "monid" : { - "description" : "Monitor ID", - "type" : "integer" - } - } }, - "proxyto" : "node", - "description" : "Destroy Ceph monitor.", - "name" : "destroymon", - "method" : "DELETE", - "returns" : { - "type" : "string" + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "description" : "Create Ceph Monitor", + "method" : "POST", + "name" : "createmon", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" } } }, - "path" : "/nodes/{node}/ceph/mon/{monid}", - "text" : "{monid}", - "leaf" : 1 + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } } - ], - "path" : "/nodes/{node}/ceph/mon", + }, "leaf" : 0, + "path" : "/nodes/{node}/ceph/mon", "text" : "mon" }, { - "text" : "init", - "leaf" : 1, - "info" : { - "POST" : { - "returns" : { - "type" : "null" - }, - "name" : "init", - "method" : "POST", + "info" : { + "POST" : { "description" : "Create initial ceph default configuration and setup symlinks.", + "method" : "POST", + "name" : "init", "parameters" : { + "additionalProperties" : 0, "properties" : { - "node" : { + "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", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" }, "pg_bits" : { - "optional" : 1, + "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.", - "minimum" : 6, "maximum" : 14, - "default" : 6, - "type" : "integer" + "minimum" : 6, + "optional" : 1, + "type" : "integer", + "typetext" : " (6 - 14)" }, "size" : { + "default" : 2, "description" : "Number of replicas per object", - "optional" : 1, - "minimum" : 1, "maximum" : 3, - "type" : "integer", - "default" : 2 - }, - "network" : { + "minimum" : 1, "optional" : 1, - "maxLength" : 128, - "description" : "Use specific network for all ceph related traffic", - "format" : "CIDR", - "type" : "string" + "type" : "integer", + "typetext" : " (1 - 3)" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -16029,83 +17696,84 @@ var pveapi = [ "Sys.Modify" ] ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" } } }, - "path" : "/nodes/{node}/ceph/init" + "leaf" : 1, + "path" : "/nodes/{node}/ceph/init", + "text" : "init" }, { - "path" : "/nodes/{node}/ceph/stop", "info" : { "POST" : { "description" : "Stop ceph services.", - "returns" : { - "type" : "string" - }, "method" : "POST", "name" : "stop", - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" + "typetext" : "" }, "service" : { - "type" : "string", "description" : "Ceph service name.", "optional" : 1, - "pattern" : "(mon|mds|osd)\\.[A-Za-z0-9]{1,32}" + "pattern" : "(mon|mds|osd)\\.[A-Za-z0-9]{1,32}", + "type" : "string" } - }, - "additionalProperties" : 0 + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] }, - "proxyto" : "node" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } } }, "leaf" : 1, + "path" : "/nodes/{node}/ceph/stop", "text" : "stop" }, { - "leaf" : 1, - "text" : "start", - "path" : "/nodes/{node}/ceph/start", "info" : { "POST" : { - "returns" : { - "type" : "string" - }, - "name" : "start", - "method" : "POST", "description" : "Start ceph services.", + "method" : "POST", + "name" : "start", "parameters" : { "additionalProperties" : 0, "properties" : { "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" }, "service" : { - "optional" : 1, "description" : "Ceph service name.", + "optional" : 1, "pattern" : "(mon|mds|osd)\\.[A-Za-z0-9]{1,32}", "type" : "string" } } }, - "proxyto" : "node", - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -16114,19 +17782,34 @@ var pveapi = [ "Sys.Modify" ] ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/ceph/start", + "text" : "start" }, { - "path" : "/nodes/{node}/ceph/status", "info" : { "GET" : { "description" : "Get ceph status.", - "name" : "status", "method" : "GET", - "returns" : { - "type" : "object" + "name" : "status", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } }, "permissions" : { "check" : [ @@ -16142,37 +17825,46 @@ var pveapi = [ }, "protected" : 1, "proxyto" : "node", - "parameters" : { - "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" - } - }, - "additionalProperties" : 0 + "returns" : { + "type" : "object" } } }, - "text" : "status", - "leaf" : 1 + "leaf" : 1, + "path" : "/nodes/{node}/ceph/status", + "text" : "status" }, { - "text" : "pools", - "leaf" : 0, "children" : [ { - "text" : "{name}", - "leaf" : 1, "info" : { "DELETE" : { "description" : "Destroy pool", - "name" : "destroypool", "method" : "DELETE", - "returns" : { - "type" : "null" + "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" : "" + } + } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -16182,161 +17874,162 @@ var pveapi = [ ] ] }, - "parameters" : { - "properties" : { - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - }, - "name" : { - "description" : "The name of the pool. It must be unique.", - "type" : "string" - } - }, - "additionalProperties" : 0 - }, - "proxyto" : "node" + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } } }, - "path" : "/nodes/{node}/ceph/pools/{name}" + "leaf" : 1, + "path" : "/nodes/{node}/ceph/pools/{name}", + "text" : "{name}" } ], "info" : { - "POST" : { + "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" : "" + } + } + }, "permissions" : { "check" : [ "perm", "/", [ - "Sys.Modify" - ] + "Sys.Audit", + "Datastore.Audit" + ], + "any", + 1 ] }, "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" : { - "pg_num" : { - "description" : "Number of placement groups.", - "optional" : 1, - "minimum" : 8, + "crush_ruleset" : { + "default" : 0, + "description" : "The ruleset to use for mapping object placement in the cluster.", "maximum" : 32768, + "minimum" : 0, + "optional" : 1, "type" : "integer", - "default" : 64 - }, - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." + "typetext" : " (0 - 32768)" }, - "crush_ruleset" : { + "min_size" : { + "default" : 1, + "description" : "Minimum number of replicas per object", + "maximum" : 3, + "minimum" : 1, "optional" : 1, - "description" : "The ruleset to use for mapping object placement in the cluster.", - "default" : 0, "type" : "integer", - "maximum" : 32768, - "minimum" : 0 + "typetext" : " (1 - 3)" + }, + "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" : "" }, - "min_size" : { - "minimum" : 1, - "maximum" : 3, - "default" : 1, + "pg_num" : { + "default" : 64, + "description" : "Number of placement groups.", + "maximum" : 32768, + "minimum" : 8, + "optional" : 1, "type" : "integer", - "description" : "Minimum number of replicas per object", - "optional" : 1 + "typetext" : " (8 - 32768)" }, "size" : { - "maximum" : 3, "default" : 2, - "type" : "integer", + "description" : "Number of replicas per object", + "maximum" : 3, "minimum" : 1, "optional" : 1, - "description" : "Number of replicas per object" - }, - "name" : { - "description" : "The name of the pool. It must be unique.", - "type" : "string" + "type" : "integer", + "typetext" : " (1 - 3)" } - }, - "additionalProperties" : 0 + } }, - "description" : "Create POOL", - "name" : "createpool", - "method" : "POST", - "returns" : { - "type" : "null" - } - }, - "GET" : { - "protected" : 1, "permissions" : { "check" : [ "perm", "/", [ - "Sys.Audit", - "Datastore.Audit" - ], - "any", - 1 + "Sys.Modify" + ] ] }, - "parameters" : { - "properties" : { - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." - } - }, - "additionalProperties" : 0 - }, + "protected" : 1, "proxyto" : "node", - "description" : "List all pools.", "returns" : { - "links" : [ - { - "rel" : "child", - "href" : "{pool_name}" - } - ], - "type" : "array", - "items" : { - "properties" : { - "pool_name" : { - "type" : "string" - }, - "pool" : { - "type" : "integer" - }, - "size" : { - "type" : "integer" - } - }, - "type" : "object" - } - }, - "method" : "GET", - "name" : "lspools" + "type" : "null" + } } }, - "path" : "/nodes/{node}/ceph/pools" + "leaf" : 0, + "path" : "/nodes/{node}/ceph/pools", + "text" : "pools" }, { - "text" : "crush", - "leaf" : 1, - "path" : "/nodes/{node}/ceph/crush", "info" : { "GET" : { - "proxyto" : "node", + "description" : "Get OSD crush map", + "method" : "GET", + "name" : "crush", "parameters" : { "additionalProperties" : 0, "properties" : { "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" } } }, @@ -16353,62 +18046,45 @@ var pveapi = [ ] }, "protected" : 1, - "method" : "GET", - "name" : "crush", + "proxyto" : "node", "returns" : { "type" : "string" - }, - "description" : "Get OSD crush map" + } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/ceph/crush", + "text" : "crush" }, { - "leaf" : 1, - "text" : "log", - "path" : "/nodes/{node}/ceph/log", "info" : { "GET" : { - "name" : "log", - "method" : "GET", - "returns" : { - "items" : { - "properties" : { - "n" : { - "description" : "Line number", - "type" : "integer" - }, - "t" : { - "type" : "string", - "description" : "Line text" - } - }, - "type" : "object" - }, - "type" : "array" - }, "description" : "Read ceph log", - "proxyto" : "node", + "method" : "GET", + "name" : "log", "parameters" : { + "additionalProperties" : 0, "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" - }, "limit" : { + "minimum" : 0, "optional" : 1, "type" : "integer", - "minimum" : 0 + "typetext" : " (0 - N)" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, "start" : { - "type" : "integer", "minimum" : 0, - "optional" : 1 + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" } - }, - "additionalProperties" : 0 + } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -16417,14 +18093,48 @@ var pveapi = [ "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" } ], - "path" : "/nodes/{node}/ceph", "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", @@ -16437,250 +18147,299 @@ var pveapi = [ 1 ] }, - "description" : "Directory index.", - "name" : "index", - "method" : "GET", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - } - } - }, "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, "links" : [ { "href" : "{name}", "rel" : "child" } ], - "items" : { - "properties" : {}, - "type" : "object" - }, "type" : "array" } } - } + }, + "leaf" : 0, + "path" : "/nodes/{node}/ceph", + "text" : "ceph" }, { + "children" : [ + { + "info" : { + "GET" : { + "description" : "Extract configuration from vzdump backup archive.", + "method" : "GET", + "name" : "extractconfig", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "volume" : { + "description" : "Volume identifier", + "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" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/vzdump/extractconfig", + "text" : "extractconfig" + } + ], "info" : { "POST" : { - "protected" : 1, - "permissions" : { - "description" : "The user needs 'VM.Backup' permissions on any VM, and 'Datastore.AllocateSpace' on the backup storage.", - "user" : "all" - }, - "proxyto" : "node", + "description" : "Create backup.", + "method" : "POST", + "name" : "vzdump", "parameters" : { "additionalProperties" : 0, "properties" : { - "mailnotification" : { - "default" : "always", - "type" : "string", - "optional" : 1, - "description" : "Specify when to send an email", - "enum" : [ - "always", - "failure" - ] - }, - "stdexcludes" : { - "default" : 1, - "type" : "boolean", - "optional" : 1, - "description" : "Exclude temporary files and logs." - }, - "pigz" : { + "all" : { "default" : 0, - "type" : "integer", - "optional" : 1, - "description" : "Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count." - }, - "maxfiles" : { - "optional" : 1, - "description" : "Maximal number of backup files per guest system.", - "minimum" : 1, - "type" : "integer", - "default" : 1 + "description" : "Backup all known guest systems on this host.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, - "lockwait" : { + "bwlimit" : { + "default" : 0, + "description" : "Limit I/O bandwidth (KBytes per second).", "minimum" : 0, - "default" : 180, + "optional" : 1, "type" : "integer", - "description" : "Maximal time to wait for the global lock (minutes).", - "optional" : 1 + "typetext" : " (0 - N)" }, - "vmid" : { + "compress" : { + "default" : "0", + "description" : "Compress dump file.", + "enum" : [ + "0", + "1", + "gzip", + "lzo" + ], "optional" : 1, - "description" : "The ID of the guest system you want to backup.", - "format" : "pve-vmid-list", "type" : "string" }, "dumpdir" : { "description" : "Store resulting files to specified directory.", "optional" : 1, - "type" : "string" + "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" : { - "maximum" : 8, - "type" : "integer", "default" : 7, - "minimum" : 0, "description" : "Set CFQ ionice priority.", - "optional" : 1 + "maximum" : 8, + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - 8)" }, - "node" : { - "format" : "pve-node", - "type" : "string", + "lockwait" : { + "default" : 180, + "description" : "Maximal time to wait for the global lock (minutes).", + "minimum" : 0, "optional" : 1, - "description" : "Only run if executed on this node." + "type" : "integer", + "typetext" : " (0 - N)" }, - "quiet" : { - "description" : "Be quiet.", + "mailnotification" : { + "default" : "always", + "description" : "Specify when to send an email", + "enum" : [ + "always", + "failure" + ], "optional" : 1, - "default" : 0, - "type" : "boolean" + "type" : "string" }, "mailto" : { + "description" : "Comma-separated list of email addresses that should receive email notifications.", "format" : "string-list", + "optional" : 1, "type" : "string", - "description" : "Comma-separated list of email addresses that should receive email notifications.", - "optional" : 1 + "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", - "type" : "string", "description" : "Backup mode.", - "optional" : 1, "enum" : [ "snapshot", "suspend", "stop" - ] - }, - "exclude" : { - "description" : "Exclude specified guest systems (assumes --all)", + ], "optional" : 1, - "format" : "pve-vmid-list", "type" : "string" }, - "stopwait" : { - "default" : 10, - "type" : "integer", - "minimum" : 0, + "node" : { + "description" : "Only run if executed on this node.", + "format" : "pve-node", "optional" : 1, - "description" : "Maximal time to wait until a guest system is stopped (minutes)." + "type" : "string", + "typetext" : "" }, - "exclude-path" : { - "description" : "Exclude certain files/directories (shell globs).", + "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, - "format" : "string-alist", - "type" : "string" + "type" : "integer", + "typetext" : "" }, - "all" : { + "quiet" : { "default" : 0, - "type" : "boolean", + "description" : "Be quiet.", "optional" : 1, - "description" : "Backup all known guest systems on this host." + "type" : "boolean", + "typetext" : "" }, "remove" : { - "type" : "boolean", "default" : 1, "description" : "Remove old backup files if there are more than 'maxfiles' backup files.", - "optional" : 1 - }, - "storage" : { - "type" : "string", - "format" : "pve-storage-id", - "optional" : 1, - "description" : "Store resulting file to this storage." - }, - "stdout" : { "optional" : 1, - "description" : "Write tar to stdout, not to a file.", - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, - "compress" : { - "enum" : [ - "0", - "1", - "gzip", - "lzo" - ], - "description" : "Compress dump file.", + "script" : { + "description" : "Use specified hook script.", "optional" : 1, - "default" : "0", - "type" : "string" + "type" : "string", + "typetext" : "" }, "size" : { - "optional" : 1, + "default" : 1024, "description" : "Unused, will be removed in a future release.", "minimum" : 500, + "optional" : 1, "type" : "integer", - "default" : 1024 + "typetext" : " (500 - N)" }, - "bwlimit" : { - "minimum" : 0, - "default" : 0, - "type" : "integer", - "description" : "Limit I/O bandwidth (KBytes per second).", - "optional" : 1 + "stdexcludes" : { + "default" : 1, + "description" : "Exclude temporary files and logs.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, - "tmpdir" : { - "type" : "string", + "stdout" : { + "description" : "Write tar to stdout, not to a file.", "optional" : 1, - "description" : "Store temporary files to specified directory." + "type" : "boolean", + "typetext" : "" }, "stop" : { "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).", + "minimum" : 0, "optional" : 1, - "description" : "Stop runnig backup jobs on this host." + "type" : "integer", + "typetext" : " (0 - N)" }, - "script" : { - "description" : "Use specified hook script.", + "storage" : { + "description" : "Store resulting file to this storage.", + "format" : "pve-storage-id", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" + }, + "tmpdir" : { + "description" : "Store temporary files to specified directory.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The ID of the guest system you want to backup.", + "format" : "pve-vmid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" } } }, - "description" : "Create backup.", + "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" - }, - "name" : "vzdump", - "method" : "POST" + } } }, + "leaf" : 0, "path" : "/nodes/{node}/vzdump", - "leaf" : 1, "text" : "vzdump" }, { - "path" : "/nodes/{node}/services", "children" : [ { "children" : [ { - "leaf" : 1, - "text" : "state", - "path" : "/nodes/{node}/services/{service}/state", "info" : { "GET" : { - "name" : "service_state", - "method" : "GET", - "returns" : { - "type" : "object", - "properties" : {} - }, "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" : [ @@ -16702,16 +18461,9 @@ var pveapi = [ "systemd-timesyncd" ], "type" : "string" - }, - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." } } }, - "proxyto" : "node", - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -16720,22 +18472,36 @@ var pveapi = [ "Sys.Audit" ] ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "properties" : {}, + "type" : "object" } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/services/{service}/state", + "text" : "state" }, { "info" : { "POST" : { - "proxyto" : "node", + "description" : "Start service.", + "method" : "POST", + "name" : "service_start", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { + "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", - "description" : "The cluster node name." + "typetext" : "" }, "service" : { + "description" : "Service ID", "enum" : [ "pveproxy", "pvedaemon", @@ -16754,11 +18520,9 @@ var pveapi = [ "ksmtuned", "systemd-timesyncd" ], - "description" : "Service ID", "type" : "string" } - }, - "additionalProperties" : 0 + } }, "permissions" : { "check" : [ @@ -16770,40 +18534,32 @@ var pveapi = [ ] }, "protected" : 1, + "proxyto" : "node", "returns" : { "type" : "string" - }, - "name" : "service_start", - "method" : "POST", - "description" : "Start service." + } } }, + "leaf" : 1, "path" : "/nodes/{node}/services/{service}/start", - "text" : "start", - "leaf" : 1 + "text" : "start" }, { - "text" : "stop", - "leaf" : 1, - "path" : "/nodes/{node}/services/{service}/stop", "info" : { "POST" : { - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", + "description" : "Stop service.", + "method" : "POST", + "name" : "service_stop", "parameters" : { "additionalProperties" : 0, "properties" : { - "service" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", + "typetext" : "" + }, + "service" : { "description" : "Service ID", "enum" : [ "pveproxy", @@ -16822,38 +18578,47 @@ var pveapi = [ "postfix", "ksmtuned", "systemd-timesyncd" - ] - }, - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." + ], + "type" : "string" } } }, - "description" : "Stop service.", + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", "returns" : { "type" : "string" - }, - "name" : "service_stop", - "method" : "POST" + } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/services/{service}/stop", + "text" : "stop" }, { - "path" : "/nodes/{node}/services/{service}/restart", "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", - "format" : "pve-node" + "typetext" : "" }, "service" : { - "type" : "string", "description" : "Service ID", "enum" : [ "pveproxy", @@ -16872,11 +18637,11 @@ var pveapi = [ "postfix", "ksmtuned", "systemd-timesyncd" - ] + ], + "type" : "string" } } }, - "proxyto" : "node", "permissions" : { "check" : [ "perm", @@ -16887,39 +18652,33 @@ var pveapi = [ ] }, "protected" : 1, - "name" : "service_restart", - "method" : "POST", + "proxyto" : "node", "returns" : { "type" : "string" - }, - "description" : "Restart service." + } } }, "leaf" : 1, + "path" : "/nodes/{node}/services/{service}/restart", "text" : "restart" }, { - "leaf" : 1, - "text" : "reload", - "path" : "/nodes/{node}/services/{service}/reload", "info" : { "POST" : { - "name" : "service_reload", - "method" : "POST", - "returns" : { - "type" : "string" - }, "description" : "Reload service.", - "proxyto" : "node", + "method" : "POST", + "name" : "service_reload", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" }, "service" : { - "type" : "string", + "description" : "Service ID", "enum" : [ "pveproxy", "pvedaemon", @@ -16938,12 +18697,10 @@ var pveapi = [ "ksmtuned", "systemd-timesyncd" ], - "description" : "Service ID" + "type" : "string" } - }, - "additionalProperties" : 0 + } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -16952,18 +18709,35 @@ var pveapi = [ "Sys.Modify" ] ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/services/{service}/reload", + "text" : "reload" } ], "info" : { "GET" : { + "description" : "Directory index", + "method" : "GET", + "name" : "srvcmdidx", "parameters" : { "additionalProperties" : 0, "properties" : { - "service" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", + "typetext" : "" + }, + "service" : { + "description" : "Service ID", "enum" : [ "pveproxy", "pvedaemon", @@ -16982,15 +18756,19 @@ var pveapi = [ "ksmtuned", "systemd-timesyncd" ], - "description" : "Service ID" - }, - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." + "type" : "string" } } }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Audit" + ] + ] + }, "returns" : { "items" : { "properties" : { @@ -17000,35 +18778,37 @@ var pveapi = [ }, "type" : "object" }, - "type" : "array", "links" : [ { - "rel" : "child", - "href" : "{subdir}" + "href" : "{subdir}", + "rel" : "child" } - ] - }, - "method" : "GET", - "name" : "srvcmdidx", - "description" : "Directory index", - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Audit" - ] - ] + ], + "type" : "array" } } }, - "path" : "/nodes/{node}/services/{service}", "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", @@ -17039,233 +18819,228 @@ var pveapi = [ ] }, "protected" : 1, - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." - } - } - }, "proxyto" : "node", - "description" : "Service list.", "returns" : { - "type" : "array", "items" : { "properties" : {}, "type" : "object" }, "links" : [ { - "rel" : "child", - "href" : "{service}" + "href" : "{service}", + "rel" : "child" } - ] - }, - "method" : "GET", - "name" : "index" + ], + "type" : "array" + } } }, "leaf" : 0, + "path" : "/nodes/{node}/services", "text" : "services" }, { "info" : { "GET" : { - "permissions" : { - "user" : "all" - }, "description" : "Read subscription info.", - "proxyto" : "node", + "method" : "GET", + "name" : "get", "parameters" : { "additionalProperties" : 0, "properties" : { "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, + "permissions" : { + "user" : "all" + }, + "proxyto" : "node", "returns" : { "type" : "object" - }, - "method" : "GET", - "name" : "get" + } }, "POST" : { + "description" : "Update subscription info.", "method" : "POST", "name" : "update", - "proxyto" : "node", "parameters" : { + "additionalProperties" : 0, "properties" : { "force" : { "default" : 0, - "type" : "boolean", + "description" : "Always connect to server, even if we have up to date info inside local cache.", "optional" : 1, - "description" : "Always connect to server, even if we have up to date info inside local cache." + "type" : "boolean", + "typetext" : "" }, "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, + "protected" : 1, + "proxyto" : "node", "returns" : { "type" : "null" - }, - "description" : "Update subscription info.", - "protected" : 1 + } }, "PUT" : { - "returns" : { - "type" : "null" - }, - "proxyto" : "node", + "description" : "Set subscription key.", + "method" : "PUT", + "name" : "set", "parameters" : { + "additionalProperties" : 0, "properties" : { "key" : { + "description" : "Proxmox VE subscription key", "type" : "string", - "description" : "Proxmox VE subscription key" + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, - "method" : "PUT", - "name" : "set", "protected" : 1, - "description" : "Set subscription key." + "proxyto" : "node", + "returns" : { + "type" : "null" + } } }, - "path" : "/nodes/{node}/subscription", "leaf" : 1, + "path" : "/nodes/{node}/subscription", "text" : "subscription" }, { - "leaf" : 0, - "text" : "network", - "path" : "/nodes/{node}/network", "children" : [ { - "leaf" : 1, - "text" : "{iface}", - "path" : "/nodes/{node}/network/{iface}", "info" : { - "PUT" : { - "method" : "PUT", - "name" : "update_network", - "returns" : { - "type" : "null" - }, - "description" : "Update network device configuration", - "proxyto" : "node", + "DELETE" : { + "description" : "Delete network device configuration", + "method" : "DELETE", + "name" : "delete_network", "parameters" : { "additionalProperties" : 0, "properties" : { - "ovs_tag" : { - "minimum" : 1, - "type" : "integer", - "maximum" : 4094, - "optional" : 1, - "description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)" - }, - "ovs_bonds" : { - "format" : "pve-iface-list", - "type" : "string", - "optional" : 1, - "description" : "Specify the interfaces used by the bonding device." - }, - "gateway6" : { - "description" : "Default ipv6 gateway address.", - "optional" : 1, - "format" : "ipv6", - "type" : "string" - }, - "type" : { + "iface" : { + "description" : "Network interface name.", + "format" : "pve-iface", + "maxLength" : 20, + "minLength" : 2, "type" : "string", - "enum" : [ - "bridge", - "bond", - "eth", - "alias", - "vlan", - "OVSBridge", - "OVSBond", - "OVSPort", - "OVSIntPort", - "unknown" - ], - "description" : "Network interface type" + "typetext" : "" }, - "comments6" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "description" : "Comments", - "optional" : 1 - }, + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + }, + "GET" : { + "description" : "Read network device configuration", + "method" : "GET", + "name" : "network_config", + "parameters" : { + "additionalProperties" : 0, + "properties" : { "iface" : { - "type" : "string", + "description" : "Network interface name.", "format" : "pve-iface", - "minLength" : 2, "maxLength" : 20, - "description" : "Network interface name." - }, - "bond_xmit_hash_policy" : { - "optional" : 1, - "description" : "Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes.", - "enum" : [ - "layer2", - "layer2+3", - "layer3+4" - ], - "type" : "string" - }, - "slaves" : { - "optional" : 1, - "description" : "Specify the interfaces used by the bonding device.", - "format" : "pve-iface-list", - "type" : "string" - }, - "netmask" : { - "description" : "Network mask.", - "optional" : 1, - "requires" : "address", + "minLength" : 2, "type" : "string", - "format" : "ipv4mask" + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Audit" + ] + ] + }, + "proxyto" : "node", + "returns" : { + "properties" : { + "method" : { "type" : "string" }, + "type" : { + "type" : "string" + } + }, + "type" : "object" + } + }, + "PUT" : { + "description" : "Update network device configuration", + "method" : "PUT", + "name" : "update_network", + "parameters" : { + "additionalProperties" : 0, + "properties" : { "address" : { - "optional" : 1, "description" : "IP address.", + "format" : "ipv4", + "optional" : 1, "requires" : "netmask", "type" : "string", - "format" : "ipv4" + "typetext" : "" }, - "bridge_ports" : { - "format" : "pve-iface-list", + "address6" : { + "description" : "IP address.", + "format" : "ipv6", + "optional" : 1, + "requires" : "netmask6", "type" : "string", - "description" : "Specify the iterfaces you want to add to your bridge.", - "optional" : 1 + "typetext" : "" }, - "comments" : { - "description" : "Comments", + "autostart" : { + "description" : "Automatically start interface on boot.", "optional" : 1, - "type" : "string" + "type" : "boolean", + "typetext" : "" }, "bond_mode" : { - "type" : "string", + "description" : "Bonding mode.", "enum" : [ "balance-rr", "active-backup", @@ -17278,128 +19053,157 @@ var pveapi = [ "lacp-balance-slb", "lacp-balance-tcp" ], - "description" : "Bonding mode.", - "optional" : 1 + "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" : { - "type" : "boolean", "description" : "Enable bridge vlan support.", - "optional" : 1 - }, - "autostart" : { - "type" : "boolean", "optional" : 1, - "description" : "Automatically start interface on boot." + "type" : "boolean", + "typetext" : "" }, - "ovs_bridge" : { - "description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port.", + "comments" : { + "description" : "Comments", "optional" : 1, "type" : "string", - "format" : "pve-iface" + "typetext" : "" }, - "address6" : { + "comments6" : { + "description" : "Comments", "optional" : 1, - "description" : "IP address.", - "requires" : "netmask6", "type" : "string", - "format" : "ipv6" + "typetext" : "" }, "delete" : { - "optional" : 1, "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", - "type" : "string" + "optional" : 1, + "type" : "string", + "typetext" : "" }, - "ovs_options" : { + "gateway" : { + "description" : "Default gateway address.", + "format" : "ipv4", + "optional" : 1, "type" : "string", - "description" : "OVS interface options.", - "maxLength" : 1024, - "optional" : 1 + "typetext" : "" }, - "ovs_ports" : { + "gateway6" : { + "description" : "Default ipv6 gateway address.", + "format" : "ipv6", "optional" : 1, - "description" : "Specify the iterfaces you want to add to your bridge.", "type" : "string", - "format" : "pve-iface-list" + "typetext" : "" }, - "gateway" : { - "description" : "Default gateway address.", + "iface" : { + "description" : "Network interface name.", + "format" : "pve-iface", + "maxLength" : 20, + "minLength" : 2, + "type" : "string", + "typetext" : "" + }, + "netmask" : { + "description" : "Network mask.", + "format" : "ipv4mask", "optional" : 1, - "format" : "ipv4", - "type" : "string" + "requires" : "address", + "type" : "string", + "typetext" : "" }, "netmask6" : { "description" : "Network mask.", - "optional" : 1, - "minimum" : 0, "maximum" : 128, + "minimum" : 0, + "optional" : 1, "requires" : "address6", - "type" : "integer" - } - } - }, - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Modify" - ] - ] - } - }, - "GET" : { - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Audit" - ] - ] - }, - "description" : "Read network device configuration", - "method" : "GET", - "name" : "network_config", - "returns" : { - "type" : "object", - "properties" : { - "method" : { - "type" : "string" + "type" : "integer", + "typetext" : " (0 - 128)" }, - "type" : { - "type" : "string" - } - } - }, - "proxyto" : "node", - "parameters" : { - "properties" : { "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" + "typetext" : "" }, - "iface" : { - "minLength" : 2, - "description" : "Network interface name.", - "maxLength" : 20, + "ovs_bonds" : { + "description" : "Specify the interfaces used by the bonding device.", + "format" : "pve-iface-list", + "optional" : 1, "type" : "string", - "format" : "pve-iface" - } - }, - "additionalProperties" : 0 - } - }, - "DELETE" : { - "description" : "Delete network device configuration", - "method" : "DELETE", - "name" : "delete_network", - "returns" : { - "type" : "null" + "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" + } + } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -17409,41 +19213,34 @@ var pveapi = [ ] ] }, + "protected" : 1, "proxyto" : "node", - "parameters" : { - "properties" : { - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - }, - "iface" : { - "description" : "Network interface name.", - "maxLength" : 20, - "minLength" : 2, - "format" : "pve-iface", - "type" : "string" - } - }, - "additionalProperties" : 0 + "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" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" } } }, - "proxyto" : "node", "permissions" : { "check" : [ "perm", @@ -17454,40 +19251,25 @@ var pveapi = [ ] }, "protected" : 1, - "method" : "DELETE", - "name" : "revert_network_changes", + "proxyto" : "node", "returns" : { "type" : "null" - }, - "description" : "Revert network configuration changes." + } }, "GET" : { "description" : "List available networks", - "permissions" : { - "user" : "all" - }, - "name" : "index", "method" : "GET", - "returns" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : {} - }, - "links" : [ - { - "href" : "{iface}", - "rel" : "child" - } - ] - }, - "proxyto" : "node", + "name" : "index", "parameters" : { "additionalProperties" : 0, "properties" : { - "type" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "optional" : 1, + "typetext" : "" + }, + "type" : { "description" : "Only list specific interface types.", "enum" : [ "bridge", @@ -17500,189 +19282,217 @@ var pveapi = [ "OVSPort", "OVSIntPort", "any_bridge" - ] - }, - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." + ], + "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", - "returns" : { - "type" : "null" - }, - "description" : "Create network device configuration", - "proxyto" : "node", "parameters" : { + "additionalProperties" : 0, "properties" : { - "slaves" : { - "format" : "pve-iface-list", + "address" : { + "description" : "IP address.", + "format" : "ipv4", + "optional" : 1, + "requires" : "netmask", "type" : "string", - "description" : "Specify the interfaces used by the bonding device.", - "optional" : 1 + "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.", - "optional" : 1, "enum" : [ "layer2", "layer2+3", "layer3+4" ], - "type" : "string" - }, - "comments6" : { - "description" : "Comments", "optional" : 1, "type" : "string" }, - "iface" : { + "bridge_ports" : { + "description" : "Specify the iterfaces you want to add to your bridge.", + "format" : "pve-iface-list", + "optional" : 1, "type" : "string", - "format" : "pve-iface", - "minLength" : 2, - "description" : "Network interface name.", - "maxLength" : 20 + "typetext" : "" }, - "type" : { + "bridge_vlan_aware" : { + "description" : "Enable bridge vlan support.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "comments" : { + "description" : "Comments", + "optional" : 1, "type" : "string", - "description" : "Network interface type", - "enum" : [ - "bridge", - "bond", - "eth", - "alias", - "vlan", - "OVSBridge", - "OVSBond", - "OVSPort", - "OVSIntPort", - "unknown" - ] + "typetext" : "" }, - "ovs_tag" : { - "minimum" : 1, - "type" : "integer", - "maximum" : 4094, - "description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)", - "optional" : 1 + "comments6" : { + "description" : "Comments", + "optional" : 1, + "type" : "string", + "typetext" : "" }, - "ovs_bonds" : { - "description" : "Specify the interfaces used by the bonding device.", + "gateway" : { + "description" : "Default gateway address.", + "format" : "ipv4", "optional" : 1, "type" : "string", - "format" : "pve-iface-list" + "typetext" : "" }, "gateway6" : { - "type" : "string", + "description" : "Default ipv6 gateway address.", "format" : "ipv6", "optional" : 1, - "description" : "Default ipv6 gateway address." + "type" : "string", + "typetext" : "" }, - "ovs_options" : { + "iface" : { + "description" : "Network interface name.", + "format" : "pve-iface", + "maxLength" : 20, + "minLength" : 2, "type" : "string", - "description" : "OVS interface options.", - "optional" : 1, - "maxLength" : 1024 + "typetext" : "" }, - "address6" : { - "format" : "ipv6", - "requires" : "netmask6", + "netmask" : { + "description" : "Network mask.", + "format" : "ipv4mask", + "optional" : 1, + "requires" : "address", "type" : "string", - "description" : "IP address.", - "optional" : 1 + "typetext" : "" }, "netmask6" : { + "description" : "Network mask.", + "maximum" : 128, "minimum" : 0, - "type" : "integer", + "optional" : 1, "requires" : "address6", - "maximum" : 128, - "description" : "Network mask.", - "optional" : 1 + "type" : "integer", + "typetext" : " (0 - 128)" }, - "ovs_ports" : { - "format" : "pve-iface-list", + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "optional" : 1, - "description" : "Specify the iterfaces you want to add to your bridge." + "typetext" : "" }, - "gateway" : { - "format" : "ipv4", + "ovs_bonds" : { + "description" : "Specify the interfaces used by the bonding device.", + "format" : "pve-iface-list", + "optional" : 1, "type" : "string", - "description" : "Default gateway address.", - "optional" : 1 + "typetext" : "" }, "ovs_bridge" : { - "optional" : 1, "description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port.", "format" : "pve-iface", - "type" : "string" - }, - "autostart" : { - "description" : "Automatically start interface on boot.", "optional" : 1, - "type" : "boolean" - }, - "bond_mode" : { "type" : "string", - "enum" : [ - "balance-rr", - "active-backup", - "balance-xor", - "broadcast", - "802.3ad", - "balance-tlb", - "balance-alb", - "balance-slb", - "lacp-balance-slb", - "lacp-balance-tcp" - ], - "description" : "Bonding mode.", - "optional" : 1 + "typetext" : "" }, - "bridge_vlan_aware" : { - "type" : "boolean", + "ovs_options" : { + "description" : "OVS interface options.", + "maxLength" : 1024, "optional" : 1, - "description" : "Enable bridge vlan support." - }, - "comments" : { - "type" : "string", - "description" : "Comments", - "optional" : 1 - }, - "node" : { - "description" : "The cluster node name.", - "type" : "string", - "format" : "pve-node" - }, - "netmask" : { "type" : "string", - "requires" : "address", - "format" : "ipv4mask", - "description" : "Network mask.", - "optional" : 1 + "typetext" : "" }, - "bridge_ports" : { + "ovs_ports" : { "description" : "Specify the iterfaces you want to add to your bridge.", + "format" : "pve-iface-list", "optional" : 1, "type" : "string", - "format" : "pve-iface-list" + "typetext" : "" }, - "address" : { + "ovs_tag" : { + "description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)", + "maximum" : 4094, + "minimum" : 1, "optional" : 1, - "description" : "IP address.", - "format" : "ipv4", - "requires" : "netmask", + "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" } - }, - "additionalProperties" : 0 + } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -17691,290 +19501,297 @@ var pveapi = [ "Sys.Modify" ] ] - } - } - } - }, - { - "leaf" : 0, - "text" : "tasks", - "info" : { - "GET" : { - "permissions" : { - "user" : "all", - "description" : "List task associated with the current user, or all task the user has 'Sys.Audit' permissions on /nodes/ (the the task runs on)." - }, - "description" : "Read task list for one node (finished tasks).", - "method" : "GET", - "name" : "node_tasks", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "limit" : { - "type" : "integer", - "minimum" : 0, - "optional" : 1 - }, - "node" : { - "description" : "The cluster node name.", - "type" : "string", - "format" : "pve-node" - }, - "errors" : { - "type" : "boolean", - "optional" : 1 - }, - "start" : { - "type" : "integer", - "minimum" : 0, - "optional" : 1 - }, - "vmid" : { - "description" : "Only list tasks for this VM.", - "optional" : 1, - "minimum" : 1, - "type" : "integer", - "format" : "pve-vmid" - }, - "userfilter" : { - "type" : "string", - "optional" : 1 - } - } }, + "protected" : 1, "proxyto" : "node", "returns" : { - "items" : { - "properties" : { - "upid" : { - "type" : "string" - } - }, - "type" : "object" - }, - "type" : "array", - "links" : [ - { - "href" : "{upid}", - "rel" : "child" - } - ] + "type" : "null" } } }, - "path" : "/nodes/{node}/tasks", + "leaf" : 0, + "path" : "/nodes/{node}/network", + "text" : "network" + }, + { "children" : [ { - "text" : "{upid}", - "leaf" : 0, "children" : [ { - "text" : "log", - "leaf" : 1, - "path" : "/nodes/{node}/tasks/{upid}/log", "info" : { "GET" : { - "permissions" : { - "description" : "The user needs 'Sys.Audit' permissions on '/nodes/' if the task does not belong to him.", - "user" : "all" - }, - "protected" : 1, - "proxyto" : "node", + "description" : "Read task log.", + "method" : "GET", + "name" : "read_task_log", "parameters" : { + "additionalProperties" : 0, "properties" : { - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - }, "limit" : { "minimum" : 0, + "optional" : 1, "type" : "integer", - "optional" : 1 + "typetext" : " (0 - N)" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, "start" : { "minimum" : 0, + "optional" : 1, "type" : "integer", - "optional" : 1 + "typetext" : " (0 - N)" }, "upid" : { - "type" : "string" + "type" : "string", + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, - "description" : "Read task log.", + "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" : { - "type" : "object", "properties" : { "n" : { - "type" : "integer", - "description" : "Line number" + "description" : "Line number", + "type" : "integer" }, "t" : { "description" : "Line text", "type" : "string" } - } + }, + "type" : "object" }, "type" : "array" - }, - "method" : "GET", - "name" : "read_task_log" + } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/tasks/{upid}/log", + "text" : "log" }, { - "text" : "status", - "leaf" : 1, "info" : { "GET" : { - "proxyto" : "node", + "description" : "Read task status.", + "method" : "GET", + "name" : "read_task_status", "parameters" : { "additionalProperties" : 0, "properties" : { - "upid" : { - "type" : "string" - }, "node" : { + "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", - "description" : "The cluster node name." + "typetext" : "" + }, + "upid" : { + "type" : "string", + "typetext" : "" } } }, - "protected" : 1, "permissions" : { - "user" : "all", - "description" : "The user needs 'Sys.Audit' permissions on '/nodes/' if the task does not belong to him." + "description" : "The user needs 'Sys.Audit' permissions on '/nodes/' if the task does not belong to him.", + "user" : "all" }, - "method" : "GET", - "name" : "read_task_status", + "protected" : 1, + "proxyto" : "node", "returns" : { - "type" : "object", "properties" : { + "pid" : { + "type" : "integer" + }, "status" : { "enum" : [ "running", "stopped" ], "type" : "string" - }, - "pid" : { - "type" : "integer" } - } - }, - "description" : "Read task status." + }, + "type" : "object" + } } }, - "path" : "/nodes/{node}/tasks/{upid}/status" + "leaf" : 1, + "path" : "/nodes/{node}/tasks/{upid}/status", + "text" : "status" } ], "info" : { - "GET" : { - "description" : "", - "permissions" : { - "user" : "all" - }, - "name" : "upid_index", - "method" : "GET", + "DELETE" : { + "description" : "Stop a task.", + "method" : "DELETE", + "name" : "stop_task", "parameters" : { "additionalProperties" : 0, "properties" : { "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" }, "upid" : { - "type" : "string" + "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" : "array", - "items" : { - "type" : "object", - "properties" : {} - }, - "links" : [ - { - "rel" : "child", - "href" : "{name}" - } - ] + "type" : "null" } }, - "DELETE" : { + "GET" : { + "description" : "", + "method" : "GET", + "name" : "upid_index", "parameters" : { "additionalProperties" : 0, "properties" : { - "upid" : { - "type" : "string" - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" + }, + "upid" : { + "type" : "string", + "typetext" : "" } } }, - "proxyto" : "node", "permissions" : { - "user" : "all", - "description" : "The user needs 'Sys.Modify' permissions on '/nodes/' if the task does not belong to him." + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/tasks/{upid}", + "text" : "{upid}" + } + ], + "info" : { + "GET" : { + "description" : "Read task list for one node (finished tasks).", + "method" : "GET", + "name" : "node_tasks", + "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)" }, - "protected" : 1, - "method" : "DELETE", - "name" : "stop_task", - "returns" : { - "type" : "null" + "userfilter" : { + "optional" : 1, + "type" : "string", + "typetext" : "" }, - "description" : "Stop a task." + "vmid" : { + "description" : "Only list tasks for this VM.", + "format" : "pve-vmid", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } } }, - "path" : "/nodes/{node}/tasks/{upid}" + "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" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{upid}", + "rel" : "child" + } + ], + "type" : "array" + } } - ] + }, + "leaf" : 0, + "path" : "/nodes/{node}/tasks", + "text" : "tasks" }, { - "text" : "scan", - "leaf" : 0, - "path" : "/nodes/{node}/scan", "children" : [ { - "text" : "zfs", - "leaf" : 1, - "path" : "/nodes/{node}/scan/zfs", "info" : { "GET" : { - "returns" : { - "type" : "array", - "items" : { - "properties" : { - "pool" : { - "type" : "string" - } - }, - "type" : "object" - } - }, - "name" : "zfsscan", - "method" : "GET", "description" : "Scan zfs pool list on local node.", + "method" : "GET", + "name" : "zfsscan", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", "permissions" : { "check" : [ "perm", @@ -17984,32 +19801,47 @@ var pveapi = [ ] ] }, - "protected" : 1 + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "pool" : { + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/scan/zfs", + "text" : "zfs" }, { - "path" : "/nodes/{node}/scan/nfs", "info" : { "GET" : { "description" : "Scan remote NFS server.", "method" : "GET", "name" : "nfsscan", - "returns" : { - "items" : { - "type" : "object", - "properties" : { - "path" : { - "type" : "string" - }, - "options" : { - "type" : "string" - } + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "server" : { + "format" : "pve-storage-server", + "type" : "string", + "typetext" : "" } - }, - "type" : "array" + } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -18019,46 +19851,50 @@ var pveapi = [ ] ] }, + "protected" : 1, "proxyto" : "node", - "parameters" : { - "properties" : { - "server" : { - "type" : "string", - "format" : "pve-storage-server" + "returns" : { + "items" : { + "properties" : { + "options" : { + "type" : "string" + }, + "path" : { + "type" : "string" + } }, - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." - } + "type" : "object" }, - "additionalProperties" : 0 + "type" : "array" } } }, "leaf" : 1, + "path" : "/nodes/{node}/scan/nfs", "text" : "nfs" }, { - "path" : "/nodes/{node}/scan/glusterfs", "info" : { "GET" : { - "proxyto" : "node", + "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" : "" + }, "server" : { "format" : "pve-storage-server", - "type" : "string" - }, - "node" : { "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." + "typetext" : "" } } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -18068,62 +19904,47 @@ var pveapi = [ ] ] }, - "name" : "glusterfsscan", - "method" : "GET", + "protected" : 1, + "proxyto" : "node", "returns" : { - "type" : "array", "items" : { - "type" : "object", "properties" : { "volname" : { "type" : "string" } - } - } - }, - "description" : "Scan remote GlusterFS server." + }, + "type" : "object" + }, + "type" : "array" + } } }, - "text" : "glusterfs", - "leaf" : 1 + "leaf" : 1, + "path" : "/nodes/{node}/scan/glusterfs", + "text" : "glusterfs" }, { - "path" : "/nodes/{node}/scan/iscsi", "info" : { "GET" : { - "returns" : { - "type" : "array", - "items" : { - "properties" : { - "target" : { - "type" : "string" - }, - "portal" : { - "type" : "string" - } - }, - "type" : "object" - } - }, + "description" : "Scan remote iSCSI server.", "method" : "GET", "name" : "iscsiscan", - "description" : "Scan remote iSCSI server.", "parameters" : { + "additionalProperties" : 0, "properties" : { - "portal" : { - "type" : "string", - "format" : "pve-storage-portal-dns" - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" + }, + "portal" : { + "format" : "pve-storage-portal-dns", + "type" : "string", + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -18132,41 +19953,46 @@ var pveapi = [ "Datastore.Allocate" ] ] - } - } - }, - "text" : "iscsi", - "leaf" : 1 - }, - { - "path" : "/nodes/{node}/scan/lvm", - "info" : { - "GET" : { + }, + "protected" : 1, + "proxyto" : "node", "returns" : { "items" : { - "type" : "object", "properties" : { - "vg" : { + "portal" : { + "type" : "string" + }, + "target" : { "type" : "string" } - } + }, + "type" : "object" }, "type" : "array" - }, - "name" : "lvmscan", - "method" : "GET", + } + } + }, + "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", - "format" : "pve-node" + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", "permissions" : { "check" : [ "perm", @@ -18176,46 +20002,59 @@ var pveapi = [ ] ] }, - "protected" : 1 + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "vg" : { + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + } } }, "leaf" : 1, + "path" : "/nodes/{node}/scan/lvm", "text" : "lvm" }, { - "leaf" : 1, - "text" : "lvmthin", "info" : { - "GET" : { - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/storage", - [ - "Datastore.Allocate" - ] - ] - }, + "GET" : { + "description" : "List local LVM Thin Pools.", + "method" : "GET", + "name" : "lvmthinscan", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "vg" : { - "type" : "string", + "maxLength" : 100, "pattern" : "[a-zA-Z0-9\\.\\+\\_][a-zA-Z0-9\\.\\+\\_\\-]+", - "maxLength" : 100 + "type" : "string" } - }, - "additionalProperties" : 0 + } + }, + "permissions" : { + "check" : [ + "perm", + "/storage", + [ + "Datastore.Allocate" + ] + ] }, + "protected" : 1, "proxyto" : "node", - "description" : "List local LVM Thin Pools.", "returns" : { - "type" : "array", "items" : { "properties" : { "lv" : { @@ -18223,38 +20062,49 @@ var pveapi = [ } }, "type" : "object" - } - }, - "method" : "GET", - "name" : "lvmthinscan" + }, + "type" : "array" + } } }, - "path" : "/nodes/{node}/scan/lvmthin" + "leaf" : 1, + "path" : "/nodes/{node}/scan/lvmthin", + "text" : "lvmthin" }, { - "text" : "usb", - "leaf" : 1, - "path" : "/nodes/{node}/scan/usb", "info" : { "GET" : { "description" : "List local USB devices.", + "method" : "GET", + "name" : "usbscan", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", "returns" : { "items" : { "properties" : { - "port" : { + "busnum" : { "type" : "integer" }, - "prodid" : { - "type" : "string" - }, - "manufacturer" : { - "optional" : 1, - "type" : "string" - }, - "product" : { - "optional" : 1, - "type" : "string" - }, "class" : { "type" : "integer" }, @@ -18264,73 +20114,66 @@ var pveapi = [ "level" : { "type" : "integer" }, - "vendid" : { + "manufacturer" : { + "optional" : 1, "type" : "string" }, - "usbpath" : { - "type" : "string", - "optional" : 1 - }, - "busnum" : { + "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" - }, - "name" : "usbscan", - "method" : "GET", - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Modify" - ] - ] - }, - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - } - } - }, - "proxyto" : "node" + } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/scan/usb", + "text" : "usb" } ], "info" : { "GET" : { "description" : "Index of available scan methods", - "permissions" : { - "user" : "all" - }, + "method" : "GET", + "name" : "index", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" + "typetext" : "" } - }, - "additionalProperties" : 0 + } + }, + "permissions" : { + "user" : "all" }, "returns" : { - "type" : "array", "items" : { "properties" : { "method" : { @@ -18341,242 +20184,188 @@ var pveapi = [ }, "links" : [ { - "rel" : "child", - "href" : "{method}" + "href" : "{method}", + "rel" : "child" } - ] - }, - "method" : "GET", - "name" : "index" + ], + "type" : "array" + } } - } + }, + "leaf" : 0, + "path" : "/nodes/{node}/scan", + "text" : "scan" }, { - "text" : "storage", - "leaf" : 0, "children" : [ { - "info" : { - "GET" : { - "description" : "", - "permissions" : { - "check" : [ - "perm", - "/storage/{storage}", - [ - "Datastore.Audit", - "Datastore.AllocateSpace" - ], - "any", - 1 - ] - }, - "method" : "GET", - "name" : "diridx", - "parameters" : { - "properties" : { - "storage" : { - "format" : "pve-storage-id", - "type" : "string", - "description" : "The storage identifier." - }, - "node" : { - "description" : "The cluster node name.", - "type" : "string", - "format" : "pve-node" - } - }, - "additionalProperties" : 0 - }, - "returns" : { - "items" : { - "properties" : { - "subdir" : { - "type" : "string" - } - }, - "type" : "object" - }, - "type" : "array", - "links" : [ - { - "href" : "{subdir}", - "rel" : "child" - } - ] - } - } - }, "children" : [ { "children" : [ { - "path" : "/nodes/{node}/storage/{storage}/content/{volume}", "info" : { "DELETE" : { - "protected" : 1, - "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" - }, + "description" : "Delete volume", + "method" : "DELETE", + "name" : "delete", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "storage" : { - "optional" : 1, "description" : "The storage identifier.", "format" : "pve-storage-id", - "type" : "string" + "optional" : 1, + "type" : "string", + "typetext" : "" }, "volume" : { "description" : "Volume identifier", - "type" : "string" + "type" : "string", + "typetext" : "" } - }, - "additionalProperties" : 0 + } + }, + "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", - "description" : "Delete volume", "returns" : { "type" : "null" - }, - "method" : "DELETE", - "name" : "delete" + } }, "GET" : { - "returns" : { - "type" : "object" - }, - "name" : "info", - "method" : "GET", "description" : "Get volume attributes", - "proxyto" : "node", + "method" : "GET", + "name" : "info", "parameters" : { "additionalProperties" : 0, "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, "storage" : { - "optional" : 1, "description" : "The storage identifier.", "format" : "pve-storage-id", - "type" : "string" + "optional" : 1, + "type" : "string", + "typetext" : "" }, "volume" : { "description" : "Volume identifier", - "type" : "string" - }, - "node" : { - "format" : "pve-node", "type" : "string", - "description" : "The cluster node name." + "typetext" : "" } } }, - "protected" : 1, "permissions" : { - "user" : "all", - "description" : "You need read access for the volume." + "description" : "You need read access for the volume.", + "user" : "all" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "object" } }, "POST" : { - "proxyto" : "node", + "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", - "description" : "The cluster node name." - }, - "target" : { - "description" : "Target volume identifier", - "type" : "string" - }, - "volume" : { - "type" : "string", - "description" : "Source volume identifier" + "typetext" : "" }, "storage" : { + "description" : "The storage identifier.", "format" : "pve-storage-id", + "optional" : 1, "type" : "string", - "description" : "The storage identifier.", - "optional" : 1 + "typetext" : "" + }, + "target" : { + "description" : "Target volume identifier", + "type" : "string", + "typetext" : "" }, "target_node" : { + "description" : "Target node. Default is local node.", "format" : "pve-node", - "type" : "string", "optional" : 1, - "description" : "Target node. Default is local node." + "type" : "string", + "typetext" : "" + }, + "volume" : { + "description" : "Source volume identifier", + "type" : "string", + "typetext" : "" } } }, + "protected" : 1, + "proxyto" : "node", "returns" : { "type" : "string" - }, - "method" : "POST", - "name" : "copy", - "description" : "Copy a volume. This is experimental code - do not use.", - "protected" : 1 + } } }, - "text" : "{volume}", - "leaf" : 1 + "leaf" : 1, + "path" : "/nodes/{node}/storage/{storage}/content/{volume}", + "text" : "{volume}" } ], "info" : { "GET" : { - "returns" : { - "items" : { - "properties" : { - "volid" : { - "type" : "string" - } - }, - "type" : "object" - }, - "type" : "array", - "links" : [ - { - "rel" : "child", - "href" : "{volid}" - } - ] - }, + "description" : "List storage content.", "method" : "GET", "name" : "index", - "description" : "List storage content.", "parameters" : { + "additionalProperties" : 0, "properties" : { - "vmid" : { + "content" : { + "description" : "Only list content of this type.", + "format" : "pve-storage-content", "optional" : 1, - "description" : "Only list images for this VM", - "type" : "integer", - "format" : "pve-vmid", - "minimum" : 1 - }, - "storage" : { - "description" : "The storage identifier.", "type" : "string", - "format" : "pve-storage-id" + "typetext" : "" }, "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" }, - "content" : { - "description" : "Only list content of this type.", - "optional" : 1, + "storage" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", "type" : "string", - "format" : "pve-storage-content" + "typetext" : "" + }, + "vmid" : { + "description" : "Only list images for this VM", + "format" : "pve-vmid", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", "permissions" : { "check" : [ "perm", @@ -18589,102 +20378,118 @@ var pveapi = [ 1 ] }, - "protected" : 1 + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "volid" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{volid}", + "rel" : "child" + } + ], + "type" : "array" + } }, "POST" : { - "permissions" : { - "check" : [ - "perm", - "/storage/{storage}", - [ - "Datastore.AllocateSpace" - ] - ] - }, - "protected" : 1, + "description" : "Allocate disk images.", + "method" : "POST", + "name" : "create", "parameters" : { "additionalProperties" : 0, "properties" : { - "storage" : { - "format" : "pve-storage-id", + "filename" : { + "description" : "The name of the file to create.", "type" : "string", - "description" : "The storage identifier." + "typetext" : "" }, "format" : { - "type" : "string", - "requires" : "size", "enum" : [ "raw", "qcow2", "subvol" ], - "optional" : 1 + "optional" : 1, + "requires" : "size", + "type" : "string" }, - "vmid" : { - "description" : "Specify owner VM", - "minimum" : 1, - "format" : "pve-vmid", - "type" : "integer" + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, "size" : { - "type" : "string", "description" : "Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)", - "pattern" : "\\d+[MG]?" - }, - "filename" : { - "description" : "The name of the file to create.", + "pattern" : "\\d+[MG]?", "type" : "string" }, - "node" : { - "description" : "The cluster node name.", + "storage" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", "type" : "string", - "format" : "pve-node" + "typetext" : "" + }, + "vmid" : { + "description" : "Specify owner VM", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" } } }, + "permissions" : { + "check" : [ + "perm", + "/storage/{storage}", + [ + "Datastore.AllocateSpace" + ] + ] + }, + "protected" : 1, "proxyto" : "node", - "description" : "Allocate disk images.", - "name" : "create", - "method" : "POST", "returns" : { "description" : "Volume identifier", "type" : "string" } } }, + "leaf" : 0, "path" : "/nodes/{node}/storage/{storage}/content", - "text" : "content", - "leaf" : 0 + "text" : "content" }, { - "text" : "status", - "leaf" : 1, "info" : { "GET" : { + "description" : "Read storage status.", "method" : "GET", "name" : "read_status", - "returns" : { - "properties" : {}, - "type" : "object" - }, - "description" : "Read storage status.", - "proxyto" : "node", "parameters" : { + "additionalProperties" : 0, "properties" : { - "storage" : { - "description" : "The storage identifier.", - "type" : "string", - "format" : "pve-storage-id" - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" + }, + "storage" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", + "type" : "string", + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -18696,45 +20501,57 @@ var pveapi = [ "any", 1 ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "properties" : {}, + "type" : "object" } } }, - "path" : "/nodes/{node}/storage/{storage}/status" + "leaf" : 1, + "path" : "/nodes/{node}/storage/{storage}/status", + "text" : "status" }, { - "path" : "/nodes/{node}/storage/{storage}/rrd", "info" : { "GET" : { + "description" : "Read storage RRD statistics (returns PNG).", "method" : "GET", "name" : "rrd", - "returns" : { - "type" : "object", - "properties" : { - "filename" : { - "type" : "string" - } - } - }, - "description" : "Read storage RRD statistics (returns PNG).", - "proxyto" : "node", "parameters" : { "additionalProperties" : 0, "properties" : { "cf" : { - "optional" : 1, "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", - "format" : "pve-storage-id" + "typetext" : "" }, "timeframe" : { + "description" : "Specify the time frame you are interested in.", "enum" : [ "hour", "day", @@ -18742,18 +20559,7 @@ var pveapi = [ "month", "year" ], - "description" : "Specify the time frame you are interested in.", "type" : "string" - }, - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - }, - "ds" : { - "format" : "pve-configid-list", - "type" : "string", - "description" : "The list of datasources you want to display." } } }, @@ -18769,28 +20575,65 @@ var pveapi = [ 1 ] }, - "protected" : 1 + "protected" : 1, + "proxyto" : "node", + "returns" : { + "properties" : { + "filename" : { + "type" : "string" + } + }, + "type" : "object" + } } }, "leaf" : 1, + "path" : "/nodes/{node}/storage/{storage}/rrd", "text" : "rrd" }, { - "text" : "rrddata", - "leaf" : 1, - "path" : "/nodes/{node}/storage/{storage}/rrddata", "info" : { "GET" : { "description" : "Read storage RRD statistics.", - "returns" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : {} + "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" + } } }, - "method" : "GET", - "name" : "rrddata", "permissions" : { "check" : [ "perm", @@ -18805,201 +20648,470 @@ var pveapi = [ }, "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" : { - "timeframe" : { - "enum" : [ - "hour", - "day", - "week", - "month", - "year" - ], - "description" : "Specify the time frame you are interested in.", - "type" : "string" - }, - "storage" : { - "format" : "pve-storage-id", + "content" : { + "description" : "Content type.", + "format" : "pve-storage-content", "type" : "string", - "description" : "The storage identifier." + "typetext" : "" }, - "cf" : { + "filename" : { + "description" : "The name of the file to create.", "type" : "string", - "enum" : [ - "AVERAGE", - "MAX" - ], - "optional" : 1, - "description" : "The RRD consolidation function" + "typetext" : "" }, "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" + "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 trustet port on localhost.", + "optional" : 1, + "type" : "string", + "typetext" : "" } } + }, + "permissions" : { + "check" : [ + "perm", + "/storage/{storage}", + [ + "Datastore.AllocateTemplate" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/storage/{storage}/upload", + "text" : "upload" + } + ], + "info" : { + "GET" : { + "description" : "", + "method" : "GET", + "name" : "diridx", + "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", + "/storage/{storage}", + [ + "Datastore.Audit", + "Datastore.AllocateSpace" + ], + "any", + 1 + ] + }, + "returns" : { + "items" : { + "properties" : { + "subdir" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{subdir}", + "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" : "" + }, + "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" : { + "storage" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{storage}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/storage", + "text" : "storage" + }, + { + "children" : [ + { + "info" : { + "GET" : { + "description" : "List local disks.", + "method" : "GET", + "name" : "list", + "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" : { + "devpath" : { + "description" : "The device path", + "type" : "string" + }, + "gpt" : { + "type" : "boolean" + }, + "health" : { + "optional" : 1, + "type" : "string" + }, + "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" + }, + "wwn" : { + "optional" : 1, + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/disks/list", + "text" : "list" + }, + { + "info" : { + "GET" : { + "description" : "Get SMART Health of a disk.", + "method" : "GET", + "name" : "smart", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "disk" : { + "description" : "Block device name", + "pattern" : "^/dev/[a-zA-Z0-9\\/]+$", + "type" : "string" + }, + "healthonly" : { + "description" : "If true returns only the health status", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "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" : { + "properties" : { + "attributes" : { + "optional" : 1, + "type" : "array" + }, + "health" : { + "type" : "string" + }, + "text" : { + "optional" : 1, + "type" : "string" + }, + "type" : { + "optional" : 1, + "type" : "string" + } + }, + "type" : "object" } - }, - { - "text" : "upload", - "leaf" : 1, - "path" : "/nodes/{node}/storage/{storage}/upload", - "info" : { - "POST" : { - "method" : "POST", - "name" : "upload", - "returns" : { + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/disks/smart", + "text" : "smart" + }, + { + "info" : { + "POST" : { + "description" : "Initialize Disk with GPT", + "method" : "POST", + "name" : "initgpt", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "disk" : { + "description" : "Block device name", + "pattern" : "^/dev/[a-zA-Z0-9\\/]+$", "type" : "string" }, - "parameters" : { - "properties" : { - "storage" : { - "description" : "The storage identifier.", - "format" : "pve-storage-id", - "type" : "string" - }, - "tmpfilename" : { - "optional" : 1, - "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.", - "type" : "string" - }, - "content" : { - "format" : "pve-storage-content", - "type" : "string", - "description" : "Content type." - }, - "filename" : { - "description" : "The name of the file to create.", - "type" : "string" - }, - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" - } - }, - "additionalProperties" : 0 + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, - "protected" : 1, - "description" : "Upload templates and ISO images.", - "permissions" : { - "check" : [ - "perm", - "/storage/{storage}", - [ - "Datastore.AllocateTemplate" - ] - ] + "uuid" : { + "description" : "UUID for the GPT table", + "maxLength" : 36, + "optional" : 1, + "pattern" : "[a-fA-F0-9\\-]+", + "type" : "string" } } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" } } - ], - "path" : "/nodes/{node}/storage/{storage}", - "text" : "{storage}", - "leaf" : 0 + }, + "leaf" : 1, + "path" : "/nodes/{node}/disks/initgpt", + "text" : "initgpt" } ], - "path" : "/nodes/{node}/storage", "info" : { "GET" : { - "description" : "Get status for all datastores.", - "returns" : { - "items" : { - "type" : "object", - "properties" : { - "storage" : { - "type" : "string" - } - } - }, - "type" : "array", - "links" : [ - { - "rel" : "child", - "href" : "{storage}" - } - ] - }, - "name" : "index", + "description" : "Node index.", "method" : "GET", - "permissions" : { - "user" : "all", - "description" : "Only list entries where you have 'Datastore.Audit' or 'Datastore.AllocateSpace' permissions on '/storage/'" - }, - "protected" : 1, + "name" : "index", "parameters" : { "additionalProperties" : 0, "properties" : { "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - }, - "content" : { - "type" : "string", - "format" : "pve-storage-content-list", - "description" : "Only list stores which support this content type.", - "optional" : 1 - }, - "target" : { - "optional" : 1, - "description" : "If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.", + "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" - }, - "enabled" : { - "optional" : 1, - "description" : "Only list stores which are enabled (not disabled in config).", - "default" : 0, - "type" : "boolean" - }, - "storage" : { - "format" : "pve-storage-id", "type" : "string", - "optional" : 1, - "description" : "Only list status for specified storage" + "typetext" : "" } } }, - "proxyto" : "node" + "permissions" : { + "user" : "all" + }, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } } - } + }, + "leaf" : 0, + "path" : "/nodes/{node}/disks", + "text" : "disks" }, { - "text" : "apt", - "leaf" : 0, "children" : [ { "info" : { - "POST" : { - "proxyto" : "node", + "GET" : { + "description" : "List available updates.", + "method" : "GET", + "name" : "list_updates", "parameters" : { "additionalProperties" : 0, "properties" : { - "notify" : { - "optional" : 1, - "description" : "Send notification mail about new packages (to email address specified for user 'root@pam').", - "default" : 0, - "type" : "boolean" - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" - }, - "quiet" : { - "type" : "boolean", - "default" : 0, - "optional" : 1, - "description" : "Only produces output suitable for logging, omitting progress indicators." + "type" : "string", + "typetext" : "" } } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -19009,15 +21121,45 @@ var pveapi = [ ] ] }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "type" : "array" + } + }, + "POST" : { + "description" : "This is used to resynchronize the package index files from their sources (apt-get update).", "method" : "POST", "name" : "update_database", - "returns" : { - "type" : "string" + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "notify" : { + "default" : 0, + "description" : "Send notification mail about new packages (to email address specified for user 'root@pam').", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "quiet" : { + "default" : 0, + "description" : "Only produces output suitable for logging, omitting progress indicators.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + } + } }, - "description" : "This is used to resynchronize the package index files from their sources (apt-get update)." - }, - "GET" : { - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -19027,63 +21169,45 @@ var pveapi = [ ] ] }, + "protected" : 1, "proxyto" : "node", - "parameters" : { - "properties" : { - "node" : { - "description" : "The cluster node name.", - "type" : "string", - "format" : "pve-node" - } - }, - "additionalProperties" : 0 - }, - "description" : "List available updates.", "returns" : { - "type" : "array", - "items" : { - "properties" : {}, - "type" : "object" - } - }, - "name" : "list_updates", - "method" : "GET" + "type" : "string" + } } }, + "leaf" : 1, "path" : "/nodes/{node}/apt/update", - "text" : "update", - "leaf" : 1 + "text" : "update" }, { - "leaf" : 1, - "text" : "changelog", "info" : { "GET" : { + "description" : "Get package changelogs.", "method" : "GET", "name" : "changelog", - "returns" : { - "type" : "string" - }, "parameters" : { + "additionalProperties" : 0, "properties" : { "name" : { "description" : "Package name.", - "type" : "string" - }, - "version" : { "type" : "string", - "optional" : 1, - "description" : "Package version." + "typetext" : "" }, "node" : { + "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", - "description" : "The cluster node name." + "typetext" : "" + }, + "version" : { + "description" : "Package version.", + "optional" : 1, + "type" : "string", + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", "permissions" : { "check" : [ "perm", @@ -19093,16 +21217,33 @@ var pveapi = [ ] ] }, - "description" : "Get package changelogs." + "proxyto" : "node", + "returns" : { + "type" : "string" + } } }, - "path" : "/nodes/{node}/apt/changelog" + "leaf" : 1, + "path" : "/nodes/{node}/apt/changelog", + "text" : "changelog" }, { - "text" : "versions", - "leaf" : 1, "info" : { "GET" : { + "description" : "Get package information for important Proxmox packages.", + "method" : "GET", + "name" : "versions", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, "permissions" : { "check" : [ "perm", @@ -19112,50 +21253,39 @@ var pveapi = [ ] ] }, - "description" : "Get package information for important Proxmox packages.", - "method" : "GET", - "name" : "versions", + "proxyto" : "node", "returns" : { "items" : { - "type" : "object", - "properties" : {} + "properties" : {}, + "type" : "object" }, "type" : "array" - }, - "proxyto" : "node", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." - } - } } } }, - "path" : "/nodes/{node}/apt/versions" + "leaf" : 1, + "path" : "/nodes/{node}/apt/versions", + "text" : "versions" } ], - "path" : "/nodes/{node}/apt", "info" : { "GET" : { "description" : "Directory index for apt (Advanced Package Tool).", - "permissions" : { - "user" : "all" - }, "method" : "GET", "name" : "index", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" + "typetext" : "" } - }, - "additionalProperties" : 0 + } + }, + "permissions" : { + "user" : "all" }, "returns" : { "items" : { @@ -19166,98 +21296,92 @@ var pveapi = [ }, "type" : "object" }, - "type" : "array", "links" : [ { - "rel" : "child", - "href" : "{id}" + "href" : "{id}", + "rel" : "child" } - ] + ], + "type" : "array" } } - } + }, + "leaf" : 0, + "path" : "/nodes/{node}/apt", + "text" : "apt" }, { - "leaf" : 0, - "text" : "firewall", - "path" : "/nodes/{node}/firewall", "children" : [ { "children" : [ { - "leaf" : 1, - "text" : "{pos}", - "path" : "/nodes/{node}/firewall/rules/{pos}", "info" : { "DELETE" : { - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, - "proxyto" : "node", + "description" : "Delete rule.", + "method" : "DELETE", + "name" : "delete_rule", "parameters" : { "additionalProperties" : 0, "properties" : { - "pos" : { - "description" : "Update rule at position .", - "optional" : 1, - "type" : "integer", - "minimum" : 0 - }, "digest" : { "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "optional" : 1, "maxLength" : 40, - "type" : "string" + "optional" : 1, + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" + }, + "pos" : { + "description" : "Update rule at position .", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" } } }, - "description" : "Delete rule.", - "name" : "delete_rule", - "method" : "DELETE", + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", "returns" : { "type" : "null" } }, "GET" : { - "returns" : { - "properties" : { - "pos" : { - "type" : "integer" - } - }, - "type" : "object" - }, - "proxyto" : "node", + "description" : "Get single rule data.", + "method" : "GET", + "name" : "get_rule", "parameters" : { "additionalProperties" : 0, "properties" : { - "pos" : { - "minimum" : 0, - "type" : "integer", - "description" : "Update rule at position .", - "optional" : 1 - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" + }, + "pos" : { + "description" : "Update rule at position .", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" } } }, - "name" : "get_rule", - "method" : "GET", "permissions" : { "check" : [ "perm", @@ -19267,120 +21391,141 @@ var pveapi = [ ] ] }, - "description" : "Get single rule data." + "proxyto" : "node", + "returns" : { + "properties" : { + "pos" : { + "type" : "integer" + } + }, + "type" : "object" + } }, "PUT" : { + "description" : "Modify rule data.", "method" : "PUT", "name" : "update_rule", - "returns" : { - "type" : "null" - }, - "description" : "Modify rule data.", - "proxyto" : "node", "parameters" : { "additionalProperties" : 0, "properties" : { - "sport" : { + "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, - "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.", "type" : "string", - "format" : "pve-fw-sport-spec" + "typetext" : "" }, "delete" : { - "type" : "string", + "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "optional" : 1, - "description" : "A list of settings you want to delete." + "type" : "string", + "typetext" : "" }, - "moveto" : { - "type" : "integer", - "minimum" : 0, + "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, - "description" : "Move rule to new position . Other arguments are ignored." + "type" : "string", + "typetext" : "" }, - "enable" : { + "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" : "integer", - "minimum" : 0 + "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, - "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." + "type" : "integer", + "typetext" : " (0 - N)" }, - "proto" : { - "type" : "string", - "format" : "pve-fw-protocol-spec", + "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, - "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'." + "type" : "string", + "typetext" : "" }, "macro" : { - "optional" : 1, + "description" : "Use predefined standard macro.", "maxLength" : 128, - "type" : "string" + "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", - "description" : "The cluster node name." + "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" : { - "format" : "pve-fw-addr-spec", - "type" : "string", "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.", - "optional" : 1 - }, - "iface" : { - "maxLength" : 20, - "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-fw-addr-spec", "optional" : 1, - "minLength" : 2, - "format" : "pve-iface", - "type" : "string" + "type" : "string", + "typetext" : "" }, - "digest" : { + "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, - "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "type" : "string" + "type" : "string", + "typetext" : "" }, "type" : { - "type" : "string", - "optional" : 1, + "description" : "Rule type.", "enum" : [ "in", "out", "group" - ] - }, - "dest" : { - "optional" : 1, - "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", - "type" : "string" - }, - "action" : { - "maxLength" : 20, + ], "optional" : 1, - "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", - "minLength" : 2, - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" - }, - "comment" : { - "type" : "string", - "optional" : 1 - }, - "pos" : { - "description" : "Update rule at position .", - "optional" : 1, - "minimum" : 0, - "type" : "integer" } } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -19389,45 +21534,35 @@ var pveapi = [ "Sys.Modify" ] ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/firewall/rules/{pos}", + "text" : "{pos}" } ], - "path" : "/nodes/{node}/firewall/rules", "info" : { "GET" : { + "description" : "List rules.", "method" : "GET", "name" : "get_rules", - "returns" : { - "links" : [ - { - "href" : "{pos}", - "rel" : "child" - } - ], - "items" : { - "properties" : { - "pos" : { - "type" : "integer" - } - }, - "type" : "object" - }, - "type" : "array" - }, "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", - "description" : "List rules.", "permissions" : { "check" : [ "perm", @@ -19436,90 +21571,127 @@ var pveapi = [ "Sys.Audit" ] ] + }, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "pos" : { + "type" : "integer" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{pos}", + "rel" : "child" + } + ], + "type" : "array" } }, "POST" : { - "proxyto" : "node", + "description" : "Create new rule.", + "method" : "POST", + "name" : "create_rule", "parameters" : { + "additionalProperties" : 0, "properties" : { - "digest" : { - "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "optional" : 1, + "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" }, - "proto" : { + "comment" : { + "description" : "Descriptive comment.", + "optional" : 1, "type" : "string", - "format" : "pve-fw-protocol-spec", + "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, - "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'." + "type" : "string", + "typetext" : "" }, - "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.", + "digest" : { + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", + "maxLength" : 40, "optional" : 1, - "maxLength" : 20, - "minLength" : 2, - "format" : "pve-iface", - "type" : "string" + "type" : "string", + "typetext" : "" }, "dport" : { - "optional" : 1, "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", - "format" : "pve-fw-dport-spec" + "typetext" : "" }, "enable" : { + "description" : "Flag to enable/disable a rule.", "minimum" : 0, + "optional" : 1, "type" : "integer", - "optional" : 1 + "typetext" : " (0 - N)" }, - "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.", + "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, - "format" : "pve-fw-addr-spec", - "type" : "string" + "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.", + "macro" : { + "description" : "Use predefined standard macro.", + "maxLength" : 128, "optional" : 1, "type" : "string", - "format" : "pve-fw-sport-spec" + "typetext" : "" }, "node" : { + "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", - "description" : "The cluster node name." + "typetext" : "" }, "pos" : { - "type" : "integer", - "minimum" : 0, "description" : "Update rule at position .", - "optional" : 1 - }, - "action" : { - "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", - "minLength" : 2, - "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.", - "maxLength" : 20, - "optional" : 0, - "type" : "string" + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" }, - "comment" : { + "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", - "optional" : 1 + "typetext" : "" }, - "dest" : { + "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", - "type" : "string", "optional" : 1, - "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." + "type" : "string", + "typetext" : "" }, - "macro" : { + "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", - "maxLength" : 128, - "optional" : 1 + "typetext" : "" }, "type" : { + "description" : "Rule type.", "enum" : [ "in", "out", @@ -19528,8 +21700,7 @@ var pveapi = [ "optional" : 0, "type" : "string" } - }, - "additionalProperties" : 0 + } }, "permissions" : { "check" : [ @@ -19541,47 +21712,52 @@ var pveapi = [ ] }, "protected" : 1, + "proxyto" : "node", "returns" : { "type" : "null" - }, - "method" : "POST", - "name" : "create_rule", - "description" : "Create new rule." + } } }, - "text" : "rules", - "leaf" : 0 + "leaf" : 0, + "path" : "/nodes/{node}/firewall/rules", + "text" : "rules" }, { - "path" : "/nodes/{node}/firewall/options", "info" : { - "PUT" : { - "protected" : 1, + "GET" : { + "description" : "Get host firewall options.", + "method" : "GET", + "name" : "get_options", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, "permissions" : { "check" : [ "perm", "/nodes/{node}", [ - "Sys.Modify" + "Sys.Audit" ] ] }, "proxyto" : "node", - "parameters" : { + "returns" : { "properties" : { - "digest" : { - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "optional" : 1, - "maxLength" : 40, - "type" : "string" - }, "enable" : { "description" : "Enable host firewall rules.", "optional" : 1, "type" : "boolean" }, "log_level_in" : { - "type" : "string", + "description" : "Log level for incoming traffic.", "enum" : [ "emerg", "alert", @@ -19594,31 +21770,10 @@ var pveapi = [ "nolog" ], "optional" : 1, - "description" : "Log level for incoming traffic." - }, - "nosmurfs" : { - "type" : "boolean", - "description" : "Enable SMURFS filter.", - "optional" : 1 - }, - "tcpflags" : { - "type" : "boolean", - "optional" : 1, - "description" : "Filter illegal combinations of TCP flags." - }, - "nf_conntrack_max" : { - "type" : "integer", - "minimum" : 32768, - "description" : "Maximum number of tracked connections.", - "optional" : 1 - }, - "delete" : { - "format" : "pve-configid-list", - "type" : "string", - "description" : "A list of settings you want to delete.", - "optional" : 1 + "type" : "string" }, "log_level_out" : { + "description" : "Log level for outgoing traffic.", "enum" : [ "emerg", "alert", @@ -19630,25 +21785,33 @@ var pveapi = [ "debug", "nolog" ], - "description" : "Log level for outgoing traffic.", "optional" : 1, "type" : "string" }, - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." + "ndp" : { + "description" : "Enable NDP.", + "optional" : 1, + "type" : "boolean" + }, + "nf_conntrack_max" : { + "description" : "Maximum number of tracked connections.", + "minimum" : 32768, + "optional" : 1, + "type" : "integer" }, "nf_conntrack_tcp_timeout_established" : { - "minimum" : 7875, - "type" : "integer", "description" : "Conntrack established timeout.", - "optional" : 1 + "minimum" : 7875, + "optional" : 1, + "type" : "integer" }, - "tcp_flags_log_level" : { - "type" : "string", - "description" : "Log level for illegal tcp flags filter.", + "nosmurfs" : { + "description" : "Enable SMURFS filter.", "optional" : 1, + "type" : "boolean" + }, + "smurf_log_level" : { + "description" : "Log level for SMURFS filter.", "enum" : [ "emerg", "alert", @@ -19659,15 +21822,12 @@ var pveapi = [ "info", "debug", "nolog" - ] - }, - "ndp" : { - "type" : "boolean", + ], "optional" : 1, - "description" : "Enable NDP." + "type" : "string" }, - "smurf_log_level" : { - "type" : "string", + "tcp_flags_log_level" : { + "description" : "Log level for illegal tcp flags filter.", "enum" : [ "emerg", "alert", @@ -19680,62 +21840,46 @@ var pveapi = [ "nolog" ], "optional" : 1, - "description" : "Log level for SMURFS filter." + "type" : "string" + }, + "tcpflags" : { + "description" : "Filter illegal combinations of TCP flags.", + "optional" : 1, + "type" : "boolean" } }, - "additionalProperties" : 0 - }, + "type" : "object" + } + }, + "PUT" : { "description" : "Set Firewall options.", - "returns" : { - "type" : "null" - }, + "method" : "PUT", "name" : "set_options", - "method" : "PUT" - }, - "GET" : { - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Audit" - ] - ] - }, - "description" : "Get host firewall options.", - "method" : "GET", - "name" : "get_options", - "returns" : { + "parameters" : { + "additionalProperties" : 0, "properties" : { - "nf_conntrack_tcp_timeout_established" : { + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", "optional" : 1, - "description" : "Conntrack established timeout.", - "type" : "integer", - "minimum" : 7875 + "type" : "string", + "typetext" : "" }, - "ndp" : { - "type" : "boolean", - "description" : "Enable NDP.", - "optional" : 1 + "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" : "" }, - "smurf_log_level" : { - "enum" : [ - "emerg", - "alert", - "crit", - "err", - "warning", - "notice", - "info", - "debug", - "nolog" - ], - "description" : "Log level for SMURFS filter.", + "enable" : { + "description" : "Enable host firewall rules.", "optional" : 1, - "type" : "string" + "type" : "boolean", + "typetext" : "" }, - "tcp_flags_log_level" : { - "type" : "string", + "log_level_in" : { + "description" : "Log level for incoming traffic.", "enum" : [ "emerg", "alert", @@ -19748,9 +21892,10 @@ var pveapi = [ "nolog" ], "optional" : 1, - "description" : "Log level for illegal tcp flags filter." + "type" : "string" }, - "log_level_in" : { + "log_level_out" : { + "description" : "Log level for outgoing traffic.", "enum" : [ "emerg", "alert", @@ -19762,32 +21907,59 @@ var pveapi = [ "debug", "nolog" ], - "description" : "Log level for incoming traffic.", "optional" : 1, "type" : "string" }, - "enable" : { - "type" : "boolean", + "ndp" : { + "description" : "Enable NDP.", "optional" : 1, - "description" : "Enable host firewall rules." + "type" : "boolean", + "typetext" : "" }, "nf_conntrack_max" : { "description" : "Maximum number of tracked connections.", + "minimum" : 32768, "optional" : 1, "type" : "integer", - "minimum" : 32768 + "typetext" : " (32768 - N)" }, - "tcpflags" : { + "nf_conntrack_tcp_timeout_established" : { + "description" : "Conntrack established timeout.", + "minimum" : 7875, "optional" : 1, - "description" : "Filter illegal combinations of TCP flags.", - "type" : "boolean" + "type" : "integer", + "typetext" : " (7875 - N)" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" }, "nosmurfs" : { + "description" : "Enable SMURFS filter.", + "optional" : 1, "type" : "boolean", + "typetext" : "" + }, + "smurf_log_level" : { + "description" : "Log level for SMURFS filter.", + "enum" : [ + "emerg", + "alert", + "crit", + "err", + "warning", + "notice", + "info", + "debug", + "nolog" + ], "optional" : 1, - "description" : "Enable SMURFS filter." + "type" : "string" }, - "log_level_out" : { + "tcp_flags_log_level" : { + "description" : "Log level for illegal tcp flags filter.", "enum" : [ "emerg", "alert", @@ -19800,186 +21972,195 @@ var pveapi = [ "nolog" ], "optional" : 1, - "description" : "Log level for outgoing traffic.", "type" : "string" + }, + "tcpflags" : { + "description" : "Filter illegal combinations of TCP flags.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" } - }, - "type" : "object" + } }, - "proxyto" : "node", - "parameters" : { - "properties" : { - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - } - }, - "additionalProperties" : 0 - } - } - }, - "leaf" : 1, - "text" : "options" - }, - { - "path" : "/nodes/{node}/firewall/log", - "info" : { - "GET" : { "permissions" : { "check" : [ "perm", "/nodes/{node}", [ - "Sys.Syslog" + "Sys.Modify" ] ] }, "protected" : 1, "proxyto" : "node", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/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", - "optional" : 1 + "typetext" : " (0 - N)" }, "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" }, "start" : { + "minimum" : 0, "optional" : 1, "type" : "integer", - "minimum" : 0 + "typetext" : " (0 - N)" } } }, - "description" : "Read firewall log", + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Syslog" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", "returns" : { "items" : { - "type" : "object", "properties" : { + "n" : { + "description" : "Line number", + "type" : "integer" + }, "t" : { "description" : "Line text", "type" : "string" - }, - "n" : { - "type" : "integer", - "description" : "Line number" } - } + }, + "type" : "object" }, "type" : "array" - }, - "method" : "GET", - "name" : "log" + } } }, - "text" : "log", - "leaf" : 1 + "leaf" : 1, + "path" : "/nodes/{node}/firewall/log", + "text" : "log" } ], "info" : { "GET" : { + "description" : "Directory index.", + "method" : "GET", + "name" : "index", "parameters" : { "additionalProperties" : 0, "properties" : { "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, + "permissions" : { + "user" : "all" + }, "returns" : { "items" : { "properties" : {}, "type" : "object" }, - "type" : "array", "links" : [ { "href" : "{name}", "rel" : "child" } - ] - }, - "name" : "index", - "method" : "GET", - "description" : "Directory index.", - "permissions" : { - "user" : "all" + ], + "type" : "array" } } - } + }, + "leaf" : 0, + "path" : "/nodes/{node}/firewall", + "text" : "firewall" }, { - "text" : "version", - "leaf" : 1, - "path" : "/nodes/{node}/version", "info" : { "GET" : { "description" : "API version details", - "permissions" : { - "user" : "all" - }, - "proxyto" : "node", + "method" : "GET", + "name" : "version", "parameters" : { "additionalProperties" : 0, "properties" : { "node" : { + "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", - "description" : "The cluster node name." + "typetext" : "" } } }, + "permissions" : { + "user" : "all" + }, + "proxyto" : "node", "returns" : { "properties" : { - "version" : { - "type" : "string" - }, "release" : { "type" : "string" }, "repoid" : { "type" : "string" + }, + "version" : { + "type" : "string" } }, "type" : "object" - }, - "method" : "GET", - "name" : "version" + } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/version", + "text" : "version" }, { - "text" : "status", - "leaf" : 1, - "path" : "/nodes/{node}/status", "info" : { "GET" : { + "description" : "Read node status", "method" : "GET", "name" : "status", - "returns" : { - "type" : "object", - "properties" : {} - }, - "proxyto" : "node", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, - "description" : "Read node status", "permissions" : { "check" : [ "perm", @@ -19988,31 +22169,33 @@ var pveapi = [ "Sys.Audit" ] ] + }, + "proxyto" : "node", + "returns" : { + "properties" : {}, + "type" : "object" } }, "POST" : { - "returns" : { - "type" : "null" - }, - "name" : "node_cmd", - "method" : "POST", "description" : "Reboot or shutdown a node.", - "proxyto" : "node", + "method" : "POST", + "name" : "node_cmd", "parameters" : { "additionalProperties" : 0, "properties" : { - "node" : { - "description" : "The cluster node name.", - "type" : "string", - "format" : "pve-node" - }, "command" : { + "description" : "Specify the command.", "enum" : [ "reboot", "shutdown" ], - "description" : "Specify the command.", "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" } } }, @@ -20025,37 +22208,34 @@ var pveapi = [ ] ] }, - "protected" : 1 + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/status", + "text" : "status" }, { - "leaf" : 1, - "text" : "netstat", - "path" : "/nodes/{node}/netstat", "info" : { "GET" : { + "description" : "Read tap/vm network device interface counters", "method" : "GET", "name" : "netstat", - "proxyto" : "node", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" } - }, - "additionalProperties" : 0 - }, - "returns" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : {} } }, - "description" : "Read tap/vm network device interface counters", "permissions" : { "check" : [ "perm", @@ -20064,28 +22244,43 @@ var pveapi = [ "Sys.Audit" ] ] + }, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "type" : "array" } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/netstat", + "text" : "netstat" }, { "info" : { "POST" : { + "description" : "Execute multiple commands in order.", + "method" : "POST", + "name" : "execute", "parameters" : { "additionalProperties" : 0, "properties" : { "commands" : { "description" : "JSON encoded array of commands.", - "type" : "string" + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" + "typetext" : "" } } }, - "proxyto" : "node", "permissions" : { "check" : [ "perm", @@ -20096,57 +22291,49 @@ var pveapi = [ ] }, "protected" : 1, + "proxyto" : "node", "returns" : { "properties" : {}, "type" : "array" - }, - "method" : "POST", - "name" : "execute", - "description" : "Execute multiple commands in order." + } } }, - "path" : "/nodes/{node}/execute", "leaf" : 1, + "path" : "/nodes/{node}/execute", "text" : "execute" }, { - "text" : "rrd", - "leaf" : 1, - "path" : "/nodes/{node}/rrd", "info" : { "GET" : { + "description" : "Read node RRD statistics (returns PNG)", "method" : "GET", "name" : "rrd", - "returns" : { - "type" : "object", - "properties" : { - "filename" : { - "type" : "string" - } - } - }, "parameters" : { + "additionalProperties" : 0, "properties" : { - "node" : { - "description" : "The cluster node name.", - "format" : "pve-node", - "type" : "string" - }, - "ds" : { - "format" : "pve-configid-list", - "type" : "string", - "description" : "The list of datasources you want to display." - }, "cf" : { "description" : "The RRD consolidation function", - "optional" : 1, "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", @@ -20154,13 +22341,10 @@ var pveapi = [ "month", "year" ], - "description" : "Specify the time frame you are interested in.", "type" : "string" } - }, - "additionalProperties" : 0 + } }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -20170,40 +22354,44 @@ var pveapi = [ ] ] }, - "description" : "Read node RRD statistics (returns PNG)" + "protected" : 1, + "returns" : { + "properties" : { + "filename" : { + "type" : "string" + } + }, + "type" : "object" + } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/rrd", + "text" : "rrd" }, { - "path" : "/nodes/{node}/rrddata", "info" : { "GET" : { - "protected" : 1, "description" : "Read node RRD statistics", - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Audit" - ] - ] - }, "method" : "GET", "name" : "rrddata", - "returns" : { - "type" : "array", - "items" : { - "properties" : {}, - "type" : "object" - } - }, "parameters" : { + "additionalProperties" : 0, "properties" : { + "cf" : { + "description" : "The RRD consolidation function", + "enum" : [ + "AVERAGE", + "MAX" + ], + "optional" : 1, + "type" : "string" + }, "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" }, "timeframe" : { "description" : "Specify the time frame you are interested in.", @@ -20215,79 +22403,133 @@ var pveapi = [ "year" ], "type" : "string" - }, - "cf" : { - "type" : "string", - "optional" : 1, - "description" : "The RRD consolidation function", - "enum" : [ - "AVERAGE", - "MAX" - ] } + } + }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Audit" + ] + ] + }, + "protected" : 1, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" }, - "additionalProperties" : 0 + "type" : "array" } } }, - "text" : "rrddata", - "leaf" : 1 + "leaf" : 1, + "path" : "/nodes/{node}/rrddata", + "text" : "rrddata" }, { - "text" : "syslog", - "leaf" : 1, - "path" : "/nodes/{node}/syslog", "info" : { "GET" : { + "description" : "Read system log", "method" : "GET", "name" : "syslog", + "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" : "" + }, + "since" : { + "description" : "Display all log since this date-time string.", + "optional" : 1, + "pattern" : "^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}(:\\d{2})?)?$", + "type" : "string" + }, + "start" : { + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "until" : { + "description" : "Display all log until this date-time string.", + "optional" : 1, + "pattern" : "^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}(:\\d{2})?)?$", + "type" : "string" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Syslog" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", "returns" : { - "type" : "array", "items" : { - "type" : "object", "properties" : { - "t" : { - "description" : "Line text", - "type" : "string" - }, "n" : { "description" : "Line number", "type" : "integer" + }, + "t" : { + "description" : "Line text", + "type" : "string" } - } - } - }, - "description" : "Read system log", - "proxyto" : "node", + }, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/syslog", + "text" : "syslog" + }, + { + "info" : { + "POST" : { + "description" : "Creates a VNC Shell proxy.", + "method" : "POST", + "name" : "vncshell", "parameters" : { "additionalProperties" : 0, "properties" : { - "start" : { - "optional" : 1, - "type" : "integer", - "minimum" : 0 - }, - "since" : { - "pattern" : "^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}(:\\d{2})?)?$", - "description" : "Display all log since this date-time string.", - "optional" : 1, - "type" : "string" - }, "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" }, - "limit" : { + "upgrade" : { + "default" : 0, + "description" : "Run 'apt-get dist-upgrade' instead of normal shell.", "optional" : 1, - "type" : "integer", - "minimum" : 0 + "type" : "boolean", + "typetext" : "" }, - "until" : { - "type" : "string", + "websocket" : { + "description" : "use websocket instead of standard vnc.", "optional" : 1, - "description" : "Display all log until this date-time string.", - "pattern" : "^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}(:\\d{2})?)?$" + "type" : "boolean", + "typetext" : "" } } }, @@ -20296,22 +22538,12 @@ var pveapi = [ "perm", "/nodes/{node}", [ - "Sys.Syslog" + "Sys.Console" ] - ] + ], + "description" : "Restricted to users on realm 'pam'" }, - "protected" : 1 - } - } - }, - { - "text" : "vncshell", - "leaf" : 1, - "path" : "/nodes/{node}/vncshell", - "info" : { - "POST" : { - "name" : "vncshell", - "method" : "POST", + "protected" : 1, "returns" : { "additionalProperties" : 0, "properties" : { @@ -20331,141 +22563,115 @@ var pveapi = [ "type" : "string" } } - }, - "parameters" : { - "properties" : { - "upgrade" : { - "type" : "boolean", - "default" : 0, - "optional" : 1, - "description" : "Run 'apt-get dist-upgrade' instead of normal shell." - }, - "node" : { - "format" : "pve-node", - "type" : "string", - "description" : "The cluster node name." - }, - "websocket" : { - "type" : "boolean", - "optional" : 1, - "description" : "use websocket instead of standard vnc." - } - }, - "additionalProperties" : 0 - }, - "protected" : 1, - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Console" - ] - ], - "description" : "Restricted to users on realm 'pam'" - }, - "description" : "Creates a VNC Shell proxy." + } } - } + }, + "leaf" : 1, + "path" : "/nodes/{node}/vncshell", + "text" : "vncshell" }, { "info" : { "GET" : { - "returns" : { - "properties" : { - "port" : { - "type" : "string" - } - }, - "type" : "object" - }, + "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", - "maximum" : 5999 + "typetext" : " (5900 - 5999)" }, "vncticket" : { "description" : "Ticket from previous call to vncproxy.", "maxLength" : 512, - "type" : "string" - }, - "node" : { - "format" : "pve-node", "type" : "string", - "description" : "The cluster node name." + "typetext" : "" } } }, - "name" : "vncwebsocket", - "method" : "GET", - "description" : "Opens a weksocket for VNC traffic.", "permissions" : { - "description" : "Restricted to users on realm 'pam'. You also need to pass a valid ticket (vncticket).", "check" : [ "perm", "/nodes/{node}", [ "Sys.Console" ] - ] + ], + "description" : "Restricted to users on realm 'pam'. You also need to pass a valid ticket (vncticket)." + }, + "returns" : { + "properties" : { + "port" : { + "type" : "string" + } + }, + "type" : "object" } } }, - "path" : "/nodes/{node}/vncwebsocket", "leaf" : 1, + "path" : "/nodes/{node}/vncwebsocket", "text" : "vncwebsocket" }, { "info" : { "POST" : { + "description" : "Creates a SPICE shell.", + "method" : "POST", + "name" : "spiceshell", "parameters" : { + "additionalProperties" : 0, "properties" : { - "upgrade" : { - "description" : "Run 'apt-get dist-upgrade' instead of normal shell.", - "optional" : 1, - "type" : "boolean", - "default" : 0 - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "proxy" : { - "type" : "string", - "format" : "address", "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).", - "optional" : 1 + "format" : "address", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "upgrade" : { + "default" : 0, + "description" : "Run 'apt-get dist-upgrade' instead of normal shell.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", - "protected" : 1, "permissions" : { - "description" : "Restricted to users on realm 'pam'", "check" : [ "perm", "/nodes/{node}", [ "Sys.Console" ] - ] + ], + "description" : "Restricted to users on realm 'pam'" }, - "method" : "POST", - "name" : "spiceshell", + "protected" : 1, + "proxyto" : "node", "returns" : { - "description" : "Returned values can be directly passed to the 'remote-viewer' application.", "additionalProperties" : 1, + "description" : "Returned values can be directly passed to the 'remote-viewer' application.", "properties" : { - "tls-port" : { - "type" : "integer" - }, - "type" : { + "host" : { "type" : "string" }, "password" : { @@ -20474,73 +22680,37 @@ var pveapi = [ "proxy" : { "type" : "string" }, - "host" : { + "tls-port" : { + "type" : "integer" + }, + "type" : { "type" : "string" } } - }, - "description" : "Creates a SPICE shell." + } } }, + "leaf" : 1, "path" : "/nodes/{node}/spiceshell", - "text" : "spiceshell", - "leaf" : 1 + "text" : "spiceshell" }, { "info" : { - "PUT" : { - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Modify" - ] - ] - }, - "protected" : 1, + "GET" : { + "description" : "Read DNS settings.", + "method" : "GET", + "name" : "dns", "parameters" : { + "additionalProperties" : 0, "properties" : { - "dns3" : { - "type" : "string", - "format" : "ip", - "description" : "Third name server IP address.", - "optional" : 1 - }, - "search" : { - "description" : "Search domain for host-name lookup.", - "type" : "string" - }, - "dns1" : { - "format" : "ip", - "type" : "string", - "optional" : 1, - "description" : "First name server IP address." - }, - "dns2" : { - "description" : "Second name server IP address.", - "optional" : 1, - "format" : "ip", - "type" : "string" - }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } - }, - "additionalProperties" : 0 - }, - "proxyto" : "node", - "description" : "Write DNS settings.", - "returns" : { - "type" : "null" + } }, - "method" : "PUT", - "name" : "update_dns" - }, - "GET" : { - "description" : "Read DNS settings.", "permissions" : { "check" : [ "perm", @@ -20550,122 +22720,163 @@ var pveapi = [ ] ] }, + "proxyto" : "node", "returns" : { "additionalProperties" : 0, "properties" : { - "dns3" : { + "dns1" : { + "description" : "First name server IP address.", + "optional" : 1, + "type" : "string" + }, + "dns2" : { + "description" : "Second name server IP address.", "optional" : 1, + "type" : "string" + }, + "dns3" : { "description" : "Third name server IP address.", + "optional" : 1, "type" : "string" }, "search" : { - "type" : "string", "description" : "Search domain for host-name lookup.", - "optional" : 1 - }, - "dns1" : { - "type" : "string", - "description" : "First name server IP address.", - "optional" : 1 - }, - "dns2" : { - "description" : "Second name server IP address.", "optional" : 1, "type" : "string" } }, "type" : "object" - }, + } + }, + "PUT" : { + "description" : "Write DNS settings.", + "method" : "PUT", + "name" : "update_dns", "parameters" : { "additionalProperties" : 0, "properties" : { - "node" : { + "dns1" : { + "description" : "First name server IP address.", + "format" : "ip", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "dns2" : { + "description" : "Second name server IP address.", + "format" : "ip", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "dns3" : { + "description" : "Third name server IP address.", + "format" : "ip", + "optional" : 1, "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" + }, + "search" : { + "description" : "Search domain for host-name lookup.", + "type" : "string", + "typetext" : "" } } }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, "proxyto" : "node", - "method" : "GET", - "name" : "dns" + "returns" : { + "type" : "null" + } } }, - "path" : "/nodes/{node}/dns", "leaf" : 1, + "path" : "/nodes/{node}/dns", "text" : "dns" }, { - "text" : "time", - "leaf" : 1, "info" : { "GET" : { - "name" : "time", + "description" : "Read server time and time zone settings.", "method" : "GET", + "name" : "time", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" + "typetext" : "" } - }, - "additionalProperties" : 0 + } + }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Audit" + ] + ] }, "proxyto" : "node", "returns" : { + "additionalProperties" : 0, "properties" : { - "time" : { - "type" : "integer", + "localtime" : { + "description" : "Seconds since 1970-01-01 00:00:00 (local time)", "minimum" : 1297163644, - "description" : "Seconds since 1970-01-01 00:00:00 UTC." + "type" : "integer" }, - "localtime" : { - "type" : "integer", + "time" : { + "description" : "Seconds since 1970-01-01 00:00:00 UTC.", "minimum" : 1297163644, - "description" : "Seconds since 1970-01-01 00:00:00 (local time)" + "type" : "integer" }, "timezone" : { - "type" : "string", - "description" : "Time zone" + "description" : "Time zone", + "type" : "string" } }, - "additionalProperties" : 0, "type" : "object" - }, - "description" : "Read server time and time zone settings.", - "permissions" : { - "check" : [ - "perm", - "/nodes/{node}", - [ - "Sys.Audit" - ] - ] } }, "PUT" : { + "description" : "Set time zone.", "method" : "PUT", "name" : "set_timezone", - "returns" : { - "type" : "null" - }, - "description" : "Set time zone.", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" + "typetext" : "" }, "timezone" : { "description" : "Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names.", - "type" : "string" + "type" : "string", + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", "permissions" : { "check" : [ "perm", @@ -20675,37 +22886,73 @@ var pveapi = [ ] ] }, - "protected" : 1 + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } } }, - "path" : "/nodes/{node}/time" + "leaf" : 1, + "path" : "/nodes/{node}/time", + "text" : "time" }, { - "leaf" : 1, - "text" : "aplinfo", "info" : { + "GET" : { + "description" : "Get list of appliances.", + "method" : "GET", + "name" : "aplinfo", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "user" : "all" + }, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "type" : "array" + } + }, "POST" : { + "description" : "Download appliance templates.", + "method" : "POST", + "name" : "apl_download", "parameters" : { + "additionalProperties" : 0, "properties" : { - "template" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "maxLength" : 255, - "description" : "The template wich will downloaded" + "typetext" : "" }, "storage" : { - "description" : "Only list status for specified storage", + "description" : "The storage where the template will be stored", + "format" : "pve-storage-id", "type" : "string", - "format" : "pve-storage-id" + "typetext" : "" }, - "node" : { + "template" : { + "description" : "The template wich will downloaded", + "maxLength" : 255, "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", "permissions" : { "check" : [ "perm", @@ -20716,57 +22963,33 @@ var pveapi = [ ] }, "protected" : 1, - "method" : "POST", - "name" : "apl_download", + "proxyto" : "node", "returns" : { "type" : "string" - }, - "description" : "Download appliance templates." - }, - "GET" : { - "method" : "GET", - "name" : "aplinfo", - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "type" : "array" - }, - "parameters" : { - "properties" : { - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - } - }, - "additionalProperties" : 0 - }, - "proxyto" : "node", - "description" : "Get list of appliances.", - "permissions" : { - "user" : "all" } } }, - "path" : "/nodes/{node}/aplinfo" + "leaf" : 1, + "path" : "/nodes/{node}/aplinfo", + "text" : "aplinfo" }, { "info" : { "GET" : { + "description" : "Gather various systems information about a node", + "method" : "GET", + "name" : "report", "parameters" : { "additionalProperties" : 0, "properties" : { "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" + "typetext" : "" } } }, - "proxyto" : "node", - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -20776,37 +22999,40 @@ var pveapi = [ ] ] }, - "name" : "report", - "method" : "GET", + "protected" : 1, + "proxyto" : "node", "returns" : { "type" : "string" - }, - "description" : "Gather various systems information about a node" + } } }, + "leaf" : 1, "path" : "/nodes/{node}/report", - "text" : "report", - "leaf" : 1 + "text" : "report" }, { "info" : { "POST" : { + "description" : "Start all VMs and containers (when onboot=1).", + "method" : "POST", + "name" : "startall", "parameters" : { + "additionalProperties" : 0, "properties" : { - "node" : { - "type" : "string", - "format" : "pve-node", - "description" : "The cluster node name." - }, "force" : { - "optional" : 1, "description" : "force if onboot=0.", - "type" : "boolean" + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, - "proxyto" : "node", "permissions" : { "check" : [ "perm", @@ -20817,31 +23043,30 @@ var pveapi = [ ] }, "protected" : 1, + "proxyto" : "node", "returns" : { "type" : "string" - }, - "name" : "startall", - "method" : "POST", - "description" : "Start all VMs and containers (when onboot=1)." + } } }, - "path" : "/nodes/{node}/startall", "leaf" : 1, + "path" : "/nodes/{node}/startall", "text" : "startall" }, { - "text" : "stopall", - "leaf" : 1, "info" : { "POST" : { - "proxyto" : "node", + "description" : "Stop all VMs and Containers.", + "method" : "POST", + "name" : "stopall", "parameters" : { "additionalProperties" : 0, "properties" : { "node" : { - "type" : "string", + "description" : "The cluster node name.", "format" : "pve-node", - "description" : "The cluster node name." + "type" : "string", + "typetext" : "" } } }, @@ -20855,38 +23080,43 @@ var pveapi = [ ] }, "protected" : 1, + "proxyto" : "node", "returns" : { "type" : "string" - }, - "method" : "POST", - "name" : "stopall", - "description" : "Stop all VMs and Containers." + } } }, - "path" : "/nodes/{node}/stopall" + "leaf" : 1, + "path" : "/nodes/{node}/stopall", + "text" : "stopall" }, { "info" : { "POST" : { - "proxyto" : "node", + "description" : "Migrate all VMs and Containers.", + "method" : "POST", + "name" : "migrateall", "parameters" : { "additionalProperties" : 0, "properties" : { + "maxworkers" : { + "description" : "Maximal number of parallel migration job. If not set use 'max_workers' from datacenter.cfg, one of both must be set!", + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + }, "node" : { + "description" : "The cluster node name.", "format" : "pve-node", "type" : "string", - "description" : "The cluster node name." + "typetext" : "" }, "target" : { - "type" : "string", + "description" : "Target node.", "format" : "pve-node", - "description" : "Target node." - }, - "maxworkers" : { - "minimum" : 1, - "type" : "integer", - "optional" : 1, - "description" : "Maximal number of parallel migration job. If not set use 'max_workers' from datacenter.cfg, one of both must be set!" + "type" : "string", + "typetext" : "" } } }, @@ -20900,92 +23130,105 @@ var pveapi = [ ] }, "protected" : 1, + "proxyto" : "node", "returns" : { "type" : "string" - }, - "method" : "POST", - "name" : "migrateall", - "description" : "Migrate all VMs and Containers." + } } }, + "leaf" : 1, "path" : "/nodes/{node}/migrateall", - "text" : "migrateall", - "leaf" : 1 + "text" : "migrateall" } ], "info" : { "GET" : { - "name" : "index", + "description" : "Node index.", "method" : "GET", + "name" : "index", "parameters" : { + "additionalProperties" : 0, "properties" : { "node" : { "description" : "The cluster node name.", + "format" : "pve-node", "type" : "string", - "format" : "pve-node" + "typetext" : "" } - }, - "additionalProperties" : 0 + } + }, + "permissions" : { + "user" : "all" }, "returns" : { "items" : { "properties" : {}, "type" : "object" }, - "type" : "array", "links" : [ { - "rel" : "child", - "href" : "{name}" + "href" : "{name}", + "rel" : "child" } - ] - }, - "permissions" : { - "user" : "all" - }, - "description" : "Node index." + ], + "type" : "array" + } } - } + }, + "leaf" : 0, + "path" : "/nodes/{node}", + "text" : "{node}" } ], "info" : { "GET" : { - "returns" : { - "links" : [ - { - "rel" : "child", - "href" : "{node}" - } - ], - "type" : "array", - "items" : { - "type" : "object", - "properties" : {} - } - }, + "description" : "Cluster node index.", + "method" : "GET", + "name" : "index", "parameters" : { "additionalProperties" : 0 }, - "name" : "index", - "method" : "GET", "permissions" : { "user" : "all" }, - "description" : "Cluster node index." + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{node}", + "rel" : "child" + } + ], + "type" : "array" + } } - } + }, + "leaf" : 0, + "path" : "/nodes", + "text" : "nodes" }, { - "leaf" : 0, - "text" : "storage", - "path" : "/storage", "children" : [ { - "path" : "/storage/{storage}", "info" : { "DELETE" : { - "protected" : 1, "description" : "Delete storage configuration.", + "method" : "DELETE", + "name" : "delete", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "storage" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", + "type" : "string", + "typetext" : "" + } + } + }, "permissions" : { "check" : [ "perm", @@ -20995,23 +23238,26 @@ var pveapi = [ ] ] }, + "protected" : 1, "returns" : { "type" : "null" - }, + } + }, + "GET" : { + "description" : "Read storage configuration.", + "method" : "GET", + "name" : "read", "parameters" : { "additionalProperties" : 0, "properties" : { "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, - "method" : "DELETE", - "name" : "delete" - }, - "GET" : { "permissions" : { "check" : [ "perm", @@ -21021,173 +23267,200 @@ var pveapi = [ ] ] }, - "description" : "Read storage configuration.", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "storage" : { - "format" : "pve-storage-id", - "type" : "string", - "description" : "The storage identifier." - } - } - }, - "returns" : {}, - "method" : "GET", - "name" : "read" + "returns" : {} }, "PUT" : { + "description" : "Update storage configuration.", "method" : "PUT", "name" : "update", - "returns" : { - "type" : "null" - }, "parameters" : { - "type" : "object", "additionalProperties" : 0, "properties" : { - "maxfiles" : { - "type" : "integer", - "minimum" : 0, + "blocksize" : { + "description" : "block size", "optional" : 1, - "description" : "Maximal number of backup files per VM. Use '0' for unlimted." - }, - "content" : { - "format" : "pve-storage-content-list", "type" : "string", - "optional" : 1, - "description" : "Allowed content types.\n\nNOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.\n" + "typetext" : "" }, - "username" : { - "description" : "RBD Id.", + "comstar_hg" : { + "description" : "host group for comstar views", "optional" : 1, - "type" : "string" - }, - "server" : { - "format" : "pve-storage-server", "type" : "string", - "optional" : 1, - "description" : "Server IP or DNS name." - }, - "krbd" : { - "description" : "Access rbd through krbd kernel module.", - "optional" : 1, - "type" : "boolean" + "typetext" : "" }, - "options" : { + "comstar_tg" : { + "description" : "target group for comstar views", "optional" : 1, - "description" : "NFS mount options (see 'man nfs')", "type" : "string", - "format" : "pve-storage-options" + "typetext" : "" }, - "comstar_hg" : { + "content" : { + "description" : "Allowed content types.\n\nNOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.\n", + "format" : "pve-storage-content-list", + "optional" : 1, "type" : "string", - "description" : "host group for comstar views", - "optional" : 1 + "typetext" : "" }, "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", "maxLength" : 4096, "optional" : 1, - "description" : "A list of settings you want to delete.", "type" : "string", - "format" : "pve-configid-list" + "typetext" : "" }, - "sparse" : { - "description" : "use sparse volumes", + "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" : "boolean" + "type" : "string", + "typetext" : "" }, - "format" : { + "disable" : { + "description" : "Flag to disable the storage.", "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "format" : { "description" : "Default image format.", "format" : "pve-storage-format", - "type" : "string" + "optional" : 1, + "type" : "string", + "typetext" : "" }, - "disable" : { + "is_mountpoint" : { + "default" : "no", + "description" : "Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.", + "optional" : 1, "type" : "boolean", - "description" : "Flag to disable the storage.", - "optional" : 1 + "typetext" : "" }, - "saferemove_throughput" : { - "type" : "string", - "description" : "Wipe throughput (cstream -t parameter value).", - "optional" : 1 + "krbd" : { + "description" : "Access rbd through krbd kernel module.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, - "saferemove" : { - "description" : "Zero-out data when removing LVs.", + "maxfiles" : { + "description" : "Maximal number of backup files per VM. Use '0' for unlimted.", + "minimum" : 0, "optional" : 1, - "type" : "boolean" + "type" : "integer", + "typetext" : " (0 - N)" }, - "digest" : { - "maxLength" : 40, + "mkdir" : { + "default" : "yes", + "description" : "Create the directory if it doesn't exist.", "optional" : 1, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", - "type" : "string" + "type" : "boolean", + "typetext" : "" }, "nodes" : { - "type" : "string", + "description" : "List of cluster node names.", "format" : "pve-node-list", "optional" : 1, - "description" : "List of cluster node names." + "type" : "string", + "typetext" : "" }, - "pool" : { - "description" : "Pool.", + "nowritecache" : { + "description" : "disable write caching on the target", "optional" : 1, - "type" : "string" + "type" : "boolean", + "typetext" : "" }, - "comstar_tg" : { + "options" : { + "description" : "NFS mount options (see 'man nfs')", + "format" : "pve-storage-options", + "optional" : 1, "type" : "string", - "description" : "target group for comstar views", - "optional" : 1 + "typetext" : "" }, - "nowritecache" : { - "description" : "disable write caching on the target", + "pool" : { + "description" : "Pool.", "optional" : 1, - "type" : "boolean" + "type" : "string", + "typetext" : "" }, "redundancy" : { - "type" : "integer", - "maximum" : 16, "default" : 2, - "minimum" : 1, "description" : "The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.", - "optional" : 1 - }, - "transport" : { - "enum" : [ - "tcp", - "rdma", - "unix" - ], + "maximum" : 16, + "minimum" : 1, "optional" : 1, - "description" : "Gluster transport: tcp or rdma", - "type" : "string" + "type" : "integer", + "typetext" : " (1 - 16)" }, - "shared" : { + "saferemove" : { + "description" : "Zero-out data when removing LVs.", "optional" : 1, - "description" : "Mark storage as shared.", - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, - "blocksize" : { - "description" : "block size", + "saferemove_throughput" : { + "description" : "Wipe throughput (cstream -t parameter value).", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, - "storage" : { - "description" : "The storage identifier.", + "server" : { + "description" : "Server IP or DNS name.", + "format" : "pve-storage-server", + "optional" : 1, "type" : "string", - "format" : "pve-storage-id" + "typetext" : "" }, "server2" : { + "description" : "Backup volfile server IP or DNS name.", "format" : "pve-storage-server", + "optional" : 1, "requires" : "server", "type" : "string", + "typetext" : "" + }, + "shared" : { + "description" : "Mark storage as shared.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "sparse" : { + "description" : "use sparse volumes", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "storage" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", + "type" : "string", + "typetext" : "" + }, + "tagged_only" : { + "description" : "Only use logical volumes tagged with 'pve-vm-ID'.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "transport" : { + "description" : "Gluster transport: tcp or rdma", + "enum" : [ + "tcp", + "rdma", + "unix" + ], + "optional" : 1, + "type" : "string" + }, + "username" : { + "description" : "RBD Id.", "optional" : 1, - "description" : "Backup volfile server IP or DNS name." + "type" : "string", + "typetext" : "" } - } + }, + "type" : "object" }, - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -21197,718 +23470,702 @@ var pveapi = [ ] ] }, - "description" : "Update storage configuration." + "protected" : 1, + "returns" : { + "type" : "null" + } } }, "leaf" : 1, + "path" : "/storage/{storage}", "text" : "{storage}" } ], "info" : { "GET" : { + "description" : "Storage index.", + "method" : "GET", + "name" : "index", "parameters" : { + "additionalProperties" : 0, "properties" : { "type" : { - "type" : "string", + "description" : "Only list storage of specific type", "enum" : [ - "rbd", - "sheepdog", - "lvm", - "iscsi", - "nfs", - "zfs", + "dir", + "drbd", "glusterfs", + "iscsi", "iscsidirect", + "lvm", "lvmthin", - "drbd", - "zfspool", - "dir" + "nfs", + "rbd", + "sheepdog", + "zfs", + "zfspool" ], - "description" : "Only list storage of specific type", - "optional" : 1 - } - }, - "additionalProperties" : 0 + "optional" : 1, + "type" : "string" + } + } + }, + "permissions" : { + "description" : "Only list entries where you have 'Datastore.Audit' or 'Datastore.AllocateSpace' permissions on '/storage/'", + "user" : "all" }, "returns" : { - "links" : [ - { - "href" : "{storage}", - "rel" : "child" - } - ], "items" : { - "type" : "object", "properties" : { "storage" : { "type" : "string" } - } + }, + "type" : "object" }, + "links" : [ + { + "href" : "{storage}", + "rel" : "child" + } + ], "type" : "array" - }, - "name" : "index", - "method" : "GET", - "description" : "Storage index.", - "permissions" : { - "description" : "Only list entries where you have 'Datastore.Audit' or 'Datastore.AllocateSpace' permissions on '/storage/'", - "user" : "all" } }, "POST" : { - "permissions" : { - "check" : [ - "perm", - "/storage", - [ - "Datastore.Allocate" - ] - ] - }, "description" : "Create a new storage.", - "protected" : 1, - "name" : "create", "method" : "POST", + "name" : "create", "parameters" : { - "type" : "object", + "additionalProperties" : 0, "properties" : { - "nowritecache" : { - "description" : "disable write caching on the target", + "authsupported" : { + "description" : "Authsupported.", "optional" : 1, - "type" : "boolean" - }, - "comstar_tg" : { "type" : "string", - "description" : "target group for comstar views", - "optional" : 1 + "typetext" : "" }, - "shared" : { + "base" : { + "description" : "Base volume. This volume is automatically activated.", + "format" : "pve-volume-id", "optional" : 1, - "description" : "Mark storage as shared.", - "type" : "boolean" + "type" : "string", + "typetext" : "" }, - "transport" : { - "description" : "Gluster transport: tcp or rdma", + "blocksize" : { + "description" : "block size", "optional" : 1, - "enum" : [ - "tcp", - "rdma", - "unix" - ], - "type" : "string" + "type" : "string", + "typetext" : "" }, - "redundancy" : { - "minimum" : 1, - "type" : "integer", - "maximum" : 16, - "default" : 2, + "comstar_hg" : { + "description" : "host group for comstar views", "optional" : 1, - "description" : "The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster." - }, - "storage" : { - "description" : "The storage identifier.", "type" : "string", - "format" : "pve-storage-id" + "typetext" : "" }, - "saferemove" : { - "description" : "Zero-out data when removing LVs.", + "comstar_tg" : { + "description" : "target group for comstar views", "optional" : 1, - "type" : "boolean" + "type" : "string", + "typetext" : "" }, - "nodes" : { + "content" : { + "description" : "Allowed content types.\n\nNOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.\n", + "format" : "pve-storage-content-list", + "optional" : 1, "type" : "string", - "format" : "pve-node-list", - "description" : "List of cluster node names.", - "optional" : 1 + "typetext" : "" }, - "sparse" : { - "description" : "use sparse volumes", + "disable" : { + "description" : "Flag to disable the storage.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, - "saferemove_throughput" : { - "description" : "Wipe throughput (cstream -t parameter value).", + "export" : { + "description" : "NFS export path.", + "format" : "pve-storage-path", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "format" : { - "type" : "string", - "format" : "pve-storage-format", "description" : "Default image format.", - "optional" : 1 - }, - "content" : { + "format" : "pve-storage-format", "optional" : 1, - "description" : "Allowed content types.\n\nNOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.\n", - "format" : "pve-storage-content-list", - "type" : "string" - }, - "portal" : { "type" : "string", - "format" : "pve-storage-portal-dns", + "typetext" : "" + }, + "is_mountpoint" : { + "default" : "no", + "description" : "Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.", "optional" : 1, - "description" : "iSCSI portal (IP or DNS name with optional port)." + "type" : "boolean", + "typetext" : "" }, - "server" : { - "description" : "Server IP or DNS name.", + "iscsiprovider" : { + "description" : "iscsi provider", "optional" : 1, - "format" : "pve-storage-server", - "type" : "string" + "type" : "string", + "typetext" : "" }, "krbd" : { + "description" : "Access rbd through krbd kernel module.", + "optional" : 1, "type" : "boolean", + "typetext" : "" + }, + "maxfiles" : { + "description" : "Maximal number of backup files per VM. Use '0' for unlimted.", + "minimum" : 0, "optional" : 1, - "description" : "Access rbd through krbd kernel module." + "type" : "integer", + "typetext" : " (0 - N)" }, - "monhost" : { + "mkdir" : { + "default" : "yes", + "description" : "Create the directory if it doesn't exist.", "optional" : 1, - "description" : "Monitors daemon ips.", - "type" : "string" + "type" : "boolean", + "typetext" : "" }, - "server2" : { - "format" : "pve-storage-server", - "requires" : "server", + "monhost" : { + "description" : "Monitors daemon ips.", + "format" : "pve-storage-portal-dns-list", + "optional" : 1, "type" : "string", - "description" : "Backup volfile server IP or DNS name.", - "optional" : 1 + "typetext" : "" }, - "blocksize" : { + "nodes" : { + "description" : "List of cluster node names.", + "format" : "pve-node-list", "optional" : 1, - "description" : "block size", - "type" : "string" + "type" : "string", + "typetext" : "" }, - "type" : { - "description" : "Storage type.", - "enum" : [ - "rbd", - "sheepdog", - "lvm", - "iscsi", - "nfs", - "zfs", - "glusterfs", - "iscsidirect", - "lvmthin", - "drbd", - "zfspool", - "dir" - ], - "type" : "string" + "nowritecache" : { + "description" : "disable write caching on the target", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, - "vgname" : { - "description" : "Volume group name.", + "options" : { + "description" : "NFS mount options (see 'man nfs')", + "format" : "pve-storage-options", "optional" : 1, "type" : "string", - "format" : "pve-storage-vgname" + "typetext" : "" }, - "iscsiprovider" : { - "description" : "iscsi provider", + "path" : { + "description" : "File system path.", + "format" : "pve-storage-path", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "pool" : { + "description" : "Pool.", + "optional" : 1, "type" : "string", + "typetext" : "" + }, + "portal" : { + "description" : "iSCSI portal (IP or DNS name with optional port).", + "format" : "pve-storage-portal-dns", "optional" : 1, - "description" : "Pool." + "type" : "string", + "typetext" : "" }, - "path" : { - "description" : "File system path.", + "redundancy" : { + "default" : 2, + "description" : "The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.", + "maximum" : 16, + "minimum" : 1, "optional" : 1, - "format" : "pve-storage-path", - "type" : "string" + "type" : "integer", + "typetext" : " (1 - 16)" }, - "export" : { - "description" : "NFS export path.", + "saferemove" : { + "description" : "Zero-out data when removing LVs.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "saferemove_throughput" : { + "description" : "Wipe throughput (cstream -t parameter value).", "optional" : 1, "type" : "string", - "format" : "pve-storage-path" + "typetext" : "" }, - "disable" : { - "description" : "Flag to disable the storage.", + "server" : { + "description" : "Server IP or DNS name.", + "format" : "pve-storage-server", "optional" : 1, - "type" : "boolean" + "type" : "string", + "typetext" : "" }, - "base" : { + "server2" : { + "description" : "Backup volfile server IP or DNS name.", + "format" : "pve-storage-server", + "optional" : 1, + "requires" : "server", "type" : "string", - "format" : "pve-volume-id", - "description" : "Base volume. This volume is automatically activated.", - "optional" : 1 + "typetext" : "" }, - "volume" : { + "shared" : { + "description" : "Mark storage as shared.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "sparse" : { + "description" : "use sparse volumes", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "storage" : { + "description" : "The storage identifier.", + "format" : "pve-storage-id", "type" : "string", + "typetext" : "" + }, + "tagged_only" : { + "description" : "Only use logical volumes tagged with 'pve-vm-ID'.", "optional" : 1, - "description" : "Glusterfs Volume." + "type" : "boolean", + "typetext" : "" }, "target" : { + "description" : "iSCSI target.", + "optional" : 1, "type" : "string", + "typetext" : "" + }, + "thinpool" : { + "description" : "LVM thin pool LV name.", + "format" : "pve-storage-vgname", "optional" : 1, - "description" : "iSCSI target." + "type" : "string", + "typetext" : "" }, - "maxfiles" : { + "transport" : { + "description" : "Gluster transport: tcp or rdma", + "enum" : [ + "tcp", + "rdma", + "unix" + ], "optional" : 1, - "description" : "Maximal number of backup files per VM. Use '0' for unlimted.", - "minimum" : 0, - "type" : "integer" + "type" : "string" + }, + "type" : { + "description" : "Storage type.", + "enum" : [ + "dir", + "drbd", + "glusterfs", + "iscsi", + "iscsidirect", + "lvm", + "lvmthin", + "nfs", + "rbd", + "sheepdog", + "zfs", + "zfspool" + ], + "type" : "string" }, - "authsupported" : { - "type" : "string", + "username" : { + "description" : "RBD Id.", "optional" : 1, - "description" : "Authsupported." - }, - "thinpool" : { "type" : "string", - "format" : "pve-storage-vgname", - "optional" : 1, - "description" : "LVM thin pool LV name." + "typetext" : "" }, - "options" : { - "description" : "NFS mount options (see 'man nfs')", + "vgname" : { + "description" : "Volume group name.", + "format" : "pve-storage-vgname", "optional" : 1, - "format" : "pve-storage-options", - "type" : "string" + "type" : "string", + "typetext" : "" }, - "username" : { - "description" : "RBD Id.", + "volume" : { + "description" : "Glusterfs Volume.", "optional" : 1, - "type" : "string" - }, - "comstar_hg" : { "type" : "string", - "description" : "host group for comstar views", - "optional" : 1 + "typetext" : "" } }, - "additionalProperties" : 0 + "type" : "object" + }, + "permissions" : { + "check" : [ + "perm", + "/storage", + [ + "Datastore.Allocate" + ] + ] }, + "protected" : 1, "returns" : { "type" : "null" } } - } + }, + "leaf" : 0, + "path" : "/storage", + "text" : "storage" }, { - "text" : "access", - "leaf" : 0, - "info" : { - "GET" : { - "returns" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "subdir" : { - "type" : "string" - } - } - }, - "links" : [ - { - "rel" : "child", - "href" : "{subdir}" - } - ] - }, - "parameters" : { - "additionalProperties" : 0 - }, - "method" : "GET", - "name" : "index", - "description" : "Directory index.", - "permissions" : { - "user" : "all" - } - } - }, - "path" : "/access", "children" : [ { - "leaf" : 0, - "text" : "users", - "info" : { - "POST" : { - "name" : "create_user", - "method" : "POST", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "keys" : { - "type" : "string", - "optional" : 1, - "description" : "Keys for two factor auth (yubico)." - }, - "lastname" : { - "type" : "string", - "optional" : 1 - }, - "firstname" : { - "optional" : 1, - "type" : "string" - }, - "comment" : { - "optional" : 1, - "type" : "string" - }, - "userid" : { - "type" : "string", - "format" : "pve-userid", - "maxLength" : 64, - "description" : "User ID" - }, - "email" : { - "optional" : 1, - "type" : "string", - "format" : "email-opt" - }, - "password" : { - "minLength" : 5, - "maxLength" : 64, - "optional" : 1, - "description" : "Initial password.", - "type" : "string" - }, - "enable" : { - "default" : 1, - "type" : "boolean", - "description" : "Enable the account (default). You can set this to '0' to disable the accout", - "optional" : 1 - }, - "expire" : { - "minimum" : 0, - "type" : "integer", - "optional" : 1, - "description" : "Account expiration date (seconds since epoch). '0' means no expiration date." - }, - "groups" : { - "type" : "string", - "format" : "pve-groupid-list", - "optional" : 1 - } - } - }, - "returns" : { - "type" : "null" - }, - "description" : "Create new user.", - "permissions" : { - "check" : [ - "and", - [ - "userid-param", - "Realm.AllocateUser" - ], - [ - "userid-group", - [ - "User.Modify" - ], - "groups_param", - 1 - ] - ], - "description" : "You need 'Realm.AllocateUser' on '/access/realm/' on the realm of user , and 'User.Modify' permissions to '/access/groups/' for any group specified (or 'User.Modify' on '/access/groups' if you pass no groups." - }, - "protected" : 1 - }, - "GET" : { - "returns" : { - "links" : [ - { - "href" : "{userid}", - "rel" : "child" - } - ], - "items" : { - "type" : "object", - "properties" : { - "userid" : { - "type" : "string" - } - } - }, - "type" : "array" - }, - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "enabled" : { - "type" : "boolean", - "optional" : 1, - "description" : "Optional filter for enable property." - } - } - }, - "method" : "GET", - "name" : "index", - "description" : "User index.", - "permissions" : { - "user" : "all", - "description" : "The returned list is restricted to users where you have 'User.Modify' or 'Sys.Audit' permissions on '/access/groups' or on a group the user belongs too. But it always includes the current (authenticated) user." - } - } - }, - "path" : "/access/users", "children" : [ { - "text" : "{userid}", - "leaf" : 1, "info" : { - "PUT" : { - "name" : "update_user", - "method" : "PUT", - "returns" : { - "type" : "null" - }, + "DELETE" : { + "description" : "Delete user.", + "method" : "DELETE", + "name" : "delete_user", "parameters" : { + "additionalProperties" : 0, "properties" : { - "expire" : { - "optional" : 1, - "description" : "Account expiration date (seconds since epoch). '0' means no expiration date.", - "minimum" : 0, - "type" : "integer" - }, - "enable" : { - "type" : "boolean", - "description" : "Enable/disable the account.", - "optional" : 1 - }, - "groups" : { - "type" : "string", - "format" : "pve-groupid-list", - "optional" : 1 - }, - "append" : { - "type" : "boolean", - "requires" : "groups", - "optional" : 1 - }, "userid" : { - "maxLength" : 64, "description" : "User ID", "format" : "pve-userid", - "type" : "string" - }, - "comment" : { - "type" : "string", - "optional" : 1 - }, - "firstname" : { + "maxLength" : 64, "type" : "string", - "optional" : 1 - }, - "keys" : { - "description" : "Keys for two factor auth (yubico).", - "optional" : 1, - "type" : "string" - }, - "lastname" : { - "optional" : 1, - "type" : "string" - }, - "email" : { - "optional" : 1, - "format" : "email-opt", - "type" : "string" + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, - "protected" : 1, - "description" : "Update user configuration.", "permissions" : { "check" : [ - "userid-group", + "and", [ - "User.Modify" + "userid-param", + "Realm.AllocateUser" ], - "groups_param", - 1 + [ + "userid-group", + [ + "User.Modify" + ] + ] ] - } - }, - "DELETE" : { - "method" : "DELETE", - "name" : "delete_user", + }, + "protected" : 1, "returns" : { "type" : "null" - }, + } + }, + "GET" : { + "description" : "Get user configuration.", + "method" : "GET", + "name" : "read_user", "parameters" : { "additionalProperties" : 0, "properties" : { "userid" : { + "description" : "User ID", "format" : "pve-userid", - "type" : "string", "maxLength" : 64, - "description" : "User ID" + "type" : "string", + "typetext" : "" } } }, - "protected" : 1, "permissions" : { "check" : [ - "and", - [ - "userid-param", - "Realm.AllocateUser" - ], + "userid-group", [ - "userid-group", - [ - "User.Modify" - ] + "User.Modify", + "Sys.Audit" ] ] }, - "description" : "Delete user." - }, - "GET" : { "returns" : { + "additionalProperties" : 0, "properties" : { - "email" : { + "comment" : { "optional" : 1, "type" : "string" }, - "comment" : { + "email" : { "optional" : 1, "type" : "string" }, + "enable" : { + "type" : "boolean" + }, + "expire" : { + "optional" : 1, + "type" : "integer" + }, "firstname" : { "optional" : 1, "type" : "string" }, + "groups" : { + "type" : "array" + }, "keys" : { - "type" : "string", - "optional" : 1 + "optional" : 1, + "type" : "string" }, "lastname" : { "optional" : 1, "type" : "string" + } + } + } + }, + "PUT" : { + "description" : "Update user configuration.", + "method" : "PUT", + "name" : "update_user", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "append" : { + "optional" : 1, + "requires" : "groups", + "type" : "boolean", + "typetext" : "" }, - "groups" : { - "type" : "array" + "comment" : { + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "email" : { + "format" : "email-opt", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "enable" : { + "description" : "Enable/disable the account.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, "expire" : { + "description" : "Account expiration date (seconds since epoch). '0' means no expiration date.", + "minimum" : 0, + "optional" : 1, "type" : "integer", - "optional" : 1 + "typetext" : " (0 - N)" + }, + "firstname" : { + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "groups" : { + "format" : "pve-groupid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "keys" : { + "description" : "Keys for two factor auth (yubico).", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "lastname" : { + "optional" : 1, + "type" : "string", + "typetext" : "" }, - "enable" : { - "type" : "boolean" - } - }, - "additionalProperties" : 0 - }, - "parameters" : { - "properties" : { "userid" : { - "maxLength" : 64, "description" : "User ID", "format" : "pve-userid", - "type" : "string" + "maxLength" : 64, + "type" : "string", + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, - "method" : "GET", - "name" : "read_user", "permissions" : { "check" : [ "userid-group", [ - "User.Modify", - "Sys.Audit" - ] + "User.Modify" + ], + "groups_param", + 1 ] }, - "description" : "Get user configuration." + "protected" : 1, + "returns" : { + "type" : "null" + } } }, - "path" : "/access/users/{userid}" + "leaf" : 1, + "path" : "/access/users/{userid}", + "text" : "{userid}" } - ] - }, - { + ], "info" : { - "POST" : { - "name" : "create_group", - "method" : "POST", + "GET" : { + "description" : "User index.", + "method" : "GET", + "name" : "index", "parameters" : { + "additionalProperties" : 0, "properties" : { - "comment" : { - "type" : "string", - "optional" : 1 - }, - "groupid" : { - "type" : "string", - "format" : "pve-groupid" + "enabled" : { + "description" : "Optional filter for enable property.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" } - }, - "additionalProperties" : 0 - }, - "returns" : { - "type" : "null" + } }, "permissions" : { - "check" : [ - "perm", - "/access/groups", - [ - "Group.Allocate" - ] - ] - }, - "description" : "Create new group.", - "protected" : 1 - }, - "GET" : { - "name" : "index", - "method" : "GET", - "parameters" : { - "additionalProperties" : 0 + "description" : "The returned list is restricted to users where you have 'User.Modify' or 'Sys.Audit' permissions on '/access/groups' or on a group the user belongs too. But it always includes the current (authenticated) user.", + "user" : "all" }, "returns" : { "items" : { - "type" : "object", "properties" : { - "groupid" : { + "userid" : { "type" : "string" } - } + }, + "type" : "object" }, - "type" : "array", "links" : [ { - "href" : "{groupid}", + "href" : "{userid}", "rel" : "child" } - ] + ], + "type" : "array" + } + }, + "POST" : { + "description" : "Create new user.", + "method" : "POST", + "name" : "create_user", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "comment" : { + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "email" : { + "format" : "email-opt", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "enable" : { + "default" : 1, + "description" : "Enable the account (default). You can set this to '0' to disable the accout", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "expire" : { + "description" : "Account expiration date (seconds since epoch). '0' means no expiration date.", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "firstname" : { + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "groups" : { + "format" : "pve-groupid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "keys" : { + "description" : "Keys for two factor auth (yubico).", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "lastname" : { + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "password" : { + "description" : "Initial password.", + "maxLength" : 64, + "minLength" : 5, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "userid" : { + "description" : "User ID", + "format" : "pve-userid", + "maxLength" : 64, + "type" : "string", + "typetext" : "" + } + } }, "permissions" : { - "description" : "The returned list is restricted to groups where you have 'User.Modify', 'Sys.Audit' or 'Group.Allocate' permissions on /access/groups/.", - "user" : "all" + "check" : [ + "and", + [ + "userid-param", + "Realm.AllocateUser" + ], + [ + "userid-group", + [ + "User.Modify" + ], + "groups_param", + 1 + ] + ], + "description" : "You need 'Realm.AllocateUser' on '/access/realm/' on the realm of user , and 'User.Modify' permissions to '/access/groups/' for any group specified (or 'User.Modify' on '/access/groups' if you pass no groups." }, - "description" : "Group index." + "protected" : 1, + "returns" : { + "type" : "null" + } } }, + "leaf" : 0, + "path" : "/access/users", + "text" : "users" + }, + { "children" : [ { - "text" : "{groupid}", - "leaf" : 1, "info" : { "DELETE" : { - "returns" : { - "type" : "null" - }, + "description" : "Delete group.", + "method" : "DELETE", + "name" : "delete_group", "parameters" : { + "additionalProperties" : 0, "properties" : { "groupid" : { "format" : "pve-groupid", - "type" : "string" + "type" : "string", + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, - "name" : "delete_group", - "method" : "DELETE", - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -21918,37 +24175,25 @@ var pveapi = [ ] ] }, - "description" : "Delete group." + "protected" : 1, + "returns" : { + "type" : "null" + } }, "GET" : { - "returns" : { - "properties" : { - "members" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "comment" : { - "type" : "string", - "optional" : 1 - } - }, - "additionalProperties" : 0, - "type" : "object" - }, + "description" : "Get group configuration.", + "method" : "GET", + "name" : "read_group", "parameters" : { "additionalProperties" : 0, "properties" : { "groupid" : { + "format" : "pve-groupid", "type" : "string", - "format" : "pve-groupid" + "typetext" : "" } } }, - "name" : "read_group", - "method" : "GET", - "description" : "Get group configuration.", "permissions" : { "check" : [ "perm", @@ -21960,29 +24205,43 @@ var pveapi = [ "any", 1 ] + }, + "returns" : { + "additionalProperties" : 0, + "properties" : { + "comment" : { + "optional" : 1, + "type" : "string" + }, + "members" : { + "items" : { + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" } }, "PUT" : { - "name" : "update_group", + "description" : "Update group data.", "method" : "PUT", - "returns" : { - "type" : "null" - }, + "name" : "update_group", "parameters" : { "additionalProperties" : 0, "properties" : { "comment" : { + "optional" : 1, "type" : "string", - "optional" : 1 + "typetext" : "" }, "groupid" : { "format" : "pve-groupid", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, - "protected" : 1, - "description" : "Update group data.", "permissions" : { "check" : [ "perm", @@ -21991,141 +24250,104 @@ var pveapi = [ "Group.Allocate" ] ] + }, + "protected" : 1, + "returns" : { + "type" : "null" } } }, - "path" : "/access/groups/{groupid}" + "leaf" : 1, + "path" : "/access/groups/{groupid}", + "text" : "{groupid}" } ], - "path" : "/access/groups", - "leaf" : 0, - "text" : "groups" - }, - { "info" : { + "GET" : { + "description" : "Group index.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "description" : "The returned list is restricted to groups where you have 'User.Modify', 'Sys.Audit' or 'Group.Allocate' permissions on /access/groups/.", + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : { + "groupid" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{groupid}", + "rel" : "child" + } + ], + "type" : "array" + } + }, "POST" : { - "name" : "create_role", + "description" : "Create new group.", "method" : "POST", + "name" : "create_group", "parameters" : { + "additionalProperties" : 0, "properties" : { - "roleid" : { + "comment" : { + "optional" : 1, "type" : "string", - "format" : "pve-roleid" + "typetext" : "" }, - "privs" : { + "groupid" : { + "format" : "pve-groupid", "type" : "string", - "format" : "pve-priv-list", - "optional" : 1 + "typetext" : "" } - }, - "additionalProperties" : 0 - }, - "returns" : { - "type" : "null" + } }, "permissions" : { "check" : [ "perm", - "/access", + "/access/groups", [ - "Sys.Modify" + "Group.Allocate" ] ] }, - "description" : "Create new role.", - "protected" : 1 - }, - "GET" : { - "method" : "GET", - "name" : "index", + "protected" : 1, "returns" : { - "links" : [ - { - "rel" : "child", - "href" : "{roleid}" - } - ], - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "roleid" : { - "type" : "string" - } - } - } - }, - "parameters" : { - "additionalProperties" : 0 - }, - "permissions" : { - "user" : "all" - }, - "description" : "Role index." + "type" : "null" + } } }, + "leaf" : 0, + "path" : "/access/groups", + "text" : "groups" + }, + { "children" : [ { - "leaf" : 1, - "text" : "{roleid}", - "path" : "/access/roles/{roleid}", "info" : { - "PUT" : { - "permissions" : { - "check" : [ - "perm", - "/access", - [ - "Sys.Modify" - ] - ] - }, - "description" : "Create new role.", - "protected" : 1, - "name" : "update_role", - "method" : "PUT", + "DELETE" : { + "description" : "Delete role.", + "method" : "DELETE", + "name" : "delete_role", "parameters" : { "additionalProperties" : 0, "properties" : { - "privs" : { - "format" : "pve-priv-list", - "type" : "string" - }, - "append" : { - "type" : "boolean", - "requires" : "privs", - "optional" : 1 - }, "roleid" : { "format" : "pve-roleid", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, - "returns" : { - "type" : "null" - } - }, - "GET" : { - "returns" : {}, - "parameters" : { - "properties" : { - "roleid" : { - "format" : "pve-roleid", - "type" : "string" - } - }, - "additionalProperties" : 0 - }, - "method" : "GET", - "name" : "read_role", - "description" : "Get role configuration.", - "permissions" : { - "user" : "all" - } - }, - "DELETE" : { - "protected" : 1, "permissions" : { "check" : [ "perm", @@ -22135,283 +24357,268 @@ var pveapi = [ ] ] }, - "description" : "Delete role.", + "protected" : 1, "returns" : { "type" : "null" - }, + } + }, + "GET" : { + "description" : "Get role configuration.", + "method" : "GET", + "name" : "read_role", "parameters" : { "additionalProperties" : 0, "properties" : { "roleid" : { + "format" : "pve-roleid", "type" : "string", - "format" : "pve-roleid" + "typetext" : "" } } }, - "method" : "DELETE", - "name" : "delete_role" - } - } - } - ], - "path" : "/access/roles", - "text" : "roles", - "leaf" : 0 - }, - { - "info" : { - "PUT" : { - "permissions" : { - "check" : [ - "perm-modify", - "{path}" - ] - }, - "description" : "Update Access Control List (add or remove permissions).", - "protected" : 1, - "method" : "PUT", - "name" : "update_acl", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "propagate" : { - "type" : "boolean", - "default" : 1, - "optional" : 1, - "description" : "Allow to propagate (inherit) permissions." - }, - "roles" : { - "type" : "string", - "format" : "pve-roleid-list", - "description" : "List of roles." - }, - "users" : { - "format" : "pve-userid-list", - "type" : "string", - "description" : "List of users.", - "optional" : 1 + "permissions" : { + "user" : "all" }, - "groups" : { - "optional" : 1, - "description" : "List of groups.", - "format" : "pve-groupid-list", - "type" : "string" + "returns" : {} + }, + "PUT" : { + "description" : "Create new role.", + "method" : "PUT", + "name" : "update_role", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "append" : { + "optional" : 1, + "requires" : "privs", + "type" : "boolean", + "typetext" : "" + }, + "privs" : { + "format" : "pve-priv-list", + "type" : "string", + "typetext" : "" + }, + "roleid" : { + "format" : "pve-roleid", + "type" : "string", + "typetext" : "" + } + } }, - "delete" : { - "type" : "boolean", - "description" : "Remove permissions (instead of adding it).", - "optional" : 1 + "permissions" : { + "check" : [ + "perm", + "/access", + [ + "Sys.Modify" + ] + ] }, - "path" : { - "type" : "string", - "description" : "Access control path" + "protected" : 1, + "returns" : { + "type" : "null" } } }, - "returns" : { - "type" : "null" - } - }, + "leaf" : 1, + "path" : "/access/roles/{roleid}", + "text" : "{roleid}" + } + ], + "info" : { "GET" : { + "description" : "Role index.", "method" : "GET", - "name" : "read_acl", + "name" : "index", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "user" : "all" + }, "returns" : { - "type" : "array", "items" : { "properties" : { - "propagate" : { - "type" : "boolean" - }, - "ugid" : { - "type" : "string" - }, - "path" : { - "type" : "string" - }, - "type" : { - "type" : "string", - "enum" : [ - "user", - "group" - ] - }, "roleid" : { "type" : "string" } }, - "additionalProperties" : 0, "type" : "object" - } - }, + }, + "links" : [ + { + "href" : "{roleid}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "description" : "Create new role.", + "method" : "POST", + "name" : "create_role", "parameters" : { - "additionalProperties" : 0 + "additionalProperties" : 0, + "properties" : { + "privs" : { + "format" : "pve-priv-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "roleid" : { + "format" : "pve-roleid", + "type" : "string", + "typetext" : "" + } + } }, - "description" : "Get Access Control List (ACLs).", "permissions" : { - "user" : "all", - "description" : "The returned list is restricted to objects where you have rights to modify permissions." + "check" : [ + "perm", + "/access", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" } } }, - "path" : "/access/acl", - "text" : "acl", - "leaf" : 1 + "leaf" : 0, + "path" : "/access/roles", + "text" : "roles" }, { "info" : { "GET" : { - "permissions" : { - "user" : "world", - "description" : "Anyone can access that, because we need that list for the login box (before the user is authenticated)." - }, - "description" : "Authentication domain index.", + "description" : "Get Access Control List (ACLs).", "method" : "GET", - "name" : "index", + "name" : "read_acl", "parameters" : { "additionalProperties" : 0 }, + "permissions" : { + "description" : "The returned list is restricted to objects where you have rights to modify permissions.", + "user" : "all" + }, "returns" : { - "links" : [ - { - "rel" : "child", - "href" : "{realm}" - } - ], - "type" : "array", "items" : { + "additionalProperties" : 0, "properties" : { - "realm" : { + "path" : { "type" : "string" }, - "tfa" : { + "propagate" : { + "type" : "boolean" + }, + "roleid" : { + "type" : "string" + }, + "type" : { "enum" : [ - "yubico", - "oath" + "user", + "group" ], - "description" : "Two-factor authentication provider.", - "optional" : 1, "type" : "string" }, - "comment" : { - "type" : "string", - "optional" : 1 + "ugid" : { + "type" : "string" } }, "type" : "object" - } + }, + "type" : "array" } }, - "POST" : { - "description" : "Add an authentication server.", - "permissions" : { - "check" : [ - "perm", - "/access/realm", - [ - "Realm.Allocate" - ] - ] - }, - "protected" : 1, + "PUT" : { + "description" : "Update Access Control List (add or remove permissions).", + "method" : "PUT", + "name" : "update_acl", "parameters" : { + "additionalProperties" : 0, "properties" : { - "server1" : { - "format" : "address", - "type" : "string", - "description" : "Server IP address (or DNS name)", + "delete" : { + "description" : "Remove permissions (instead of adding it).", "optional" : 1, - "maxLength" : 256 - }, - "default" : { "type" : "boolean", - "optional" : 1, - "description" : "Use this as default realm" + "typetext" : "" }, - "realm" : { + "groups" : { + "description" : "List of groups.", + "format" : "pve-groupid-list", + "optional" : 1, "type" : "string", - "format" : "pve-realm", - "description" : "Authentication domain ID", - "maxLength" : 32 + "typetext" : "" }, - "base_dn" : { + "path" : { + "description" : "Access control path", "type" : "string", - "pattern" : "\\w+=[^,]+(,\\s*\\w+=[^,]+)*", - "maxLength" : 256, - "description" : "LDAP base domain name", - "optional" : 1 + "typetext" : "" }, - "tfa" : { - "format" : "pve-tfa-config", - "type" : "string", - "maxLength" : 128, + "propagate" : { + "default" : 1, + "description" : "Allow to propagate (inherit) permissions.", "optional" : 1, - "description" : "Use Two-factor authentication." + "type" : "boolean", + "typetext" : "" }, - "server2" : { - "format" : "address", + "roles" : { + "description" : "List of roles.", + "format" : "pve-roleid-list", "type" : "string", - "description" : "Fallback Server IP address (or DNS name)", - "maxLength" : 256, - "optional" : 1 + "typetext" : "" }, - "domain" : { - "pattern" : "\\S+", + "users" : { + "description" : "List of users.", + "format" : "pve-userid-list", "optional" : 1, - "description" : "AD domain name", - "maxLength" : 256, - "type" : "string" - }, - "type" : { - "type" : "string", - "description" : "Realm type.", - "enum" : [ - "ldap", - "pve", - "ad", - "pam" - ] - }, - "user_attr" : { - "type" : "string", - "pattern" : "\\S{2,}", - "description" : "LDAP user attribute name", - "maxLength" : 256, - "optional" : 1 - }, - "port" : { - "minimum" : 1, - "type" : "integer", - "maximum" : 65535, - "description" : "Server port.", - "optional" : 1 - }, - "comment" : { "type" : "string", - "description" : "Description.", - "maxLength" : 4096, - "optional" : 1 - }, - "secure" : { - "optional" : 1, - "description" : "Use secure LDAPS protocol.", - "type" : "boolean" + "typetext" : "" } - }, - "additionalProperties" : 0, - "type" : "object" + } + }, + "permissions" : { + "check" : [ + "perm-modify", + "{path}" + ] }, + "protected" : 1, "returns" : { "type" : "null" - }, - "name" : "create", - "method" : "POST" + } } }, + "leaf" : 1, + "path" : "/access/acl", + "text" : "acl" + }, + { "children" : [ { - "path" : "/access/domains/{realm}", "info" : { - "PUT" : { + "DELETE" : { + "description" : "Delete an authentication server.", + "method" : "DELETE", + "name" : "delete", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "realm" : { + "description" : "Authentication domain ID", + "format" : "pve-realm", + "maxLength" : 32, + "type" : "string", + "typetext" : "" + } + } + }, "permissions" : { "check" : [ "perm", @@ -22421,268 +24628,460 @@ var pveapi = [ ] ] }, - "description" : "Update authentication server settings.", "protected" : 1, + "returns" : { + "type" : "null" + } + }, + "GET" : { + "description" : "Get auth server configuration.", + "method" : "GET", + "name" : "read", "parameters" : { "additionalProperties" : 0, "properties" : { - "comment" : { + "realm" : { + "description" : "Authentication domain ID", + "format" : "pve-realm", + "maxLength" : 32, "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/access/realm", + [ + "Realm.Allocate", + "Sys.Audit" + ], + "any", + 1 + ] + }, + "returns" : {} + }, + "PUT" : { + "description" : "Update authentication server settings.", + "method" : "PUT", + "name" : "update", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "base_dn" : { + "description" : "LDAP base domain name", + "maxLength" : 256, + "optional" : 1, + "pattern" : "\\w+=[^,]+(,\\s*\\w+=[^,]+)*", + "type" : "string" + }, + "bind_dn" : { + "description" : "LDAP bind domain name", + "maxLength" : 256, + "optional" : 1, + "pattern" : "\\w+=[^,]+(,\\s*\\w+=[^,]+)*", + "type" : "string" + }, + "comment" : { "description" : "Description.", "maxLength" : 4096, - "optional" : 1 + "optional" : 1, + "type" : "string", + "typetext" : "" }, - "secure" : { - "type" : "boolean", + "default" : { + "description" : "Use this as default realm", "optional" : 1, - "description" : "Use secure LDAPS protocol." + "type" : "boolean", + "typetext" : "" }, - "user_attr" : { - "type" : "string", - "pattern" : "\\S{2,}", + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", + "maxLength" : 4096, "optional" : 1, - "description" : "LDAP user attribute name", - "maxLength" : 256 + "type" : "string", + "typetext" : "" }, - "port" : { - "description" : "Server port.", + "digest" : { + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", + "maxLength" : 40, "optional" : 1, - "minimum" : 1, - "maximum" : 65535, - "type" : "integer" + "type" : "string", + "typetext" : "" }, "domain" : { - "type" : "string", - "pattern" : "\\S+", - "optional" : 1, "description" : "AD domain name", - "maxLength" : 256 - }, - "server2" : { - "type" : "string", - "format" : "address", - "optional" : 1, "maxLength" : 256, - "description" : "Fallback Server IP address (or DNS name)" + "optional" : 1, + "pattern" : "\\S+", + "type" : "string" }, - "digest" : { - "type" : "string", + "port" : { + "description" : "Server port.", + "maximum" : 65535, + "minimum" : 1, "optional" : 1, - "maxLength" : 40, - "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." + "type" : "integer", + "typetext" : " (1 - 65535)" }, "realm" : { - "maxLength" : 32, "description" : "Authentication domain ID", "format" : "pve-realm", - "type" : "string" + "maxLength" : 32, + "type" : "string", + "typetext" : "" }, - "default" : { + "secure" : { + "description" : "Use secure LDAPS protocol.", + "optional" : 1, "type" : "boolean", + "typetext" : "" + }, + "server1" : { + "description" : "Server IP address (or DNS name)", + "format" : "address", + "maxLength" : 256, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "server2" : { + "description" : "Fallback Server IP address (or DNS name)", + "format" : "address", + "maxLength" : 256, "optional" : 1, - "description" : "Use this as default realm" + "type" : "string", + "typetext" : "" }, "tfa" : { "description" : "Use Two-factor authentication.", + "format" : "pve-tfa-config", "maxLength" : 128, "optional" : 1, "type" : "string", - "format" : "pve-tfa-config" - }, - "base_dn" : { - "type" : "string", - "pattern" : "\\w+=[^,]+(,\\s*\\w+=[^,]+)*", - "optional" : 1, - "description" : "LDAP base domain name", - "maxLength" : 256 + "typetext" : "" }, - "delete" : { - "maxLength" : 4096, + "user_attr" : { + "description" : "LDAP user attribute name", + "maxLength" : 256, "optional" : 1, - "description" : "A list of settings you want to delete.", - "format" : "pve-configid-list", + "pattern" : "\\S{2,}", "type" : "string" - }, - "server1" : { - "format" : "address", - "type" : "string", - "description" : "Server IP address (or DNS name)", - "maxLength" : 256, - "optional" : 1 } }, "type" : "object" }, + "permissions" : { + "check" : [ + "perm", + "/access/realm", + [ + "Realm.Allocate" + ] + ] + }, + "protected" : 1, "returns" : { "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/access/domains/{realm}", + "text" : "{realm}" + } + ], + "info" : { + "GET" : { + "description" : "Authentication domain index.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "description" : "Anyone can access that, because we need that list for the login box (before the user is authenticated).", + "user" : "world" + }, + "returns" : { + "items" : { + "properties" : { + "comment" : { + "optional" : 1, + "type" : "string" + }, + "realm" : { + "type" : "string" + }, + "tfa" : { + "description" : "Two-factor authentication provider.", + "enum" : [ + "yubico", + "oath" + ], + "optional" : 1, + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{realm}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "description" : "Add an authentication server.", + "method" : "POST", + "name" : "create", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "base_dn" : { + "description" : "LDAP base domain name", + "maxLength" : 256, + "optional" : 1, + "pattern" : "\\w+=[^,]+(,\\s*\\w+=[^,]+)*", + "type" : "string" + }, + "bind_dn" : { + "description" : "LDAP bind domain name", + "maxLength" : 256, + "optional" : 1, + "pattern" : "\\w+=[^,]+(,\\s*\\w+=[^,]+)*", + "type" : "string" + }, + "comment" : { + "description" : "Description.", + "maxLength" : 4096, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "default" : { + "description" : "Use this as default realm", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "domain" : { + "description" : "AD domain name", + "maxLength" : 256, + "optional" : 1, + "pattern" : "\\S+", + "type" : "string" + }, + "port" : { + "description" : "Server port.", + "maximum" : 65535, + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - 65535)" + }, + "realm" : { + "description" : "Authentication domain ID", + "format" : "pve-realm", + "maxLength" : 32, + "type" : "string", + "typetext" : "" }, - "method" : "PUT", - "name" : "update" - }, - "GET" : { - "description" : "Get auth server configuration.", - "permissions" : { - "check" : [ - "perm", - "/access/realm", - [ - "Realm.Allocate", - "Sys.Audit" - ], - "any", - 1 - ] + "secure" : { + "description" : "Use secure LDAPS protocol.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "realm" : { - "description" : "Authentication domain ID", - "maxLength" : 32, - "type" : "string", - "format" : "pve-realm" - } - } + "server1" : { + "description" : "Server IP address (or DNS name)", + "format" : "address", + "maxLength" : 256, + "optional" : 1, + "type" : "string", + "typetext" : "" }, - "returns" : {}, - "name" : "read", - "method" : "GET" - }, - "DELETE" : { - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "realm" : { - "maxLength" : 32, - "description" : "Authentication domain ID", - "type" : "string", - "format" : "pve-realm" - } - } + "server2" : { + "description" : "Fallback Server IP address (or DNS name)", + "format" : "address", + "maxLength" : 256, + "optional" : 1, + "type" : "string", + "typetext" : "" }, - "returns" : { - "type" : "null" + "tfa" : { + "description" : "Use Two-factor authentication.", + "format" : "pve-tfa-config", + "maxLength" : 128, + "optional" : 1, + "type" : "string", + "typetext" : "" }, - "method" : "DELETE", - "name" : "delete", - "description" : "Delete an authentication server.", - "permissions" : { - "check" : [ - "perm", - "/access/realm", - [ - "Realm.Allocate" - ] - ] + "type" : { + "description" : "Realm type.", + "enum" : [ + "ad", + "ldap", + "pam", + "pve" + ], + "type" : "string" }, - "protected" : 1 - } + "user_attr" : { + "description" : "LDAP user attribute name", + "maxLength" : 256, + "optional" : 1, + "pattern" : "\\S{2,}", + "type" : "string" + } + }, + "type" : "object" }, - "leaf" : 1, - "text" : "{realm}" + "permissions" : { + "check" : [ + "perm", + "/access/realm", + [ + "Realm.Allocate" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } } - ], - "path" : "/access/domains", + }, "leaf" : 0, + "path" : "/access/domains", "text" : "domains" }, { - "path" : "/access/ticket", "info" : { + "GET" : { + "description" : "Dummy. Useful for formaters which want to priovde a login page.", + "method" : "GET", + "name" : "get_ticket", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "user" : "world" + }, + "returns" : { + "type" : "null" + } + }, "POST" : { + "description" : "Create or verify authentication ticket.", "method" : "POST", "name" : "create_ticket", - "returns" : { - "properties" : { - "CSRFPreventionToken" : { - "optional" : 1, - "type" : "string" - }, - "ticket" : { - "type" : "string", - "optional" : 1 - }, - "username" : { - "type" : "string" - } - }, - "type" : "object" - }, "parameters" : { + "additionalProperties" : 0, "properties" : { "otp" : { "description" : "One-time password for Two-factor authentication.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" + }, + "password" : { + "description" : "The secret password. This can also be a valid ticket.", + "type" : "string", + "typetext" : "" }, "path" : { + "description" : "Verify ticket, and check if user have access 'privs' on 'path'", + "maxLength" : 64, + "optional" : 1, "requires" : "privs", "type" : "string", - "optional" : 1, - "maxLength" : 64, - "description" : "Verify ticket, and check if user have access 'privs' on 'path'" + "typetext" : "" }, - "password" : { - "description" : "The secret password. This can also be a valid ticket.", - "type" : "string" + "privs" : { + "description" : "Verify ticket, and check if user have access 'privs' on 'path'", + "format" : "pve-priv-list", + "maxLength" : 64, + "optional" : 1, + "requires" : "path", + "type" : "string", + "typetext" : "" }, "realm" : { - "optional" : 1, - "maxLength" : 32, "description" : "You can optionally pass the realm using this parameter. Normally the realm is simply added to the username @.", + "format" : "pve-realm", + "maxLength" : 32, + "optional" : 1, "type" : "string", - "format" : "pve-realm" + "typetext" : "" }, "username" : { "description" : "User name", "maxLength" : 64, - "type" : "string" - }, - "privs" : { - "format" : "pve-priv-list", "type" : "string", - "requires" : "path", - "description" : "Verify ticket, and check if user have access 'privs' on 'path'", - "optional" : 1, - "maxLength" : 64 + "typetext" : "" } - }, - "additionalProperties" : 0 + } }, - "protected" : 1, - "description" : "Create or verify authentication ticket.", - "permissions" : { - "user" : "world", - "description" : "You need to pass valid credientials." - } - }, - "GET" : { - "description" : "Dummy. Useful for formaters which want to priovde a login page.", "permissions" : { + "description" : "You need to pass valid credientials.", "user" : "world" }, - "method" : "GET", - "name" : "get_ticket", - "parameters" : { - "additionalProperties" : 0 - }, + "protected" : 1, "returns" : { - "type" : "null" + "properties" : { + "CSRFPreventionToken" : { + "optional" : 1, + "type" : "string" + }, + "ticket" : { + "optional" : 1, + "type" : "string" + }, + "username" : { + "type" : "string" + } + }, + "type" : "object" } } }, - "text" : "ticket", - "leaf" : 1 + "leaf" : 1, + "path" : "/access/ticket", + "text" : "ticket" }, { - "text" : "password", - "leaf" : 1, - "path" : "/access/password", "info" : { "PUT" : { - "protected" : 1, + "description" : "Change user password.", + "method" : "PUT", + "name" : "change_passsword", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "password" : { + "description" : "The new password.", + "maxLength" : 64, + "minLength" : 5, + "type" : "string", + "typetext" : "" + }, + "userid" : { + "description" : "User ID", + "format" : "pve-userid", + "maxLength" : 64, + "type" : "string", + "typetext" : "" + } + } + }, "permissions" : { - "description" : "Each user is allowed to change his own password. A user can change the password of another user if he has 'Realm.AllocateUser' (on the realm of user ) and 'User.Modify' permission on /access/groups/ on a group where user is member of.", "check" : [ "or", [ @@ -22702,64 +25101,130 @@ var pveapi = [ ] ] ] - ] - }, - "description" : "Change user password.", - "returns" : { - "type" : "null" - }, - "parameters" : { - "properties" : { - "password" : { - "type" : "string", - "maxLength" : 64, - "description" : "The new password.", - "minLength" : 5 - }, - "userid" : { - "description" : "User ID", - "maxLength" : 64, - "format" : "pve-userid", - "type" : "string" - } - }, - "additionalProperties" : 0 + ], + "description" : "Each user is allowed to change his own password. A user can change the password of another user if he has 'Realm.AllocateUser' (on the realm of user ) and 'User.Modify' permission on /access/groups/ on a group where user is member of." }, - "name" : "change_passsword", - "method" : "PUT" + "protected" : 1, + "returns" : { + "type" : "null" + } } + }, + "leaf" : 1, + "path" : "/access/password", + "text" : "password" + } + ], + "info" : { + "GET" : { + "description" : "Directory index.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : { + "subdir" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{subdir}", + "rel" : "child" + } + ], + "type" : "array" } } - ] + }, + "leaf" : 0, + "path" : "/access", + "text" : "access" }, { "children" : [ { - "path" : "/pools/{poolid}", "info" : { + "DELETE" : { + "description" : "Delete pool.", + "method" : "DELETE", + "name" : "delete_pool", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "poolid" : { + "format" : "pve-poolid", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/pool/{poolid}", + [ + "Pool.Allocate" + ] + ], + "description" : "You can only delete empty pools (no members)." + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + }, "GET" : { - "name" : "read_pool", + "description" : "Get pool configuration.", "method" : "GET", + "name" : "read_pool", "parameters" : { "additionalProperties" : 0, "properties" : { "poolid" : { + "format" : "pve-poolid", "type" : "string", - "format" : "pve-poolid" + "typetext" : "" } } }, + "permissions" : { + "check" : [ + "perm", + "/pool/{poolid}", + [ + "Pool.Allocate" + ] + ] + }, "returns" : { - "type" : "object", + "additionalProperties" : 0, "properties" : { + "comment" : { + "optional" : 1, + "type" : "string" + }, "members" : { "items" : { - "type" : "object", "additionalProperties" : 1, "properties" : { + "id" : { + "type" : "string" + }, + "node" : { + "type" : "string" + }, "storage" : { - "type" : "string", - "optional" : 1 + "optional" : 1, + "type" : "string" }, "type" : { "enum" : [ @@ -22771,132 +25236,91 @@ var pveapi = [ "type" : "string" }, "vmid" : { - "type" : "integer", - "optional" : 1 - }, - "node" : { - "type" : "string" - }, - "id" : { - "type" : "string" + "optional" : 1, + "type" : "integer" } - } + }, + "type" : "object" }, "type" : "array" - }, - "comment" : { - "type" : "string", - "optional" : 1 - } - }, - "additionalProperties" : 0 - }, - "permissions" : { - "check" : [ - "perm", - "/pool/{poolid}", - [ - "Pool.Allocate" - ] - ] - }, - "description" : "Get pool configuration." - }, - "DELETE" : { - "permissions" : { - "check" : [ - "perm", - "/pool/{poolid}", - [ - "Pool.Allocate" - ] - ], - "description" : "You can only delete empty pools (no members)." - }, - "description" : "Delete pool.", - "protected" : 1, - "parameters" : { - "properties" : { - "poolid" : { - "format" : "pve-poolid", - "type" : "string" } }, - "additionalProperties" : 0 - }, - "returns" : { - "type" : "null" - }, - "name" : "delete_pool", - "method" : "DELETE" + "type" : "object" + } }, "PUT" : { - "permissions" : { - "description" : "You also need the right to modify permissions on any object you add/delete.", - "check" : [ - "perm", - "/pool/{poolid}", - [ - "Pool.Allocate" - ] - ] - }, "description" : "Update pool data.", - "protected" : 1, + "method" : "PUT", + "name" : "update_pool", "parameters" : { + "additionalProperties" : 0, "properties" : { - "storage" : { - "format" : "pve-storage-id-list", + "comment" : { + "optional" : 1, "type" : "string", - "description" : "List of storage IDs.", - "optional" : 1 + "typetext" : "" }, "delete" : { + "description" : "Remove vms/storage (instead of adding it).", + "optional" : 1, "type" : "boolean", + "typetext" : "" + }, + "poolid" : { + "format" : "pve-poolid", + "type" : "string", + "typetext" : "" + }, + "storage" : { + "description" : "List of storage IDs.", + "format" : "pve-storage-id-list", "optional" : 1, - "description" : "Remove vms/storage (instead of adding it)." + "type" : "string", + "typetext" : "" }, "vms" : { "description" : "List of virtual machines.", - "optional" : 1, "format" : "pve-vmid-list", - "type" : "string" - }, - "comment" : { "optional" : 1, - "type" : "string" - }, - "poolid" : { - "format" : "pve-poolid", - "type" : "string" + "type" : "string", + "typetext" : "" } - }, - "additionalProperties" : 0 + } + }, + "permissions" : { + "check" : [ + "perm", + "/pool/{poolid}", + [ + "Pool.Allocate" + ] + ], + "description" : "You also need the right to modify permissions on any object you add/delete." }, + "protected" : 1, "returns" : { "type" : "null" - }, - "name" : "update_pool", - "method" : "PUT" + } } }, - "text" : "{poolid}", - "leaf" : 1 + "leaf" : 1, + "path" : "/pools/{poolid}", + "text" : "{poolid}" } ], - "path" : "/pools", "info" : { "GET" : { "description" : "Pool index.", - "permissions" : { - "user" : "all", - "description" : "List all pools where you have Pool.Allocate or VM.Allocate permissions on /pool/." - }, + "method" : "GET", + "name" : "index", "parameters" : { "additionalProperties" : 0 }, + "permissions" : { + "description" : "List all pools where you have Pool.Allocate or VM.Allocate permissions on /pool/.", + "user" : "all" + }, "returns" : { - "type" : "array", "items" : { "properties" : { "poolid" : { @@ -22910,32 +25334,29 @@ var pveapi = [ "href" : "{poolid}", "rel" : "child" } - ] - }, - "name" : "index", - "method" : "GET" + ], + "type" : "array" + } }, "POST" : { - "returns" : { - "type" : "null" - }, + "description" : "Create new pool.", + "method" : "POST", + "name" : "create_pool", "parameters" : { "additionalProperties" : 0, "properties" : { - "poolid" : { + "comment" : { + "optional" : 1, "type" : "string", - "format" : "pve-poolid" + "typetext" : "" }, - "comment" : { + "poolid" : { + "format" : "pve-poolid", "type" : "string", - "optional" : 1 + "typetext" : "" } } }, - "name" : "create_pool", - "method" : "POST", - "protected" : 1, - "description" : "Create new pool.", "permissions" : { "check" : [ "perm", @@ -22944,42 +25365,47 @@ var pveapi = [ "Pool.Allocate" ] ] + }, + "protected" : 1, + "returns" : { + "type" : "null" } } }, - "text" : "pools", - "leaf" : 0 + "leaf" : 0, + "path" : "/pools", + "text" : "pools" }, { - "path" : "/version", "info" : { "GET" : { + "description" : "API version details. The result also includes the global datacenter confguration.", + "method" : "GET", + "name" : "version", "parameters" : { "additionalProperties" : 0 }, + "permissions" : { + "user" : "all" + }, "returns" : { - "type" : "object", "properties" : { "release" : { "type" : "string" }, - "version" : { + "repoid" : { "type" : "string" }, - "repoid" : { + "version" : { "type" : "string" } - } - }, - "method" : "GET", - "name" : "version", - "permissions" : { - "user" : "all" - }, - "description" : "API version details. The result also includes the global datacenter confguration." + }, + "type" : "object" + } } }, "leaf" : 1, + "path" : "/version", "text" : "version" } ]