X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=vzdump.1-synopsis.adoc;h=1654299fa7253b53e9adea62707cd5addaa6cb50;hb=78881712eb226e8cfc160be7d2ffffde0c98f69a;hp=53e73ea0a7b3ec0a840cb9204b0f1db628fce170;hpb=9b3e4991113526213b75551d302c8d73deb0b6ed;p=pve-docs.git

diff --git a/vzdump.1-synopsis.adoc b/vzdump.1-synopsis.adoc
index 53e73ea..1654299 100644
--- a/vzdump.1-synopsis.adoc
+++ b/vzdump.1-synopsis.adoc
@@ -4,104 +4,123 @@
 
 Create backup.
 
-`<vmid>` `string` ::
+`<vmid>`: `<string>` ::
 
-The ID of the VM you want to backup.
+The ID of the guest system you want to backup.
 
-`-all` `boolean` (default=`0`)::
+`--all` `<boolean>` ('default =' `0`)::
 
-Backup all known VMs on this host.
+Backup all known guest systems on this host.
 
-`-bwlimit` `integer (0 - N)` (default=`0`)::
+`--bwlimit` `<integer> (0 - N)` ('default =' `0`)::
 
 Limit I/O bandwidth (KBytes per second).
 
-`-compress` `(0 | 1 | gzip | lzo)` (default=`lzo`)::
+`--compress` `<0 | 1 | gzip | lzo | zstd>` ('default =' `0`)::
 
 Compress dump file.
 
-`-dumpdir` `string` ::
+`--dumpdir` `<string>` ::
 
 Store resulting files to specified directory.
 
-`-exclude` `string` ::
+`--exclude` `<string>` ::
 
-exclude specified VMs (assumes --all)
+Exclude specified guest systems (assumes --all)
 
-`-exclude-path` `string` ::
+`--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`)::
+`--ionice` `<integer> (0 - 8)` ('default =' `7`)::
 
 Set CFQ ionice priority.
 
-`-lockwait` `integer (0 - N)` (default=`180`)::
+`--lockwait` `<integer> (0 - N)` ('default =' `180`)::
 
 Maximal time to wait for the global lock (minutes).
 
-`-mailnotification` `(always | failure)` (default=`always`)::
+`--mailnotification` `<always | failure>` ('default =' `always`)::
 
 Specify when to send an email
 
-`-mailto` `string` ::
+`--mailto` `<string>` ::
 
-no description available
+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 VM.
+Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system.
 
-`-mode` `(snapshot | stop | suspend)` (default=`snapshot`)::
+`--mode` `<snapshot | stop | suspend>` ('default =' `snapshot`)::
 
 Backup mode.
 
-`-node` `string` ::
+`--node` `<string>` ::
 
 Only run if executed on this node.
 
-`-pigz` `integer` (default=`0`)::
+`--notes-template` `<string>` ::
 
-Uses 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.
++
+NOTE: Requires option(s): `storage`
 
-`-quiet` `boolean` (default=`0`)::
+`--pigz` `<integer>` ('default =' `0`)::
 
-Be quiet.
+Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
 
-`-remove` `boolean` (default=`1`)::
+`--pool` `<string>` ::
 
-Remove old backup files if there are more than 'maxfiles' backup files.
+Backup all known guest systems included in the specified pool.
 
-`-script` `string` ::
+`--protected` `<boolean>` ::
 
-Use specified hook script.
+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.
+
+`--quiet` `<boolean>` ('default =' `0`)::
+
+Be quiet.
+
+`--remove` `<boolean>` ('default =' `1`)::
+
+Prune older backups according to 'prune-backups'.
 
-`-size` `integer (500 - N)` (default=`1024`)::
+`--script` `<string>` ::
 
-LVM snapshot size in MB.
+Use specified hook script.
 
-`-stdexcludes` `boolean` (default=`1`)::
+`--stdexcludes` `<boolean>` ('default =' `1`)::
 
-Exclude temorary files and logs.
+Exclude temporary files and logs.
 
-`-stdout` `boolean` ::
+`--stdout` `<boolean>` ::
 
 Write tar to stdout, not to a file.
 
-`-stop` `boolean` (default=`0`)::
+`--stop` `<boolean>` ('default =' `0`)::
 
-Stop runnig backup jobs on this host.
+Stop running backup jobs on this host.
 
-`-stopwait` `integer (0 - N)` (default=`10`)::
+`--stopwait` `<integer> (0 - N)` ('default =' `10`)::
 
-Maximal time to wait until a VM is stopped (minutes).
+Maximal time to wait until a guest system is stopped (minutes).
 
-`-storage` `string` ::
+`--storage` `<string>` ::
 
 Store resulting file to this storage.
 
-`-tmpdir` `string` ::
+`--tmpdir` `<string>` ::
 
 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.
+