X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=api-viewer%2Fapidata.js;h=bde490469459bffec74545fe009dcdd34d5a0b86;hp=81a2327ff8174d0fa6ab1947c4c0e81b2b4117d6;hb=c4808e75e00d27b1d90100900e5ca6d364f191df;hpb=c2993fe56c757a6b53001af4b2af6517ef598f1e diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index 81a2327..bde4904 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -20,11 +20,12 @@ var pveapi = [ "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" : "Security Group name.", - "maxLength" : 20, + "maxLength" : 18, "minLength" : 2, "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" @@ -33,7 +34,8 @@ var pveapi = [ "description" : "Update rule at position .", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" } } }, @@ -61,7 +63,7 @@ var pveapi = [ "properties" : { "group" : { "description" : "Security Group name.", - "maxLength" : 20, + "maxLength" : 18, "minLength" : 2, "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" @@ -70,7 +72,8 @@ var pveapi = [ "description" : "Update rule at position .", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" } } }, @@ -109,41 +112,49 @@ var pveapi = [ "type" : "string" }, "comment" : { + "description" : "Descriptive comment.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "delete" : { "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "optional" : 1, - "type" : "string" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "enable" : { + "description" : "Flag to enable/disable a rule.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "group" : { "description" : "Security Group name.", - "maxLength" : 20, + "maxLength" : 18, "minLength" : 2, "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" @@ -154,44 +165,53 @@ var pveapi = [ "maxLength" : 20, "minLength" : 2, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "macro" : { + "description" : "Use predefined standard macro.", "maxLength" : 128, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "moveto" : { "description" : "Move rule to new position . Other arguments are ignored.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "pos" : { "description" : "Update rule at position .", "minimum" : 0, "optional" : 1, - "type" : "integer" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "type" : { + "description" : "Rule type.", "enum" : [ "in", "out", @@ -233,7 +253,7 @@ var pveapi = [ "properties" : { "group" : { "description" : "Security Group name.", - "maxLength" : 20, + "maxLength" : 18, "minLength" : 2, "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" @@ -263,7 +283,7 @@ var pveapi = [ "properties" : { "group" : { "description" : "Security Group name.", - "maxLength" : 20, + "maxLength" : 18, "minLength" : 2, "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" @@ -314,35 +334,42 @@ var pveapi = [ "type" : "string" }, "comment" : { + "description" : "Descriptive comment.", "optional" : 1, - "type" : "string" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "enable" : { + "description" : "Flag to enable/disable a rule.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "group" : { "description" : "Security Group name.", - "maxLength" : 20, + "maxLength" : 18, "minLength" : 2, "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" @@ -353,38 +380,46 @@ var pveapi = [ "maxLength" : 20, "minLength" : 2, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "macro" : { + "description" : "Use predefined standard macro.", "maxLength" : 128, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "pos" : { "description" : "Update rule at position .", "minimum" : 0, "optional" : 1, - "type" : "integer" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "type" : { + "description" : "Rule type.", "enum" : [ "in", "out", @@ -442,7 +477,7 @@ var pveapi = [ }, "group" : { "description" : "Security Group name.", - "maxLength" : 20, + "maxLength" : 18, "minLength" : 2, "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" @@ -468,24 +503,26 @@ var pveapi = [ "properties" : { "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "group" : { "description" : "Security Group name.", - "maxLength" : 20, + "maxLength" : 18, "minLength" : 2, "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", "type" : "string" }, "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" : 20, + "maxLength" : 18, "minLength" : 2, "optional" : 1, "pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+", @@ -527,13 +564,15 @@ var pveapi = [ "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" : "" }, "pos" : { "description" : "Update rule at position .", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" } } }, @@ -563,7 +602,8 @@ var pveapi = [ "description" : "Update rule at position .", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" } } }, @@ -602,37 +642,45 @@ var pveapi = [ "type" : "string" }, "comment" : { + "description" : "Descriptive comment.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "delete" : { "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "optional" : 1, - "type" : "string" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "enable" : { + "description" : "Flag to enable/disable a rule.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "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.", @@ -640,44 +688,53 @@ var pveapi = [ "maxLength" : 20, "minLength" : 2, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "macro" : { + "description" : "Use predefined standard macro.", "maxLength" : 128, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "moveto" : { "description" : "Move rule to new position . Other arguments are ignored.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "pos" : { "description" : "Update rule at position .", "minimum" : 0, "optional" : 1, - "type" : "integer" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "type" : { + "description" : "Rule type.", "enum" : [ "in", "out", @@ -761,31 +818,38 @@ var pveapi = [ "type" : "string" }, "comment" : { + "description" : "Descriptive comment.", "optional" : 1, - "type" : "string" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "enable" : { + "description" : "Flag to enable/disable a rule.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "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.", @@ -793,38 +857,46 @@ var pveapi = [ "maxLength" : 20, "minLength" : 2, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "macro" : { + "description" : "Use predefined standard macro.", "maxLength" : 128, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "pos" : { "description" : "Update rule at position .", "minimum" : 0, "optional" : 1, - "type" : "integer" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "type" : { + "description" : "Rule type.", "enum" : [ "in", "out", @@ -871,13 +943,15 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDRorAlias", - "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "IP set name.", @@ -912,7 +986,8 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDRorAlias", - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "IP set name.", @@ -947,17 +1022,20 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDRorAlias", - "type" : "string" + "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "IP set name.", @@ -968,7 +1046,8 @@ var pveapi = [ }, "nomatch" : { "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" } } }, @@ -1090,11 +1169,13 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDRorAlias", - "type" : "string" + "type" : "string", + "typetext" : "" }, "comment" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "IP set name.", @@ -1105,7 +1186,8 @@ var pveapi = [ }, "nomatch" : { "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" } } }, @@ -1187,13 +1269,15 @@ var pveapi = [ "properties" : { "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "IP set name.", @@ -1246,7 +1330,8 @@ var pveapi = [ "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" : { "description" : "Alias name.", @@ -1310,17 +1395,20 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDR", - "type" : "string" + "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "Alias name.", @@ -1417,11 +1505,13 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDR", - "type" : "string" + "type" : "string", + "typetext" : "" }, "comment" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "Alias name.", @@ -1512,19 +1602,22 @@ var pveapi = [ "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "enable" : { "description" : "Enable or disable the firewall cluster wide.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "policy_in" : { "description" : "Input policy.", @@ -1706,7 +1799,8 @@ var pveapi = [ "id" : { "description" : "The job ID.", "maxLength" : 50, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -1734,7 +1828,8 @@ var pveapi = [ "id" : { "description" : "The job ID.", "maxLength" : 50, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -1762,14 +1857,16 @@ var pveapi = [ "default" : 0, "description" : "Backup all known guest systems on this host.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "bwlimit" : { "default" : 0, "description" : "Limit I/O bandwidth (KBytes per second).", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "compress" : { "default" : "0", @@ -1787,41 +1884,48 @@ var pveapi = [ "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "dow" : { "description" : "Day of week selection.", "format" : "pve-day-of-week-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "dumpdir" : { "description" : "Store resulting files to specified directory.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "enabled" : { "default" : "1", "description" : "Enable or disable the job.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "exclude" : { "description" : "Exclude specified guest systems (assumes --all)", "format" : "pve-vmid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "exclude-path" : { "description" : "Exclude certain files/directories (shell globs).", "format" : "string-alist", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "id" : { "description" : "The job ID.", "maxLength" : 50, - "type" : "string" + "type" : "string", + "typetext" : "" }, "ionice" : { "default" : 7, @@ -1829,14 +1933,16 @@ var pveapi = [ "maximum" : 8, "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - 8)" }, "lockwait" : { "default" : 180, "description" : "Maximal time to wait for the global lock (minutes).", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "mailnotification" : { "default" : "always", @@ -1852,14 +1958,16 @@ var pveapi = [ "description" : "Comma-separated list of email addresses that should receive email notifications.", "format" : "string-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "maxfiles" : { "default" : 1, "description" : "Maximal number of backup files per guest system.", "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "mode" : { "default" : "snapshot", @@ -1876,37 +1984,43 @@ var pveapi = [ "description" : "Only run if executed on this node.", "format" : "pve-node", "optional" : 1, - "type" : "string" + "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" + "type" : "integer", + "typetext" : "" }, "quiet" : { "default" : 0, "description" : "Be quiet.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "remove" : { "default" : 1, "description" : "Remove old backup files if there are more than 'maxfiles' backup files.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "script" : { "description" : "Use specified hook script.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "size" : { "default" : 1024, "description" : "Unused, will be removed in a future release.", "minimum" : 500, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (500 - N)" }, "starttime" : { "description" : "Job Start time.", @@ -1918,37 +2032,43 @@ var pveapi = [ "default" : 1, "description" : "Exclude temporary files and logs.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "stop" : { "default" : 0, "description" : "Stop runnig backup jobs on this host.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "stopwait" : { "default" : 10, "description" : "Maximal time to wait until a guest system is stopped (minutes).", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The ID of the guest system you want to backup.", "format" : "pve-vmid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -2018,14 +2138,16 @@ var pveapi = [ "default" : 0, "description" : "Backup all known guest systems on this host.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "bwlimit" : { "default" : 0, "description" : "Limit I/O bandwidth (KBytes per second).", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "compress" : { "default" : "0", @@ -2044,30 +2166,35 @@ var pveapi = [ "description" : "Day of week selection.", "format" : "pve-day-of-week-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "dumpdir" : { "description" : "Store resulting files to specified directory.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "enabled" : { "default" : "1", "description" : "Enable or disable the job.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "exclude" : { "description" : "Exclude specified guest systems (assumes --all)", "format" : "pve-vmid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "exclude-path" : { "description" : "Exclude certain files/directories (shell globs).", "format" : "string-alist", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "ionice" : { "default" : 7, @@ -2075,14 +2202,16 @@ var pveapi = [ "maximum" : 8, "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - 8)" }, "lockwait" : { "default" : 180, "description" : "Maximal time to wait for the global lock (minutes).", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "mailnotification" : { "default" : "always", @@ -2098,14 +2227,16 @@ var pveapi = [ "description" : "Comma-separated list of email addresses that should receive email notifications.", "format" : "string-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "maxfiles" : { "default" : 1, "description" : "Maximal number of backup files per guest system.", "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "mode" : { "default" : "snapshot", @@ -2122,37 +2253,43 @@ var pveapi = [ "description" : "Only run if executed on this node.", "format" : "pve-node", "optional" : 1, - "type" : "string" + "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" + "type" : "integer", + "typetext" : "" }, "quiet" : { "default" : 0, "description" : "Be quiet.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "remove" : { "default" : 1, "description" : "Remove old backup files if there are more than 'maxfiles' backup files.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "script" : { "description" : "Use specified hook script.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "size" : { "default" : 1024, "description" : "Unused, will be removed in a future release.", "minimum" : 500, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (500 - N)" }, "starttime" : { "description" : "Job Start time.", @@ -2164,37 +2301,43 @@ var pveapi = [ "default" : 1, "description" : "Exclude temporary files and logs.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "stop" : { "default" : 0, "description" : "Stop runnig backup jobs on this host.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "stopwait" : { "default" : 10, "description" : "Maximal time to wait until a guest system is stopped (minutes).", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The ID of the guest system you want to backup.", "format" : "pve-vmid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -2205,7 +2348,8 @@ var pveapi = [ [ "Sys.Modify" ] - ] + ], + "description" : "The 'tmpdir', 'dumpdir' and 'script' parameters are additionally restricted to the 'root@pam' user." }, "protected" : 1, "returns" : { @@ -2235,7 +2379,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "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).", @@ -2276,7 +2421,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "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).", @@ -2373,40 +2519,46 @@ var pveapi = [ "description" : "Description.", "maxLength" : 4096, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "delete" : { "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "maxLength" : 4096, "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "group" : { "description" : "The HA group identifier.", "format" : "pve-configid", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "max_relocate" : { "default" : 1, "description" : "Maximal number of service relocate tries when a service failes to start.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "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" + "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).", @@ -2415,14 +2567,17 @@ var pveapi = [ "typetext" : ":" }, "state" : { - "default" : "enabled", - "description" : "Resource state.", + "default" : "started", + "description" : "Requested resource state.", "enum" : [ + "started", + "stopped", "enabled", "disabled" ], "optional" : 1, - "type" : "string" + "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" } }, "type" : "object" @@ -2504,27 +2659,31 @@ var pveapi = [ "description" : "Description.", "maxLength" : 4096, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "group" : { "description" : "The HA group identifier.", "format" : "pve-configid", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "max_relocate" : { "default" : 1, "description" : "Maximal number of service relocate tries when a service failes to start.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "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" + "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).", @@ -2533,14 +2692,17 @@ var pveapi = [ "typetext" : ":" }, "state" : { - "default" : "enabled", - "description" : "Resource state.", + "default" : "started", + "description" : "Requested resource state.", "enum" : [ + "started", + "stopped", "enabled", "disabled" ], "optional" : 1, - "type" : "string" + "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" }, "type" : { "description" : "Resource type.", @@ -2587,7 +2749,8 @@ var pveapi = [ "group" : { "description" : "The HA group identifier.", "format" : "pve-configid", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -2615,7 +2778,8 @@ var pveapi = [ "group" : { "description" : "The HA group identifier.", "format" : "pve-configid", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -2641,44 +2805,52 @@ var pveapi = [ "description" : "Description.", "maxLength" : 4096, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "delete" : { "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "maxLength" : 4096, "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "group" : { "description" : "The HA group identifier.", "format" : "pve-configid", - "type" : "string" + "type" : "string", + "typetext" : "" }, "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').", + "description" : "List of cluster node names with optional priority.", "format" : "pve-ha-group-node-list", "optional" : 1, "type" : "string", - "typetext" : "[:]{,[:]}*" + "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" + "type" : "boolean", + "typetext" : "" }, "restricted" : { "default" : 0, - "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.", + "description" : "Resources bound to restricted groups may only run on nodes defined by the group.", "optional" : 1, - "type" : "boolean" + "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" @@ -2749,31 +2921,37 @@ var pveapi = [ "description" : "Description.", "maxLength" : 4096, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "group" : { "description" : "The HA group identifier.", "format" : "pve-configid", - "type" : "string" + "type" : "string", + "typetext" : "" }, "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').", + "description" : "List of cluster node names with optional priority.", "format" : "pve-ha-group-node-list", "optional" : 0, "type" : "string", - "typetext" : "[:]{,[:]}*" + "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" + "type" : "boolean", + "typetext" : "" }, "restricted" : { "default" : 0, - "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.", + "description" : "Resources bound to restricted groups may only run on nodes defined by the group.", "optional" : 1, - "type" : "boolean" + "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.", @@ -2946,7 +3124,8 @@ var pveapi = [ "description" : "Maximum number of entries.", "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -3075,13 +3254,15 @@ var pveapi = [ "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "email_from" : { "description" : "Specify email address to send notification from (default is root@$hostname)", "format" : "email-opt", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "fencing" : { "default" : "watchdog", @@ -3141,16 +3322,49 @@ var pveapi = [ "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" + "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.", + "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" + "type" : "boolean", + "typetext" : "" } } }, @@ -3223,7 +3437,8 @@ var pveapi = [ "format" : "pve-vmid", "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -3296,24 +3511,28 @@ var pveapi = [ "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" : "" }, "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" + "type" : "integer", + "typetext" : " (0 - N)" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -3342,19 +3561,22 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (0 - N)" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -3393,37 +3615,45 @@ var pveapi = [ "type" : "string" }, "comment" : { + "description" : "Descriptive comment.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "delete" : { "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "optional" : 1, - "type" : "string" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "enable" : { + "description" : "Flag to enable/disable a rule.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "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.", @@ -3431,49 +3661,59 @@ var pveapi = [ "maxLength" : 20, "minLength" : 2, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "macro" : { + "description" : "Use predefined standard macro.", "maxLength" : 128, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "moveto" : { "description" : "Move rule to new position . Other arguments are ignored.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "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" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "type" : { + "description" : "Rule type.", "enum" : [ "in", "out", @@ -3486,7 +3726,8 @@ var pveapi = [ "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -3522,13 +3763,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -3576,31 +3819,38 @@ var pveapi = [ "type" : "string" }, "comment" : { + "description" : "Descriptive comment.", "optional" : 1, - "type" : "string" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "enable" : { + "description" : "Flag to enable/disable a rule.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "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.", @@ -3608,43 +3858,52 @@ var pveapi = [ "maxLength" : 20, "minLength" : 2, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "macro" : { + "description" : "Use predefined standard macro.", "maxLength" : 128, "optional" : 1, - "type" : "string" + "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" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "type" : { + "description" : "Rule type.", "enum" : [ "in", "out", @@ -3657,7 +3916,8 @@ var pveapi = [ "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -3696,7 +3956,8 @@ var pveapi = [ "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" : { "description" : "Alias name.", @@ -3708,13 +3969,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -3749,13 +4012,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -3782,17 +4047,20 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDR", - "type" : "string" + "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "Alias name.", @@ -3804,7 +4072,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "rename" : { "description" : "Rename an existing alias.", @@ -3818,7 +4087,8 @@ var pveapi = [ "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -3853,13 +4123,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -3913,11 +4185,13 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDR", - "type" : "string" + "type" : "string", + "typetext" : "" }, "comment" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "Alias name.", @@ -3929,13 +4203,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -3974,13 +4250,15 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDRorAlias", - "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "IP set name.", @@ -3992,13 +4270,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -4026,7 +4306,8 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDRorAlias", - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "IP set name.", @@ -4038,13 +4319,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -4072,17 +4355,20 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDRorAlias", - "type" : "string" + "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "IP set name.", @@ -4094,17 +4380,20 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "nomatch" : { "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -4146,13 +4435,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -4187,13 +4478,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -4248,11 +4541,13 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDRorAlias", - "type" : "string" + "type" : "string", + "typetext" : "" }, "comment" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "IP set name.", @@ -4264,17 +4559,20 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "nomatch" : { "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -4309,13 +4607,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -4369,13 +4669,15 @@ var pveapi = [ "properties" : { "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "IP set name.", @@ -4387,7 +4689,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "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.", @@ -4401,7 +4704,8 @@ var pveapi = [ "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -4436,13 +4740,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -4555,28 +4861,33 @@ var pveapi = [ "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "dhcp" : { "description" : "Enable DHCP.", "optional" : 1, - "type" : "boolean" + "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" + "type" : "string", + "typetext" : "" }, "enable" : { "description" : "Enable/disable firewall rules.", "optional" : 1, - "type" : "boolean" + "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" + "type" : "boolean", + "typetext" : "" }, "log_level_in" : { "description" : "Log level for incoming traffic.", @@ -4613,17 +4924,20 @@ var pveapi = [ "macfilter" : { "description" : "Enable/disable MAC address filter.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "ndp" : { "description" : "Enable NDP.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "policy_in" : { "description" : "Input policy.", @@ -4648,13 +4962,15 @@ var pveapi = [ "radv" : { "description" : "Allow sending Router Advertisement.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -4690,23 +5006,27 @@ var pveapi = [ "limit" : { "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "start" : { "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -4755,7 +5075,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "type" : { "description" : "Only list references of specified type.", @@ -4770,7 +5091,8 @@ var pveapi = [ "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -4823,13 +5145,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -4876,12 +5200,14 @@ var pveapi = [ "ds" : { "description" : "The list of datasources you want to display.", "format" : "pve-configid-list", - "type" : "string" + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "timeframe" : { "description" : "Specify the time frame you are interested in.", @@ -4898,7 +5224,8 @@ var pveapi = [ "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -4947,7 +5274,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "timeframe" : { "description" : "Specify the time frame you are interested in.", @@ -4964,7 +5292,8 @@ var pveapi = [ "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -5004,18 +5333,21 @@ var pveapi = [ "default" : 0, "description" : "Get current values (instead of pending values).", "optional" : 1, - "type" : "boolean" + "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -5050,38 +5382,44 @@ var pveapi = [ "default" : 1, "description" : "Enable/disable ACPI.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "agent" : { "default" : 0, "description" : "Enable/disable Qemu GuestAgent.", "optional" : 1, - "type" : "boolean" + "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" + "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" + "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" + "type" : "integer", + "typetext" : " (0 - N)" }, "bios" : { "default" : "seabios", @@ -5109,17 +5447,18 @@ var pveapi = [ }, "cdrom" : { "description" : "This is an alias for option -ide2", - "format" : "pve-qm-drive", + "format" : "pve-qm-ide", "optional" : 1, "type" : "string", - "typetext" : "volume" + "typetext" : "" }, "cores" : { "default" : 1, "description" : "The number of cores per socket.", "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "cpu" : { "description" : "Emulated CPU type.", @@ -5158,7 +5497,6 @@ var pveapi = [ "SandyBridge", "Westmere" ], - "format_description" : "cputype", "type" : "string" }, "hidden" : { @@ -5169,7 +5507,8 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "[cputype=] [,hidden=<1|0>]" }, "cpulimit" : { "default" : 0, @@ -5178,56 +5517,76 @@ var pveapi = [ "minimum" : 0, "optional" : 1, "type" : "number", + "typetext" : " (0 - 128)", "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit." }, "cpuunits" : { - "default" : 1000, + "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" + "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" + "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" + "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" + "type" : "boolean", + "typetext" : "" }, "freeze" : { "description" : "Freeze CPU at startup (use 'c' monitor command to start execution).", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "hostpci[n]" : { "description" : "Map host PCI devices into guest.", "format" : "pve-qm-hostpci", "optional" : 1, - "type" : "string" + "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]" : { @@ -5248,23 +5607,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -5314,7 +5694,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -5324,73 +5703,94 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -5474,7 +5874,8 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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", @@ -5513,12 +5914,14 @@ var pveapi = [ "default" : 1, "description" : "Enable/disable KVM hardware virtualization.", "optional" : 1, - "type" : "boolean" + "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" + "type" : "boolean", + "typetext" : "" }, "lock" : { "description" : "Lock/unlock the VM.", @@ -5543,27 +5946,31 @@ var pveapi = [ "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" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "net[n]" : { "description" : "Specify network devices.", @@ -5637,7 +6044,6 @@ var pveapi = [ "e1000-82544gc", "e1000-82545em" ], - "format_description" : "model", "type" : "string" }, "ne2k_isa" : { @@ -5693,18 +6099,21 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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" + "type" : "string", + "typetext" : "" }, "numa" : { "default" : 0, "description" : "Enable/disable NUMA.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "numa[n]" : { "description" : "NUMA topology.", @@ -5739,13 +6148,15 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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" + "type" : "boolean", + "typetext" : "" }, "ostype" : { "description" : "Specify guest operating system.", @@ -5777,19 +6188,22 @@ var pveapi = [ "default" : 0, "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "reboot" : { "default" : 1, "description" : "Allow reboot. If set to '0' the VM exit on reboot.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "revert" : { "description" : "Revert a pending change.", "format" : "pve-configid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "sata[n]" : { "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).", @@ -5809,23 +6223,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -5875,7 +6310,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -5885,73 +6319,94 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, - "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", - "format_description" : "iops", + "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 speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -6027,7 +6482,8 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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).", @@ -6047,23 +6503,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -6113,7 +6590,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -6123,37 +6599,58 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" @@ -6164,37 +6661,37 @@ var pveapi = [ "type" : "boolean" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -6266,7 +6763,8 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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", @@ -6287,7 +6785,7 @@ var pveapi = [ "optional" : 1, "pattern" : "(/dev/.+|socket)", "type" : "string", - "verbose_description" : "\nCreate 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" + "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, @@ -6295,33 +6793,38 @@ var pveapi = [ "maximum" : 50000, "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - 50000)" }, "skiplock" : { "description" : "Ignore locks - only root is allowed to use this option.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "smbios1" : { "description" : "Specify SMBIOS type 1 fields.", "format" : "pve-qm-smbios1", "maxLength" : 256, "optional" : 1, - "type" : "string" + "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" + "type" : "integer", + "typetext" : " (1 - N)" }, "sockets" : { "default" : 1, "description" : "The number of CPU sockets.", "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "startdate" : { "default" : "now", @@ -6343,25 +6846,29 @@ var pveapi = [ "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" + "type" : "boolean", + "typetext" : "" }, "template" : { "default" : 0, "description" : "Enable/disable Template.", "optional" : 1, - "type" : "boolean" + "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" + "type" : "string", + "typetext" : "" }, "usb[n]" : { "description" : "Configure an USB device (n is 0 to 4).", @@ -6381,14 +6888,16 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "[host=] [,usb3=<1|0>]" }, "vcpus" : { "default" : 0, "description" : "Number of hotplugged vcpus.", "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "vga" : { "description" : "Select the VGA type.", @@ -6427,23 +6936,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -6493,7 +7023,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -6503,37 +7032,58 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" @@ -6544,37 +7094,37 @@ var pveapi = [ "type" : "boolean" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -6650,19 +7200,22 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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=]" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "watchdog" : { "description" : "Create a virtual hardware watchdog device.", "format" : "pve-qm-watchdog", "optional" : 1, "type" : "string", + "typetext" : "[[model=]] [,action=]", "verbose_description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)" } } @@ -6702,31 +7255,36 @@ var pveapi = [ "default" : 1, "description" : "Enable/disable ACPI.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "agent" : { "default" : 0, "description" : "Enable/disable Qemu GuestAgent.", "optional" : 1, - "type" : "boolean" + "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" + "type" : "boolean", + "typetext" : "" }, "balloon" : { "description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "bios" : { "default" : "seabios", @@ -6754,17 +7312,18 @@ var pveapi = [ }, "cdrom" : { "description" : "This is an alias for option -ide2", - "format" : "pve-qm-drive", + "format" : "pve-qm-ide", "optional" : 1, "type" : "string", - "typetext" : "volume" + "typetext" : "" }, "cores" : { "default" : 1, "description" : "The number of cores per socket.", "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "cpu" : { "description" : "Emulated CPU type.", @@ -6803,7 +7362,6 @@ var pveapi = [ "SandyBridge", "Westmere" ], - "format_description" : "cputype", "type" : "string" }, "hidden" : { @@ -6814,7 +7372,8 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "[cputype=] [,hidden=<1|0>]" }, "cpulimit" : { "default" : 0, @@ -6823,56 +7382,76 @@ var pveapi = [ "minimum" : 0, "optional" : 1, "type" : "number", + "typetext" : " (0 - 128)", "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit." }, "cpuunits" : { - "default" : 1000, + "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" + "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" + "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" + "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" + "type" : "boolean", + "typetext" : "" }, "freeze" : { "description" : "Freeze CPU at startup (use 'c' monitor command to start execution).", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "hostpci[n]" : { "description" : "Map host PCI devices into guest.", "format" : "pve-qm-hostpci", "optional" : 1, - "type" : "string" + "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]" : { @@ -6893,23 +7472,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -6959,7 +7559,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -6969,73 +7568,94 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -7119,7 +7739,8 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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", @@ -7158,12 +7779,14 @@ var pveapi = [ "default" : 1, "description" : "Enable/disable KVM hardware virtualization.", "optional" : 1, - "type" : "boolean" + "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" + "type" : "boolean", + "typetext" : "" }, "lock" : { "description" : "Lock/unlock the VM.", @@ -7188,27 +7811,31 @@ var pveapi = [ "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" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "net[n]" : { "description" : "Specify network devices.", @@ -7282,7 +7909,6 @@ var pveapi = [ "e1000-82544gc", "e1000-82545em" ], - "format_description" : "model", "type" : "string" }, "ne2k_isa" : { @@ -7338,18 +7964,21 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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" + "type" : "string", + "typetext" : "" }, "numa" : { "default" : 0, "description" : "Enable/disable NUMA.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "numa[n]" : { "description" : "NUMA topology.", @@ -7384,13 +8013,15 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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" + "type" : "boolean", + "typetext" : "" }, "ostype" : { "description" : "Specify guest operating system.", @@ -7422,19 +8053,22 @@ var pveapi = [ "default" : 0, "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "reboot" : { "default" : 1, "description" : "Allow reboot. If set to '0' the VM exit on reboot.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "revert" : { "description" : "Revert a pending change.", "format" : "pve-configid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "sata[n]" : { "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).", @@ -7454,23 +8088,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -7520,7 +8175,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -7530,73 +8184,94 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -7672,7 +8347,8 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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).", @@ -7692,23 +8368,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -7758,7 +8455,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -7768,37 +8464,58 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" @@ -7809,37 +8526,37 @@ var pveapi = [ "type" : "boolean" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -7911,7 +8628,8 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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", @@ -7932,7 +8650,7 @@ var pveapi = [ "optional" : 1, "pattern" : "(/dev/.+|socket)", "type" : "string", - "verbose_description" : "\nCreate 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" + "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, @@ -7940,33 +8658,38 @@ var pveapi = [ "maximum" : 50000, "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - 50000)" }, "skiplock" : { "description" : "Ignore locks - only root is allowed to use this option.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "smbios1" : { "description" : "Specify SMBIOS type 1 fields.", "format" : "pve-qm-smbios1", "maxLength" : 256, "optional" : 1, - "type" : "string" + "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" + "type" : "integer", + "typetext" : " (1 - N)" }, "sockets" : { "default" : 1, "description" : "The number of CPU sockets.", "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "startdate" : { "default" : "now", @@ -7988,25 +8711,29 @@ var pveapi = [ "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" + "type" : "boolean", + "typetext" : "" }, "template" : { "default" : 0, "description" : "Enable/disable Template.", "optional" : 1, - "type" : "boolean" + "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" + "type" : "string", + "typetext" : "" }, "usb[n]" : { "description" : "Configure an USB device (n is 0 to 4).", @@ -8026,14 +8753,16 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "[host=] [,usb3=<1|0>]" }, "vcpus" : { "default" : 0, "description" : "Number of hotplugged vcpus.", "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "vga" : { "description" : "Select the VGA type.", @@ -8072,24 +8801,45 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, - "cache" : { + "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", @@ -8138,7 +8888,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -8148,37 +8897,58 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" @@ -8189,37 +8959,37 @@ var pveapi = [ "type" : "boolean" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -8295,19 +9065,22 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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=]" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "watchdog" : { "description" : "Create a virtual hardware watchdog device.", "format" : "pve-qm-watchdog", "optional" : 1, "type" : "string", + "typetext" : "[[model=]] [,action=]", "verbose_description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)" } } @@ -8352,13 +9125,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -8419,23 +9194,27 @@ var pveapi = [ "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" + "type" : "string", + "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -8471,18 +9250,21 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" }, "websocket" : { "description" : "starts websockify instead of vncproxy", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" } } }, @@ -8534,24 +9316,28 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "port" : { "description" : "Port number returned by previous vncproxy call.", "maximum" : 5999, "minimum" : 5900, - "type" : "integer" + "type" : "integer", + "typetext" : " (5900 - 5999)" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "vncticket" : { "description" : "Ticket from previous call to vncproxy.", "maxLength" : 512, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -8591,19 +9377,22 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -8659,13 +9448,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -8709,29 +9500,50 @@ var pveapi = [ "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" + "type" : "string", + "typetext" : "" }, "skiplock" : { "description" : "Ignore locks - only root is allowed to use this option.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "stateuri" : { "description" : "Some command save/restore state from this location.", "maxLength" : 128, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -8766,37 +9578,43 @@ var pveapi = [ "properties" : { "keepActive" : { "default" : 0, - "description" : "Do not decativate storage volumes.", + "description" : "Do not deactivate storage volumes.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "migratedfrom" : { "description" : "The cluster node name.", "format" : "pve-node", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "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, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -8832,18 +9650,21 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -8880,35 +9701,41 @@ var pveapi = [ "default" : 0, "description" : "Make sure the VM stops.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "keepActive" : { "default" : 0, - "description" : "Do not decativate storage volumes.", + "description" : "Do not deactivate storage volumes.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "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, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -8944,18 +9771,21 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -8990,23 +9820,27 @@ var pveapi = [ "properties" : { "nocheck" : { "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -9042,13 +9876,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -9090,23 +9926,27 @@ var pveapi = [ "properties" : { "key" : { "description" : "The key (qemu monitor encoding).", - "type" : "string" + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -9151,20 +9991,23 @@ 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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -9211,7 +10054,8 @@ var pveapi = [ "description" : { "description" : "Description for the new VM.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "format" : { "description" : "Target format for file storage.", @@ -9228,56 +10072,65 @@ var pveapi = [ "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" : "boolean" + "type" : "boolean", + "typetext" : "" }, "name" : { "description" : "Set a name for the new VM.", "format" : "dns-name", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "newid" : { "description" : "VMID for the clone.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "pool" : { "description" : "Add the new VM to the specified pool.", "format" : "pve-poolid", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "snapname" : { "description" : "The name of the snapshot.", "format" : "pve-configid", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "storage" : { "description" : "Target storage for full clone.", "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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -9337,13 +10190,15 @@ var pveapi = [ "default" : 0, "description" : "Delete the original disk after successful copy. By default the original disk is kept as unused disk.", "optional" : 1, - "type" : "boolean" + "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" + "type" : "string", + "typetext" : "" }, "disk" : { "description" : "The disk you want to move.", @@ -9387,7 +10242,8 @@ var pveapi = [ "sata2", "sata3", "sata4", - "sata5" + "sata5", + "efidisk0" ], "type" : "string" }, @@ -9404,18 +10260,21 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "storage" : { "description" : "Target storage.", "format" : "pve-storage-id", - "type" : "string" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -9463,28 +10322,49 @@ var pveapi = [ "force" : { "description" : "Allow to migrate VMs which use local devices. Only root may use this option.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" + }, + "migration_network" : { + "description" : "CIDR of the (sub) network that is used for migration.", + "format" : "CIDR", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "migration_type" : { + "description" : "Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.", + "enum" : [ + "secure", + "insecure" + ], + "optional" : 1, + "type" : "string" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "online" : { "description" : "Use online/live migration.", "optional" : 1, - "type" : "boolean" + "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -9520,18 +10400,21 @@ var pveapi = [ "properties" : { "command" : { "description" : "The monitor command.", - "type" : "string" + "type" : "string", + "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -9568,7 +10451,8 @@ var pveapi = [ "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" : "" }, "disk" : { "description" : "The disk you want to resize.", @@ -9612,14 +10496,16 @@ var pveapi = [ "sata2", "sata3", "sata4", - "sata5" + "sata5", + "efidisk0" ], "type" : "string" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "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.", @@ -9629,13 +10515,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -9675,19 +10563,22 @@ 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, - "type" : "string" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -9715,24 +10606,28 @@ var pveapi = [ "description" : { "description" : "A textual description or comment.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -9768,19 +10663,22 @@ 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, - "type" : "string" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -9817,24 +10715,28 @@ var pveapi = [ "force" : { "description" : "For removal from config file, even if removing disk snapshots fails.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -9864,19 +10766,22 @@ 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, - "type" : "string" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -9914,13 +10819,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -9959,29 +10866,34 @@ var pveapi = [ "description" : { "description" : "A textual description or comment.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "vmstate" : { "description" : "Save the vmstate", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" } } }, @@ -10057,7 +10969,8 @@ var pveapi = [ "sata2", "sata3", "sata4", - "sata5" + "sata5", + "efidisk0" ], "optional" : 1, "type" : "string" @@ -10065,13 +10978,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -10108,18 +11023,21 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -10148,13 +11066,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -10197,12 +11117,14 @@ var pveapi = [ "full" : { "description" : "Determine the full status of active VMs.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -10237,37 +11159,43 @@ var pveapi = [ "default" : 1, "description" : "Enable/disable ACPI.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "agent" : { "default" : 0, "description" : "Enable/disable Qemu GuestAgent.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "archive" : { "description" : "The backup file.", "maxLength" : 255, "optional" : 1, - "type" : "string" + "type" : "string", + "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" + "type" : "boolean", + "typetext" : "" }, "balloon" : { "description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "bios" : { "default" : "seabios", @@ -10295,17 +11223,18 @@ var pveapi = [ }, "cdrom" : { "description" : "This is an alias for option -ide2", - "format" : "pve-qm-drive", + "format" : "pve-qm-ide", "optional" : 1, "type" : "string", - "typetext" : "volume" + "typetext" : "" }, "cores" : { "default" : 1, "description" : "The number of cores per socket.", "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "cpu" : { "description" : "Emulated CPU type.", @@ -10344,7 +11273,6 @@ var pveapi = [ "SandyBridge", "Westmere" ], - "format_description" : "cputype", "type" : "string" }, "hidden" : { @@ -10355,7 +11283,8 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "[cputype=] [,hidden=<1|0>]" }, "cpulimit" : { "default" : 0, @@ -10364,44 +11293,62 @@ var pveapi = [ "minimum" : 0, "optional" : 1, "type" : "number", + "typetext" : " (0 - 128)", "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit." }, "cpuunits" : { - "default" : 1000, + "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" + "type" : "string", + "typetext" : "" }, "force" : { "description" : "Allow to overwrite existing VM.", "optional" : 1, "requires" : "archive", - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "freeze" : { "description" : "Freeze CPU at startup (use 'c' monitor command to start execution).", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "hostpci[n]" : { "description" : "Map host PCI devices into guest.", "format" : "pve-qm-hostpci", "optional" : 1, - "type" : "string" + "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]" : { @@ -10422,23 +11369,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -10488,7 +11456,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -10498,73 +11465,94 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, - "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "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 speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -10648,7 +11636,8 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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", @@ -10687,12 +11676,14 @@ var pveapi = [ "default" : 1, "description" : "Enable/disable KVM hardware virtualization.", "optional" : 1, - "type" : "boolean" + "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" + "type" : "boolean", + "typetext" : "" }, "lock" : { "description" : "Lock/unlock the VM.", @@ -10717,27 +11708,31 @@ var pveapi = [ "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" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "net[n]" : { "description" : "Specify network devices.", @@ -10811,7 +11806,6 @@ var pveapi = [ "e1000-82544gc", "e1000-82545em" ], - "format_description" : "model", "type" : "string" }, "ne2k_isa" : { @@ -10867,18 +11861,21 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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" + "type" : "string", + "typetext" : "" }, "numa" : { "default" : 0, "description" : "Enable/disable NUMA.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "numa[n]" : { "description" : "NUMA topology.", @@ -10913,13 +11910,15 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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" + "type" : "boolean", + "typetext" : "" }, "ostype" : { "description" : "Specify guest operating system.", @@ -10951,19 +11950,22 @@ var pveapi = [ "description" : "Add the VM to the specified pool.", "format" : "pve-poolid", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "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" + "type" : "boolean", + "typetext" : "" }, "reboot" : { "default" : 1, "description" : "Allow reboot. If set to '0' the VM exit on reboot.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "sata[n]" : { "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).", @@ -10983,23 +11985,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -11049,7 +12072,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -11059,73 +12081,94 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -11201,7 +12244,8 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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).", @@ -11221,23 +12265,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -11287,7 +12352,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -11297,37 +12361,58 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" @@ -11338,37 +12423,37 @@ var pveapi = [ "type" : "boolean" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -11440,7 +12525,8 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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", @@ -11461,7 +12547,7 @@ var pveapi = [ "optional" : 1, "pattern" : "(/dev/.+|socket)", "type" : "string", - "verbose_description" : "\nCreate 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" + "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, @@ -11469,28 +12555,32 @@ var pveapi = [ "maximum" : 50000, "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - 50000)" }, "smbios1" : { "description" : "Specify SMBIOS type 1 fields.", "format" : "pve-qm-smbios1", "maxLength" : 256, "optional" : 1, - "type" : "string" + "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" + "type" : "integer", + "typetext" : " (1 - N)" }, "sockets" : { "default" : 1, "description" : "The number of CPU sockets.", "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "startdate" : { "default" : "now", @@ -11511,38 +12601,44 @@ var pveapi = [ "description" : "Default storage.", "format" : "pve-storage-id", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "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" + "type" : "boolean", + "typetext" : "" }, "template" : { "default" : 0, "description" : "Enable/disable Template.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "unique" : { "description" : "Assign a unique random ethernet address.", "optional" : 1, "requires" : "archive", - "type" : "boolean" + "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" + "type" : "string", + "typetext" : "" }, "usb[n]" : { "description" : "Configure an USB device (n is 0 to 4).", @@ -11562,14 +12658,16 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "[host=] [,usb3=<1|0>]" }, "vcpus" : { "default" : 0, "description" : "Number of hotplugged vcpus.", "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "vga" : { "description" : "Select the VGA type.", @@ -11608,23 +12706,44 @@ var pveapi = [ "type" : "boolean" }, "bps" : { - "description" : "Maximum r/w speed speed in bytes per second.", + "description" : "Maximum r/w speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_rd" : { - "description" : "Maximum read speed speed in bytes per second.", + "description" : "Maximum read speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "bps_wr" : { - "description" : "Maximum write speed speed in bytes per second.", + "description" : "Maximum write speed in bytes per second.", "format_description" : "bps", "optional" : 1, "type" : "integer" }, + "bps_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "cache" : { "description" : "The drive's cache mode", "enum" : [ @@ -11674,7 +12793,6 @@ var pveapi = [ "vmdk", "cloop" ], - "format_description" : "image format", "optional" : 1, "type" : "string" }, @@ -11684,37 +12802,58 @@ var pveapi = [ "type" : "integer" }, "iops" : { - "description" : "Maximum r/w I/O speed in operations per second.", + "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_max" : { - "description" : "Maximum unthrottled r/w I/O pool speed in operations per second.", + "description" : "Maximum unthrottled r/w I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_max_length" : { + "description" : "Maximum length of I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd" : { - "description" : "Maximum read I/O speed in operations per second.", + "description" : "Maximum read I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_rd_length" : { + "description" : "Maximum length of read I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_rd_max" : { - "description" : "Maximum unthrottled read I/O pool speed in operations per second.", + "description" : "Maximum unthrottled read I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, "iops_wr" : { - "description" : "Maximum write I/O speed in operations per second.", + "description" : "Maximum write I/O in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" }, + "iops_wr_length" : { + "description" : "Maximum length of write I/O bursts in seconds.", + "format_description" : "seconds", + "minimum" : 1, + "optional" : 1, + "type" : "integer" + }, "iops_wr_max" : { - "description" : "Maximum unthrottled write I/O pool speed in operations per second.", + "description" : "Maximum unthrottled write I/O pool in operations per second.", "format_description" : "iops", "optional" : 1, "type" : "integer" @@ -11725,37 +12864,37 @@ var pveapi = [ "type" : "boolean" }, "mbps" : { - "description" : "Maximum r/w speed speed in megabytes per second.", + "description" : "Maximum r/w speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_max" : { - "description" : "Maximum unthrottled r/w pool speed in megabytes per second.", + "description" : "Maximum unthrottled r/w pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd" : { - "description" : "Maximum read speed speed in megabytes per second.", + "description" : "Maximum read speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_rd_max" : { - "description" : "Maximum unthrottled read pool speed in megabytes per second.", + "description" : "Maximum unthrottled read pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr" : { - "description" : "Maximum write speed speed in megabytes per second.", + "description" : "Maximum write speed in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" }, "mbps_wr_max" : { - "description" : "Maximum unthrottled write pool speed in megabytes per second.", + "description" : "Maximum unthrottled write pool in megabytes per second.", "format_description" : "mbps", "optional" : 1, "type" : "number" @@ -11831,19 +12970,22 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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=]" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "watchdog" : { "description" : "Create a virtual hardware watchdog device.", "format" : "pve-qm-watchdog", "optional" : 1, "type" : "string", + "typetext" : "[[model=]] [,action=]", "verbose_description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)" } } @@ -11879,13 +13021,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -11941,7 +13085,16 @@ var pveapi = [ "default" : 1, "description" : "Attach a console device (/dev/console) to the container.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" + }, + "cores" : { + "description" : "The number of cores assigned to the container. A container can use all available cores by default.", + "maximum" : 128, + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - 128)" }, "cpulimit" : { "default" : 0, @@ -11949,7 +13102,8 @@ var pveapi = [ "maximum" : 128, "minimum" : 0, "optional" : 1, - "type" : "number" + "type" : "number", + "typetext" : " (0 - 128)" }, "cpuunits" : { "default" : 1024, @@ -11957,31 +13111,36 @@ var pveapi = [ "maximum" : 500000, "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - 500000)" }, "delete" : { "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "description" : { "description" : "Container description. Only used on the configuration web interface.", "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "hostname" : { "description" : "Set a host name for the container.", "format" : "dns-name", "maxLength" : 255, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "lock" : { "description" : "Lock/unlock the VM.", @@ -11999,7 +13158,8 @@ var pveapi = [ "description" : "Amount of RAM for the VM in MB.", "minimum" : 16, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (16 - N)" }, "mp[n]" : { "description" : "Use volume as container mount point.", @@ -12010,15 +13170,17 @@ var pveapi = [ "type" : "boolean" }, "backup" : { - "description" : "Whether to include the mountpoint in backups.", + "description" : "Whether to include the mount point in backups.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "verbose_description" : "Whether to include the mount point in backups (only used for volume mount points)." }, "mp" : { - "description" : "Path to the mountpoint as seen from inside the container.", + "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" + "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)", @@ -12026,10 +13188,17 @@ var pveapi = [ "type" : "boolean" }, "ro" : { - "description" : "Read-only mountpoint (not supported with bind mounts)", + "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", @@ -12046,13 +13215,15 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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" + "type" : "string", + "typetext" : "" }, "net[n]" : { "description" : "Specifies network interfaces for the container.", @@ -12124,8 +13295,8 @@ var pveapi = [ }, "tag" : { "description" : "VLAN tag for this interface.", - "maximum" : "4094", - "minimum" : "1", + "maximum" : 4094, + "minimum" : 1, "optional" : 1, "type" : "integer" }, @@ -12146,18 +13317,21 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "onboot" : { "default" : 0, "description" : "Specifies whether a VM will be started during system bootup.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "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.", @@ -12169,6 +13343,7 @@ var pveapi = [ "opensuse", "archlinux", "alpine", + "gentoo", "unmanaged" ], "optional" : 1, @@ -12178,7 +13353,8 @@ var pveapi = [ "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" + "type" : "boolean", + "typetext" : "" }, "rootfs" : { "description" : "Use volume as container root.", @@ -12194,10 +13370,17 @@ var pveapi = [ "type" : "boolean" }, "ro" : { - "description" : "Read-only mountpoint (not supported with bind mounts)", + "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", @@ -12214,13 +13397,15 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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" + "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.", @@ -12234,13 +13419,15 @@ var pveapi = [ "description" : "Amount of SWAP for the VM in MB.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "template" : { "default" : 0, "description" : "Enable/disable Template.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "tty" : { "default" : 2, @@ -12248,25 +13435,29 @@ var pveapi = [ "maximum" : 6, "minimum" : 0, "optional" : 1, - "type" : "integer" + "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" + "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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -12310,13 +13501,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -12352,18 +13545,21 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -12399,18 +13595,21 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -12447,25 +13646,29 @@ var pveapi = [ "default" : 0, "description" : "Make sure the Container stops.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "timeout" : { "default" : 60, "description" : "Wait maximal timeout seconds.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -12501,13 +13704,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -12543,13 +13748,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -12585,13 +13792,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -12638,19 +13847,22 @@ 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, - "type" : "string" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -12687,19 +13899,22 @@ 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, - "type" : "string" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -12727,24 +13942,28 @@ var pveapi = [ "description" : { "description" : "A textual description or comment.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -12780,24 +13999,28 @@ var pveapi = [ "force" : { "description" : "For removal from config file, even if removing disk snapshots fails.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -12827,19 +14050,22 @@ 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, - "type" : "string" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -12877,13 +14103,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -12922,24 +14150,28 @@ var pveapi = [ "description" : { "description" : "A textual description or comment.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -12981,24 +14213,28 @@ var pveapi = [ "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" : "" }, "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" + "type" : "integer", + "typetext" : " (0 - N)" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -13027,19 +14263,22 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (0 - N)" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -13078,37 +14317,45 @@ var pveapi = [ "type" : "string" }, "comment" : { + "description" : "Descriptive comment.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "delete" : { "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "optional" : 1, - "type" : "string" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "enable" : { + "description" : "Flag to enable/disable a rule.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "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.", @@ -13116,49 +14363,59 @@ var pveapi = [ "maxLength" : 20, "minLength" : 2, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "macro" : { + "description" : "Use predefined standard macro.", "maxLength" : 128, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "moveto" : { "description" : "Move rule to new position . Other arguments are ignored.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "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" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "type" : { + "description" : "Rule type.", "enum" : [ "in", "out", @@ -13171,7 +14428,8 @@ var pveapi = [ "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -13207,13 +14465,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -13261,31 +14521,38 @@ var pveapi = [ "type" : "string" }, "comment" : { + "description" : "Descriptive comment.", "optional" : 1, - "type" : "string" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "enable" : { + "description" : "Flag to enable/disable a rule.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "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.", @@ -13293,43 +14560,52 @@ var pveapi = [ "maxLength" : 20, "minLength" : 2, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "macro" : { + "description" : "Use predefined standard macro.", "maxLength" : 128, "optional" : 1, - "type" : "string" + "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" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "type" : { + "description" : "Rule type.", "enum" : [ "in", "out", @@ -13342,7 +14618,8 @@ var pveapi = [ "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -13381,7 +14658,8 @@ var pveapi = [ "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" : { "description" : "Alias name.", @@ -13393,13 +14671,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -13434,13 +14714,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -13467,17 +14749,20 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDR", - "type" : "string" + "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "Alias name.", @@ -13489,7 +14774,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "rename" : { "description" : "Rename an existing alias.", @@ -13503,7 +14789,8 @@ var pveapi = [ "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -13538,13 +14825,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -13598,11 +14887,13 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDR", - "type" : "string" + "type" : "string", + "typetext" : "" }, "comment" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "Alias name.", @@ -13614,13 +14905,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -13659,13 +14952,15 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDRorAlias", - "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "IP set name.", @@ -13677,13 +14972,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -13711,7 +15008,8 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDRorAlias", - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "IP set name.", @@ -13723,13 +15021,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -13757,17 +15057,20 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDRorAlias", - "type" : "string" + "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "IP set name.", @@ -13779,17 +15082,20 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "nomatch" : { "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -13831,13 +15137,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -13872,13 +15180,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -13933,11 +15243,13 @@ var pveapi = [ "cidr" : { "description" : "Network/IP specification in CIDR format.", "format" : "IPorCIDRorAlias", - "type" : "string" + "type" : "string", + "typetext" : "" }, "comment" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "IP set name.", @@ -13949,17 +15261,20 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "nomatch" : { "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -13994,13 +15309,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -14054,13 +15371,15 @@ var pveapi = [ "properties" : { "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "name" : { "description" : "IP set name.", @@ -14072,7 +15391,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "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.", @@ -14086,7 +15406,8 @@ var pveapi = [ "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -14121,13 +15442,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -14240,28 +15563,33 @@ var pveapi = [ "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "dhcp" : { "description" : "Enable DHCP.", "optional" : 1, - "type" : "boolean" + "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" + "type" : "string", + "typetext" : "" }, "enable" : { "description" : "Enable/disable firewall rules.", "optional" : 1, - "type" : "boolean" + "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" + "type" : "boolean", + "typetext" : "" }, "log_level_in" : { "description" : "Log level for incoming traffic.", @@ -14298,17 +15626,20 @@ var pveapi = [ "macfilter" : { "description" : "Enable/disable MAC address filter.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "ndp" : { "description" : "Enable NDP.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "policy_in" : { "description" : "Input policy.", @@ -14333,13 +15664,15 @@ var pveapi = [ "radv" : { "description" : "Allow sending Router Advertisement.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -14375,23 +15708,27 @@ var pveapi = [ "limit" : { "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "start" : { "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -14440,7 +15777,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "type" : { "description" : "Only list references of specified type.", @@ -14455,7 +15793,8 @@ var pveapi = [ "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -14508,13 +15847,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -14561,12 +15902,14 @@ var pveapi = [ "ds" : { "description" : "The list of datasources you want to display.", "format" : "pve-configid-list", - "type" : "string" + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "timeframe" : { "description" : "Specify the time frame you are interested in.", @@ -14583,7 +15926,8 @@ var pveapi = [ "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -14632,7 +15976,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "timeframe" : { "description" : "Specify the time frame you are interested in.", @@ -14649,7 +15994,8 @@ var pveapi = [ "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -14688,18 +16034,21 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" }, "websocket" : { "description" : "use websocket instead of standard VNC.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" } } }, @@ -14751,24 +16100,28 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "port" : { "description" : "Port number returned by previous vncproxy call.", "maximum" : 5999, "minimum" : 5900, - "type" : "integer" + "type" : "integer", + "typetext" : " (5900 - 5999)" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "vncticket" : { "description" : "Ticket from previous call to vncproxy.", "maxLength" : 512, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -14808,19 +16161,22 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -14872,30 +16228,35 @@ var pveapi = [ "additionalProperties" : 0, "properties" : { "force" : { - "description" : "Force migration despite local bind / device mounts. WARNING: identical bind / device mounts need to be available on the target node.", + "description" : "Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "online" : { "description" : "Use online/live migration.", "optional" : 1, - "type" : "boolean" + "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -14939,20 +16300,23 @@ 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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -14993,18 +16357,21 @@ var pveapi = [ "experimental" : { "default" : 0, "description" : "The template feature is experimental, set this flag if you know what you are doing.", - "type" : "boolean" + "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -15041,61 +16408,71 @@ var pveapi = [ "description" : { "description" : "Description for the new CT.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "experimental" : { "default" : 0, "description" : "The clone feature is experimental, set this flag if you know what you are doing.", - "type" : "boolean" + "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" + "type" : "boolean", + "typetext" : "" }, "hostname" : { "description" : "Set a hostname for the new CT.", "format" : "dns-name", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "newid" : { "description" : "VMID for the clone.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "pool" : { "description" : "Add the new CT to the specified pool.", "format" : "pve-poolid", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "snapname" : { "description" : "The name of the snapshot.", "format" : "pve-configid", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "storage" : { "description" : "Target storage for full clone.", "format" : "pve-storage-id", "optional" : 1, "requires" : "full", - "type" : "string" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -15145,7 +16522,7 @@ var pveapi = [ { "info" : { "PUT" : { - "description" : "Resize a container mountpoint.", + "description" : "Resize a container mount point.", "method" : "PUT", "name" : "resize_vm", "parameters" : { @@ -15155,7 +16532,8 @@ var pveapi = [ "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" : "" }, "disk" : { "description" : "The disk you want to resize.", @@ -15177,7 +16555,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "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.", @@ -15188,7 +16567,8 @@ var pveapi = [ "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -15227,13 +16607,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -15262,13 +16644,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -15311,7 +16695,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -15367,7 +16752,16 @@ var pveapi = [ "default" : 1, "description" : "Attach a console device (/dev/console) to the container.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" + }, + "cores" : { + "description" : "The number of cores assigned to the container. A container can use all available cores by default.", + "maximum" : 128, + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - 128)" }, "cpulimit" : { "default" : 0, @@ -15375,7 +16769,8 @@ var pveapi = [ "maximum" : 128, "minimum" : 0, "optional" : 1, - "type" : "number" + "type" : "number", + "typetext" : " (0 - 128)" }, "cpuunits" : { "default" : 1024, @@ -15383,29 +16778,34 @@ var pveapi = [ "maximum" : 500000, "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - 500000)" }, "description" : { "description" : "Container description. Only used on the configuration web interface.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "force" : { "description" : "Allow to overwrite existing container.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "hostname" : { "description" : "Set a host name for the container.", "format" : "dns-name", "maxLength" : 255, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "ignore-unpack-errors" : { "description" : "Ignore errors when extracting the template.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "lock" : { "description" : "Lock/unlock the VM.", @@ -15423,7 +16823,8 @@ var pveapi = [ "description" : "Amount of RAM for the VM in MB.", "minimum" : 16, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (16 - N)" }, "mp[n]" : { "description" : "Use volume as container mount point.", @@ -15434,15 +16835,17 @@ var pveapi = [ "type" : "boolean" }, "backup" : { - "description" : "Whether to include the mountpoint in backups.", + "description" : "Whether to include the mount point in backups.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "verbose_description" : "Whether to include the mount point in backups (only used for volume mount points)." }, "mp" : { - "description" : "Path to the mountpoint as seen from inside the container.", + "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" + "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)", @@ -15450,10 +16853,17 @@ var pveapi = [ "type" : "boolean" }, "ro" : { - "description" : "Read-only mountpoint (not supported with bind mounts)", + "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", @@ -15470,13 +16880,15 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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" + "type" : "string", + "typetext" : "" }, "net[n]" : { "description" : "Specifies network interfaces for the container.", @@ -15548,8 +16960,8 @@ var pveapi = [ }, "tag" : { "description" : "VLAN tag for this interface.", - "maximum" : "4094", - "minimum" : "1", + "maximum" : 4094, + "minimum" : 1, "optional" : 1, "type" : "integer" }, @@ -15570,23 +16982,27 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "onboot" : { "default" : 0, "description" : "Specifies whether a VM will be started during system bootup.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "ostemplate" : { "description" : "The OS template or backup file.", "maxLength" : 255, - "type" : "string" + "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.", @@ -15598,6 +17014,7 @@ var pveapi = [ "opensuse", "archlinux", "alpine", + "gentoo", "unmanaged" ], "optional" : 1, @@ -15607,24 +17024,28 @@ var pveapi = [ "description" : "Sets root password inside container.", "minLength" : 5, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "pool" : { "description" : "Add the VM to the specified pool.", "format" : "pve-poolid", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "protection" : { "default" : 0, "description" : "Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "restore" : { "description" : "Mark this as restore task.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "rootfs" : { "description" : "Use volume as container root.", @@ -15640,10 +17061,17 @@ var pveapi = [ "type" : "boolean" }, "ro" : { - "description" : "Read-only mountpoint (not supported with bind mounts)", + "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", @@ -15660,18 +17088,21 @@ var pveapi = [ } }, "optional" : 1, - "type" : "string" + "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" + "type" : "string", + "typetext" : "" }, "ssh-public-keys" : { "description" : "Setup public SSH keys (one key per line, OpenSSH format).", "optional" : 1, - "type" : "string" + "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.", @@ -15685,20 +17116,23 @@ var pveapi = [ "description" : "Default Storage.", "format" : "pve-storage-id", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "swap" : { "default" : 512, "description" : "Amount of SWAP for the VM in MB.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "template" : { "default" : 0, "description" : "Enable/disable Template.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "tty" : { "default" : 2, @@ -15706,25 +17140,29 @@ var pveapi = [ "maximum" : 6, "minimum" : 0, "optional" : 1, - "type" : "integer" + "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" + "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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -15761,11 +17199,13 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "osdid" : { "description" : "OSD ID", - "type" : "integer" + "type" : "integer", + "typetext" : "" } } }, @@ -15801,11 +17241,13 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "osdid" : { "description" : "OSD ID", - "type" : "integer" + "type" : "integer", + "typetext" : "" } } }, @@ -15842,16 +17284,19 @@ var pveapi = [ "default" : 0, "description" : "If set, we remove partition table entries.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "osdid" : { "description" : "OSD ID", - "type" : "integer" + "type" : "integer", + "typetext" : "" } } }, @@ -15878,7 +17323,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -15909,7 +17355,8 @@ var pveapi = [ "properties" : { "dev" : { "description" : "Block device name.", - "type" : "string" + "type" : "string", + "typetext" : "" }, "fstype" : { "default" : "xfs", @@ -15925,12 +17372,14 @@ var pveapi = [ "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" + "type" : "string", + "typetext" : "" } } }, @@ -15957,7 +17406,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "type" : { "description" : "Only list specific types of disks.", @@ -16038,7 +17488,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -16076,12 +17527,14 @@ var pveapi = [ "properties" : { "monid" : { "description" : "Monitor ID", - "type" : "integer" + "type" : "integer", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -16117,7 +17570,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -16166,7 +17620,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -16204,12 +17659,14 @@ var pveapi = [ "format" : "CIDR", "maxLength" : 128, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "pg_bits" : { "default" : 6, @@ -16217,7 +17674,8 @@ var pveapi = [ "maximum" : 14, "minimum" : 6, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (6 - 14)" }, "size" : { "default" : 2, @@ -16225,7 +17683,8 @@ var pveapi = [ "maximum" : 3, "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - 3)" } } }, @@ -16261,7 +17720,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "service" : { "description" : "Ceph service name.", @@ -16303,7 +17763,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "service" : { "description" : "Ceph service name.", @@ -16345,7 +17806,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -16383,14 +17845,23 @@ var pveapi = [ "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" + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -16426,7 +17897,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -16481,7 +17953,8 @@ var pveapi = [ "maximum" : 32768, "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - 32768)" }, "min_size" : { "default" : 1, @@ -16489,16 +17962,19 @@ var pveapi = [ "maximum" : 3, "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - 3)" }, "name" : { "description" : "The name of the pool. It must be unique.", - "type" : "string" + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "pg_num" : { "default" : 64, @@ -16506,7 +17982,8 @@ var pveapi = [ "maximum" : 32768, "minimum" : 8, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (8 - 32768)" }, "size" : { "default" : 2, @@ -16514,7 +17991,8 @@ var pveapi = [ "maximum" : 3, "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - 3)" } } }, @@ -16550,7 +18028,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -16589,17 +18068,20 @@ var pveapi = [ "limit" : { "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "start" : { "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" } } }, @@ -16648,7 +18130,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -16684,6 +18167,45 @@ var pveapi = [ "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" : { "description" : "Create backup.", @@ -16696,14 +18218,16 @@ var pveapi = [ "default" : 0, "description" : "Backup all known guest systems on this host.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "bwlimit" : { "default" : 0, "description" : "Limit I/O bandwidth (KBytes per second).", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "compress" : { "default" : "0", @@ -16720,19 +18244,22 @@ var pveapi = [ "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" + "type" : "string", + "typetext" : "" }, "exclude-path" : { "description" : "Exclude certain files/directories (shell globs).", "format" : "string-alist", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "ionice" : { "default" : 7, @@ -16740,14 +18267,16 @@ var pveapi = [ "maximum" : 8, "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - 8)" }, "lockwait" : { "default" : 180, "description" : "Maximal time to wait for the global lock (minutes).", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "mailnotification" : { "default" : "always", @@ -16763,14 +18292,16 @@ var pveapi = [ "description" : "Comma-separated list of email addresses that should receive email notifications.", "format" : "string-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "maxfiles" : { "default" : 1, "description" : "Maximal number of backup files per guest system.", "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" }, "mode" : { "default" : "snapshot", @@ -16787,83 +18318,96 @@ var pveapi = [ "description" : "Only run if executed on this node.", "format" : "pve-node", "optional" : 1, - "type" : "string" + "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" + "type" : "integer", + "typetext" : "" }, "quiet" : { "default" : 0, "description" : "Be quiet.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "remove" : { "default" : 1, "description" : "Remove old backup files if there are more than 'maxfiles' backup files.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "script" : { "description" : "Use specified hook script.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "size" : { "default" : 1024, "description" : "Unused, will be removed in a future release.", "minimum" : 500, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (500 - N)" }, "stdexcludes" : { "default" : 1, "description" : "Exclude temporary files and logs.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "stdout" : { "description" : "Write tar to stdout, not to a file.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "stop" : { "default" : 0, "description" : "Stop runnig backup jobs on this host.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "stopwait" : { "default" : 10, "description" : "Maximal time to wait until a guest system is stopped (minutes).", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "The ID of the guest system you want to backup.", "format" : "pve-vmid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, "permissions" : { - "description" : "The user needs 'VM.Backup' permissions on any VM, and 'Datastore.AllocateSpace' on the backup storage.", + "description" : "The user needs 'VM.Backup' permissions on any VM, and 'Datastore.AllocateSpace' on the backup storage. The 'maxfiles', 'tmpdir', 'dumpdir', 'script', 'bwlimit' and 'ionice' parameters are restricted to the 'root@pam' user.", "user" : "all" }, "protected" : 1, @@ -16873,7 +18417,7 @@ var pveapi = [ } } }, - "leaf" : 1, + "leaf" : 0, "path" : "/nodes/{node}/vzdump", "text" : "vzdump" }, @@ -16893,7 +18437,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "service" : { "description" : "Service ID", @@ -16952,7 +18497,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "service" : { "description" : "Service ID", @@ -17010,7 +18556,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "service" : { "description" : "Service ID", @@ -17068,7 +18615,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "service" : { "description" : "Service ID", @@ -17126,7 +18674,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "service" : { "description" : "Service ID", @@ -17184,7 +18733,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "service" : { "description" : "Service ID", @@ -17254,7 +18804,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -17300,7 +18851,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -17323,12 +18875,14 @@ var pveapi = [ "default" : 0, "description" : "Always connect to server, even if we have up to date info inside local cache.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -17347,12 +18901,14 @@ var pveapi = [ "properties" : { "key" : { "description" : "Proxmox VE subscription key", - "type" : "string" + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -17383,12 +18939,14 @@ var pveapi = [ "format" : "pve-iface", "maxLength" : 20, "minLength" : 2, - "type" : "string" + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -17419,12 +18977,14 @@ var pveapi = [ "format" : "pve-iface", "maxLength" : 20, "minLength" : 2, - "type" : "string" + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -17462,19 +19022,22 @@ var pveapi = [ "format" : "ipv4", "optional" : 1, "requires" : "netmask", - "type" : "string" + "type" : "string", + "typetext" : "" }, "address6" : { "description" : "IP address.", "format" : "ipv6", "optional" : 1, "requires" : "netmask6", - "type" : "string" + "type" : "string", + "typetext" : "" }, "autostart" : { "description" : "Automatically start interface on boot.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "bond_mode" : { "description" : "Bonding mode.", @@ -17507,54 +19070,63 @@ var pveapi = [ "description" : "Specify the iterfaces you want to add to your bridge.", "format" : "pve-iface-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "bridge_vlan_aware" : { "description" : "Enable bridge vlan support.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "comments" : { "description" : "Comments", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "comments6" : { "description" : "Comments", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "delete" : { "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "gateway" : { "description" : "Default gateway address.", "format" : "ipv4", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "gateway6" : { "description" : "Default ipv6 gateway address.", "format" : "ipv6", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "iface" : { "description" : "Network interface name.", "format" : "pve-iface", "maxLength" : 20, "minLength" : 2, - "type" : "string" + "type" : "string", + "typetext" : "" }, "netmask" : { "description" : "Network mask.", "format" : "ipv4mask", "optional" : 1, "requires" : "address", - "type" : "string" + "type" : "string", + "typetext" : "" }, "netmask6" : { "description" : "Network mask.", @@ -17562,49 +19134,57 @@ var pveapi = [ "minimum" : 0, "optional" : 1, "requires" : "address6", - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - 128)" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "ovs_bonds" : { "description" : "Specify the interfaces used by the bonding device.", "format" : "pve-iface-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "ovs_bridge" : { "description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port.", "format" : "pve-iface", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "ovs_options" : { "description" : "OVS interface options.", "maxLength" : 1024, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "ovs_ports" : { "description" : "Specify the iterfaces you want to add to your bridge.", "format" : "pve-iface-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "ovs_tag" : { "description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)", "maximum" : 4094, "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - 4094)" }, "slaves" : { "description" : "Specify the interfaces used by the bonding device.", "format" : "pve-iface-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "type" : { "description" : "Network interface type", @@ -17656,7 +19236,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -17685,7 +19266,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "type" : { "description" : "Only list specific interface types.", @@ -17736,19 +19318,22 @@ var pveapi = [ "format" : "ipv4", "optional" : 1, "requires" : "netmask", - "type" : "string" + "type" : "string", + "typetext" : "" }, "address6" : { "description" : "IP address.", "format" : "ipv6", "optional" : 1, "requires" : "netmask6", - "type" : "string" + "type" : "string", + "typetext" : "" }, "autostart" : { "description" : "Automatically start interface on boot.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "bond_mode" : { "description" : "Bonding mode.", @@ -17781,48 +19366,56 @@ var pveapi = [ "description" : "Specify the iterfaces you want to add to your bridge.", "format" : "pve-iface-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "bridge_vlan_aware" : { "description" : "Enable bridge vlan support.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "comments" : { "description" : "Comments", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "comments6" : { "description" : "Comments", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "gateway" : { "description" : "Default gateway address.", "format" : "ipv4", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "gateway6" : { "description" : "Default ipv6 gateway address.", "format" : "ipv6", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "iface" : { "description" : "Network interface name.", "format" : "pve-iface", "maxLength" : 20, "minLength" : 2, - "type" : "string" + "type" : "string", + "typetext" : "" }, "netmask" : { "description" : "Network mask.", "format" : "ipv4mask", "optional" : 1, "requires" : "address", - "type" : "string" + "type" : "string", + "typetext" : "" }, "netmask6" : { "description" : "Network mask.", @@ -17830,49 +19423,57 @@ var pveapi = [ "minimum" : 0, "optional" : 1, "requires" : "address6", - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - 128)" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "ovs_bonds" : { "description" : "Specify the interfaces used by the bonding device.", "format" : "pve-iface-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "ovs_bridge" : { "description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port.", "format" : "pve-iface", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "ovs_options" : { "description" : "OVS interface options.", "maxLength" : 1024, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "ovs_ports" : { "description" : "Specify the iterfaces you want to add to your bridge.", "format" : "pve-iface-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "ovs_tag" : { "description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)", "maximum" : 4094, "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - 4094)" }, "slaves" : { "description" : "Specify the interfaces used by the bonding device.", "format" : "pve-iface-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "type" : { "description" : "Network interface type", @@ -17928,20 +19529,24 @@ var pveapi = [ "limit" : { "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "start" : { "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "upid" : { - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -17985,10 +19590,12 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "upid" : { - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -18031,10 +19638,12 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "upid" : { - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -18058,10 +19667,12 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "upid" : { - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -18098,33 +19709,39 @@ var pveapi = [ "properties" : { "errors" : { "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "limit" : { "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "start" : { "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "userfilter" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "Only list tasks for this VM.", "format" : "pve-vmid", "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -18170,7 +19787,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -18214,11 +19832,13 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "server" : { "format" : "pve-storage-server", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -18265,11 +19885,13 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "server" : { "format" : "pve-storage-server", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -18313,11 +19935,13 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "portal" : { "format" : "pve-storage-portal-dns", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -18364,7 +19988,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -18408,7 +20033,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "vg" : { "maxLength" : 100, @@ -18457,7 +20083,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -18538,7 +20165,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -18586,17 +20214,20 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "volume" : { "description" : "Volume identifier", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -18620,17 +20251,20 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "volume" : { "description" : "Volume identifier", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -18654,27 +20288,32 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "target" : { "description" : "Target volume identifier", - "type" : "string" + "type" : "string", + "typetext" : "" }, "target_node" : { "description" : "Target node. Default is local node.", "format" : "pve-node", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "volume" : { "description" : "Source volume identifier", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -18702,24 +20341,28 @@ var pveapi = [ "description" : "Only list content of this type.", "format" : "pve-storage-content", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "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" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "Only list images for this VM", "format" : "pve-vmid", "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -18764,7 +20407,8 @@ var pveapi = [ "properties" : { "filename" : { "description" : "The name of the file to create.", - "type" : "string" + "type" : "string", + "typetext" : "" }, "format" : { "enum" : [ @@ -18779,7 +20423,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "size" : { "description" : "Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)", @@ -18789,13 +20434,15 @@ var pveapi = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", - "type" : "string" + "type" : "string", + "typetext" : "" }, "vmid" : { "description" : "Specify owner VM", "format" : "pve-vmid", "minimum" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - N)" } } }, @@ -18832,12 +20479,14 @@ var pveapi = [ "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" + "type" : "string", + "typetext" : "" } } }, @@ -18886,17 +20535,20 @@ var pveapi = [ "ds" : { "description" : "The list of datasources you want to display.", "format" : "pve-configid-list", - "type" : "string" + "type" : "string", + "typetext" : "" }, "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" + "type" : "string", + "typetext" : "" }, "timeframe" : { "description" : "Specify the time frame you are interested in.", @@ -18960,12 +20612,14 @@ var pveapi = [ "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" + "type" : "string", + "typetext" : "" }, "timeframe" : { "description" : "Specify the time frame you are interested in.", @@ -19019,26 +20673,31 @@ var pveapi = [ "content" : { "description" : "Content type.", "format" : "pve-storage-content", - "type" : "string" + "type" : "string", + "typetext" : "" }, "filename" : { "description" : "The name of the file to create.", - "type" : "string" + "type" : "string", + "typetext" : "" }, "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" + "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" + "type" : "string", + "typetext" : "" } } }, @@ -19073,12 +20732,14 @@ var pveapi = [ "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" + "type" : "string", + "typetext" : "" } } }, @@ -19130,30 +20791,35 @@ var pveapi = [ "description" : "Only list stores which support this content type.", "format" : "pve-storage-content-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "enabled" : { "default" : 0, "description" : "Only list stores which are enabled (not disabled in config).", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "storage" : { "description" : "Only list status for specified storage", "format" : "pve-storage-id", "optional" : 1, - "type" : "string" + "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" + "type" : "string", + "typetext" : "" } } }, @@ -19186,6 +20852,247 @@ var pveapi = [ "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" + } + } + }, + "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" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "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" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/disks/initgpt", + "text" : "initgpt" + } + ], + "info" : { + "GET" : { + "description" : "Node index.", + "method" : "GET", + "name" : "index", + "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" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/disks", + "text" : "disks" + }, { "children" : [ { @@ -19200,7 +21107,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -19233,19 +21141,22 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "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" + "type" : "boolean", + "typetext" : "" }, "quiet" : { "default" : 0, "description" : "Only produces output suitable for logging, omitting progress indicators.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" } } }, @@ -19280,17 +21191,20 @@ var pveapi = [ "properties" : { "name" : { "description" : "Package name.", - "type" : "string" + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "version" : { "description" : "Package version.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -19325,7 +21239,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -19364,7 +21279,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -19411,18 +21327,21 @@ var pveapi = [ "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" : "" }, "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" + "type" : "integer", + "typetext" : " (0 - N)" } } }, @@ -19451,13 +21370,15 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (0 - N)" } } }, @@ -19496,37 +21417,45 @@ var pveapi = [ "type" : "string" }, "comment" : { + "description" : "Descriptive comment.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "delete" : { "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "optional" : 1, - "type" : "string" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "enable" : { + "description" : "Flag to enable/disable a rule.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "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.", @@ -19534,49 +21463,59 @@ var pveapi = [ "maxLength" : 20, "minLength" : 2, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "macro" : { + "description" : "Use predefined standard macro.", "maxLength" : 128, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "moveto" : { "description" : "Move rule to new position . Other arguments are ignored.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "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" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "type" : { + "description" : "Rule type.", "enum" : [ "in", "out", @@ -19619,7 +21558,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -19667,31 +21607,38 @@ var pveapi = [ "type" : "string" }, "comment" : { + "description" : "Descriptive comment.", "optional" : 1, - "type" : "string" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "enable" : { + "description" : "Flag to enable/disable a rule.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "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.", @@ -19699,43 +21646,52 @@ var pveapi = [ "maxLength" : 20, "minLength" : 2, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "macro" : { + "description" : "Use predefined standard macro.", "maxLength" : 128, "optional" : 1, - "type" : "string" + "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" + "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" + "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" + "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" + "type" : "string", + "typetext" : "" }, "type" : { + "description" : "Rule type.", "enum" : [ "in", "out", @@ -19778,7 +21734,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -19905,18 +21862,21 @@ var pveapi = [ "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "enable" : { "description" : "Enable host firewall rules.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "log_level_in" : { "description" : "Log level for incoming traffic.", @@ -19953,29 +21913,34 @@ var pveapi = [ "ndp" : { "description" : "Enable NDP.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "nf_conntrack_max" : { "description" : "Maximum number of tracked connections.", "minimum" : 32768, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (32768 - N)" }, "nf_conntrack_tcp_timeout_established" : { "description" : "Conntrack established timeout.", "minimum" : 7875, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (7875 - N)" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "nosmurfs" : { "description" : "Enable SMURFS filter.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "smurf_log_level" : { "description" : "Log level for SMURFS filter.", @@ -20012,7 +21977,8 @@ var pveapi = [ "tcpflags" : { "description" : "Filter illegal combinations of TCP flags.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" } } }, @@ -20048,17 +22014,20 @@ var pveapi = [ "limit" : { "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "start" : { "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" } } }, @@ -20107,7 +22076,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -20145,7 +22115,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -20185,7 +22156,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -20222,7 +22194,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -20258,7 +22231,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -20296,12 +22270,14 @@ var pveapi = [ "properties" : { "commands" : { "description" : "JSON encoded array of commands.", - "type" : "string" + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -20347,12 +22323,14 @@ var pveapi = [ "ds" : { "description" : "The list of datasources you want to display.", "format" : "pve-configid-list", - "type" : "string" + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "timeframe" : { "description" : "Specify the time frame you are interested in.", @@ -20412,7 +22390,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "timeframe" : { "description" : "Specify the time frame you are interested in.", @@ -20462,12 +22441,14 @@ var pveapi = [ "limit" : { "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "since" : { "description" : "Display all log since this date-time string.", @@ -20478,7 +22459,8 @@ var pveapi = [ "start" : { "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "until" : { "description" : "Display all log until this date-time string.", @@ -20533,18 +22515,21 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "upgrade" : { "default" : 0, "description" : "Run 'apt-get dist-upgrade' instead of normal shell.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "websocket" : { "description" : "use websocket instead of standard vnc.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" } } }, @@ -20597,18 +22582,21 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "port" : { "description" : "Port number returned by previous vncproxy call.", "maximum" : 5999, "minimum" : 5900, - "type" : "integer" + "type" : "integer", + "typetext" : " (5900 - 5999)" }, "vncticket" : { "description" : "Ticket from previous call to vncproxy.", "maxLength" : 512, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -20648,19 +22636,22 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "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" + "type" : "string", + "typetext" : "" }, "upgrade" : { "default" : 0, "description" : "Run 'apt-get dist-upgrade' instead of normal shell.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" } } }, @@ -20715,7 +22706,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -20767,28 +22759,33 @@ var pveapi = [ "description" : "First name server IP address.", "format" : "ip", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "dns2" : { "description" : "Second name server IP address.", "format" : "ip", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "dns3" : { "description" : "Third name server IP address.", "format" : "ip", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "search" : { "description" : "Search domain for host-name lookup.", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -20824,7 +22821,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -20869,11 +22867,13 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "timezone" : { "description" : "Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names.", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -20909,7 +22909,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -20935,17 +22936,20 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "storage" : { - "description" : "Only list status for specified storage", + "description" : "The storage where the template will be stored", "format" : "pve-storage-id", - "type" : "string" + "type" : "string", + "typetext" : "" }, "template" : { "description" : "The template wich will downloaded", "maxLength" : 255, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -20981,7 +22985,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -21017,12 +23022,14 @@ var pveapi = [ "force" : { "description" : "force if onboot=0.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -21058,7 +23065,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -21095,17 +23103,20 @@ var pveapi = [ "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" + "type" : "integer", + "typetext" : " (1 - N)" }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" }, "target" : { "description" : "Target node.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -21141,7 +23152,8 @@ var pveapi = [ "node" : { "description" : "The cluster node name.", "format" : "pve-node", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -21212,7 +23224,8 @@ var pveapi = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -21240,7 +23253,8 @@ var pveapi = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -21265,80 +23279,108 @@ var pveapi = [ "blocksize" : { "description" : "block size", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "comstar_hg" : { "description" : "host group for comstar views", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "comstar_tg" : { "description" : "target group for comstar views", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "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" + "type" : "string", + "typetext" : "" }, "delete" : { "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "maxLength" : 4096, "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "disable" : { "description" : "Flag to disable the storage.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "format" : { "description" : "Default image format.", "format" : "pve-storage-format", "optional" : 1, - "type" : "string" + "type" : "string", + "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, + "type" : "boolean", + "typetext" : "" }, "krbd" : { "description" : "Access rbd through krbd kernel module.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "maxfiles" : { "description" : "Maximal number of backup files per VM. Use '0' for unlimted.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" + }, + "mkdir" : { + "default" : "yes", + "description" : "Create the directory if it doesn't exist.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, "nodes" : { "description" : "List of cluster node names.", "format" : "pve-node-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "nowritecache" : { "description" : "disable write caching on the target", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "options" : { "description" : "NFS mount options (see 'man nfs')", "format" : "pve-storage-options", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "pool" : { "description" : "Pool.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "redundancy" : { "default" : 2, @@ -21346,45 +23388,59 @@ var pveapi = [ "maximum" : 16, "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - 16)" }, "saferemove" : { "description" : "Zero-out data when removing LVs.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "saferemove_throughput" : { "description" : "Wipe throughput (cstream -t parameter value).", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "server" : { "description" : "Server IP or DNS name.", "format" : "pve-storage-server", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "server2" : { "description" : "Backup volfile server IP or DNS name.", "format" : "pve-storage-server", "optional" : 1, "requires" : "server", - "type" : "string" + "type" : "string", + "typetext" : "" }, "shared" : { "description" : "Mark storage as shared.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "sparse" : { "description" : "use sparse volumes", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", - "type" : "string" + "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", @@ -21399,7 +23455,8 @@ var pveapi = [ "username" : { "description" : "RBD Id.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" } }, "type" : "object" @@ -21485,106 +23542,140 @@ var pveapi = [ "authsupported" : { "description" : "Authsupported.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "base" : { "description" : "Base volume. This volume is automatically activated.", "format" : "pve-volume-id", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "blocksize" : { "description" : "block size", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "comstar_hg" : { "description" : "host group for comstar views", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "comstar_tg" : { "description" : "target group for comstar views", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "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" + "type" : "string", + "typetext" : "" }, "disable" : { "description" : "Flag to disable the storage.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "export" : { "description" : "NFS export path.", "format" : "pve-storage-path", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "format" : { "description" : "Default image format.", "format" : "pve-storage-format", "optional" : 1, - "type" : "string" + "type" : "string", + "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, + "type" : "boolean", + "typetext" : "" }, "iscsiprovider" : { "description" : "iscsi provider", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "krbd" : { "description" : "Access rbd through krbd kernel module.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "maxfiles" : { "description" : "Maximal number of backup files per VM. Use '0' for unlimted.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" + }, + "mkdir" : { + "default" : "yes", + "description" : "Create the directory if it doesn't exist.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, "monhost" : { "description" : "Monitors daemon ips.", + "format" : "pve-storage-portal-dns-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "nodes" : { "description" : "List of cluster node names.", "format" : "pve-node-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "nowritecache" : { "description" : "disable write caching on the target", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "options" : { "description" : "NFS mount options (see 'man nfs')", "format" : "pve-storage-options", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "path" : { "description" : "File system path.", "format" : "pve-storage-path", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "pool" : { "description" : "Pool.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "portal" : { "description" : "iSCSI portal (IP or DNS name with optional port).", "format" : "pve-storage-portal-dns", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "redundancy" : { "default" : 2, @@ -21592,56 +23683,72 @@ var pveapi = [ "maximum" : 16, "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - 16)" }, "saferemove" : { "description" : "Zero-out data when removing LVs.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "saferemove_throughput" : { "description" : "Wipe throughput (cstream -t parameter value).", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "server" : { "description" : "Server IP or DNS name.", "format" : "pve-storage-server", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "server2" : { "description" : "Backup volfile server IP or DNS name.", "format" : "pve-storage-server", "optional" : 1, "requires" : "server", - "type" : "string" + "type" : "string", + "typetext" : "" }, "shared" : { "description" : "Mark storage as shared.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "sparse" : { "description" : "use sparse volumes", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", - "type" : "string" + "type" : "string", + "typetext" : "" + }, + "tagged_only" : { + "description" : "Only use logical volumes tagged with 'pve-vm-ID'.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, "target" : { "description" : "iSCSI target.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "thinpool" : { "description" : "LVM thin pool LV name.", "format" : "pve-storage-vgname", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "transport" : { "description" : "Gluster transport: tcp or rdma", @@ -21674,18 +23781,21 @@ var pveapi = [ "username" : { "description" : "RBD Id.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "vgname" : { "description" : "Volume group name.", "format" : "pve-storage-vgname", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "volume" : { "description" : "Glusterfs Volume.", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" } }, "type" : "object" @@ -21726,7 +23836,8 @@ var pveapi = [ "description" : "User ID", "format" : "pve-userid", "maxLength" : 64, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -21761,7 +23872,8 @@ var pveapi = [ "description" : "User ID", "format" : "pve-userid", "maxLength" : 64, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -21820,51 +23932,61 @@ var pveapi = [ "append" : { "optional" : 1, "requires" : "groups", - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "comment" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "email" : { "format" : "email-opt", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "enable" : { "description" : "Enable/disable the account.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "expire" : { "description" : "Account expiration date (seconds since epoch). '0' means no expiration date.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "firstname" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "groups" : { "format" : "pve-groupid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "keys" : { "description" : "Keys for two factor auth (yubico).", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "lastname" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "userid" : { "description" : "User ID", "format" : "pve-userid", "maxLength" : 64, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -21900,7 +24022,8 @@ var pveapi = [ "enabled" : { "description" : "Optional filter for enable property.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" } } }, @@ -21935,55 +24058,65 @@ var pveapi = [ "properties" : { "comment" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "email" : { "format" : "email-opt", "optional" : 1, - "type" : "string" + "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" + "type" : "boolean", + "typetext" : "" }, "expire" : { "description" : "Account expiration date (seconds since epoch). '0' means no expiration date.", "minimum" : 0, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (0 - N)" }, "firstname" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "groups" : { "format" : "pve-groupid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "keys" : { "description" : "Keys for two factor auth (yubico).", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "lastname" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "password" : { "description" : "Initial password.", "maxLength" : 64, "minLength" : 5, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "userid" : { "description" : "User ID", "format" : "pve-userid", "maxLength" : 64, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -22028,7 +24161,8 @@ var pveapi = [ "properties" : { "groupid" : { "format" : "pve-groupid", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -22055,7 +24189,8 @@ var pveapi = [ "properties" : { "groupid" : { "format" : "pve-groupid", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -22097,11 +24232,13 @@ var pveapi = [ "properties" : { "comment" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "groupid" : { "format" : "pve-groupid", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -22164,11 +24301,13 @@ var pveapi = [ "properties" : { "comment" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "groupid" : { "format" : "pve-groupid", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -22204,7 +24343,8 @@ var pveapi = [ "properties" : { "roleid" : { "format" : "pve-roleid", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -22231,7 +24371,8 @@ var pveapi = [ "properties" : { "roleid" : { "format" : "pve-roleid", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -22250,15 +24391,18 @@ var pveapi = [ "append" : { "optional" : 1, "requires" : "privs", - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "privs" : { "format" : "pve-priv-list", - "type" : "string" + "type" : "string", + "typetext" : "" }, "roleid" : { "format" : "pve-roleid", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -22321,11 +24465,13 @@ var pveapi = [ "privs" : { "format" : "pve-priv-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "roleid" : { "format" : "pve-roleid", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -22400,34 +24546,40 @@ var pveapi = [ "delete" : { "description" : "Remove permissions (instead of adding it).", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "groups" : { "description" : "List of groups.", "format" : "pve-groupid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "path" : { "description" : "Access control path", - "type" : "string" + "type" : "string", + "typetext" : "" }, "propagate" : { "default" : 1, "description" : "Allow to propagate (inherit) permissions.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "roles" : { "description" : "List of roles.", "format" : "pve-roleid-list", - "type" : "string" + "type" : "string", + "typetext" : "" }, "users" : { "description" : "List of users.", "format" : "pve-userid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -22462,7 +24614,8 @@ var pveapi = [ "description" : "Authentication domain ID", "format" : "pve-realm", "maxLength" : 32, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -22491,7 +24644,8 @@ var pveapi = [ "description" : "Authentication domain ID", "format" : "pve-realm", "maxLength" : 32, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -22523,29 +24677,40 @@ var pveapi = [ "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" + "type" : "string", + "typetext" : "" }, "default" : { "description" : "Use this as default realm", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "delete" : { "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", "maxLength" : 4096, "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.", "maxLength" : 40, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "domain" : { "description" : "AD domain name", @@ -22559,39 +24724,45 @@ var pveapi = [ "maximum" : 65535, "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - 65535)" }, "realm" : { "description" : "Authentication domain ID", "format" : "pve-realm", "maxLength" : 32, - "type" : "string" + "type" : "string", + "typetext" : "" }, "secure" : { "description" : "Use secure LDAPS protocol.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "server1" : { "description" : "Server IP address (or DNS name)", "format" : "address", "maxLength" : 256, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "server2" : { "description" : "Fallback Server IP address (or DNS name)", "format" : "address", "maxLength" : 256, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "tfa" : { "description" : "Use Two-factor authentication.", "format" : "pve-tfa-config", "maxLength" : 128, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "user_attr" : { "description" : "LDAP user attribute name", @@ -22680,16 +24851,25 @@ var pveapi = [ "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" + "type" : "string", + "typetext" : "" }, "default" : { "description" : "Use this as default realm", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "domain" : { "description" : "AD domain name", @@ -22703,39 +24883,45 @@ var pveapi = [ "maximum" : 65535, "minimum" : 1, "optional" : 1, - "type" : "integer" + "type" : "integer", + "typetext" : " (1 - 65535)" }, "realm" : { "description" : "Authentication domain ID", "format" : "pve-realm", "maxLength" : 32, - "type" : "string" + "type" : "string", + "typetext" : "" }, "secure" : { "description" : "Use secure LDAPS protocol.", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "server1" : { "description" : "Server IP address (or DNS name)", "format" : "address", "maxLength" : 256, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "server2" : { "description" : "Fallback Server IP address (or DNS name)", "format" : "address", "maxLength" : 256, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "tfa" : { "description" : "Use Two-factor authentication.", "format" : "pve-tfa-config", "maxLength" : 128, "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "type" : { "description" : "Realm type.", @@ -22802,18 +24988,21 @@ var pveapi = [ "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" + "type" : "string", + "typetext" : "" }, "path" : { "description" : "Verify ticket, and check if user have access 'privs' on 'path'", "maxLength" : 64, "optional" : 1, "requires" : "privs", - "type" : "string" + "type" : "string", + "typetext" : "" }, "privs" : { "description" : "Verify ticket, and check if user have access 'privs' on 'path'", @@ -22821,19 +25010,22 @@ var pveapi = [ "maxLength" : 64, "optional" : 1, "requires" : "path", - "type" : "string" + "type" : "string", + "typetext" : "" }, "realm" : { "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" + "type" : "string", + "typetext" : "" }, "username" : { "description" : "User name", "maxLength" : 64, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -22877,13 +25069,15 @@ var pveapi = [ "description" : "The new password.", "maxLength" : 64, "minLength" : 5, - "type" : "string" + "type" : "string", + "typetext" : "" }, "userid" : { "description" : "User ID", "format" : "pve-userid", "maxLength" : 64, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -22968,7 +25162,8 @@ var pveapi = [ "properties" : { "poolid" : { "format" : "pve-poolid", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -22996,7 +25191,8 @@ var pveapi = [ "properties" : { "poolid" : { "format" : "pve-poolid", - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -23061,28 +25257,33 @@ var pveapi = [ "properties" : { "comment" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "delete" : { "description" : "Remove vms/storage (instead of adding it).", "optional" : 1, - "type" : "boolean" + "type" : "boolean", + "typetext" : "" }, "poolid" : { "format" : "pve-poolid", - "type" : "string" + "type" : "string", + "typetext" : "" }, "storage" : { "description" : "List of storage IDs.", "format" : "pve-storage-id-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "vms" : { "description" : "List of virtual machines.", "format" : "pve-vmid-list", "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" } } }, @@ -23146,11 +25347,13 @@ var pveapi = [ "properties" : { "comment" : { "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "poolid" : { "format" : "pve-poolid", - "type" : "string" + "type" : "string", + "typetext" : "" } } },