diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index 0c89bda..7abb5d2 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -8499,6 +8499,436 @@ var pmgapi = [ "path" : "/config/customscores", "text" : "customscores" }, + { + "children" : [ + { + "info" : { + "DELETE" : { + "allowtoken" : 1, + "description" : "Delete an PBS remote", + "method" : "DELETE", + "name" : "delete", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "remote" : { + "description" : "Profile ID.", + "format" : "pve-configid", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin" + ] + }, + "protected" : 1, + "proxyto" : "master", + "returns" : { + "type" : "null" + } + }, + "GET" : { + "allowtoken" : 1, + "description" : "Get Proxmox Backup Server remote configuration.", + "method" : "GET", + "name" : "read_config", + "parameters" : { + "additionalProperties" : 1, + "properties" : { + "remote" : { + "description" : "Proxmox Backup Server ID.", + "format" : "pve-configid", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin", + "audit" + ] + }, + "proxyto" : "master", + "returns" : {} + }, + "PUT" : { + "allowtoken" : 1, + "description" : "Update PBS remote settings.", + "method" : "PUT", + "name" : "update_config", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "datastore" : { + "description" : "Proxmox Backup Server datastore 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" : "" + }, + "disable" : { + "description" : "Flag to disable (deactivate) the entry.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "fingerprint" : { + "description" : "Certificate SHA 256 fingerprint.", + "optional" : 1, + "pattern" : "([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}", + "type" : "string" + }, + "keep-daily" : { + "description" : "Keep backups for the last different days. If there is more than one backup for a single day, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "keep-hourly" : { + "description" : "Keep backups for the last different hours. If there is more than one backup for a single hour, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "keep-last" : { + "description" : "Keep the last backups.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "keep-monthly" : { + "description" : "Keep backups for the last different months. If there is more than one backup for a single month, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "keep-weekly" : { + "description" : "Keep backups for the last different weeks. If there ismore than one backup for a single week, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "keep-yearly" : { + "description" : "Keep backups for the last different years. If there is more than one backup for a single year, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "password" : { + "description" : "Password or API token secret for the user on the Proxmox Backup Server.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "remote" : { + "description" : "Proxmox Backup Server ID.", + "format" : "pve-configid", + "type" : "string", + "typetext" : "" + }, + "server" : { + "description" : "Proxmox Backup Server address.", + "format" : "address", + "maxLength" : 256, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "username" : { + "description" : "Username or API token ID on the Proxmox Backup Server", + "maxLength" : 512, + "minLength" : 3, + "optional" : 1, + "pattern" : "(?:[^\\s\\/\\\\@]+\\@[^\\s\\/\\\\@]+)", + "type" : "string" + } + }, + "type" : "object" + }, + "permissions" : { + "check" : [ + "admin" + ] + }, + "protected" : 1, + "proxyto" : "master", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/config/pbs/{remote}", + "text" : "{remote}" + } + ], + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "List all configured Proxmox Backup Server instances.", + "method" : "GET", + "name" : "list", + "parameters" : { + "additionalProperties" : 0 + }, + "permissions" : { + "check" : [ + "admin", + "audit" + ] + }, + "protected" : 1, + "proxyto" : "master", + "returns" : { + "items" : { + "additionalProperties" : 0, + "properties" : { + "datastore" : { + "description" : "Proxmox Backup Server datastore name.", + "optional" : 0, + "type" : "string" + }, + "disable" : { + "description" : "Flag to disable (deactivate) the entry.", + "optional" : 1, + "type" : "boolean" + }, + "fingerprint" : { + "description" : "Certificate SHA 256 fingerprint.", + "optional" : 1, + "pattern" : "([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}", + "type" : "string" + }, + "keep-daily" : { + "description" : "Keep backups for the last different days. If there is more than one backup for a single day, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer" + }, + "keep-hourly" : { + "description" : "Keep backups for the last different hours. If there is more than one backup for a single hour, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer" + }, + "keep-last" : { + "description" : "Keep the last backups.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer" + }, + "keep-monthly" : { + "description" : "Keep backups for the last different months. If there is more than one backup for a single month, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer" + }, + "keep-weekly" : { + "description" : "Keep backups for the last different weeks. If there ismore than one backup for a single week, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer" + }, + "keep-yearly" : { + "description" : "Keep backups for the last different years. If there is more than one backup for a single year, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer" + }, + "password" : { + "description" : "Password or API token secret for the user on the Proxmox Backup Server.", + "optional" : 1, + "type" : "string" + }, + "remote" : { + "description" : "Proxmox Backup Server ID.", + "format" : "pve-configid", + "type" : "string" + }, + "server" : { + "description" : "Proxmox Backup Server address.", + "format" : "address", + "maxLength" : 256, + "optional" : 0, + "type" : "string" + }, + "username" : { + "description" : "Username or API token ID on the Proxmox Backup Server", + "maxLength" : 512, + "minLength" : 3, + "optional" : 1, + "pattern" : "(?:[^\\s\\/\\\\@]+\\@[^\\s\\/\\\\@]+)", + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{remote}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "allowtoken" : 1, + "description" : "Add Proxmox Backup Server remote instance.", + "method" : "POST", + "name" : "create", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "datastore" : { + "description" : "Proxmox Backup Server datastore name.", + "optional" : 0, + "type" : "string", + "typetext" : "" + }, + "disable" : { + "description" : "Flag to disable (deactivate) the entry.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "fingerprint" : { + "description" : "Certificate SHA 256 fingerprint.", + "optional" : 1, + "pattern" : "([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}", + "type" : "string" + }, + "keep-daily" : { + "description" : "Keep backups for the last different days. If there is more than one backup for a single day, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "keep-hourly" : { + "description" : "Keep backups for the last different hours. If there is more than one backup for a single hour, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "keep-last" : { + "description" : "Keep the last backups.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "keep-monthly" : { + "description" : "Keep backups for the last different months. If there is more than one backup for a single month, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "keep-weekly" : { + "description" : "Keep backups for the last different weeks. If there ismore than one backup for a single week, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "keep-yearly" : { + "description" : "Keep backups for the last different years. If there is more than one backup for a single year, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer", + "typetext" : "" + }, + "password" : { + "description" : "Password or API token secret for the user on the Proxmox Backup Server.", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "remote" : { + "description" : "Proxmox Backup Server ID.", + "format" : "pve-configid", + "type" : "string", + "typetext" : "" + }, + "server" : { + "description" : "Proxmox Backup Server address.", + "format" : "address", + "maxLength" : 256, + "optional" : 0, + "type" : "string", + "typetext" : "" + }, + "username" : { + "description" : "Username or API token ID on the Proxmox Backup Server", + "maxLength" : 512, + "minLength" : 3, + "optional" : 1, + "pattern" : "(?:[^\\s\\/\\\\@]+\\@[^\\s\\/\\\\@]+)", + "type" : "string" + } + }, + "type" : "object" + }, + "permissions" : { + "check" : [ + "admin" + ] + }, + "protected" : 1, + "proxyto" : "master", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 0, + "path" : "/config/pbs", + "text" : "pbs" + }, { "info" : { "GET" : { @@ -9357,6 +9787,13 @@ var pmgapi = [ "optional" : 1, "type" : "string" }, + "quarantinelink" : { + "default" : 0, + "description" : "Enables user self-service for Quarantine Links. Caution: this is accessible without authentication", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "reportstyle" : { "default" : "verbose", "description" : "Spam report style.", @@ -9484,7 +9921,7 @@ var pmgapi = [ "info" : { "POST" : { "allowtoken" : 1, - "description" : "Test Regex", + "description" : "Test Regex ignoring case", "method" : "POST", "name" : "regextest", "parameters" : { @@ -9844,6 +10281,28 @@ var pmgapi = [ ], "type" : "string" }, + "sortdir" : { + "description" : "Sort direction.", + "enum" : [ + "ASC", + "DESC" + ], + "optional" : 1, + "requires" : "sortfield", + "type" : "string" + }, + "sortfield" : { + "description" : "Sort field.", + "enum" : [ + "arrival_time", + "message_size", + "sender", + "receiver", + "reason" + ], + "optional" : 1, + "type" : "string" + }, "start" : { "minimum" : 0, "optional" : 1, @@ -11635,6 +12094,28 @@ var pmgapi = [ }, { "info" : { + "DELETE" : { + "allowtoken" : 1, + "description" : "Delete subscription key.", + "method" : "DELETE", + "name" : "delete", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + }, "GET" : { "allowtoken" : 1, "description" : "Read subscription info.", @@ -12440,6 +12921,628 @@ var pmgapi = [ "path" : "/nodes/{node}/backup", "text" : "backup" }, + { + "children" : [ + { + "children" : [ + { + "children" : [ + { + "children" : [ + { + "info" : { + "DELETE" : { + "allowtoken" : 1, + "description" : "Forget a snapshot", + "method" : "DELETE", + "name" : "forget_snapshot", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "backup-id" : { + "description" : "ID (hostname) of backup snapshot", + "type" : "string", + "typetext" : "" + }, + "backup-time" : { + "description" : "Backup time in RFC 3339 format", + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "remote" : { + "description" : "Proxmox Backup Server ID.", + "format" : "pve-configid", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin", + "audit" + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + }, + "POST" : { + "allowtoken" : 1, + "description" : "Restore the system configuration.", + "method" : "POST", + "name" : "restore", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "backup-id" : { + "description" : "backup-id (hostname) of backup snapshot", + "type" : "string", + "typetext" : "" + }, + "backup-time" : { + "description" : "backup-time to restore", + "type" : "string", + "typetext" : "" + }, + "config" : { + "default" : 0, + "description" : "Restore system configuration.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "database" : { + "default" : 1, + "description" : "Restore the rule database. This is the default.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "remote" : { + "description" : "Proxmox Backup Server ID.", + "format" : "pve-configid", + "type" : "string", + "typetext" : "" + }, + "statistic" : { + "default" : 0, + "description" : "Restore statistic databases. Only considered when you restore the 'database'.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin" + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/pbs/{remote}/snapshot/{backup-id}/{backup-time}", + "text" : "{backup-time}" + } + ], + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "Get snapshots from a specific ID stored on remote.", + "method" : "GET", + "name" : "get_group_snapshots", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "backup-id" : { + "description" : "ID (hostname) of backup snapshot", + "type" : "string", + "typetext" : "" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "remote" : { + "description" : "Proxmox Backup Server ID.", + "format" : "pve-configid", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin", + "audit" + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "backup-id" : { + "type" : "string" + }, + "backup-time" : { + "type" : "string" + }, + "ctime" : { + "type" : "string" + }, + "size" : { + "type" : "integer" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{backup-time}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/pbs/{remote}/snapshot/{backup-id}", + "text" : "{backup-id}" + } + ], + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "Get snapshots stored on remote.", + "method" : "GET", + "name" : "get_snapshots", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "remote" : { + "description" : "Proxmox Backup Server ID.", + "format" : "pve-configid", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin", + "audit" + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : { + "backup-id" : { + "type" : "string" + }, + "backup-time" : { + "type" : "string" + }, + "ctime" : { + "type" : "string" + }, + "size" : { + "type" : "integer" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{backup-id}", + "rel" : "child" + } + ], + "type" : "array" + } + }, + "POST" : { + "allowtoken" : 1, + "description" : "Create a new backup and prune the backup group afterwards, if configured.", + "method" : "POST", + "name" : "run_backup", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "remote" : { + "description" : "Proxmox Backup Server ID.", + "format" : "pve-configid", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin", + "audit" + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/pbs/{remote}/snapshot", + "text" : "snapshot" + }, + { + "info" : { + "DELETE" : { + "allowtoken" : 1, + "description" : "Delete backup schedule", + "method" : "DELETE", + "name" : "delete_timer", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "remote" : { + "description" : "Proxmox Backup Server ID.", + "format" : "pve-configid", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin", + "audit" + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + }, + "GET" : { + "allowtoken" : 1, + "description" : "Get timer specification", + "method" : "GET", + "name" : "list_timer", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "remote" : { + "description" : "Proxmox Backup Server ID.", + "format" : "pve-configid", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin", + "audit" + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "properties" : { + "delay" : { + "default" : "5min", + "description" : "Randomized delay to add to the starttime (RandomizedDelaySec setting of the systemd.timer)", + "optional" : 1, + "pattern" : "[0-9a-zA-Z. ]+", + "type" : "string" + }, + "next-run" : { + "description" : "The date time of the next run, in server locale.", + "optional" : 1, + "type" : "string" + }, + "remote" : { + "description" : "Proxmox Backup Server remote ID.", + "format" : "pve-configid", + "optional" : 1, + "type" : "string" + }, + "schedule" : { + "default" : "daily", + "description" : "Schedule for the backup (OnCalendar setting of the systemd.timer)", + "optional" : 1, + "pattern" : "[0-9a-zA-Z*.:,\\-/ ]+", + "type" : "string" + }, + "unitfile" : { + "description" : "unit file for the systemd.timer unit", + "optional" : 1, + "type" : "string" + } + }, + "type" : "object" + } + }, + "POST" : { + "allowtoken" : 1, + "description" : "Create backup schedule", + "method" : "POST", + "name" : "create_timer", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "delay" : { + "default" : "5min", + "description" : "Randomized delay to add to the starttime (RandomizedDelaySec setting of the systemd.timer)", + "optional" : 1, + "pattern" : "[0-9a-zA-Z. ]+", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "remote" : { + "description" : "Proxmox Backup Server ID.", + "format" : "pve-configid", + "type" : "string", + "typetext" : "" + }, + "schedule" : { + "default" : "daily", + "description" : "Schedule for the backup (OnCalendar setting of the systemd.timer)", + "optional" : 1, + "pattern" : "[0-9a-zA-Z*.:,\\-/ ]+", + "type" : "string" + } + } + }, + "permissions" : { + "check" : [ + "admin", + "audit" + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/pbs/{remote}/timer", + "text" : "timer" + } + ], + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "Backup Job index.", + "method" : "GET", + "name" : "remote_index", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "remote" : { + "description" : "Proxmox Backup Server ID.", + "format" : "pve-configid", + "type" : "string", + "typetext" : "" + } + } + }, + "returns" : { + "items" : { + "properties" : { + "section" : { + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{section}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/pbs/{remote}", + "text" : "{remote}" + } + ], + "info" : { + "GET" : { + "allowtoken" : 1, + "description" : "List all configured Proxmox Backup Server jobs.", + "method" : "GET", + "name" : "list", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin", + "audit" + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "additionalProperties" : 0, + "properties" : { + "datastore" : { + "description" : "Proxmox Backup Server datastore name.", + "optional" : 0, + "type" : "string" + }, + "disable" : { + "description" : "Flag to disable (deactivate) the entry.", + "optional" : 1, + "type" : "boolean" + }, + "fingerprint" : { + "description" : "Certificate SHA 256 fingerprint.", + "optional" : 1, + "pattern" : "([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}", + "type" : "string" + }, + "keep-daily" : { + "description" : "Keep backups for the last different days. If there is more than one backup for a single day, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer" + }, + "keep-hourly" : { + "description" : "Keep backups for the last different hours. If there is more than one backup for a single hour, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer" + }, + "keep-last" : { + "description" : "Keep the last backups.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer" + }, + "keep-monthly" : { + "description" : "Keep backups for the last different months. If there is more than one backup for a single month, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer" + }, + "keep-weekly" : { + "description" : "Keep backups for the last different weeks. If there ismore than one backup for a single week, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer" + }, + "keep-yearly" : { + "description" : "Keep backups for the last different years. If there is more than one backup for a single year, only the latest one is kept.", + "format_description" : "N", + "minimum" : "0", + "optional" : 1, + "type" : "integer" + }, + "password" : { + "description" : "Password or API token secret for the user on the Proxmox Backup Server.", + "optional" : 1, + "type" : "string" + }, + "remote" : { + "description" : "Proxmox Backup Server ID.", + "format" : "pve-configid", + "type" : "string" + }, + "server" : { + "description" : "Proxmox Backup Server address.", + "format" : "address", + "maxLength" : 256, + "optional" : 0, + "type" : "string" + }, + "username" : { + "description" : "Username or API token ID on the Proxmox Backup Server", + "maxLength" : 512, + "minLength" : 3, + "optional" : 1, + "pattern" : "(?:[^\\s\\/\\\\@]+\\@[^\\s\\/\\\\@]+)", + "type" : "string" + } + }, + "type" : "object" + }, + "links" : [ + { + "href" : "{remote}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/pbs", + "text" : "pbs" + }, { "info" : { "GET" : { @@ -14620,6 +15723,38 @@ var pmgapi = [ "leaf" : 1, "path" : "/quarantine/download", "text" : "download" + }, + { + "info" : { + "POST" : { + "allowtoken" : 1, + "description" : "Send Quarantine link to given e-mail.", + "method" : "POST", + "name" : "sendlink", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "mail" : { + "description" : "Email Address (allow most characters).", + "maxLength" : 512, + "minLength" : 3, + "pattern" : "(?:[^\\s\\/\\\\@]+\\@[^\\s\\/\\\\@]+)", + "type" : "string" + } + } + }, + "permissions" : { + "user" : "world" + }, + "protected" : 1, + "returns" : { + "type" : "null" + } + } + }, + "leaf" : 1, + "path" : "/quarantine/sendlink", + "text" : "sendlink" } ], "info" : { diff --git a/pmg.conf.5-opts.adoc b/pmg.conf.5-opts.adoc index 346d8c9..735d06a 100644 --- a/pmg.conf.5-opts.adoc +++ b/pmg.conf.5-opts.adoc @@ -300,6 +300,10 @@ Quarantine Port. Useful if you have a reverse proxy or port forwarding for the w Quarantine Webinterface Protocol. Useful if you have a reverse proxy for the webinterface. Only used for the generated Spam report. +`quarantinelink`: `` ('default =' `0`):: + +Enables user self-service for Quarantine Links. Caution: this is accessible without authentication + `reportstyle`: `` ('default =' `verbose`):: Spam report style. diff --git a/pmg.spamquar-conf-opts.adoc b/pmg.spamquar-conf-opts.adoc index 52b7d64..0fdb686 100644 --- a/pmg.spamquar-conf-opts.adoc +++ b/pmg.spamquar-conf-opts.adoc @@ -26,6 +26,10 @@ Quarantine Port. Useful if you have a reverse proxy or port forwarding for the w Quarantine Webinterface Protocol. Useful if you have a reverse proxy for the webinterface. Only used for the generated Spam report. +`quarantinelink`: `` ('default =' `0`):: + +Enables user self-service for Quarantine Links. Caution: this is accessible without authentication + `reportstyle`: `` ('default =' `verbose`):: Spam report style. diff --git a/pmgbackup.1-synopsis.adoc b/pmgbackup.1-synopsis.adoc index e435f71..8ac4da8 100644 --- a/pmgbackup.1-synopsis.adoc +++ b/pmgbackup.1-synopsis.adoc @@ -24,6 +24,230 @@ Verbose output format. List all stored backups (files named proxmox-backup_{DATE}.tgz). +*pmgbackup proxmox-backup backup* `` + +Create a new backup and prune the backup group afterwards, if configured. + +``: `` :: + +Proxmox Backup Server ID. + +*pmgbackup proxmox-backup forget* ` ` + +Forget a snapshot + +``: `` :: + +Proxmox Backup Server ID. + +``: `` :: + +ID (hostname) of backup snapshot + +``: `` :: + +Backup time in RFC 3339 format + +*pmgbackup proxmox-backup job create* `` `[OPTIONS]` + +Create backup schedule + +``: `` :: + +Proxmox Backup Server ID. + +`--delay` `[0-9a-zA-Z. ]+` ('default =' `5min`):: + +Randomized delay to add to the starttime (RandomizedDelaySec setting of the systemd.timer) + +`--schedule` `[0-9a-zA-Z*.:,\-/ ]+` ('default =' `daily`):: + +Schedule for the backup (OnCalendar setting of the systemd.timer) + +*pmgbackup proxmox-backup job delete* `` + +Delete backup schedule + +``: `` :: + +Proxmox Backup Server ID. + +*pmgbackup proxmox-backup job show* `` `[FORMAT_OPTIONS]` + +Get timer specification + +``: `` :: + +Proxmox Backup Server ID. + +*pmgbackup proxmox-backup list* `` `[FORMAT_OPTIONS]` + +Get snapshots stored on remote. + +``: `` :: + +Proxmox Backup Server ID. + +*pmgbackup proxmox-backup remote add* ` --datastore --server ` `[OPTIONS]` + +Add Proxmox Backup Server remote instance. + +``: `` :: + +Proxmox Backup Server ID. + +`--datastore` `` :: + +Proxmox Backup Server datastore name. + +`--disable` `` :: + +Flag to disable (deactivate) the entry. + +`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` :: + +Certificate SHA 256 fingerprint. + +`--keep-daily` `` :: + +Keep backups for the last different days. If there is more than one backup for a single day, only the latest one is kept. + +`--keep-hourly` `` :: + +Keep backups for the last different hours. If there is more than one backup for a single hour, only the latest one is kept. + +`--keep-last` `` :: + +Keep the last backups. + +`--keep-monthly` `` :: + +Keep backups for the last different months. If there is more than one backup for a single month, only the latest one is kept. + +`--keep-weekly` `` :: + +Keep backups for the last different weeks. If there ismore than one backup for a single week, only the latest one is kept. + +`--keep-yearly` `` :: + +Keep backups for the last different years. If there is more than one backup for a single year, only the latest one is kept. + +`--password` `` :: + +Password or API token secret for the user on the Proxmox Backup Server. + +`--server` `` :: + +Proxmox Backup Server address. + +`--username` `(?:[^\s\/\\@]+\@[^\s\/\\@]+)` :: + +Username or API token ID on the Proxmox Backup Server + +*pmgbackup proxmox-backup remote list* `[FORMAT_OPTIONS]` + +List all configured Proxmox Backup Server instances. + +*pmgbackup proxmox-backup remote remove* `` + +Delete an PBS remote + +``: `` :: + +Profile ID. + +*pmgbackup proxmox-backup remote set* `` `[OPTIONS]` + +Update PBS remote settings. + +``: `` :: + +Proxmox Backup Server ID. + +`--datastore` `` :: + +Proxmox Backup Server datastore name. + +`--delete` `` :: + +A list of settings you want to delete. + +`--digest` `` :: + +Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. + +`--disable` `` :: + +Flag to disable (deactivate) the entry. + +`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` :: + +Certificate SHA 256 fingerprint. + +`--keep-daily` `` :: + +Keep backups for the last different days. If there is more than one backup for a single day, only the latest one is kept. + +`--keep-hourly` `` :: + +Keep backups for the last different hours. If there is more than one backup for a single hour, only the latest one is kept. + +`--keep-last` `` :: + +Keep the last backups. + +`--keep-monthly` `` :: + +Keep backups for the last different months. If there is more than one backup for a single month, only the latest one is kept. + +`--keep-weekly` `` :: + +Keep backups for the last different weeks. If there ismore than one backup for a single week, only the latest one is kept. + +`--keep-yearly` `` :: + +Keep backups for the last different years. If there is more than one backup for a single year, only the latest one is kept. + +`--password` `` :: + +Password or API token secret for the user on the Proxmox Backup Server. + +`--server` `` :: + +Proxmox Backup Server address. + +`--username` `(?:[^\s\/\\@]+\@[^\s\/\\@]+)` :: + +Username or API token ID on the Proxmox Backup Server + +*pmgbackup proxmox-backup restore* ` ` `[OPTIONS]` + +Restore the system configuration. + +``: `` :: + +Proxmox Backup Server ID. + +``: `` :: + +backup-id (hostname) of backup snapshot + +``: `` :: + +backup-time to restore + +`--config` `` ('default =' `0`):: + +Restore system configuration. + +`--database` `` ('default =' `1`):: + +Restore the rule database. This is the default. + +`--statistic` `` ('default =' `0`):: + +Restore statistic databases. Only considered when you restore the 'database'. + *pmgbackup restore* `--filename ` `[OPTIONS]` Restore the system configuration. diff --git a/pmgsubscription.1-synopsis.adoc b/pmgsubscription.1-synopsis.adoc index 1e15f29..a78c5ff 100644 --- a/pmgsubscription.1-synopsis.adoc +++ b/pmgsubscription.1-synopsis.adoc @@ -1,5 +1,9 @@ *pmgsubscription* ` [ARGS] [OPTIONS]` +*pmgsubscription delete* + +Delete subscription key. + *pmgsubscription get* Read subscription info.