From c30bb419ced3266828f7450636222006368914d6 Mon Sep 17 00:00:00 2001 From: Thomas Lamprecht Date: Mon, 4 Apr 2022 14:16:48 +0200 Subject: [PATCH] update static/schema information Signed-off-by: Thomas Lamprecht --- api-viewer/apidata.js | 255 +++++++++++++++++++++++++++++++---- pct.1-synopsis.adoc | 4 + pve-firewall-rules-opts.adoc | 33 +---- pvesm.1-synopsis.adoc | 8 ++ pveum.1-synopsis.adoc | 26 +++- 5 files changed, 276 insertions(+), 50 deletions(-) diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index 5b793ee..781c4c8 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -7050,6 +7050,13 @@ const apiSchema = [ "type" : "boolean", "typetext" : "" }, + "exitnodes-primary" : { + "description" : "Force traffic to this exitnode first.", + "format" : "pve-node", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "ipam" : { "description" : "use a specific ipam", "optional" : 1, @@ -7089,6 +7096,13 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "rt-import" : { + "description" : "Route-Target import", + "format" : "pve-sdn-bgp-rt-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "tag" : { "description" : "Service-VLAN Tag", "minimum" : 0, @@ -7295,6 +7309,13 @@ const apiSchema = [ "type" : "boolean", "typetext" : "" }, + "exitnodes-primary" : { + "description" : "Force traffic to this exitnode first.", + "format" : "pve-node", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "ipam" : { "description" : "use a specific ipam", "optional" : 1, @@ -7334,6 +7355,13 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "rt-import" : { + "description" : "Route-Target import", + "format" : "pve-sdn-bgp-rt-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "tag" : { "description" : "Service-VLAN Tag", "minimum" : 0, @@ -7482,9 +7510,16 @@ const apiSchema = [ "properties" : { "asn" : { "description" : "autonomous system number", + "maximum" : 4294967296, + "minimum" : 0, "optional" : 1, "type" : "integer", - "typetext" : "" + "typetext" : " (0 - 4294967296)" + }, + "bgp-multipath-as-path-relax" : { + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, "controller" : { "description" : "The SDN controller object identifier.", @@ -7636,9 +7671,16 @@ const apiSchema = [ "properties" : { "asn" : { "description" : "autonomous system number", + "maximum" : 4294967296, + "minimum" : 0, "optional" : 1, "type" : "integer", - "typetext" : "" + "typetext" : " (0 - 4294967296)" + }, + "bgp-multipath-as-path-relax" : { + "optional" : 1, + "type" : "boolean", + "typetext" : "" }, "controller" : { "description" : "The SDN controller object identifier.", @@ -8874,7 +8916,7 @@ const apiSchema = [ "info" : { "GET" : { "allowtoken" : 1, - "description" : "Get next free VMID. If you pass an VMID it will raise an error if the ID is already used.", + "description" : "Get next free VMID. Pass a VMID to assert that its free (at time of check).", "method" : "GET", "name" : "nextid", "parameters" : { @@ -25147,7 +25189,7 @@ const apiSchema = [ "description" : "Extra mount options for rootfs/mps.", "format_description" : "opt[;opt...]", "optional" : 1, - "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)", + "pattern" : "(?^:(?^:(noatime|lazytime|nodev|nosuid|noexec))(;(?^:(noatime|lazytime|nodev|nosuid|noexec)))*)", "type" : "string" }, "mp" : { @@ -25340,7 +25382,7 @@ const apiSchema = [ "description" : "Extra mount options for rootfs/mps.", "format_description" : "opt[;opt...]", "optional" : 1, - "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)", + "pattern" : "(?^:(?^:(noatime|lazytime|nodev|nosuid|noexec))(;(?^:(noatime|lazytime|nodev|nosuid|noexec)))*)", "type" : "string" }, "quota" : { @@ -25649,7 +25691,7 @@ const apiSchema = [ "description" : "Extra mount options for rootfs/mps.", "format_description" : "opt[;opt...]", "optional" : 1, - "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)", + "pattern" : "(?^:(?^:(noatime|lazytime|nodev|nosuid|noexec))(;(?^:(noatime|lazytime|nodev|nosuid|noexec)))*)", "type" : "string" }, "mp" : { @@ -25860,7 +25902,7 @@ const apiSchema = [ "description" : "Extra mount options for rootfs/mps.", "format_description" : "opt[;opt...]", "optional" : 1, - "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)", + "pattern" : "(?^:(?^:(noatime|lazytime|nodev|nosuid|noexec))(;(?^:(noatime|lazytime|nodev|nosuid|noexec)))*)", "type" : "string" }, "quota" : { @@ -29178,6 +29220,13 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "target-storage" : { + "description" : "Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.", + "format" : "storage-pair-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "timeout" : { "default" : 180, "description" : "Timeout in seconds for shutdown for restart migration", @@ -31389,7 +31438,7 @@ const apiSchema = [ "description" : "Extra mount options for rootfs/mps.", "format_description" : "opt[;opt...]", "optional" : 1, - "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)", + "pattern" : "(?^:(?^:(noatime|lazytime|nodev|nosuid|noexec))(;(?^:(noatime|lazytime|nodev|nosuid|noexec)))*)", "type" : "string" }, "mp" : { @@ -31619,7 +31668,7 @@ const apiSchema = [ "description" : "Extra mount options for rootfs/mps.", "format_description" : "opt[;opt...]", "optional" : 1, - "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)", + "pattern" : "(?^:(?^:(noatime|lazytime|nodev|nosuid|noexec))(;(?^:(noatime|lazytime|nodev|nosuid|noexec)))*)", "type" : "string" }, "quota" : { @@ -41905,6 +41954,85 @@ const apiSchema = [ }, "proxyto" : "node", "returns" : { + "properties" : { + "acme" : { + "description" : "Node specific ACME settings.", + "format" : { + "account" : { + "default" : "default", + "description" : "ACME account config file name.", + "format" : "pve-configid", + "format_description" : "name", + "optional" : 1, + "type" : "string" + }, + "domains" : { + "description" : "List of domains for this node's ACME certificate", + "format" : "pve-acme-domain-list", + "format_description" : "domain[;domain;...]", + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string" + }, + "acmedomain[n]" : { + "description" : "ACME domain and validation plugin", + "format" : { + "alias" : { + "description" : "Alias for the Domain to verify ACME Challenge over DNS", + "format" : "pve-acme-alias", + "format_description" : "domain", + "optional" : 1, + "type" : "string" + }, + "domain" : { + "default_key" : 1, + "description" : "domain for this node's ACME certificate", + "format" : "pve-acme-domain", + "format_description" : "domain", + "type" : "string" + }, + "plugin" : { + "default" : "standalone", + "description" : "The ACME plugin ID", + "format" : "pve-configid", + "format_description" : "name of the plugin configuration", + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string" + }, + "description" : { + "description" : "Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file.", + "maxLength" : 65536, + "optional" : 1, + "type" : "string" + }, + "digest" : { + "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", + "maxLength" : 40, + "optional" : 1, + "type" : "string" + }, + "startall-onboot-delay" : { + "default" : 0, + "description" : "Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled.", + "maximum" : 300, + "minimum" : 0, + "optional" : 1, + "type" : "integer" + }, + "wakeonlan" : { + "description" : "MAC address for wake on LAN", + "format" : "mac-addr", + "optional" : 1, + "type" : "string" + } + }, "type" : "object" } }, @@ -42810,8 +42938,8 @@ const apiSchema = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ - "ceph_install", "upgrade", + "ceph_install", "login" ], "optional" : 1, @@ -42906,8 +43034,8 @@ const apiSchema = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ - "ceph_install", "upgrade", + "ceph_install", "login" ], "optional" : 1, @@ -43032,8 +43160,8 @@ const apiSchema = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ - "ceph_install", "upgrade", + "ceph_install", "login" ], "optional" : 1, @@ -44010,6 +44138,12 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "data-pool" : { + "description" : "Data Pool (for erasure coding only)", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "delete" : { "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", @@ -44496,6 +44630,12 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "data-pool" : { + "description" : "Data Pool (for erasure coding only)", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "datastore" : { "description" : "Proxmox Backup Server datastore name.", "optional" : 1, @@ -45484,6 +45624,28 @@ const apiSchema = [ "type" : "string" }, "tokens" : { + "additionalProperties" : { + "properties" : { + "comment" : { + "optional" : 1, + "type" : "string" + }, + "expire" : { + "default" : "same as user", + "description" : "API token expiration date (seconds since epoch). '0' means no expiration date.", + "minimum" : 0, + "optional" : 1, + "type" : "integer" + }, + "privsep" : { + "default" : 1, + "description" : "Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.", + "optional" : 1, + "type" : "boolean" + } + }, + "type" : "object" + }, "optional" : 1, "type" : "object" } @@ -45568,7 +45730,7 @@ const apiSchema = [ "User.Modify" ], "groups_param", - 1 + "update" ] }, "protected" : 1, @@ -45792,7 +45954,7 @@ const apiSchema = [ "User.Modify" ], "groups_param", - 1 + "create" ] ], "description" : "You need 'Realm.AllocateUser' on '/access/realm/' on the realm of user , and 'User.Modify' permissions to '/access/groups/' for any group specified (or 'User.Modify' on '/access/groups' if you pass no groups." @@ -46520,11 +46682,15 @@ const apiSchema = [ "check" : [ "and", [ - "userid-param", - "Realm.AllocateUser" + "perm", + "/access/realm/{realm}", + [ + "Realm.AllocateUser" + ] ], [ - "userid-group", + "perm", + "/access/groups", [ "User.Modify" ] @@ -46615,6 +46781,12 @@ const apiSchema = [ "parameters" : { "additionalProperties" : 0, "properties" : { + "acr-values" : { + "description" : "Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "autocreate" : { "default" : 0, "description" : "Automatically create users if they do not exist.", @@ -46780,6 +46952,12 @@ const apiSchema = [ "type" : "integer", "typetext" : " (1 - 65535)" }, + "prompt" : { + "description" : "Specifies whether the Authorization Server prompts the End-User for reauthentication and consent.", + "optional" : 1, + "pattern" : "(?:none|login|consent|select_account|\\S+)", + "type" : "string" + }, "realm" : { "description" : "Authentication domain ID", "format" : "pve-realm", @@ -46787,6 +46965,13 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "scopes" : { + "default" : "email profile", + "description" : "Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "secure" : { "description" : "Use secure LDAPS protocol. DEPRECATED: use 'mode' instead.", "optional" : 1, @@ -46942,6 +47127,12 @@ const apiSchema = [ "parameters" : { "additionalProperties" : 0, "properties" : { + "acr-values" : { + "description" : "Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "autocreate" : { "default" : 0, "description" : "Automatically create users if they do not exist.", @@ -47092,6 +47283,12 @@ const apiSchema = [ "type" : "integer", "typetext" : " (1 - 65535)" }, + "prompt" : { + "description" : "Specifies whether the Authorization Server prompts the End-User for reauthentication and consent.", + "optional" : 1, + "pattern" : "(?:none|login|consent|select_account|\\S+)", + "type" : "string" + }, "realm" : { "description" : "Authentication domain ID", "format" : "pve-realm", @@ -47099,6 +47296,13 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "scopes" : { + "default" : "email profile", + "description" : "Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "secure" : { "description" : "Use secure LDAPS protocol. DEPRECATED: use 'mode' instead.", "optional" : 1, @@ -47181,13 +47385,9 @@ const apiSchema = [ }, "username-claim" : { "description" : "OpenID claim used to generate the unique username.", - "enum" : [ - "subject", - "username", - "email" - ], "optional" : 1, - "type" : "string" + "type" : "string", + "typetext" : "" }, "verify" : { "default" : 0, @@ -48128,6 +48328,15 @@ const apiSchema = [ "format" : "pve-poolid", "type" : "string", "typetext" : "" + }, + "type" : { + "enum" : [ + "qemu", + "lxc", + "storage" + ], + "optional" : 1, + "type" : "string" } } }, diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc index 4d084af..b756e15 100644 --- a/pct.1-synopsis.adoc +++ b/pct.1-synopsis.adoc @@ -390,6 +390,10 @@ Use online/live migration. Use restart migration +`--target-storage` `` :: + +Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. + `--timeout` `` ('default =' `180`):: Timeout in seconds for shutdown for restart migration diff --git a/pve-firewall-rules-opts.adoc b/pve-firewall-rules-opts.adoc index 3735ab7..4e674af 100644 --- a/pve-firewall-rules-opts.adoc +++ b/pve-firewall-rules-opts.adoc @@ -1,29 +1,18 @@ `--dest` `` :: -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. +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. `--dport` `` :: -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. +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. `--icmp-type` `` :: -Restrict ICMP packets to specific types. You can either use the names as -ip[6]tables ('ip[6]tables -p icmp[v6] -h') provides them, or use the -Type[/Code] value, for example 'network-unreachable' which corresponds to -'3/0'. +Specify icmp-type. Only valid if proto equals 'icmp'. `--iface` `` :: -Network interface name. You have to use network configuration key names for VMs -and containers ('net\d+'). Host related rules can use arbitrary strings. +Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. `--log` `` :: @@ -31,21 +20,13 @@ Log level for firewall rule. `--proto` `` :: -IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as -defined in '/etc/protocols'. +IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. `--source` `` :: -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. +Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. `--sport` `` :: -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. +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. diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index d322974..0c1f369 100644 --- a/pvesm.1-synopsis.adoc +++ b/pvesm.1-synopsis.adoc @@ -42,6 +42,10 @@ Allowed content types. + NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. +`--data-pool` `` :: + +Data Pool (for erasure coding only) + `--datastore` `` :: Proxmox Backup Server datastore name. @@ -586,6 +590,10 @@ Allowed content types. + NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. +`--data-pool` `` :: + +Data Pool (for erasure coding only) + `--delete` `` :: A list of settings you want to delete. diff --git a/pveum.1-synopsis.adoc b/pveum.1-synopsis.adoc index 85765a9..3b38a9f 100644 --- a/pveum.1-synopsis.adoc +++ b/pveum.1-synopsis.adoc @@ -192,6 +192,10 @@ Add an authentication server. Authentication domain ID +`--acr-values` `` :: + +Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. + `--autocreate` `` ('default =' `0`):: Automatically create users if they do not exist. @@ -276,6 +280,14 @@ LDAP bind password. Will be stored in '/etc/pve/priv/realm/.pw'. Server port. +`--prompt` `(?:none|login|consent|select_account|\S+)` :: + +Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. + +`--scopes` `` ('default =' `email profile`):: + +Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. + `--secure` `` :: Use secure LDAPS protocol. DEPRECATED: use 'mode' instead. @@ -316,7 +328,7 @@ LDAP user attribute name The objectclasses for users. -`--username-claim` `` :: +`--username-claim` `` :: OpenID claim used to generate the unique username. @@ -344,6 +356,10 @@ Update authentication server settings. Authentication domain ID +`--acr-values` `` :: + +Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. + `--autocreate` `` ('default =' `0`):: Automatically create users if they do not exist. @@ -436,6 +452,14 @@ LDAP bind password. Will be stored in '/etc/pve/priv/realm/.pw'. Server port. +`--prompt` `(?:none|login|consent|select_account|\S+)` :: + +Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. + +`--scopes` `` ('default =' `email profile`):: + +Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. + `--secure` `` :: Use secure LDAPS protocol. DEPRECATED: use 'mode' instead. -- 2.39.2