]> git.proxmox.com Git - pve-docs.git/blobdiff - vzdump.conf.5-opts.adoc
docs: intro: avoid office@ mail address for sales related questions
[pve-docs.git] / vzdump.conf.5-opts.adoc
index 21b96e87885f824135f5ec6cca04011fe9249dfa..0f4dde92b1f08af3992bb42fd203ba4014538b36 100644 (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,16 +28,22 @@ 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.
++
+NOTE: Requires option(s): `storage`
+
 `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.
@@ -46,7 +52,13 @@ 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=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
+`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.
 
@@ -80,7 +92,7 @@ Keep backups for the last <N> different years. If there is morethan one backup f
 
 `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>` ::