]> git.proxmox.com Git - pve-docs.git/blobdiff - vzdump.1-synopsis.adoc
network: adapt apply config section to PVE 7
[pve-docs.git] / vzdump.1-synopsis.adoc
index 74587110413b85190351615a6e1b85cef61a7001..1654299fa7253b53e9adea62707cd5addaa6cb50 100644 (file)
@@ -30,7 +30,7 @@ Exclude specified guest systems (assumes --all)
 
 `--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`)::
 
@@ -46,11 +46,11 @@ 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`)::
 
@@ -60,6 +60,12 @@ Backup mode.
 
 Only run if executed on this node.
 
+`--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.
@@ -68,7 +74,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-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.
 
@@ -78,16 +90,12 @@ Be quiet.
 
 `--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>` ::
 
 Use specified hook script.
 
-`--size` `<integer> (500 - N)` ('default =' `1024`)::
-
-Unused, will be removed in a future release.
-
 `--stdexcludes` `<boolean>` ('default =' `1`)::
 
 Exclude temporary files and logs.