qm: add documentation for vm network MTU setting

[pve-docs.git] / vzdump.conf.5-opts.adoc

diff --git a/vzdump.conf.5-opts.adoc b/vzdump.conf.5-opts.adoc
index 6bf86159047c3b2f043cd3fb5985537278403d2d..58b5167190cc7d4783593b62355d2cb9415d857c 100644 (file)
--- 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`: `<string>` ::
 
-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`)::
 
@@ -28,23 +28,79 @@ Specify when to send an email
 
 `mailto`: `<string>` ::
 
-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`: `<integer> (1 - N)` ('default =' `1`)::
+`maxfiles`: `<integer> (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`)::
 
 Backup mode.
 
+`notes-template`: `<string>` ::
+
+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`
+
+`performance`: `[max-workers=<integer>]` ::
+
+Other performance-related settings.
+
+`max-workers`=`<integer> (1 - 256)` ('default =' `16`);;
+
+Applies to VMs. Allow up to this many IO workers at the same time.
+
 `pigz`: `<integer>` ('default =' `0`)::
 
 Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
 
+`pool`: `<string>` ::
+
+Backup all known guest systems included in the specified pool.
+
+`protected`: `<boolean>` ::
+
+If true, mark backup(s) as protected.
++
+NOTE: Requires option(s): `storage`
+
+`prune-backups`: `[keep-all=<1|0>] [,keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ('default =' `keep-all=1`)::
+
+Use these retention options instead of those from the storage configuration.
+
+`keep-all`=`<boolean>` ;;
+
+Keep all backups. Conflicts with the other options when true.
+
+`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.
+Prune older backups according to 'prune-backups'.
 
 `script`: `<string>` ::
 
@@ -66,3 +122,7 @@ Store resulting file to this storage.
 
 Store temporary files to specified directory.
 
+`zstd`: `<integer>` ('default =' `1`)::
+
+Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count.
+