]> git.proxmox.com Git - pve-docs.git/blobdiff - vzdump.1-synopsis.adoc
totp: fix copy/paste mistake
[pve-docs.git] / vzdump.1-synopsis.adoc
index 1654299fa7253b53e9adea62707cd5addaa6cb50..375d23a7f2b95a6474ec3bc68054bc9e37e80f5a 100644 (file)
@@ -14,7 +14,7 @@ Backup all known guest systems on this host.
 
 `--bwlimit` `<integer> (0 - N)` ('default =' `0`)::
 
-Limit I/O bandwidth (KBytes per second).
+Limit I/O bandwidth (in KiB/s).
 
 `--compress` `<0 | 1 | gzip | lzo | zstd>` ('default =' `0`)::
 
@@ -28,13 +28,17 @@ Store resulting files to specified directory.
 
 Exclude specified guest systems (assumes --all)
 
-`--exclude-path` `<string>` ::
+`--exclude-path` `<array>` ::
 
-Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root,  other paths match relative to each subdirectory.
+Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.
+
+`--fleecing` `[[enabled=]<1|0>] [,storage=<storage ID>]` ::
+
+Options for backup fleecing (VM only).
 
 `--ionice` `<integer> (0 - 8)` ('default =' `7`)::
 
-Set CFQ ionice priority.
+Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value.
 
 `--lockwait` `<integer> (0 - N)` ('default =' `180`)::
 
@@ -42,11 +46,11 @@ Maximal time to wait for the global lock (minutes).
 
 `--mailnotification` `<always | failure>` ('default =' `always`)::
 
-Specify when to send an email
+Deprecated: use notification targets/matchers instead. Specify when to send a notification mail
 
 `--mailto` `<string>` ::
 
-Comma-separated list of email addresses or users that should receive email notifications.
+Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications.
 
 `--maxfiles` `<integer> (1 - N)` ::
 
@@ -62,10 +66,26 @@ 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.
+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`
 
+`--notification-mode` `<auto | legacy-sendmail | notification-system>` ('default =' `auto`)::
+
+Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not.
+
+`--notification-policy` `<always | failure | never>` ('default =' `always`)::
+
+Deprecated: Do not use
+
+`--notification-target` `<string>` ::
+
+Deprecated: Do not use
+
+`--performance` `[max-workers=<integer>] [,pbs-entries-max=<integer>]` ::
+
+Other performance-related settings.
+
 `--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.
@@ -112,7 +132,7 @@ Stop running backup jobs on this host.
 
 Maximal time to wait until a guest system is stopped (minutes).
 
-`--storage` `<string>` ::
+`--storage` `<storage ID>` ::
 
 Store resulting file to this storage.
 
@@ -122,5 +142,5 @@ 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.
+Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count.