]> git.proxmox.com Git - pve-docs.git/blobdiff - vzdump.1-synopsis.adoc
update static/schema information
[pve-docs.git] / vzdump.1-synopsis.adoc
index 1654299fa7253b53e9adea62707cd5addaa6cb50..afed3d7df1048b8a02e3230b547358215608da59 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,13 @@ 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.
 
 `--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`)::
 
@@ -62,10 +62,14 @@ 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`
 
+`--performance` `[max-workers=<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.