X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=vzdump.conf.5-opts.adoc;h=f7f05784ee51e8281d0f15f1ac9e83b1dba4f62c;hb=5c85b0a1683b3fcd9919b5344590a83a2d5b9c76;hp=b2f7d0c36b9f1f5cef53614169f7f3a9602317db;hpb=9226ccbcd137f880700ba0a045a8bf0ab2a4d08d;p=pve-docs.git diff --git a/vzdump.conf.5-opts.adoc b/vzdump.conf.5-opts.adoc index b2f7d0c..f7f0578 100644 --- a/vzdump.conf.5-opts.adoc +++ b/vzdump.conf.5-opts.adoc @@ -2,7 +2,7 @@ Limit I/O bandwidth (KBytes per second). -`compress`: `<0 | 1 | gzip | lzo>` ('default =' `0`):: +`compress`: `<0 | 1 | gzip | lzo | zstd>` ('default =' `0`):: Compress dump file. @@ -12,7 +12,7 @@ Store resulting files to specified directory. `exclude-path`: `` :: -Exclude certain files/directories (shell globs). +Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. `ionice`: ` (0 - 8)` ('default =' `7`):: @@ -28,11 +28,11 @@ Specify when to send an email `mailto`: `` :: -Comma-separated list of email addresses that should receive email notifications. +Comma-separated list of email addresses or users that should receive email notifications. -`maxfiles`: ` (1 - N)` ('default =' `1`):: +`maxfiles`: ` (1 - N)` :: -Maximal number of backup files per guest system. +Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system. `mode`: `` ('default =' `snapshot`):: @@ -46,9 +46,41 @@ 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-all=<1|0>] [,keep-daily=] [,keep-hourly=] [,keep-last=] [,keep-monthly=] [,keep-weekly=] [,keep-yearly=]` ('default =' `keep-all=1`):: + +Use these retention options instead of those from the storage configuration. + +`keep-all`=`` ;; + +Keep all backups. Conflicts with the other options when true. + +`keep-daily`=`` ;; + +Keep backups for the last different days. If there is morethan one backup for a single day, only the latest one is kept. + +`keep-hourly`=`` ;; + +Keep backups for the last different hours. If there is morethan 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 morethan one backup for a single month, only the latest one is kept. + +`keep-weekly`=`` ;; + +Keep backups for the last different weeks. If there is morethan one backup for a single week, only the latest one is kept. + +`keep-yearly`=`` ;; + +Keep backups for the last different years. If there is morethan one backup for a single year, only the latest one is kept. + `remove`: `` ('default =' `1`):: -Remove old backup files if there are more than 'maxfiles' backup files. +Prune older backups according to 'prune-backups'. `script`: `` :: @@ -70,3 +102,7 @@ Store resulting file to this storage. Store temporary files to specified directory. +`zstd`: `` ('default =' `1`):: + +Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count. +