sdn: use correct spelling for software-defined network

[pve-docs.git] / vzdump.conf.5-opts.adoc

diff --git a/vzdump.conf.5-opts.adoc b/vzdump.conf.5-opts.adoc
index 0f4dde92b1f08af3992bb42fd203ba4014538b36..d50f573fdb8ba94adc727ebbc1b920a80d273482 100644 (file)
--- a/vzdump.conf.5-opts.adoc
+++ b/vzdump.conf.5-opts.adoc
@@ -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`)::
 
@@ -24,11 +24,11 @@ Maximal time to wait for the global lock (minutes).
 
 `mailnotification`: `<always | failure>` ('default =' `always`)::
 
-Specify when to send an email
+Deprecated: use 'notification-policy' instead.
 
 `mailto`: `<string>` ::
 
-Comma-separated list of email addresses or users that should receive email notifications.
+Comma-separated list of email addresses or users that should receive email notifications. Has no effect if the 'notification-target' option  is set at the same time.
 
 `maxfiles`: `<integer> (1 - N)` ::
 
@@ -40,10 +40,30 @@ 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.
+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-policy`: `<always | failure | never>` ('default =' `always`)::
+
+Specify when to send a notification
+
+`notification-target`: `<string>` ::
+
+Determine the target to which notifications should be sent. Can either be a notification endpoint or a notification group. This option takes precedence over 'mailto', meaning that if both are  set, the 'mailto' option will be ignored.
+
+`performance`: `[max-workers=<integer>] [,pbs-entries-max=<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.
+
+`pbs-entries-max`=`<integer> (1 - N)` ('default =' `1048576`);;
+
+Applies to container backups sent to PBS. Limits the number of entries allowed in memory at a given time to avoid unintended OOM situations. Increase it to enable backups of containers with a large amount of files.
+
 `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.