proxmox-mirrors/pmg-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pmg-docs synced 2025-10-04 17:16:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update static schema info

Browse Source 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2022-11-10 13:29:01 +01:00
parent 4659120990
commit 0b9926d3fb
3 changed files with 71 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
api-viewer/apidata.js
View File

@ -5833,9 +5833,10 @@ var apiSchema = [
"properties" : { "properties" : {
"email" : { "email" : {
"description" : "Email address.", "description" : "Email address.",
"format" : "email", "maxLength" : 512,
"type" : "string", "minLength" : 3,
"typetext" : "<string>" "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
"type" : "string"
}, },
"profile" : { "profile" : {
"description" : "Profile ID.", "description" : "Profile ID.",
@ -8571,8 +8572,8 @@ var apiSchema = [
"datastore" : { "datastore" : {
"description" : "Proxmox Backup Server datastore name.", "description" : "Proxmox Backup Server datastore name.",
"optional" : 1, "optional" : 1,
"type" : "string", "pattern" : "(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*)",
"typetext" : "<string>" "type" : "string"
}, },
"delete" : { "delete" : {
"description" : "A list of settings you want to delete.", "description" : "A list of settings you want to delete.",
@ -8655,6 +8656,13 @@ var apiSchema = [
"type" : "integer", "type" : "integer",
"typetext" : "<N>" "typetext" : "<N>"
}, },
"namespace" : {
"description" : "Proxmox Backup Server namespace in the datastore, defaults to the root NS.",
"maxLength" : 256,
"optional" : 1,
"pattern" : "(?:(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*))?",
"type" : "string"
},
"notify" : { "notify" : {
"description" : "Specify when to notify via e-mail", "description" : "Specify when to notify via e-mail",
"enum" : [ "enum" : [
@ -8737,6 +8745,7 @@ var apiSchema = [
"datastore" : { "datastore" : {
"description" : "Proxmox Backup Server datastore name.", "description" : "Proxmox Backup Server datastore name.",
"optional" : 0, "optional" : 0,
"pattern" : "(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*)",
"type" : "string" "type" : "string"
}, },
"disable" : { "disable" : {
@ -8797,6 +8806,13 @@ var apiSchema = [
"optional" : 1, "optional" : 1,
"type" : "integer" "type" : "integer"
}, },
"namespace" : {
"description" : "Proxmox Backup Server namespace in the datastore, defaults to the root NS.",
"maxLength" : 256,
"optional" : 1,
"pattern" : "(?:(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*))?",
"type" : "string"
},
"notify" : { "notify" : {
"description" : "Specify when to notify via e-mail", "description" : "Specify when to notify via e-mail",
"enum" : [ "enum" : [
@ -8855,8 +8871,8 @@ var apiSchema = [
"datastore" : { "datastore" : {
"description" : "Proxmox Backup Server datastore name.", "description" : "Proxmox Backup Server datastore name.",
"optional" : 0, "optional" : 0,
"type" : "string", "pattern" : "(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*)",
"typetext" : "<string>" "type" : "string"
}, },
"disable" : { "disable" : {
"description" : "Flag to disable (deactivate) the entry.", "description" : "Flag to disable (deactivate) the entry.",
@ -8924,6 +8940,13 @@ var apiSchema = [
"type" : "integer", "type" : "integer",
"typetext" : "<N>" "typetext" : "<N>"
}, },
"namespace" : {
"description" : "Proxmox Backup Server namespace in the datastore, defaults to the root NS.",
"maxLength" : 256,
"optional" : 1,
"pattern" : "(?:(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*))?",
"type" : "string"
},
"notify" : { "notify" : {
"description" : "Specify when to notify via e-mail", "description" : "Specify when to notify via e-mail",
"enum" : [ "enum" : [
@ -9869,6 +9892,12 @@ var apiSchema = [
"returns" : { "returns" : {
"optional" : 1, "optional" : 1,
"properties" : { "properties" : {
"allow-subdomains" : {
"default" : 1,
"description" : "Whether to allow the origin to be a subdomain, rather than the exact URL.",
"optional" : 1,
"type" : "boolean"
},
"id" : { "id" : {
"description" : "Relying part ID. Must be the domain name without protocol, port or location.\nChanging this *will* break existing credentials.", "description" : "Relying part ID. Must be the domain name without protocol, port or location.\nChanging this *will* break existing credentials.",
"optional" : 1, "optional" : 1,
@ -9896,11 +9925,19 @@ var apiSchema = [
"parameters" : { "parameters" : {
"additionalProperties" : 0, "additionalProperties" : 0,
"properties" : { "properties" : {
"allow-subdomains" : {
"default" : 1,
"description" : "Whether to allow the origin to be a subdomain, rather than the exact URL.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"delete" : { "delete" : {
"description" : "A list of settings you want to delete.", "description" : "A list of settings you want to delete.",
"enum" : [ "enum" : [
"origin",
"id", "id",
"origin",
"allow-subdomains",
"rp" "rp"
], ],
"optional" : 1, "optional" : 1,
@ -14897,6 +14934,7 @@ var apiSchema = [
"datastore" : { "datastore" : {
"description" : "Proxmox Backup Server datastore name.", "description" : "Proxmox Backup Server datastore name.",
"optional" : 0, "optional" : 0,
"pattern" : "(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*)",
"type" : "string" "type" : "string"
}, },
"disable" : { "disable" : {
@ -14957,6 +14995,13 @@ var apiSchema = [
"optional" : 1, "optional" : 1,
"type" : "integer" "type" : "integer"
}, },
"namespace" : {
"description" : "Proxmox Backup Server namespace in the datastore, defaults to the root NS.",
"maxLength" : 256,
"optional" : 1,
"pattern" : "(?:(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\\-]*))?",
"type" : "string"
},
"notify" : { "notify" : {
"description" : "Specify when to notify via e-mail", "description" : "Specify when to notify via e-mail",
"enum" : [ "enum" : [

12
pmgbackup.1-synopsis.adoc
View File

@ -108,7 +108,7 @@ Add Proxmox Backup Server remote instance.
Proxmox Backup Server ID. Proxmox Backup Server ID.
`--datastore` `<string>` :: `--datastore` `(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)` ::
Proxmox Backup Server datastore name. Proxmox Backup Server datastore name.
@ -148,6 +148,10 @@ Keep backups for the last <N> different weeks. If there ismore than one backup f
Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept. Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.
`--namespace` `(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*))?` ::
Proxmox Backup Server namespace in the datastore, defaults to the root NS.
`--notify` `<always | error | never>` :: `--notify` `<always | error | never>` ::
Specify when to notify via e-mail Specify when to notify via e-mail
@ -184,7 +188,7 @@ Update PBS remote settings.
Proxmox Backup Server ID. Proxmox Backup Server ID.
`--datastore` `<string>` :: `--datastore` `(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)` ::
Proxmox Backup Server datastore name. Proxmox Backup Server datastore name.
@ -232,6 +236,10 @@ Keep backups for the last <N> different weeks. If there ismore than one backup f
Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept. Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.
`--namespace` `(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*))?` ::
Proxmox Backup Server namespace in the datastore, defaults to the root NS.
`--notify` `<always | error | never>` :: `--notify` `<always | error | never>` ::
Specify when to notify via e-mail Specify when to notify via e-mail

8
pmgsubscription.1-synopsis.adoc
View File

@ -28,6 +28,14 @@ Set subscription key.
Proxmox Mail Gateway subscription key Proxmox Mail Gateway subscription key
*pmgsubscription set-offline-key* `<data>`
(Internal use only!) Set a signed subscription info blob as offline key
`<data>`: `<string>` ::
no description available
*pmgsubscription update* `[OPTIONS]` *pmgsubscription update* `[OPTIONS]`
Update subscription info. Update subscription info.