]> git.proxmox.com Git - pve-docs.git/blobdiff - vzdump.1-synopsis.adoc
qm: add section about TPM
[pve-docs.git] / vzdump.1-synopsis.adoc
index 87642b13e40e2f5e1fc0e8194016cb4c3c729a04..369daae9fd6bde4d37752a538422006847c1cb55 100644 (file)
@@ -16,7 +16,7 @@ Backup all known guest systems on this host.
 
 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.
 
@@ -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`)::
 
@@ -64,22 +64,26 @@ Only run if executed on this node.
 
 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.
+
+`--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`)::
 
-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.
@@ -90,7 +94,7 @@ Write tar to stdout, not to a file.
 
 `--stop` `<boolean>` ('default =' `0`)::
 
-Stop runnig backup jobs on this host.
+Stop running backup jobs on this host.
 
 `--stopwait` `<integer> (0 - N)` ('default =' `10`)::
 
@@ -104,3 +108,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.
+