]> git.proxmox.com Git - pve-docs.git/blobdiff - vzdump.conf.5-opts.adoc
bump version to 8.0.1
[pve-docs.git] / vzdump.conf.5-opts.adoc
index f7f05784ee51e8281d0f15f1ac9e83b1dba4f62c..d57e4fdc18613e920e35d6b7e9417d2e9eceff4b 100644 (file)
@@ -1,6 +1,6 @@
 `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`)::
 
@@ -10,13 +10,13 @@ Compress dump file.
 
 Store resulting files to specified directory.
 
-`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`)::
 
@@ -38,6 +38,20 @@ Deprecated: use 'prune-backups' instead. Maximal number of backup files per gues
 
 Backup mode.
 
+`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. 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.
+
+`max-workers`=`<integer> (1 - 256)` ('default =' `16`);;
+
+Applies to VMs. Allow up to this many IO workers at the same time.
+
 `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.
@@ -46,6 +60,12 @@ 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.
 
+`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.