mirror of
https://git.proxmox.com/git/pve-docs
synced 2025-04-28 22:47:13 +00:00
update static and schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht
parent
c7601c213f
commit
739d4d64c2
@ -3207,6 +3207,13 @@ var pveapi = [
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"prune-backups" : {
|
||||
"description" : "Use these retention options instead of those from the storage configuration.",
|
||||
"format" : "prune-backups",
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]"
|
||||
},
|
||||
"quiet" : {
|
||||
"default" : 0,
|
||||
"description" : "Be quiet.",
|
||||
@ -3495,6 +3502,13 @@ var pveapi = [
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"prune-backups" : {
|
||||
"description" : "Use these retention options instead of those from the storage configuration.",
|
||||
"format" : "prune-backups",
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]"
|
||||
},
|
||||
"quiet" : {
|
||||
"default" : 0,
|
||||
"description" : "Be quiet.",
|
||||
@ -22392,6 +22406,12 @@ var pveapi = [
|
||||
"optional" : 1,
|
||||
"type" : "integer"
|
||||
},
|
||||
"debug" : {
|
||||
"default" : 0,
|
||||
"description" : "Try to be more verbose. For now this only enables debug log-level on start.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean"
|
||||
},
|
||||
"description" : {
|
||||
"description" : "Container description. Only used on the configuration web interface.",
|
||||
"optional" : 1,
|
||||
@ -22881,6 +22901,13 @@ var pveapi = [
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer> (0 - 500000)"
|
||||
},
|
||||
"debug" : {
|
||||
"default" : 0,
|
||||
"description" : "Try to be more verbose. For now this only enables debug log-level on start.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"delete" : {
|
||||
"description" : "A list of settings you want to delete.",
|
||||
"format" : "pve-configid-list",
|
||||
@ -23490,6 +23517,13 @@ var pveapi = [
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"debug" : {
|
||||
"default" : 0,
|
||||
"description" : "If set, enables very verbose debug log-level on start.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"node" : {
|
||||
"description" : "The cluster node name.",
|
||||
"format" : "pve-node",
|
||||
@ -27803,6 +27837,13 @@ var pveapi = [
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer> (0 - 500000)"
|
||||
},
|
||||
"debug" : {
|
||||
"default" : 0,
|
||||
"description" : "Try to be more verbose. For now this only enables debug log-level on start.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"description" : {
|
||||
"description" : "Container description. Only used on the configuration web interface.",
|
||||
"optional" : 1,
|
||||
@ -28551,6 +28592,12 @@ var pveapi = [
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"crush-device-class" : {
|
||||
"description" : "Set the device class of the OSD in crush.",
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"db_dev" : {
|
||||
"description" : "Block device name for block.db.",
|
||||
"optional" : 1,
|
||||
@ -30418,6 +30465,13 @@ var pveapi = [
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"prune-backups" : {
|
||||
"description" : "Use these retention options instead of those from the storage configuration.",
|
||||
"format" : "prune-backups",
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]"
|
||||
},
|
||||
"quiet" : {
|
||||
"default" : 0,
|
||||
"description" : "Be quiet.",
|
||||
@ -30706,7 +30760,7 @@ var pveapi = [
|
||||
"info" : {
|
||||
"POST" : {
|
||||
"allowtoken" : 1,
|
||||
"description" : "Restart service.",
|
||||
"description" : "Hard restart service. Use reload if you want to reduce interruptions.",
|
||||
"method" : "POST",
|
||||
"name" : "service_restart",
|
||||
"parameters" : {
|
||||
@ -30766,7 +30820,7 @@ var pveapi = [
|
||||
"info" : {
|
||||
"POST" : {
|
||||
"allowtoken" : 1,
|
||||
"description" : "Reload service.",
|
||||
"description" : "Reload service. Falls back to restart if service cannot be reloaded.",
|
||||
"method" : "POST",
|
||||
"name" : "service_reload",
|
||||
"parameters" : {
|
||||
@ -32915,6 +32969,159 @@ var pveapi = [
|
||||
"children" : [
|
||||
{
|
||||
"children" : [
|
||||
{
|
||||
"info" : {
|
||||
"DELETE" : {
|
||||
"allowtoken" : 1,
|
||||
"description" : "Prune backups. Only those using the standard naming scheme are considered.",
|
||||
"method" : "DELETE",
|
||||
"name" : "delete",
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"node" : {
|
||||
"description" : "The cluster node name.",
|
||||
"format" : "pve-node",
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"prune-backups" : {
|
||||
"description" : "Use these retention options instead of those from the storage configuration.",
|
||||
"format" : "prune-backups",
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]"
|
||||
},
|
||||
"storage" : {
|
||||
"description" : "The storage identifier.",
|
||||
"format" : "pve-storage-id",
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"type" : {
|
||||
"description" : "Either 'qemu' or 'lxc'. Only consider backups for guests of this type.",
|
||||
"enum" : [
|
||||
"qemu",
|
||||
"lxc"
|
||||
],
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
},
|
||||
"vmid" : {
|
||||
"description" : "Only prune backups for this VM.",
|
||||
"format" : "pve-vmid",
|
||||
"minimum" : 1,
|
||||
"optional" : 1,
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer> (1 - N)"
|
||||
}
|
||||
}
|
||||
},
|
||||
"permissions" : {
|
||||
"description" : "You need the 'Datastore.Allocate' privilege on the storage (or if a VM ID is specified, 'Datastore.AllocateSpace' and 'VM.Backup' for the VM).",
|
||||
"user" : "all"
|
||||
},
|
||||
"protected" : 1,
|
||||
"proxyto" : "node",
|
||||
"returns" : {
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"GET" : {
|
||||
"allowtoken" : 1,
|
||||
"description" : "Get prune information for backups. NOTE: this is only a preview and might not be exactly what a subsequent prune call does, if the hour changes or if backups are removed/added in the meantime.",
|
||||
"method" : "GET",
|
||||
"name" : "dryrun",
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"node" : {
|
||||
"description" : "The cluster node name.",
|
||||
"format" : "pve-node",
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"prune-backups" : {
|
||||
"description" : "Use these retention options instead of those from the storage configuration.",
|
||||
"format" : "prune-backups",
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]"
|
||||
},
|
||||
"storage" : {
|
||||
"description" : "The storage identifier.",
|
||||
"format" : "pve-storage-id",
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"type" : {
|
||||
"description" : "Either 'qemu' or 'lxc'. Only consider backups for guests of this type.",
|
||||
"enum" : [
|
||||
"qemu",
|
||||
"lxc"
|
||||
],
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
},
|
||||
"vmid" : {
|
||||
"description" : "Only consider backups for this guest.",
|
||||
"format" : "pve-vmid",
|
||||
"minimum" : 1,
|
||||
"optional" : 1,
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer> (1 - N)"
|
||||
}
|
||||
}
|
||||
},
|
||||
"permissions" : {
|
||||
"check" : [
|
||||
"perm",
|
||||
"/storage/{storage}",
|
||||
[
|
||||
"Datastore.Audit",
|
||||
"Datastore.AllocateSpace"
|
||||
],
|
||||
"any",
|
||||
1
|
||||
]
|
||||
},
|
||||
"protected" : 1,
|
||||
"proxyto" : "node",
|
||||
"returns" : {
|
||||
"items" : {
|
||||
"properties" : {
|
||||
"ctime" : {
|
||||
"description" : "Creation time of the backup (seconds since the UNIX epoch).",
|
||||
"type" : "integer"
|
||||
},
|
||||
"mark" : {
|
||||
"description" : "Whether the backup would be kept or removed. For backups that don't use the standard naming scheme, it's 'protected'.",
|
||||
"type" : "string"
|
||||
},
|
||||
"type" : {
|
||||
"description" : "One of 'qemu', 'lxc', 'openvz' or 'unknown'.",
|
||||
"type" : "string"
|
||||
},
|
||||
"vmid" : {
|
||||
"description" : "The VM the backup belongs to.",
|
||||
"optional" : 1,
|
||||
"type" : "integer"
|
||||
},
|
||||
"volid" : {
|
||||
"description" : "Backup volume ID.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"type" : "object"
|
||||
},
|
||||
"type" : "array"
|
||||
}
|
||||
}
|
||||
},
|
||||
"leaf" : 1,
|
||||
"path" : "/nodes/{node}/storage/{storage}/prunebackups",
|
||||
"text" : "prunebackups"
|
||||
},
|
||||
{
|
||||
"children" : [
|
||||
{
|
||||
@ -38728,6 +38935,13 @@ var pveapi = [
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"prune-backups" : {
|
||||
"description" : "The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.",
|
||||
"format" : "prune-backups",
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]"
|
||||
},
|
||||
"redundancy" : {
|
||||
"default" : 2,
|
||||
"description" : "The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.",
|
||||
@ -39138,6 +39352,13 @@ var pveapi = [
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"prune-backups" : {
|
||||
"description" : "The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.",
|
||||
"format" : "prune-backups",
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]"
|
||||
},
|
||||
"redundancy" : {
|
||||
"default" : 2,
|
||||
"description" : "The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.",
|
||||
|
||||
@ -120,6 +120,10 @@ CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger t
|
||||
+
|
||||
NOTE: You can disable fair-scheduler configuration by setting this to 0.
|
||||
|
||||
`--debug` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Try to be more verbose. For now this only enables debug log-level on start.
|
||||
|
||||
`--description` `<string>` ::
|
||||
|
||||
Container description. Only used on the configuration web interface.
|
||||
@ -577,6 +581,10 @@ CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger t
|
||||
+
|
||||
NOTE: You can disable fair-scheduler configuration by setting this to 0.
|
||||
|
||||
`--debug` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Try to be more verbose. For now this only enables debug log-level on start.
|
||||
|
||||
`--description` `<string>` ::
|
||||
|
||||
Container description. Only used on the configuration web interface.
|
||||
@ -755,6 +763,10 @@ CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger t
|
||||
+
|
||||
NOTE: You can disable fair-scheduler configuration by setting this to 0.
|
||||
|
||||
`--debug` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Try to be more verbose. For now this only enables debug log-level on start.
|
||||
|
||||
`--delete` `<string>` ::
|
||||
|
||||
A list of settings you want to delete.
|
||||
@ -896,6 +908,10 @@ Start the container.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--debug` `<boolean>` ('default =' `0`)::
|
||||
|
||||
If set, enables very verbose debug log-level on start.
|
||||
|
||||
`--skiplock` `<boolean>` ::
|
||||
|
||||
Ignore locks - only root is allowed to use this option.
|
||||
|
||||
@ -26,6 +26,10 @@ CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger t
|
||||
+
|
||||
NOTE: You can disable fair-scheduler configuration by setting this to 0.
|
||||
|
||||
`debug`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Try to be more verbose. For now this only enables debug log-level on start.
|
||||
|
||||
`description`: `<string>` ::
|
||||
|
||||
Container description. Only used on the configuration web interface.
|
||||
|
||||
@ -174,6 +174,10 @@ Create OSD
|
||||
|
||||
Block device name.
|
||||
|
||||
`--crush-device-class` `<string>` ::
|
||||
|
||||
Set the device class of the OSD in crush.
|
||||
|
||||
`--db_dev` `<string>` ::
|
||||
|
||||
Block device name for block.db.
|
||||
|
||||
@ -54,7 +54,7 @@ Flag to disable the storage.
|
||||
|
||||
CIFS domain.
|
||||
|
||||
`--encryption-key` `<filepath>` ::
|
||||
`--encryption-key` `a file containing an encryption key, or the special value "autogen"` ::
|
||||
|
||||
Encryption key. Use 'autogen' to generate one automatically without passphrase.
|
||||
|
||||
@ -134,6 +134,10 @@ Pool.
|
||||
|
||||
iSCSI portal (IP or DNS name with optional port).
|
||||
|
||||
`--prune-backups` `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
|
||||
|
||||
The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.
|
||||
|
||||
`--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
|
||||
|
||||
The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.
|
||||
@ -378,6 +382,30 @@ Get filesystem path for specified volume
|
||||
|
||||
Volume identifier
|
||||
|
||||
*pvesm prune-backups* `<storage>` `[OPTIONS]`
|
||||
|
||||
Prune backups. This is only a wrapper for the proper API endpoints.
|
||||
|
||||
`<storage>`: `<string>` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
`--dry-run` `<boolean>` ::
|
||||
|
||||
Only show what would be pruned, don't delete anything.
|
||||
|
||||
`--prune-backups` `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
|
||||
|
||||
Use these retention options instead of those from the storage configuration.
|
||||
|
||||
`--type` `<lxc | qemu>` ::
|
||||
|
||||
Either 'qemu' or 'lxc'. Only consider backups for guests of this type.
|
||||
|
||||
`--vmid` `<integer> (1 - N)` ::
|
||||
|
||||
Only consider backups for this guest.
|
||||
|
||||
*pvesm remove* `<storage>`
|
||||
|
||||
Delete storage configuration.
|
||||
@ -492,7 +520,7 @@ Flag to disable the storage.
|
||||
|
||||
CIFS domain.
|
||||
|
||||
`--encryption-key` `<filepath>` ::
|
||||
`--encryption-key` `a file containing an encryption key, or the special value "autogen"` ::
|
||||
|
||||
Encryption key. Use 'autogen' to generate one automatically without passphrase.
|
||||
|
||||
@ -556,6 +584,10 @@ Password for accessing the share/datastore.
|
||||
|
||||
Pool.
|
||||
|
||||
`--prune-backups` `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
|
||||
|
||||
The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.
|
||||
|
||||
`--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
|
||||
|
||||
The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.
|
||||
|
||||
@ -68,6 +68,10 @@ Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread
|
||||
|
||||
Backup all known guest systems included in the specified pool.
|
||||
|
||||
`--prune-backups` `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
|
||||
|
||||
Use these retention options instead of those from the storage configuration.
|
||||
|
||||
`--quiet` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Be quiet.
|
||||
|
||||
@ -46,6 +46,34 @@ Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread
|
||||
|
||||
Backup all known guest systems included in the specified pool.
|
||||
|
||||
`prune-backups`: `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
|
||||
|
||||
Use these retention options instead of those from the storage configuration.
|
||||
|
||||
`keep-daily`=`<N>` ;;
|
||||
|
||||
Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept.
|
||||
|
||||
`keep-hourly`=`<N>` ;;
|
||||
|
||||
Keep backups for the last <N> different hours. If there is morethan one backup for a single hour, only the latest one is kept.
|
||||
|
||||
`keep-last`=`<N>` ;;
|
||||
|
||||
Keep the last <N> backups.
|
||||
|
||||
`keep-monthly`=`<N>` ;;
|
||||
|
||||
Keep backups for the last <N> different months. If there is morethan one backup for a single month, only the latest one is kept.
|
||||
|
||||
`keep-weekly`=`<N>` ;;
|
||||
|
||||
Keep backups for the last <N> different weeks. If there is morethan one backup for a single week, only the latest one is kept.
|
||||
|
||||
`keep-yearly`=`<N>` ;;
|
||||
|
||||
Keep backups for the last <N> different years. If there is morethan one backup for a single year, only the latest one is kept.
|
||||
|
||||
`remove`: `<boolean>` ('default =' `1`)::
|
||||
|
||||
Remove old backup files if there are more than 'maxfiles' backup files.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user