]> git.proxmox.com Git - pve-docs.git/commitdiff
update static and schema information
authorThomas Lamprecht <t.lamprecht@proxmox.com>
Fri, 7 May 2021 16:48:47 +0000 (18:48 +0200)
committerThomas Lamprecht <t.lamprecht@proxmox.com>
Fri, 7 May 2021 16:48:52 +0000 (18:48 +0200)
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
api-viewer/apidata.js
pvenode.1-synopsis.adoc

index 0b4879e9d73ff69cf96c89bfa733db89e689a1a1..ad92e12aa98b5c29ade6134395748fd4487bb1d9 100644 (file)
@@ -5062,6 +5062,7 @@ var pveapi = [
                                           "ali",
                                           "anx",
                                           "arvan",
+                                          "aurora",
                                           "autodns",
                                           "aws",
                                           "azure",
@@ -5152,6 +5153,7 @@ var pveapi = [
                                           "pdns",
                                           "pleskxml",
                                           "pointhq",
+                                          "porkbun",
                                           "rackcorp",
                                           "rackspace",
                                           "rcode0",
@@ -5168,6 +5170,7 @@ var pveapi = [
                                           "variomedia",
                                           "vscale",
                                           "vultr",
+                                          "websupport",
                                           "world4you",
                                           "yandex",
                                           "zilore",
@@ -5318,6 +5321,7 @@ var pveapi = [
                                     "ali",
                                     "anx",
                                     "arvan",
+                                    "aurora",
                                     "autodns",
                                     "aws",
                                     "azure",
@@ -5408,6 +5412,7 @@ var pveapi = [
                                     "pdns",
                                     "pleskxml",
                                     "pointhq",
+                                    "porkbun",
                                     "rackcorp",
                                     "rackspace",
                                     "rcode0",
@@ -5424,6 +5429,7 @@ var pveapi = [
                                     "variomedia",
                                     "vscale",
                                     "vultr",
+                                    "websupport",
                                     "world4you",
                                     "yandex",
                                     "zilore",
@@ -6859,6 +6865,7 @@ var pveapi = [
                                     },
                                     "ipam" : {
                                        "description" : "use a specific ipam",
+                                       "optional" : 1,
                                        "type" : "string",
                                        "typetext" : "<string>"
                                     },
@@ -6968,7 +6975,7 @@ var pveapi = [
                                  "typetext" : "<boolean>"
                               },
                               "type" : {
-                                 "description" : "Only list sdn zones of specific type",
+                                 "description" : "Only list SDN zones of specific type",
                                  "enum" : [
                                     "evpn",
                                     "faucet",
@@ -7085,6 +7092,7 @@ var pveapi = [
                               },
                               "ipam" : {
                                  "description" : "use a specific ipam",
+                                 "optional" : 1,
                                  "type" : "string",
                                  "typetext" : "<string>"
                               },
@@ -32232,6 +32240,229 @@ var pveapi = [
                },
                {
                   "children" : [
+                     {
+                        "info" : {
+                           "GET" : {
+                              "allowtoken" : 1,
+                              "description" : "Get the currently configured vzdump defaults.",
+                              "method" : "GET",
+                              "name" : "defaults",
+                              "parameters" : {
+                                 "additionalProperties" : 0,
+                                 "properties" : {
+                                    "node" : {
+                                       "description" : "The cluster node name.",
+                                       "format" : "pve-node",
+                                       "type" : "string",
+                                       "typetext" : "<string>"
+                                    },
+                                    "storage" : {
+                                       "description" : "The storage identifier.",
+                                       "format" : "pve-storage-id",
+                                       "optional" : 1,
+                                       "type" : "string",
+                                       "typetext" : "<string>"
+                                    }
+                                 }
+                              },
+                              "permissions" : {
+                                 "description" : "The user needs 'Datastore.Audit' or 'Datastore.AllocateSpace' permissions for the specified storage (or default storage if none specified). Some properties are only returned when the user has 'Sys.Audit' permissions for the node.",
+                                 "user" : "all"
+                              },
+                              "proxyto" : "node",
+                              "returns" : {
+                                 "additionalProperties" : 0,
+                                 "properties" : {
+                                    "all" : {
+                                       "default" : 0,
+                                       "description" : "Backup all known guest systems on this host.",
+                                       "optional" : 1,
+                                       "type" : "boolean"
+                                    },
+                                    "bwlimit" : {
+                                       "default" : 0,
+                                       "description" : "Limit I/O bandwidth (KBytes per second).",
+                                       "minimum" : 0,
+                                       "optional" : 1,
+                                       "type" : "integer"
+                                    },
+                                    "compress" : {
+                                       "default" : "0",
+                                       "description" : "Compress dump file.",
+                                       "enum" : [
+                                          "0",
+                                          "1",
+                                          "gzip",
+                                          "lzo",
+                                          "zstd"
+                                       ],
+                                       "optional" : 1,
+                                       "type" : "string"
+                                    },
+                                    "dumpdir" : {
+                                       "description" : "Store resulting files to specified directory.",
+                                       "optional" : 1,
+                                       "type" : "string"
+                                    },
+                                    "exclude" : {
+                                       "description" : "Exclude specified guest systems (assumes --all)",
+                                       "format" : "pve-vmid-list",
+                                       "optional" : 1,
+                                       "type" : "string"
+                                    },
+                                    "exclude-path" : {
+                                       "description" : "Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root,  other paths match relative to each subdirectory.",
+                                       "format" : "string-alist",
+                                       "optional" : 1,
+                                       "type" : "string"
+                                    },
+                                    "ionice" : {
+                                       "default" : 7,
+                                       "description" : "Set CFQ ionice priority.",
+                                       "maximum" : 8,
+                                       "minimum" : 0,
+                                       "optional" : 1,
+                                       "type" : "integer"
+                                    },
+                                    "lockwait" : {
+                                       "default" : 180,
+                                       "description" : "Maximal time to wait for the global lock (minutes).",
+                                       "minimum" : 0,
+                                       "optional" : 1,
+                                       "type" : "integer"
+                                    },
+                                    "mailnotification" : {
+                                       "default" : "always",
+                                       "description" : "Specify when to send an email",
+                                       "enum" : [
+                                          "always",
+                                          "failure"
+                                       ],
+                                       "optional" : 1,
+                                       "type" : "string"
+                                    },
+                                    "mailto" : {
+                                       "description" : "Comma-separated list of email addresses or users that should receive email notifications.",
+                                       "format" : "email-or-username-list",
+                                       "optional" : 1,
+                                       "type" : "string"
+                                    },
+                                    "maxfiles" : {
+                                       "default" : 1,
+                                       "description" : "Maximal number of backup files per guest system.",
+                                       "minimum" : 1,
+                                       "optional" : 1,
+                                       "type" : "integer"
+                                    },
+                                    "mode" : {
+                                       "default" : "snapshot",
+                                       "description" : "Backup mode.",
+                                       "enum" : [
+                                          "snapshot",
+                                          "suspend",
+                                          "stop"
+                                       ],
+                                       "optional" : 1,
+                                       "type" : "string"
+                                    },
+                                    "node" : {
+                                       "description" : "Only run if executed on this node.",
+                                       "format" : "pve-node",
+                                       "optional" : 1,
+                                       "type" : "string"
+                                    },
+                                    "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"
+                                    },
+                                    "pool" : {
+                                       "description" : "Backup all known guest systems included in the specified pool.",
+                                       "optional" : 1,
+                                       "type" : "string"
+                                    },
+                                    "prune-backups" : {
+                                       "description" : "Use these retention options instead of those from the storage configuration.",
+                                       "format" : "prune-backups",
+                                       "optional" : 1,
+                                       "type" : "string"
+                                    },
+                                    "quiet" : {
+                                       "default" : 0,
+                                       "description" : "Be quiet.",
+                                       "optional" : 1,
+                                       "type" : "boolean"
+                                    },
+                                    "remove" : {
+                                       "default" : 1,
+                                       "description" : "Remove old backup files if there are more than 'maxfiles' backup files.",
+                                       "optional" : 1,
+                                       "type" : "boolean"
+                                    },
+                                    "script" : {
+                                       "description" : "Use specified hook script.",
+                                       "optional" : 1,
+                                       "type" : "string"
+                                    },
+                                    "size" : {
+                                       "default" : 1024,
+                                       "description" : "Unused, will be removed in a future release.",
+                                       "minimum" : 500,
+                                       "optional" : 1,
+                                       "type" : "integer"
+                                    },
+                                    "stdexcludes" : {
+                                       "default" : 1,
+                                       "description" : "Exclude temporary files and logs.",
+                                       "optional" : 1,
+                                       "type" : "boolean"
+                                    },
+                                    "stop" : {
+                                       "default" : 0,
+                                       "description" : "Stop running backup jobs on this host.",
+                                       "optional" : 1,
+                                       "type" : "boolean"
+                                    },
+                                    "stopwait" : {
+                                       "default" : 10,
+                                       "description" : "Maximal time to wait until a guest system is stopped (minutes).",
+                                       "minimum" : 0,
+                                       "optional" : 1,
+                                       "type" : "integer"
+                                    },
+                                    "storage" : {
+                                       "description" : "Store resulting file to this storage.",
+                                       "format" : "pve-storage-id",
+                                       "optional" : 1,
+                                       "type" : "string"
+                                    },
+                                    "tmpdir" : {
+                                       "description" : "Store temporary files to specified directory.",
+                                       "optional" : 1,
+                                       "type" : "string"
+                                    },
+                                    "vmid" : {
+                                       "description" : "The ID of the guest system you want to backup.",
+                                       "format" : "pve-vmid-list",
+                                       "optional" : 1,
+                                       "type" : "string"
+                                    },
+                                    "zstd" : {
+                                       "default" : 1,
+                                       "description" : "Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count.",
+                                       "optional" : 1,
+                                       "type" : "integer"
+                                    }
+                                 },
+                                 "type" : "object"
+                              }
+                           }
+                        },
+                        "leaf" : 1,
+                        "path" : "/nodes/{node}/vzdump/defaults",
+                        "text" : "defaults"
+                     },
                      {
                         "info" : {
                            "GET" : {
@@ -40183,8 +40414,8 @@ var pveapi = [
                                  "default" : "login",
                                  "description" : "Run specific command or default to login.",
                                  "enum" : [
-                                    "ceph_install",
                                     "upgrade",
+                                    "ceph_install",
                                     "login"
                                  ],
                                  "optional" : 1,
@@ -40286,8 +40517,8 @@ var pveapi = [
                                  "default" : "login",
                                  "description" : "Run specific command or default to login.",
                                  "enum" : [
-                                    "ceph_install",
                                     "upgrade",
+                                    "ceph_install",
                                     "login"
                                  ],
                                  "optional" : 1,
@@ -40419,8 +40650,8 @@ var pveapi = [
                                  "default" : "login",
                                  "description" : "Run specific command or default to login.",
                                  "enum" : [
-                                    "ceph_install",
                                     "upgrade",
+                                    "ceph_install",
                                     "login"
                                  ],
                                  "optional" : 1,
index eeeca67fcd5995cb2622014b4efdeb1b7c545f42..e20b0c126662999c3ed7be48dd2aabf2629a807a 100644 (file)
@@ -81,7 +81,7 @@ ACME challenge type.
 
 ACME Plugin ID name
 
-`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | vscale | vultr | world4you | yandex | zilore | zone | zonomi>` ::
+`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | vscale | vultr | websupport | world4you | yandex | zilore | zone | zonomi>` ::
 
 API plugin name
 
@@ -133,7 +133,7 @@ Update ACME plugin configuration.
 
 ACME Plugin ID name
 
-`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | vscale | vultr | world4you | yandex | zilore | zone | zonomi>` ::
+`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | vscale | vultr | websupport | world4you | yandex | zilore | zone | zonomi>` ::
 
 API plugin name