From 1c5325464b3b90a1a729f36638f528edc1692347 Mon Sep 17 00:00:00 2001 From: Thomas Lamprecht Date: Mon, 18 Nov 2019 12:51:28 +0100 Subject: [PATCH] update static schema/synopsis definitions Signed-off-by: Thomas Lamprecht --- api-viewer/apidata.js | 1603 ++++++++++++++++++++++++++++++++---- datacenter.cfg.5-opts.adoc | 2 +- ha-manager.1-synopsis.adoc | 62 +- pct.1-synopsis.adoc | 28 +- pct.conf.5-opts.adoc | 2 +- pve-firewall-macros.adoc | 1 + pvenode.1-synopsis.adoc | 9 +- pvesm.1-synopsis.adoc | 4 + qm.1-synopsis.adoc | 41 +- qm.conf.5-opts.adoc | 32 +- 10 files changed, 1593 insertions(+), 191 deletions(-) diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index 73c116e..45c0206 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -3135,6 +3135,8 @@ var pveapi = [ "items" : { "properties" : { "id" : { + "description" : "The job ID.", + "maxLength" : 50, "type" : "string" } }, @@ -4472,6 +4474,828 @@ var pveapi = [ "path" : "/cluster/acme", "text" : "acme" }, + { + "children" : [ + { + "info" : { + "GET" : { + "description" : "Get ceph metadata.", + "method" : "GET", + "name" : "metadata", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit", + "Datastore.Audit" + ], + "any", + 1 + ] + }, + "protected" : 1, + "returns" : { + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/cluster/ceph/metadata", + "text" : "metadata" + }, + { + "info" : { + "GET" : { + "description" : "Get ceph status.", + "method" : "GET", + "name" : "status", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit", + "Datastore.Audit" + ], + "any", + 1 + ] + }, + "protected" : 1, + "returns" : { + "type" : "object" + } + } + }, + "leaf" : 1, + "path" : "/cluster/ceph/status", + "text" : "status" + }, + { + "children" : [ + { + "info" : { + "GET" : { + "description" : "Get the status of a specific ceph flag.", + "method" : "GET", + "name" : "get_flag", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "flag" : { + "description" : "The name of the flag name to get.", + "enum" : [ + "nobackfill", + "nodeep-scrub", + "nodown", + "noin", + "noout", + "norebalance", + "norecover", + "noscrub", + "notieragent", + "noup", + "pause" + ], + "type" : "string" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "boolean" + } + }, + "PUT" : { + "description" : "Set or clear (unset) a specific ceph flag", + "method" : "PUT", + "name" : "update_flag", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "flag" : { + "description" : "The ceph flag to update", + "enum" : [ + "nobackfill", + "nodeep-scrub", + "nodown", + "noin", + "noout", + "norebalance", + "norecover", + "noscrub", + "notieragent", + "noup", + "pause" + ], + "type" : "string" + }, + "value" : { + "description" : "The new value of the flag", + "type" : "boolean", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/cluster/ceph/flags/{flag}", + "text" : "{flag}" + } + ], + "info" : { + "GET" : { + "description" : "get the status of all ceph flags", + "method" : "GET", + "name" : "get_all_flags", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit" + ] + ] + }, + "protected" : 1, + "returns" : { + "items" : { + "additionalProperties" : 1, + "properties" : { + "name" : { + "description" : "Flag name.", + "enum" : [ + "nobackfill", + "nodeep-scrub", + "nodown", + "noin", + "noout", + "norebalance", + "norecover", + "noscrub", + "notieragent", + "noup", + "pause" + ], + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "PUT" : { + "description" : "Set/Unset multiple ceph flags at once.", + "method" : "PUT", + "name" : "set_flags", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "nobackfill" : { + "description" : "Backfilling of PGs is suspended.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "nodeep-scrub" : { + "description" : "Deep Scrubbing is disabled.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "nodown" : { + "description" : "OSD failure reports are being ignored, such that the monitors will not mark OSDs down.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "noin" : { + "description" : "OSDs that were previously marked out will not be marked back in when they start.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "noout" : { + "description" : "OSDs will not automatically be marked out after the configured interval.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "norebalance" : { + "description" : "Rebalancing of PGs is suspended.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "norecover" : { + "description" : "Recovery of PGs is suspended.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "noscrub" : { + "description" : "Scrubbing is disabled.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "notieragent" : { + "description" : "Cache tiering activity is suspended.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "noup" : { + "description" : "OSDs are not allowed to start.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "pause" : { + "description" : "Pauses read and writes.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 0, + "path" : "/cluster/ceph/flags", + "text" : "flags" + } + ], + "info" : { + "GET" : { + "description" : "Cluster ceph index.", + "method" : "GET", + "name" : "cephindex", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/cluster/ceph", + "text" : "ceph" + }, + { + "children" : [ + { + "info" : { + "DELETE" : { + "description" : "Delete sdn object configuration.", + "method" : "DELETE", + "name" : "delete", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "sdn" : { + "description" : "The SDN object identifier.", + "format" : "pve-sdn-id", + "type" : "string", + "typetext" : "" + } + } + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + }, + "GET" : { + "description" : "Read sdn configuration.", + "method" : "GET", + "name" : "read", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "sdn" : { + "description" : "The SDN object identifier.", + "format" : "pve-sdn-id", + "type" : "string", + "typetext" : "" + } + } + }, + "returns" : { + "type" : "object" + } + }, + "PUT" : { + "description" : "Update sdn object configuration.", + "method" : "PUT", + "name" : "update", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "alias" : { + "description" : "alias name of the vnet", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "asn" : { + "description" : "autonomous system number", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "controller" : { + "description" : "Frr router name", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "delete" : { + "description" : "A list of settings you want to delete.", + "format" : "pve-configid-list", + "maxLength" : 4096, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "digest" : { + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", + "maxLength" : 40, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "dp-id" : { + "description" : "Faucet dataplane id", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "gateway-external-peers" : { + "description" : "upstream bgp peers address list.", + "format" : "ip-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "gateway-nodes" : { + "description" : "List of cluster node names.", + "format" : "pve-node-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "ipv4" : { + "description" : "Anycast router ipv4 address.", + "format" : "CIDRv4", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "ipv6" : { + "description" : "Anycast router ipv6 address.", + "format" : "CIDRv6", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "mac" : { + "description" : "Anycast router mac address", + "format" : "mac-addr", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "mtu" : { + "description" : "mtu", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "multicast-address" : { + "description" : "Multicast address.", + "format" : "ipv4-multicast", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "peers" : { + "description" : "peers address list.", + "format" : "ip-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "sdn" : { + "description" : "The SDN object identifier.", + "format" : "pve-sdn-id", + "type" : "string", + "typetext" : "" + }, + "tag" : { + "description" : "vlan or vxlan id", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "transportzone" : { + "description" : "transportzone id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "unicast-address" : { + "description" : "Unicast peers address ip list.", + "format" : "ip-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "uplink-id" : { + "description" : "Uplink interface", + "maximum" : 4096, + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - 4096)" + }, + "vlan-allowed" : { + "description" : "Allowed vlan range", + "format" : "pve-sdn-vlanrange", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "vlan-protocol" : { + "default" : "802.1q", + "description" : "vlan protocol", + "enum" : [ + "802.1q", + "802.1ad" + ], + "optional" : 1, + "type" : "string" + }, + "vrf" : { + "description" : "vrf name.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "vrf-vxlan" : { + "description" : "l3vni.", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "vxlan-allowed" : { + "description" : "Allowed vlan range", + "format" : "pve-sdn-vxlanrange", + "optional" : 1, + "type" : "string", + "typetext" : "" + } + }, + "type" : "object" + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/cluster/sdn/{sdn}", + "text" : "{sdn}" + } + ], + "info" : { + "DELETE" : { + "description" : "Revert sdn changes.", + "method" : "DELETE", + "name" : "revert_configuration", + "parameters" : { + "additionalProperties" : 0 + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + }, + "GET" : { + "description" : "SDN index.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "type" : { + "description" : "Only list sdn of specific type", + "enum" : [ + "evpn", + "evpncontroller", + "faucet", + "faucetcontroller", + "qinq", + "vlan", + "vnet", + "vxlan" + ], + "optional" : 1, + "type" : "string" + } + } + }, + "permissions" : { + "description" : "Only list entries where you have 'SDN.Audit' or 'SDN.Allocate' permissions on '/cluster/sdn/'", + "user" : "all" + }, + "returns" : { + "items" : { + "properties" : { + "role" : { + "type" : "string" + }, + "sdn" : { + "type" : "string" + }, + "type" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{sdn}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "description" : "Create a new sdn object.", + "method" : "POST", + "name" : "create", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "alias" : { + "description" : "alias name of the vnet", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "asn" : { + "description" : "autonomous system number", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "controller" : { + "description" : "Frr router name", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "dp-id" : { + "description" : "Faucet dataplane id", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "gateway-external-peers" : { + "description" : "upstream bgp peers address list.", + "format" : "ip-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "gateway-nodes" : { + "description" : "List of cluster node names.", + "format" : "pve-node-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "ipv4" : { + "description" : "Anycast router ipv4 address.", + "format" : "CIDRv4", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "ipv6" : { + "description" : "Anycast router ipv6 address.", + "format" : "CIDRv6", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "mac" : { + "description" : "Anycast router mac address", + "format" : "mac-addr", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "mtu" : { + "description" : "mtu", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "multicast-address" : { + "description" : "Multicast address.", + "format" : "ipv4-multicast", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "peers" : { + "description" : "peers address list.", + "format" : "ip-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "sdn" : { + "description" : "The SDN object identifier.", + "format" : "pve-sdn-id", + "type" : "string", + "typetext" : "" + }, + "tag" : { + "description" : "vlan or vxlan id", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "transportzone" : { + "description" : "transportzone id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "type" : { + "description" : "Plugin type.", + "enum" : [ + "evpn", + "evpncontroller", + "faucet", + "faucetcontroller", + "qinq", + "vlan", + "vnet", + "vxlan" + ], + "format" : "pve-configid", + "type" : "string" + }, + "unicast-address" : { + "description" : "Unicast peers address ip list.", + "format" : "ip-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "uplink-id" : { + "description" : "Uplink interface", + "maximum" : 4096, + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - 4096)" + }, + "vlan-allowed" : { + "description" : "Allowed vlan range", + "format" : "pve-sdn-vlanrange", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "vlan-protocol" : { + "default" : "802.1q", + "description" : "vlan protocol", + "enum" : [ + "802.1q", + "802.1ad" + ], + "optional" : 1, + "type" : "string" + }, + "vrf" : { + "description" : "vrf name.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "vrf-vxlan" : { + "description" : "l3vni.", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "vxlan-allowed" : { + "description" : "Allowed vlan range", + "format" : "pve-sdn-vxlanrange", + "optional" : 1, + "type" : "string", + "typetext" : "" + } + }, + "type" : "object" + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + }, + "PUT" : { + "description" : "Apply sdn changes.", + "method" : "PUT", + "name" : "apply_configuration", + "parameters" : { + "additionalProperties" : 0 + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 0, + "path" : "/cluster/sdn", + "text" : "sdn" + }, { "info" : { "GET" : { @@ -4519,7 +5343,8 @@ var pveapi = [ "enum" : [ "vm", "storage", - "node" + "node", + "sdn" ], "optional" : 1, "type" : "string" @@ -4610,7 +5435,8 @@ var pveapi = [ "pool", "qemu", "lxc", - "openvz" + "openvz", + "sdn" ], "type" : "string" }, @@ -4828,25 +5654,27 @@ var pveapi = [ "language" : { "description" : "Default GUI language.", "enum" : [ - "zh_CN", - "zh_TW", "ca", + "da", + "de", "en", + "es", "eu", + "fa", "fr", - "de", + "he", "it", - "es", "ja", "nb", "nn", - "fa", "pl", "pt_BR", "ru", "sl", "sv", - "tr" + "tr", + "zh_CN", + "zh_TW" ], "optional" : 1, "type" : "string" @@ -5004,101 +5832,6 @@ var pveapi = [ "leaf" : 1, "path" : "/cluster/nextid", "text" : "nextid" - }, - { - "children" : [ - { - "info" : { - "GET" : { - "description" : "Get ceph metadata.", - "method" : "GET", - "name" : "ceph_metadata", - "parameters" : { - "additionalProperties" : 0 - }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit", - "Datastore.Audit" - ], - "any", - 1 - ] - }, - "protected" : 1, - "returns" : { - "type" : "object" - } - } - }, - "leaf" : 1, - "path" : "/cluster/ceph/metadata", - "text" : "metadata" - }, - { - "info" : { - "GET" : { - "description" : "Get ceph status.", - "method" : "GET", - "name" : "cephstatus", - "parameters" : { - "additionalProperties" : 0 - }, - "permissions" : { - "check" : [ - "perm", - "/", - [ - "Sys.Audit", - "Datastore.Audit" - ], - "any", - 1 - ] - }, - "protected" : 1, - "returns" : { - "type" : "object" - } - } - }, - "leaf" : 1, - "path" : "/cluster/ceph/status", - "text" : "status" - } - ], - "info" : { - "GET" : { - "description" : "Cluster ceph index.", - "method" : "GET", - "name" : "cephindex", - "parameters" : { - "additionalProperties" : 0 - }, - "permissions" : { - "user" : "all" - }, - "returns" : { - "items" : { - "properties" : {}, - "type" : "object" - }, - "links" : [ - { - "href" : "{name}", - "rel" : "child" - } - ], - "type" : "array" - } - } - }, - "leaf" : 0, - "path" : "/cluster/ceph", - "text" : "ceph" } ], "info" : { @@ -7844,7 +8577,7 @@ var pveapi = [ }, "password" : { "description" : "The new password.", - "maxLength" : 64, + "maxLength" : 1024, "minLength" : 5, "type" : "string", "typetext" : "" @@ -8486,6 +9219,31 @@ var pveapi = [ "type" : "string", "verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n" }, + "audio0" : { + "description" : "Configure a audio device, useful in combination with QXL/Spice.", + "format" : { + "device" : { + "description" : "Configure an audio device.", + "enum" : [ + "ich9-intel-hda", + "intel-hda", + "AC97" + ], + "type" : "string" + }, + "driver" : { + "default" : "spice", + "description" : "Driver backend for the audio device.", + "enum" : [ + "spice" + ], + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string" + }, "autostart" : { "default" : 0, "description" : "Automatic restart after crash (currently ignored).", @@ -8575,6 +9333,7 @@ var pveapi = [ "Broadwell-IBRS", "Broadwell-noTSX", "Broadwell-noTSX-IBRS", + "Cascadelake-Server", "Conroe", "core2duo", "coreduo", @@ -8587,6 +9346,7 @@ var pveapi = [ "host", "IvyBridge", "IvyBridge-IBRS", + "KnightsMill", "kvm32", "kvm64", "max", @@ -8616,10 +9376,10 @@ var pveapi = [ "type" : "string" }, "flags" : { - "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'.", + "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.", "format_description" : "+FLAG[;-FLAG...]", "optional" : 1, - "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear)))*)", + "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes)))*)", "type" : "string" }, "hidden" : { @@ -9152,7 +9912,7 @@ var pveapi = [ "description" : "Specifies the Qemu machine type.", "maxLength" : 40, "optional" : 1, - "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)", + "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?)", "type" : "string" }, "memory" : { @@ -10108,6 +10868,30 @@ var pveapi = [ "optional" : 1, "type" : "integer" }, + "spice_enhancements" : { + "description" : "Configure additional enhancements for SPICE.", + "format" : { + "foldersharing" : { + "default" : "0", + "description" : "Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.", + "optional" : 1, + "type" : "boolean" + }, + "videostreaming" : { + "default" : "off", + "description" : "Enable video streaming. Uses compression for detected video streams.", + "enum" : [ + "off", + "all", + "filter" + ], + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string" + }, "sshkeys" : { "description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).", "format" : "urlencoded", @@ -10166,7 +10950,7 @@ var pveapi = [ }, "usb3" : { "default" : 0, - "description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).", + "description" : "Specifies whether if given host option is a USB3 device or port.", "optional" : 1, "type" : "boolean" } @@ -10603,6 +11387,32 @@ var pveapi = [ "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" }, + "audio0" : { + "description" : "Configure a audio device, useful in combination with QXL/Spice.", + "format" : { + "device" : { + "description" : "Configure an audio device.", + "enum" : [ + "ich9-intel-hda", + "intel-hda", + "AC97" + ], + "type" : "string" + }, + "driver" : { + "default" : "spice", + "description" : "Driver backend for the audio device.", + "enum" : [ + "spice" + ], + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "device= [,driver=]" + }, "autostart" : { "default" : 0, "description" : "Automatic restart after crash (currently ignored).", @@ -10706,6 +11516,7 @@ var pveapi = [ "Broadwell-IBRS", "Broadwell-noTSX", "Broadwell-noTSX-IBRS", + "Cascadelake-Server", "Conroe", "core2duo", "coreduo", @@ -10718,6 +11529,7 @@ var pveapi = [ "host", "IvyBridge", "IvyBridge-IBRS", + "KnightsMill", "kvm32", "kvm64", "max", @@ -10747,10 +11559,10 @@ var pveapi = [ "type" : "string" }, "flags" : { - "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'.", + "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.", "format_description" : "+FLAG[;-FLAG...]", "optional" : 1, - "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear)))*)", + "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes)))*)", "type" : "string" }, "hidden" : { @@ -11314,7 +12126,7 @@ var pveapi = [ "description" : "Specifies the Qemu machine type.", "maxLength" : 40, "optional" : 1, - "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)", + "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?)", "type" : "string" }, "memory" : { @@ -12307,6 +13119,31 @@ var pveapi = [ "type" : "integer", "typetext" : " (1 - N)" }, + "spice_enhancements" : { + "description" : "Configure additional enhancements for SPICE.", + "format" : { + "foldersharing" : { + "default" : "0", + "description" : "Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.", + "optional" : 1, + "type" : "boolean" + }, + "videostreaming" : { + "default" : "off", + "description" : "Enable video streaming. Uses compression for detected video streams.", + "enum" : [ + "off", + "all", + "filter" + ], + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[foldersharing=<1|0>] [,videostreaming=]" + }, "sshkeys" : { "description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).", "format" : "urlencoded", @@ -12370,7 +13207,7 @@ var pveapi = [ }, "usb3" : { "default" : 0, - "description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).", + "description" : "Specifies whether if given host option is a USB3 device or port.", "optional" : 1, "type" : "boolean" } @@ -12842,6 +13679,32 @@ var pveapi = [ "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" }, + "audio0" : { + "description" : "Configure a audio device, useful in combination with QXL/Spice.", + "format" : { + "device" : { + "description" : "Configure an audio device.", + "enum" : [ + "ich9-intel-hda", + "intel-hda", + "AC97" + ], + "type" : "string" + }, + "driver" : { + "default" : "spice", + "description" : "Driver backend for the audio device.", + "enum" : [ + "spice" + ], + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "device= [,driver=]" + }, "autostart" : { "default" : 0, "description" : "Automatic restart after crash (currently ignored).", @@ -12937,6 +13800,7 @@ var pveapi = [ "Broadwell-IBRS", "Broadwell-noTSX", "Broadwell-noTSX-IBRS", + "Cascadelake-Server", "Conroe", "core2duo", "coreduo", @@ -12949,6 +13813,7 @@ var pveapi = [ "host", "IvyBridge", "IvyBridge-IBRS", + "KnightsMill", "kvm32", "kvm64", "max", @@ -12978,10 +13843,10 @@ var pveapi = [ "type" : "string" }, "flags" : { - "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'.", + "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.", "format_description" : "+FLAG[;-FLAG...]", "optional" : 1, - "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear)))*)", + "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes)))*)", "type" : "string" }, "hidden" : { @@ -13545,7 +14410,7 @@ var pveapi = [ "description" : "Specifies the Qemu machine type.", "maxLength" : 40, "optional" : 1, - "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)", + "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?)", "type" : "string" }, "memory" : { @@ -14538,6 +15403,31 @@ var pveapi = [ "type" : "integer", "typetext" : " (1 - N)" }, + "spice_enhancements" : { + "description" : "Configure additional enhancements for SPICE.", + "format" : { + "foldersharing" : { + "default" : "0", + "description" : "Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.", + "optional" : 1, + "type" : "boolean" + }, + "videostreaming" : { + "default" : "off", + "description" : "Enable video streaming. Uses compression for detected video streams.", + "enum" : [ + "off", + "all", + "filter" + ], + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[foldersharing=<1|0>] [,videostreaming=]" + }, "sshkeys" : { "description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).", "format" : "urlencoded", @@ -14601,7 +15491,7 @@ var pveapi = [ }, "usb3" : { "default" : 0, - "description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).", + "description" : "Specifies whether if given host option is a USB3 device or port.", "optional" : 1, "type" : "boolean" } @@ -15548,7 +16438,7 @@ var pveapi = [ "description" : "Specifies the Qemu machine type.", "maxLength" : 40, "optional" : 1, - "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)", + "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?)", "type" : "string" }, "migratedfrom" : { @@ -15820,6 +16710,57 @@ var pveapi = [ "path" : "/nodes/{node}/qemu/{vmid}/status/shutdown", "text" : "shutdown" }, + { + "info" : { + "POST" : { + "description" : "Reboot the VM by shutting it down, and starting it again. Applies pending changes.", + "method" : "POST", + "name" : "vm_reboot", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "timeout" : { + "description" : "Wait maximal timeout seconds for the shutdown.", + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - N)" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.PowerMgmt" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/status/reboot", + "text" : "reboot" + }, { "info" : { "POST" : { @@ -16512,7 +17453,7 @@ var pveapi = [ "typetext" : "" }, "online" : { - "description" : "Use online/live migration.", + "description" : "Use online/live migration if VM is running. Ignored if VM is stopped.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -17294,6 +18235,12 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "purge" : { + "description" : "Remove vmid from backup cron jobs.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "skiplock" : { "description" : "Ignore locks - only root is allowed to use this option.", "optional" : 1, @@ -17531,6 +18478,32 @@ var pveapi = [ "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" }, + "audio0" : { + "description" : "Configure a audio device, useful in combination with QXL/Spice.", + "format" : { + "device" : { + "description" : "Configure an audio device.", + "enum" : [ + "ich9-intel-hda", + "intel-hda", + "AC97" + ], + "type" : "string" + }, + "driver" : { + "default" : "spice", + "description" : "Driver backend for the audio device.", + "enum" : [ + "spice" + ], + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "device= [,driver=]" + }, "autostart" : { "default" : 0, "description" : "Automatic restart after crash (currently ignored).", @@ -17634,6 +18607,7 @@ var pveapi = [ "Broadwell-IBRS", "Broadwell-noTSX", "Broadwell-noTSX-IBRS", + "Cascadelake-Server", "Conroe", "core2duo", "coreduo", @@ -17646,6 +18620,7 @@ var pveapi = [ "host", "IvyBridge", "IvyBridge-IBRS", + "KnightsMill", "kvm32", "kvm64", "max", @@ -17675,10 +18650,10 @@ var pveapi = [ "type" : "string" }, "flags" : { - "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'.", + "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.", "format_description" : "+FLAG[;-FLAG...]", "optional" : 1, - "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear)))*)", + "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes)))*)", "type" : "string" }, "hidden" : { @@ -18228,7 +19203,7 @@ var pveapi = [ "description" : "Specifies the Qemu machine type.", "maxLength" : 40, "optional" : 1, - "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)", + "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?)", "type" : "string" }, "memory" : { @@ -19215,6 +20190,31 @@ var pveapi = [ "type" : "integer", "typetext" : " (1 - N)" }, + "spice_enhancements" : { + "description" : "Configure additional enhancements for SPICE.", + "format" : { + "foldersharing" : { + "default" : "0", + "description" : "Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.", + "optional" : 1, + "type" : "boolean" + }, + "videostreaming" : { + "default" : "off", + "description" : "Enable video streaming. Uses compression for detected video streams.", + "enum" : [ + "off", + "all", + "filter" + ], + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[foldersharing=<1|0>] [,videostreaming=]" + }, "sshkeys" : { "description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).", "format" : "urlencoded", @@ -19299,7 +20299,7 @@ var pveapi = [ }, "usb3" : { "default" : 0, - "description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).", + "description" : "Specifies whether if given host option is a USB3 device or port.", "optional" : 1, "type" : "boolean" } @@ -19725,6 +20725,13 @@ var pveapi = [ "parameters" : { "additionalProperties" : 0, "properties" : { + "current" : { + "default" : 0, + "description" : "Get current values (instead of pending values).", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", @@ -19871,6 +20878,7 @@ var pveapi = [ "enum" : [ "backup", "create", + "destroyed", "disk", "fstrim", "migrate", @@ -20340,6 +21348,7 @@ var pveapi = [ "enum" : [ "backup", "create", + "destroyed", "disk", "fstrim", "migrate", @@ -20568,6 +21577,13 @@ var pveapi = [ "type" : "boolean", "typetext" : "" }, + "revert" : { + "description" : "Revert a pending change.", + "format" : "pve-configid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "rootfs" : { "description" : "Use volume as container root.", "format" : { @@ -24688,6 +25704,75 @@ var pveapi = [ "leaf" : 1, "path" : "/nodes/{node}/lxc/{vmid}/move_volume", "text" : "move_volume" + }, + { + "info" : { + "GET" : { + "description" : "Get container configuration, including pending changes.", + "method" : "GET", + "name" : "vm_pending", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Audit" + ] + ] + }, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "delete" : { + "description" : "Indicates a pending delete request if present and not 0.", + "maximum" : 2, + "minimum" : 0, + "optional" : 1, + "type" : "integer" + }, + "key" : { + "description" : "Configuration option name.", + "type" : "string" + }, + "pending" : { + "description" : "Pending value.", + "optional" : 1, + "type" : "string" + }, + "value" : { + "description" : "Current value.", + "optional" : 1, + "type" : "string" + } + }, + "type" : "object" + }, + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/pending", + "text" : "pending" } ], "info" : { @@ -24704,6 +25789,12 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "purge" : { + "description" : "Remove vmid from backup cron jobs.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", @@ -25010,6 +26101,7 @@ var pveapi = [ "enum" : [ "backup", "create", + "destroyed", "disk", "fstrim", "migrate", @@ -26950,20 +28042,19 @@ var pveapi = [ "additionalProperties" : 0, "properties" : { "flag" : { - "description" : "The ceph flag to set/unset", + "description" : "The ceph flag to unset", "enum" : [ - "full", - "pause", - "noup", + "nobackfill", + "nodeep-scrub", "nodown", - "noout", "noin", - "nobackfill", + "noout", "norebalance", "norecover", "noscrub", - "nodeep-scrub", - "notieragent" + "notieragent", + "noup", + "pause" ], "type" : "string" }, @@ -26991,27 +28082,26 @@ var pveapi = [ } }, "POST" : { - "description" : "Set a ceph flag", + "description" : "Set a specific ceph flag", "method" : "POST", "name" : "set_flag", "parameters" : { "additionalProperties" : 0, "properties" : { "flag" : { - "description" : "The ceph flag to set/unset", + "description" : "The ceph flag to set", "enum" : [ - "full", - "pause", - "noup", + "nobackfill", + "nodeep-scrub", "nodown", - "noout", "noin", - "nobackfill", + "noout", "norebalance", "norecover", "noscrub", - "nodeep-scrub", - "notieragent" + "notieragent", + "noup", + "pause" ], "type" : "string" }, @@ -29823,6 +30913,14 @@ var pveapi = [ "parameters" : { "additionalProperties" : 0, "properties" : { + "delay" : { + "description" : "Time to wait for the task to finish. We return 'null' if the task finish within that time.", + "maximum" : 30, + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - 30)" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", @@ -29850,7 +30948,8 @@ var pveapi = [ "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "null" + "optional" : 1, + "type" : "string" } }, "GET" : { @@ -33018,6 +34117,16 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "public-key-bits" : { + "description" : "Certificate's public key size", + "optional" : 1, + "type" : "integer" + }, + "public-key-type" : { + "description" : "Certificate's public key algorithm", + "optional" : 1, + "type" : "string" + }, "san" : { "description" : "List of Certificate's SubjectAlternativeName entries.", "items" : { @@ -33152,6 +34261,16 @@ var pveapi = [ "optional" : 1, "type" : "string" }, + "public-key-bits" : { + "description" : "Certificate's public key size", + "optional" : 1, + "type" : "integer" + }, + "public-key-type" : { + "description" : "Certificate's public key algorithm", + "optional" : 1, + "type" : "string" + }, "san" : { "description" : "List of Certificate's SubjectAlternativeName entries.", "items" : { @@ -33329,6 +34448,162 @@ var pveapi = [ "path" : "/nodes/{node}/config", "text" : "config" }, + { + "children" : [ + { + "children" : [ + { + "info" : { + "GET" : { + "description" : "List transportzone content.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "sdn" : { + "description" : "The SDN object identifier.", + "format" : "pve-sdn-id", + "type" : "string", + "typetext" : "" + } + } + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "status" : { + "description" : "Status.", + "optional" : 1, + "type" : "string" + }, + "vnet" : { + "description" : "Vnet identifier.", + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{vnet}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/sdn/{sdn}/content", + "text" : "content" + } + ], + "info" : { + "GET" : { + "description" : "", + "method" : "GET", + "name" : "diridx", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "sdn" : { + "description" : "The SDN object identifier.", + "format" : "pve-sdn-id", + "type" : "string", + "typetext" : "" + } + } + }, + "returns" : { + "items" : { + "properties" : { + "subdir" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{subdir}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/sdn/{sdn}", + "text" : "{sdn}" + } + ], + "info" : { + "GET" : { + "description" : "Get status for all transportzones.", + "method" : "GET", + "name" : "index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "description" : "Only list entries where you have 'SDN.Audit'", + "user" : "all" + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "sdn" : { + "description" : "The SDN object identifier.", + "format" : "pve-sdn-id", + "type" : "string" + }, + "status" : { + "description" : "Status of transportzone", + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{sdn}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/sdn", + "text" : "sdn" + }, { "info" : { "GET" : { @@ -33861,9 +35136,9 @@ var pveapi = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ + "login", "upgrade", - "ceph_install", - "login" + "ceph_install" ], "optional" : 1, "type" : "string" @@ -33955,9 +35230,9 @@ var pveapi = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ + "login", "upgrade", - "ceph_install", - "login" + "ceph_install" ], "optional" : 1, "type" : "string" @@ -34078,9 +35353,9 @@ var pveapi = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ + "login", "upgrade", - "ceph_install", - "login" + "ceph_install" ], "optional" : 1, "type" : "string" @@ -34467,14 +35742,15 @@ var pveapi = [ { "info" : { "POST" : { - "description" : "Start all VMs and containers (when onboot=1).", + "description" : "Start all VMs and containers located on this node (by default only those with onboot=1).", "method" : "POST", "name" : "startall", "parameters" : { "additionalProperties" : 0, "properties" : { "force" : { - "description" : "force if onboot=0.", + "default" : "off", + "description" : "Issue start command even if virtual guest have 'onboot' not set or set to off.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -34486,7 +35762,7 @@ var pveapi = [ "typetext" : "" }, "vms" : { - "description" : "Only consider Guests with these IDs.", + "description" : "Only consider guests from this comma separated list of VMIDs.", "format" : "pve-vmid-list", "optional" : 1, "type" : "string", @@ -34786,7 +36062,7 @@ var pveapi = [ "description" : "Used memory in bytes.", "optional" : 1, "renderer" : "bytes", - "type" : "string" + "type" : "integer" }, "node" : { "description" : "The cluster node name.", @@ -36854,6 +38130,17 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "sslversion" : { + "description" : "LDAPS TLS/SSL version. It's not recommended to use version older than 1.2!", + "enum" : [ + "tlsv1", + "tlsv1_1", + "tlsv1_2", + "tlsv1_3" + ], + "optional" : 1, + "type" : "string" + }, "tfa" : { "description" : "Use Two-factor authentication.", "format" : "pve-tfa-config", @@ -37040,6 +38327,17 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "sslversion" : { + "description" : "LDAPS TLS/SSL version. It's not recommended to use version older than 1.2!", + "enum" : [ + "tlsv1", + "tlsv1_1", + "tlsv1_2", + "tlsv1_3" + ], + "optional" : 1, + "type" : "string" + }, "tfa" : { "description" : "Use Two-factor authentication.", "format" : "pve-tfa-config", @@ -37305,9 +38603,10 @@ var pveapi = [ }, "key" : { "description" : "When adding TOTP, the shared secret value.", + "format" : "pve-tfa-secret", "optional" : 1, - "pattern" : "(?^:[A-Z2-7=]{16}|[A-Fa-f0-9]{40})", - "type" : "string" + "type" : "string", + "typetext" : "" }, "password" : { "description" : "The current password.", diff --git a/datacenter.cfg.5-opts.adoc b/datacenter.cfg.5-opts.adoc index 2b9fd21..2ef1792 100644 --- a/datacenter.cfg.5-opts.adoc +++ b/datacenter.cfg.5-opts.adoc @@ -52,7 +52,7 @@ Specify external http proxy which is used for downloads (example: 'http://userna Default keybord layout for vnc server. -`language`: `` :: +`language`: `` :: Default GUI language. diff --git a/ha-manager.1-synopsis.adoc b/ha-manager.1-synopsis.adoc index f91530d..83adbf8 100644 --- a/ha-manager.1-synopsis.adoc +++ b/ha-manager.1-synopsis.adoc @@ -40,6 +40,43 @@ List HA resources. Only list resources of specific type +*ha-manager crm-command migrate* ` ` + +Request resource migration (online) to another node. + +``: `:` :: + +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). + +``: `` :: + +Target node. + +*ha-manager crm-command relocate* ` ` + +Request resource relocatzion to another node. This stops the service on the +old node, and restarts it on the target node. + +``: `:` :: + +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). + +``: `` :: + +Target node. + +*ha-manager crm-command stop* ` ` + +Request the service to be stopped. + +``: `:` :: + +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). + +``: ` (0 - N)` :: + +Timeout in seconds. If set to 0 a hard stop will be performed. + *ha-manager groupadd* ` --nodes ` `[OPTIONS]` Create a new HA group. @@ -124,30 +161,13 @@ Shows help for a specific command Verbose output format. -*ha-manager migrate* ` ` +*ha-manager migrate* -Request resource migration (online) to another node. +An alias for 'ha-manager crm-command migrate'. -``: `:` :: - -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). +*ha-manager relocate* -``: `` :: - -Target node. - -*ha-manager relocate* ` ` - -Request resource relocatzion to another node. This stops the service on the -old node, and restarts it on the target node. - -``: `:` :: - -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). - -``: `` :: - -Target node. +An alias for 'ha-manager crm-command relocate'. *ha-manager remove* `` diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc index e4ebec4..5630a98 100644 --- a/pct.1-synopsis.adoc +++ b/pct.1-synopsis.adoc @@ -52,6 +52,10 @@ Get container configuration. The (unique) ID of the VM. +`--current` `` ('default =' `0`):: + +Get current values (instead of pending values). + `--snapshot` `` :: Fetch config values from given snapshot. @@ -140,7 +144,7 @@ Set a host name for the container. Ignore errors when extracting the template. -`--lock` `` :: +`--lock` `` :: Lock/unlock the VM. @@ -250,7 +254,7 @@ The name of the snapshot. For removal from config file, even if removing disk snapshots fails. -*pct destroy* `` +*pct destroy* `` `[OPTIONS]` Destroy the container (also delete all uses files). @@ -258,6 +262,10 @@ Destroy the container (also delete all uses files). The (unique) ID of the VM. +`--purge` `` :: + +Remove vmid from backup cron jobs. + *pct df* `` Get the container's current disk usage. @@ -404,6 +412,14 @@ Delete the original volume after successful copy. By default the original is kep Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. +*pct pending* `` + +Get container configuration, including pending changes. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + *pct pull* ` ` `[OPTIONS]` Copy a file from the container to the local system. @@ -560,7 +576,7 @@ Set a host name for the container. Ignore errors when extracting the template. -`--lock` `` :: +`--lock` `` :: Lock/unlock the VM. @@ -730,7 +746,7 @@ Script that will be exectued during various steps in the containers lifetime. Set a host name for the container. -`--lock` `` :: +`--lock` `` :: Lock/unlock the VM. @@ -762,6 +778,10 @@ OS type. This is used to setup configuration inside the container, and correspon Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. +`--revert` `` :: + +Revert a pending change. + `--rootfs` `[volume=] [,acl=<1|0>] [,mountoptions=] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: Use volume as container root. diff --git a/pct.conf.5-opts.adoc b/pct.conf.5-opts.adoc index a1be9e7..5035c9b 100644 --- a/pct.conf.5-opts.adoc +++ b/pct.conf.5-opts.adoc @@ -58,7 +58,7 @@ Script that will be exectued during various steps in the containers lifetime. Set a host name for the container. -`lock`: `` :: +`lock`: `` :: Lock/unlock the VM. diff --git a/pve-firewall-macros.adoc b/pve-firewall-macros.adoc index fdb31eb..e971a98 100644 --- a/pve-firewall-macros.adoc +++ b/pve-firewall-macros.adoc @@ -62,6 +62,7 @@ |=========================================================== |Action|proto|dport|sport |PARAM|tcp|6789| +|PARAM|tcp|3300| |PARAM|tcp|6800:7300| |=========================================================== diff --git a/pvenode.1-synopsis.adoc b/pvenode.1-synopsis.adoc index 4c49df2..e6ddecf 100644 --- a/pvenode.1-synopsis.adoc +++ b/pvenode.1-synopsis.adoc @@ -159,15 +159,16 @@ Only consider Guests with these IDs. *pvenode startall* `[OPTIONS]` -Start all VMs and containers (when onboot=1). +Start all VMs and containers located on this node (by default only those +with onboot=1). -`--force` `` :: +`--force` `` ('default =' `off`):: -force if onboot=0. +Issue start command even if virtual guest have 'onboot' not set or set to off. `--vms` `` :: -Only consider Guests with these IDs. +Only consider guests from this comma separated list of VMIDs. *pvenode stopall* `[OPTIONS]` diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index 9e2f16e..e98aa20 100644 --- a/pvesm.1-synopsis.adoc +++ b/pvesm.1-synopsis.adoc @@ -262,6 +262,10 @@ Delete volume Volume identifier +`--delay` ` (1 - 30)` :: + +Time to wait for the task to finish. We return 'null' if the task finish within that time. + `--storage` `` :: The storage identifier. diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index 43c3022..fed122a 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -126,6 +126,10 @@ The backup file. Arbitrary arguments passed to kvm. +`--audio0` `device= [,driver=]` :: + +Configure a audio device, useful in combination with QXL/Spice. + `--autostart` `` ('default =' `0`):: Automatic restart after crash (currently ignored). @@ -255,7 +259,7 @@ Set the real time clock to local time. This is enabled by default if ostype indi Lock/unlock the VM. -`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` :: +`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` :: Specifies the Qemu machine type. @@ -351,6 +355,10 @@ The number of CPUs. Please use option -sockets instead. The number of CPU sockets. +`--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=]` :: + +Configure additional enhancements for SPICE. + `--sshkeys` `` :: cloud-init: Setup public SSH keys (one key per line, OpenSSH format). @@ -445,6 +453,10 @@ Destroy the vm (also delete all used/owned volumes). The (unique) ID of the VM. +`--purge` `` :: + +Remove vmid from backup cron jobs. + `--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -612,7 +624,7 @@ Migration traffic is encrypted using an SSH tunnel by default. On secure, comple `--online` `` :: -Use online/live migration. +Use online/live migration if VM is running. Ignored if VM is stopped. `--targetstorage` `` :: @@ -682,6 +694,19 @@ Get virtual machine configuration, including pending changes. The (unique) ID of the VM. +*qm reboot* `` `[OPTIONS]` + +Reboot the VM by shutting it down, and starting it again. Applies pending +changes. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +`--timeout` ` (0 - N)` :: + +Wait maximal timeout seconds for the shutdown. + *qm rescan* `[OPTIONS]` Rescan all storages and update disk sizes and unused disk images. @@ -800,6 +825,10 @@ Virtual processor architecture. Defaults to the host. Arbitrary arguments passed to kvm. +`--audio0` `device= [,driver=]` :: + +Configure a audio device, useful in combination with QXL/Spice. + `--autostart` `` ('default =' `0`):: Automatic restart after crash (currently ignored). @@ -933,7 +962,7 @@ Set the real time clock to local time. This is enabled by default if ostype indi Lock/unlock the VM. -`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` :: +`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` :: Specifies the Qemu machine type. @@ -1033,6 +1062,10 @@ The number of CPUs. Please use option -sockets instead. The number of CPU sockets. +`--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=]` :: + +Configure additional enhancements for SPICE. + `--sshkeys` `` :: cloud-init: Setup public SSH keys (one key per line, OpenSSH format). @@ -1159,7 +1192,7 @@ Start virtual machine. The (unique) ID of the VM. -`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` :: +`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` :: Specifies the Qemu machine type. diff --git a/qm.conf.5-opts.adoc b/qm.conf.5-opts.adoc index d0685c2..89def92 100644 --- a/qm.conf.5-opts.adoc +++ b/qm.conf.5-opts.adoc @@ -26,6 +26,18 @@ args: -no-reboot -no-hpet + NOTE: this option is for experts only. +`audio0`: `device= [,driver=]` :: + +Configure a audio device, useful in combination with QXL/Spice. + +`device`=`` ;; + +Configure an audio device. + +`driver`=`` ('default =' `spice`);; + +Driver backend for the audio device. + `autostart`: `` ('default =' `0`):: Automatic restart after crash (currently ignored). @@ -86,13 +98,13 @@ The number of cores per socket. Emulated CPU type. -`cputype`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Conroe | EPYC | EPYC-IBPB | Haswell | Haswell-IBRS | Haswell-noTSX | Haswell-noTSX-IBRS | IvyBridge | IvyBridge-IBRS | Nehalem | Nehalem-IBRS | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | SandyBridge-IBRS | Skylake-Client | Skylake-Client-IBRS | Skylake-Server | Skylake-Server-IBRS | Westmere | Westmere-IBRS | athlon | core2duo | coreduo | host | kvm32 | kvm64 | max | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64>` ('default =' `kvm64`);; +`cputype`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Cascadelake-Server | Conroe | EPYC | EPYC-IBPB | Haswell | Haswell-IBRS | Haswell-noTSX | Haswell-noTSX-IBRS | IvyBridge | IvyBridge-IBRS | KnightsMill | Nehalem | Nehalem-IBRS | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | SandyBridge-IBRS | Skylake-Client | Skylake-Client-IBRS | Skylake-Server | Skylake-Server-IBRS | Westmere | Westmere-IBRS | athlon | core2duo | coreduo | host | kvm32 | kvm64 | max | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64>` ('default =' `kvm64`);; Emulated CPU type. `flags`=`<+FLAG[;-FLAG...]>` ;; -List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'. +List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes. `hidden`=`` ('default =' `0`);; @@ -425,7 +437,7 @@ Set the real time clock to local time. This is enabled by default if ostype indi Lock/unlock the VM. -`machine`: `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` :: +`machine`: `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` :: Specifies the Qemu machine type. @@ -991,6 +1003,18 @@ The number of CPUs. Please use option -sockets instead. The number of CPU sockets. +`spice_enhancements`: `[foldersharing=<1|0>] [,videostreaming=]` :: + +Configure additional enhancements for SPICE. + +`foldersharing`=`` ('default =' `0`);; + +Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM. + +`videostreaming`=`` ('default =' `off`);; + +Enable video streaming. Uses compression for detected video streams. + `sshkeys`: `` :: cloud-init: Setup public SSH keys (one key per line, OpenSSH format). @@ -1039,7 +1063,7 @@ The value 'spice' can be used to add a usb redirection devices for spice. `usb3`=`` ('default =' `0`);; -Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored). +Specifies whether if given host option is a USB3 device or port. `vcpus`: ` (1 - N)` ('default =' `0`):: -- 2.39.2