mirror of
https://git.proxmox.com/git/pve-docs
synced 2025-08-05 09:42:49 +00:00
update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht
parent
aa42586806
commit
c30bb419ce
@ -7050,6 +7050,13 @@ const apiSchema = [
|
|||||||
"type" : "boolean",
|
"type" : "boolean",
|
||||||
"typetext" : "<boolean>"
|
"typetext" : "<boolean>"
|
||||||
},
|
},
|
||||||
|
"exitnodes-primary" : {
|
||||||
|
"description" : "Force traffic to this exitnode first.",
|
||||||
|
"format" : "pve-node",
|
||||||
|
"optional" : 1,
|
||||||
|
"type" : "string",
|
||||||
|
"typetext" : "<string>"
|
||||||
|
},
|
||||||
"ipam" : {
|
"ipam" : {
|
||||||
"description" : "use a specific ipam",
|
"description" : "use a specific ipam",
|
||||||
"optional" : 1,
|
"optional" : 1,
|
||||||
@ -7089,6 +7096,13 @@ const apiSchema = [
|
|||||||
"type" : "string",
|
"type" : "string",
|
||||||
"typetext" : "<string>"
|
"typetext" : "<string>"
|
||||||
},
|
},
|
||||||
|
"rt-import" : {
|
||||||
|
"description" : "Route-Target import",
|
||||||
|
"format" : "pve-sdn-bgp-rt-list",
|
||||||
|
"optional" : 1,
|
||||||
|
"type" : "string",
|
||||||
|
"typetext" : "<string>"
|
||||||
|
},
|
||||||
"tag" : {
|
"tag" : {
|
||||||
"description" : "Service-VLAN Tag",
|
"description" : "Service-VLAN Tag",
|
||||||
"minimum" : 0,
|
"minimum" : 0,
|
||||||
@ -7295,6 +7309,13 @@ const apiSchema = [
|
|||||||
"type" : "boolean",
|
"type" : "boolean",
|
||||||
"typetext" : "<boolean>"
|
"typetext" : "<boolean>"
|
||||||
},
|
},
|
||||||
|
"exitnodes-primary" : {
|
||||||
|
"description" : "Force traffic to this exitnode first.",
|
||||||
|
"format" : "pve-node",
|
||||||
|
"optional" : 1,
|
||||||
|
"type" : "string",
|
||||||
|
"typetext" : "<string>"
|
||||||
|
},
|
||||||
"ipam" : {
|
"ipam" : {
|
||||||
"description" : "use a specific ipam",
|
"description" : "use a specific ipam",
|
||||||
"optional" : 1,
|
"optional" : 1,
|
||||||
@ -7334,6 +7355,13 @@ const apiSchema = [
|
|||||||
"type" : "string",
|
"type" : "string",
|
||||||
"typetext" : "<string>"
|
"typetext" : "<string>"
|
||||||
},
|
},
|
||||||
|
"rt-import" : {
|
||||||
|
"description" : "Route-Target import",
|
||||||
|
"format" : "pve-sdn-bgp-rt-list",
|
||||||
|
"optional" : 1,
|
||||||
|
"type" : "string",
|
||||||
|
"typetext" : "<string>"
|
||||||
|
},
|
||||||
"tag" : {
|
"tag" : {
|
||||||
"description" : "Service-VLAN Tag",
|
"description" : "Service-VLAN Tag",
|
||||||
"minimum" : 0,
|
"minimum" : 0,
|
||||||
@ -7482,9 +7510,16 @@ const apiSchema = [
|
|||||||
"properties" : {
|
"properties" : {
|
||||||
"asn" : {
|
"asn" : {
|
||||||
"description" : "autonomous system number",
|
"description" : "autonomous system number",
|
||||||
|
"maximum" : 4294967296,
|
||||||
|
"minimum" : 0,
|
||||||
"optional" : 1,
|
"optional" : 1,
|
||||||
"type" : "integer",
|
"type" : "integer",
|
||||||
"typetext" : "<integer>"
|
"typetext" : "<integer> (0 - 4294967296)"
|
||||||
|
},
|
||||||
|
"bgp-multipath-as-path-relax" : {
|
||||||
|
"optional" : 1,
|
||||||
|
"type" : "boolean",
|
||||||
|
"typetext" : "<boolean>"
|
||||||
},
|
},
|
||||||
"controller" : {
|
"controller" : {
|
||||||
"description" : "The SDN controller object identifier.",
|
"description" : "The SDN controller object identifier.",
|
||||||
@ -7636,9 +7671,16 @@ const apiSchema = [
|
|||||||
"properties" : {
|
"properties" : {
|
||||||
"asn" : {
|
"asn" : {
|
||||||
"description" : "autonomous system number",
|
"description" : "autonomous system number",
|
||||||
|
"maximum" : 4294967296,
|
||||||
|
"minimum" : 0,
|
||||||
"optional" : 1,
|
"optional" : 1,
|
||||||
"type" : "integer",
|
"type" : "integer",
|
||||||
"typetext" : "<integer>"
|
"typetext" : "<integer> (0 - 4294967296)"
|
||||||
|
},
|
||||||
|
"bgp-multipath-as-path-relax" : {
|
||||||
|
"optional" : 1,
|
||||||
|
"type" : "boolean",
|
||||||
|
"typetext" : "<boolean>"
|
||||||
},
|
},
|
||||||
"controller" : {
|
"controller" : {
|
||||||
"description" : "The SDN controller object identifier.",
|
"description" : "The SDN controller object identifier.",
|
||||||
@ -8874,7 +8916,7 @@ const apiSchema = [
|
|||||||
"info" : {
|
"info" : {
|
||||||
"GET" : {
|
"GET" : {
|
||||||
"allowtoken" : 1,
|
"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",
|
"method" : "GET",
|
||||||
"name" : "nextid",
|
"name" : "nextid",
|
||||||
"parameters" : {
|
"parameters" : {
|
||||||
@ -25147,7 +25189,7 @@ const apiSchema = [
|
|||||||
"description" : "Extra mount options for rootfs/mps.",
|
"description" : "Extra mount options for rootfs/mps.",
|
||||||
"format_description" : "opt[;opt...]",
|
"format_description" : "opt[;opt...]",
|
||||||
"optional" : 1,
|
"optional" : 1,
|
||||||
"pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
|
"pattern" : "(?^:(?^:(noatime|lazytime|nodev|nosuid|noexec))(;(?^:(noatime|lazytime|nodev|nosuid|noexec)))*)",
|
||||||
"type" : "string"
|
"type" : "string"
|
||||||
},
|
},
|
||||||
"mp" : {
|
"mp" : {
|
||||||
@ -25340,7 +25382,7 @@ const apiSchema = [
|
|||||||
"description" : "Extra mount options for rootfs/mps.",
|
"description" : "Extra mount options for rootfs/mps.",
|
||||||
"format_description" : "opt[;opt...]",
|
"format_description" : "opt[;opt...]",
|
||||||
"optional" : 1,
|
"optional" : 1,
|
||||||
"pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
|
"pattern" : "(?^:(?^:(noatime|lazytime|nodev|nosuid|noexec))(;(?^:(noatime|lazytime|nodev|nosuid|noexec)))*)",
|
||||||
"type" : "string"
|
"type" : "string"
|
||||||
},
|
},
|
||||||
"quota" : {
|
"quota" : {
|
||||||
@ -25649,7 +25691,7 @@ const apiSchema = [
|
|||||||
"description" : "Extra mount options for rootfs/mps.",
|
"description" : "Extra mount options for rootfs/mps.",
|
||||||
"format_description" : "opt[;opt...]",
|
"format_description" : "opt[;opt...]",
|
||||||
"optional" : 1,
|
"optional" : 1,
|
||||||
"pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
|
"pattern" : "(?^:(?^:(noatime|lazytime|nodev|nosuid|noexec))(;(?^:(noatime|lazytime|nodev|nosuid|noexec)))*)",
|
||||||
"type" : "string"
|
"type" : "string"
|
||||||
},
|
},
|
||||||
"mp" : {
|
"mp" : {
|
||||||
@ -25860,7 +25902,7 @@ const apiSchema = [
|
|||||||
"description" : "Extra mount options for rootfs/mps.",
|
"description" : "Extra mount options for rootfs/mps.",
|
||||||
"format_description" : "opt[;opt...]",
|
"format_description" : "opt[;opt...]",
|
||||||
"optional" : 1,
|
"optional" : 1,
|
||||||
"pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
|
"pattern" : "(?^:(?^:(noatime|lazytime|nodev|nosuid|noexec))(;(?^:(noatime|lazytime|nodev|nosuid|noexec)))*)",
|
||||||
"type" : "string"
|
"type" : "string"
|
||||||
},
|
},
|
||||||
"quota" : {
|
"quota" : {
|
||||||
@ -29178,6 +29220,13 @@ const apiSchema = [
|
|||||||
"type" : "string",
|
"type" : "string",
|
||||||
"typetext" : "<string>"
|
"typetext" : "<string>"
|
||||||
},
|
},
|
||||||
|
"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" : "<string>"
|
||||||
|
},
|
||||||
"timeout" : {
|
"timeout" : {
|
||||||
"default" : 180,
|
"default" : 180,
|
||||||
"description" : "Timeout in seconds for shutdown for restart migration",
|
"description" : "Timeout in seconds for shutdown for restart migration",
|
||||||
@ -31389,7 +31438,7 @@ const apiSchema = [
|
|||||||
"description" : "Extra mount options for rootfs/mps.",
|
"description" : "Extra mount options for rootfs/mps.",
|
||||||
"format_description" : "opt[;opt...]",
|
"format_description" : "opt[;opt...]",
|
||||||
"optional" : 1,
|
"optional" : 1,
|
||||||
"pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
|
"pattern" : "(?^:(?^:(noatime|lazytime|nodev|nosuid|noexec))(;(?^:(noatime|lazytime|nodev|nosuid|noexec)))*)",
|
||||||
"type" : "string"
|
"type" : "string"
|
||||||
},
|
},
|
||||||
"mp" : {
|
"mp" : {
|
||||||
@ -31619,7 +31668,7 @@ const apiSchema = [
|
|||||||
"description" : "Extra mount options for rootfs/mps.",
|
"description" : "Extra mount options for rootfs/mps.",
|
||||||
"format_description" : "opt[;opt...]",
|
"format_description" : "opt[;opt...]",
|
||||||
"optional" : 1,
|
"optional" : 1,
|
||||||
"pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
|
"pattern" : "(?^:(?^:(noatime|lazytime|nodev|nosuid|noexec))(;(?^:(noatime|lazytime|nodev|nosuid|noexec)))*)",
|
||||||
"type" : "string"
|
"type" : "string"
|
||||||
},
|
},
|
||||||
"quota" : {
|
"quota" : {
|
||||||
@ -41905,6 +41954,85 @@ const apiSchema = [
|
|||||||
},
|
},
|
||||||
"proxyto" : "node",
|
"proxyto" : "node",
|
||||||
"returns" : {
|
"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"
|
"type" : "object"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@ -42810,8 +42938,8 @@ const apiSchema = [
|
|||||||
"default" : "login",
|
"default" : "login",
|
||||||
"description" : "Run specific command or default to login.",
|
"description" : "Run specific command or default to login.",
|
||||||
"enum" : [
|
"enum" : [
|
||||||
"ceph_install",
|
|
||||||
"upgrade",
|
"upgrade",
|
||||||
|
"ceph_install",
|
||||||
"login"
|
"login"
|
||||||
],
|
],
|
||||||
"optional" : 1,
|
"optional" : 1,
|
||||||
@ -42906,8 +43034,8 @@ const apiSchema = [
|
|||||||
"default" : "login",
|
"default" : "login",
|
||||||
"description" : "Run specific command or default to login.",
|
"description" : "Run specific command or default to login.",
|
||||||
"enum" : [
|
"enum" : [
|
||||||
"ceph_install",
|
|
||||||
"upgrade",
|
"upgrade",
|
||||||
|
"ceph_install",
|
||||||
"login"
|
"login"
|
||||||
],
|
],
|
||||||
"optional" : 1,
|
"optional" : 1,
|
||||||
@ -43032,8 +43160,8 @@ const apiSchema = [
|
|||||||
"default" : "login",
|
"default" : "login",
|
||||||
"description" : "Run specific command or default to login.",
|
"description" : "Run specific command or default to login.",
|
||||||
"enum" : [
|
"enum" : [
|
||||||
"ceph_install",
|
|
||||||
"upgrade",
|
"upgrade",
|
||||||
|
"ceph_install",
|
||||||
"login"
|
"login"
|
||||||
],
|
],
|
||||||
"optional" : 1,
|
"optional" : 1,
|
||||||
@ -44010,6 +44138,12 @@ const apiSchema = [
|
|||||||
"type" : "string",
|
"type" : "string",
|
||||||
"typetext" : "<string>"
|
"typetext" : "<string>"
|
||||||
},
|
},
|
||||||
|
"data-pool" : {
|
||||||
|
"description" : "Data Pool (for erasure coding only)",
|
||||||
|
"optional" : 1,
|
||||||
|
"type" : "string",
|
||||||
|
"typetext" : "<string>"
|
||||||
|
},
|
||||||
"delete" : {
|
"delete" : {
|
||||||
"description" : "A list of settings you want to delete.",
|
"description" : "A list of settings you want to delete.",
|
||||||
"format" : "pve-configid-list",
|
"format" : "pve-configid-list",
|
||||||
@ -44496,6 +44630,12 @@ const apiSchema = [
|
|||||||
"type" : "string",
|
"type" : "string",
|
||||||
"typetext" : "<string>"
|
"typetext" : "<string>"
|
||||||
},
|
},
|
||||||
|
"data-pool" : {
|
||||||
|
"description" : "Data Pool (for erasure coding only)",
|
||||||
|
"optional" : 1,
|
||||||
|
"type" : "string",
|
||||||
|
"typetext" : "<string>"
|
||||||
|
},
|
||||||
"datastore" : {
|
"datastore" : {
|
||||||
"description" : "Proxmox Backup Server datastore name.",
|
"description" : "Proxmox Backup Server datastore name.",
|
||||||
"optional" : 1,
|
"optional" : 1,
|
||||||
@ -45484,6 +45624,28 @@ const apiSchema = [
|
|||||||
"type" : "string"
|
"type" : "string"
|
||||||
},
|
},
|
||||||
"tokens" : {
|
"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,
|
"optional" : 1,
|
||||||
"type" : "object"
|
"type" : "object"
|
||||||
}
|
}
|
||||||
@ -45568,7 +45730,7 @@ const apiSchema = [
|
|||||||
"User.Modify"
|
"User.Modify"
|
||||||
],
|
],
|
||||||
"groups_param",
|
"groups_param",
|
||||||
1
|
"update"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"protected" : 1,
|
"protected" : 1,
|
||||||
@ -45792,7 +45954,7 @@ const apiSchema = [
|
|||||||
"User.Modify"
|
"User.Modify"
|
||||||
],
|
],
|
||||||
"groups_param",
|
"groups_param",
|
||||||
1
|
"create"
|
||||||
]
|
]
|
||||||
],
|
],
|
||||||
"description" : "You need 'Realm.AllocateUser' on '/access/realm/<realm>' on the realm of user <userid>, and 'User.Modify' permissions to '/access/groups/<group>' for any group specified (or 'User.Modify' on '/access/groups' if you pass no groups."
|
"description" : "You need 'Realm.AllocateUser' on '/access/realm/<realm>' on the realm of user <userid>, and 'User.Modify' permissions to '/access/groups/<group>' for any group specified (or 'User.Modify' on '/access/groups' if you pass no groups."
|
||||||
@ -46520,11 +46682,15 @@ const apiSchema = [
|
|||||||
"check" : [
|
"check" : [
|
||||||
"and",
|
"and",
|
||||||
[
|
[
|
||||||
"userid-param",
|
"perm",
|
||||||
"Realm.AllocateUser"
|
"/access/realm/{realm}",
|
||||||
|
[
|
||||||
|
"Realm.AllocateUser"
|
||||||
|
]
|
||||||
],
|
],
|
||||||
[
|
[
|
||||||
"userid-group",
|
"perm",
|
||||||
|
"/access/groups",
|
||||||
[
|
[
|
||||||
"User.Modify"
|
"User.Modify"
|
||||||
]
|
]
|
||||||
@ -46615,6 +46781,12 @@ const apiSchema = [
|
|||||||
"parameters" : {
|
"parameters" : {
|
||||||
"additionalProperties" : 0,
|
"additionalProperties" : 0,
|
||||||
"properties" : {
|
"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" : "<string>"
|
||||||
|
},
|
||||||
"autocreate" : {
|
"autocreate" : {
|
||||||
"default" : 0,
|
"default" : 0,
|
||||||
"description" : "Automatically create users if they do not exist.",
|
"description" : "Automatically create users if they do not exist.",
|
||||||
@ -46780,6 +46952,12 @@ const apiSchema = [
|
|||||||
"type" : "integer",
|
"type" : "integer",
|
||||||
"typetext" : "<integer> (1 - 65535)"
|
"typetext" : "<integer> (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" : {
|
"realm" : {
|
||||||
"description" : "Authentication domain ID",
|
"description" : "Authentication domain ID",
|
||||||
"format" : "pve-realm",
|
"format" : "pve-realm",
|
||||||
@ -46787,6 +46965,13 @@ const apiSchema = [
|
|||||||
"type" : "string",
|
"type" : "string",
|
||||||
"typetext" : "<string>"
|
"typetext" : "<string>"
|
||||||
},
|
},
|
||||||
|
"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" : "<string>"
|
||||||
|
},
|
||||||
"secure" : {
|
"secure" : {
|
||||||
"description" : "Use secure LDAPS protocol. DEPRECATED: use 'mode' instead.",
|
"description" : "Use secure LDAPS protocol. DEPRECATED: use 'mode' instead.",
|
||||||
"optional" : 1,
|
"optional" : 1,
|
||||||
@ -46942,6 +47127,12 @@ const apiSchema = [
|
|||||||
"parameters" : {
|
"parameters" : {
|
||||||
"additionalProperties" : 0,
|
"additionalProperties" : 0,
|
||||||
"properties" : {
|
"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" : "<string>"
|
||||||
|
},
|
||||||
"autocreate" : {
|
"autocreate" : {
|
||||||
"default" : 0,
|
"default" : 0,
|
||||||
"description" : "Automatically create users if they do not exist.",
|
"description" : "Automatically create users if they do not exist.",
|
||||||
@ -47092,6 +47283,12 @@ const apiSchema = [
|
|||||||
"type" : "integer",
|
"type" : "integer",
|
||||||
"typetext" : "<integer> (1 - 65535)"
|
"typetext" : "<integer> (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" : {
|
"realm" : {
|
||||||
"description" : "Authentication domain ID",
|
"description" : "Authentication domain ID",
|
||||||
"format" : "pve-realm",
|
"format" : "pve-realm",
|
||||||
@ -47099,6 +47296,13 @@ const apiSchema = [
|
|||||||
"type" : "string",
|
"type" : "string",
|
||||||
"typetext" : "<string>"
|
"typetext" : "<string>"
|
||||||
},
|
},
|
||||||
|
"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" : "<string>"
|
||||||
|
},
|
||||||
"secure" : {
|
"secure" : {
|
||||||
"description" : "Use secure LDAPS protocol. DEPRECATED: use 'mode' instead.",
|
"description" : "Use secure LDAPS protocol. DEPRECATED: use 'mode' instead.",
|
||||||
"optional" : 1,
|
"optional" : 1,
|
||||||
@ -47181,13 +47385,9 @@ const apiSchema = [
|
|||||||
},
|
},
|
||||||
"username-claim" : {
|
"username-claim" : {
|
||||||
"description" : "OpenID claim used to generate the unique username.",
|
"description" : "OpenID claim used to generate the unique username.",
|
||||||
"enum" : [
|
|
||||||
"subject",
|
|
||||||
"username",
|
|
||||||
"email"
|
|
||||||
],
|
|
||||||
"optional" : 1,
|
"optional" : 1,
|
||||||
"type" : "string"
|
"type" : "string",
|
||||||
|
"typetext" : "<string>"
|
||||||
},
|
},
|
||||||
"verify" : {
|
"verify" : {
|
||||||
"default" : 0,
|
"default" : 0,
|
||||||
@ -48128,6 +48328,15 @@ const apiSchema = [
|
|||||||
"format" : "pve-poolid",
|
"format" : "pve-poolid",
|
||||||
"type" : "string",
|
"type" : "string",
|
||||||
"typetext" : "<string>"
|
"typetext" : "<string>"
|
||||||
|
},
|
||||||
|
"type" : {
|
||||||
|
"enum" : [
|
||||||
|
"qemu",
|
||||||
|
"lxc",
|
||||||
|
"storage"
|
||||||
|
],
|
||||||
|
"optional" : 1,
|
||||||
|
"type" : "string"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|||||||
@ -390,6 +390,10 @@ Use online/live migration.
|
|||||||
|
|
||||||
Use restart migration
|
Use restart migration
|
||||||
|
|
||||||
|
`--target-storage` `<string>` ::
|
||||||
|
|
||||||
|
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` `<integer>` ('default =' `180`)::
|
`--timeout` `<integer>` ('default =' `180`)::
|
||||||
|
|
||||||
Timeout in seconds for shutdown for restart migration
|
Timeout in seconds for shutdown for restart migration
|
||||||
|
|||||||
@ -1,29 +1,18 @@
|
|||||||
`--dest` `<string>` ::
|
`--dest` `<string>` ::
|
||||||
|
|
||||||
Restrict packet destination address. This can refer to a single IP address, an
|
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.
|
||||||
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` `<string>` ::
|
`--dport` `<string>` ::
|
||||||
|
|
||||||
Restrict TCP/UDP destination port. You can use service names or simple numbers
|
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.
|
||||||
(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` `<string>` ::
|
`--icmp-type` `<string>` ::
|
||||||
|
|
||||||
Restrict ICMP packets to specific types. You can either use the names as
|
Specify icmp-type. Only valid if proto equals 'icmp'.
|
||||||
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'.
|
|
||||||
|
|
||||||
`--iface` `<string>` ::
|
`--iface` `<string>` ::
|
||||||
|
|
||||||
Network interface name. You have to use network configuration key names for VMs
|
Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.
|
||||||
and containers ('net\d+'). Host related rules can use arbitrary strings.
|
|
||||||
|
|
||||||
`--log` `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ::
|
`--log` `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ::
|
||||||
|
|
||||||
@ -31,21 +20,13 @@ Log level for firewall rule.
|
|||||||
|
|
||||||
`--proto` `<string>` ::
|
`--proto` `<string>` ::
|
||||||
|
|
||||||
IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as
|
IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.
|
||||||
defined in '/etc/protocols'.
|
|
||||||
|
|
||||||
`--source` `<string>` ::
|
`--source` `<string>` ::
|
||||||
|
|
||||||
Restrict packet source address. This can refer to a single IP address, an IP
|
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.
|
||||||
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` `<string>` ::
|
`--sport` `<string>` ::
|
||||||
|
|
||||||
Restrict TCP/UDP source port. You can use service names or simple numbers
|
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.
|
||||||
(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.
|
|
||||||
|
|
||||||
|
|||||||
@ -42,6 +42,10 @@ Allowed content types.
|
|||||||
+
|
+
|
||||||
NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
|
NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
|
||||||
|
|
||||||
|
`--data-pool` `<string>` ::
|
||||||
|
|
||||||
|
Data Pool (for erasure coding only)
|
||||||
|
|
||||||
`--datastore` `<string>` ::
|
`--datastore` `<string>` ::
|
||||||
|
|
||||||
Proxmox Backup Server datastore name.
|
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.
|
NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
|
||||||
|
|
||||||
|
`--data-pool` `<string>` ::
|
||||||
|
|
||||||
|
Data Pool (for erasure coding only)
|
||||||
|
|
||||||
`--delete` `<string>` ::
|
`--delete` `<string>` ::
|
||||||
|
|
||||||
A list of settings you want to delete.
|
A list of settings you want to delete.
|
||||||
|
|||||||
@ -192,6 +192,10 @@ Add an authentication server.
|
|||||||
|
|
||||||
Authentication domain ID
|
Authentication domain ID
|
||||||
|
|
||||||
|
`--acr-values` `<string>` ::
|
||||||
|
|
||||||
|
Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request.
|
||||||
|
|
||||||
`--autocreate` `<boolean>` ('default =' `0`)::
|
`--autocreate` `<boolean>` ('default =' `0`)::
|
||||||
|
|
||||||
Automatically create users if they do not exist.
|
Automatically create users if they do not exist.
|
||||||
@ -276,6 +280,14 @@ LDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'.
|
|||||||
|
|
||||||
Server port.
|
Server port.
|
||||||
|
|
||||||
|
`--prompt` `(?:none|login|consent|select_account|\S+)` ::
|
||||||
|
|
||||||
|
Specifies whether the Authorization Server prompts the End-User for reauthentication and consent.
|
||||||
|
|
||||||
|
`--scopes` `<string>` ('default =' `email profile`)::
|
||||||
|
|
||||||
|
Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'.
|
||||||
|
|
||||||
`--secure` `<boolean>` ::
|
`--secure` `<boolean>` ::
|
||||||
|
|
||||||
Use secure LDAPS protocol. DEPRECATED: use 'mode' instead.
|
Use secure LDAPS protocol. DEPRECATED: use 'mode' instead.
|
||||||
@ -316,7 +328,7 @@ LDAP user attribute name
|
|||||||
|
|
||||||
The objectclasses for users.
|
The objectclasses for users.
|
||||||
|
|
||||||
`--username-claim` `<email | subject | username>` ::
|
`--username-claim` `<string>` ::
|
||||||
|
|
||||||
OpenID claim used to generate the unique username.
|
OpenID claim used to generate the unique username.
|
||||||
|
|
||||||
@ -344,6 +356,10 @@ Update authentication server settings.
|
|||||||
|
|
||||||
Authentication domain ID
|
Authentication domain ID
|
||||||
|
|
||||||
|
`--acr-values` `<string>` ::
|
||||||
|
|
||||||
|
Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request.
|
||||||
|
|
||||||
`--autocreate` `<boolean>` ('default =' `0`)::
|
`--autocreate` `<boolean>` ('default =' `0`)::
|
||||||
|
|
||||||
Automatically create users if they do not exist.
|
Automatically create users if they do not exist.
|
||||||
@ -436,6 +452,14 @@ LDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'.
|
|||||||
|
|
||||||
Server port.
|
Server port.
|
||||||
|
|
||||||
|
`--prompt` `(?:none|login|consent|select_account|\S+)` ::
|
||||||
|
|
||||||
|
Specifies whether the Authorization Server prompts the End-User for reauthentication and consent.
|
||||||
|
|
||||||
|
`--scopes` `<string>` ('default =' `email profile`)::
|
||||||
|
|
||||||
|
Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'.
|
||||||
|
|
||||||
`--secure` `<boolean>` ::
|
`--secure` `<boolean>` ::
|
||||||
|
|
||||||
Use secure LDAPS protocol. DEPRECATED: use 'mode' instead.
|
Use secure LDAPS protocol. DEPRECATED: use 'mode' instead.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user