X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=vzdump.conf.5-opts.adoc;h=d50f573fdb8ba94adc727ebbc1b920a80d273482;hb=0554c751fdc4e27b8a98d2d6de447907dd9da1d2;hp=2e72b238d848781d7a6bceb09eaaefd5ae0a2858;hpb=d083d3d384304e74892ad5d6907c8eb9f1444fb8;p=pve-docs.git diff --git a/vzdump.conf.5-opts.adoc b/vzdump.conf.5-opts.adoc index 2e72b23..d50f573 100644 --- a/vzdump.conf.5-opts.adoc +++ b/vzdump.conf.5-opts.adoc @@ -1,69 +1,140 @@ -`bwlimit`: `integer (0 - N)` (default=`0`):: +`bwlimit`: ` (0 - N)` ('default =' `0`):: -Limit I/O bandwidth (KBytes per second). +Limit I/O bandwidth (in KiB/s). -`compress`: `(0 | 1 | gzip | lzo)` (default=`0`):: +`compress`: `<0 | 1 | gzip | lzo | zstd>` ('default =' `0`):: Compress dump file. -`dumpdir`: `string` :: +`dumpdir`: `` :: Store resulting files to specified directory. -`exclude-path`: `string` :: +`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`: `integer (0 - 8)` (default=`7`):: +`ionice`: ` (0 - 8)` ('default =' `7`):: -Set CFQ ionice priority. +Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. -`lockwait`: `integer (0 - N)` (default=`180`):: +`lockwait`: ` (0 - N)` ('default =' `180`):: Maximal time to wait for the global lock (minutes). -`mailnotification`: `(always | failure)` (default=`always`):: +`mailnotification`: `` ('default =' `always`):: -Specify when to send an email +Deprecated: use 'notification-policy' instead. -`mailto`: `string` :: +`mailto`: `` :: -no description available +Comma-separated list of email addresses or users that should receive email notifications. Has no effect if the 'notification-target' option is set at the same time. -`maxfiles`: `integer (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`: `(snapshot | stop | suspend)` (default=`snapshot`):: +`mode`: `` ('default =' `snapshot`):: Backup mode. -`pigz`: `integer` (default=`0`):: +`notes-template`: `` :: -Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as -thread count. +Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are \{\{cluster\}\}, \{\{guestname\}\}, \{\{node\}\}, and \{\{vmid\}\}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. ++ +NOTE: Requires option(s): `storage` -`remove`: `boolean` (default=`1`):: +`notification-policy`: `` ('default =' `always`):: -Remove old backup files if there are more than 'maxfiles' backup files. +Specify when to send a notification -`script`: `string` :: +`notification-target`: `` :: + +Determine the target to which notifications should be sent. Can either be a notification endpoint or a notification group. This option takes precedence over 'mailto', meaning that if both are set, the 'mailto' option will be ignored. + +`performance`: `[max-workers=] [,pbs-entries-max=]` :: + +Other performance-related settings. + +`max-workers`=` (1 - 256)` ('default =' `16`);; + +Applies to VMs. Allow up to this many IO workers at the same time. + +`pbs-entries-max`=` (1 - N)` ('default =' `1048576`);; + +Applies to container backups sent to PBS. Limits the number of entries allowed in memory at a given time to avoid unintended OOM situations. Increase it to enable backups of containers with a large amount of files. + +`pigz`: `` ('default =' `0`):: + +Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. + +`pool`: `` :: + +Backup all known guest systems included in the specified pool. + +`protected`: `` :: + +If true, mark backup(s) as protected. ++ +NOTE: Requires option(s): `storage` + +`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`):: + +Prune older backups according to 'prune-backups'. + +`script`: `` :: Use specified hook script. -`stdexcludes`: `boolean` (default=`1`):: +`stdexcludes`: `` ('default =' `1`):: Exclude temporary files and logs. -`stopwait`: `integer (0 - N)` (default=`10`):: +`stopwait`: ` (0 - N)` ('default =' `10`):: Maximal time to wait until a guest system is stopped (minutes). -`storage`: `string` :: +`storage`: `` :: Store resulting file to this storage. -`tmpdir`: `string` :: +`tmpdir`: `` :: 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. +