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

`bwlimit`: `<integer> (0 - N)` ('default =' `0`)::

Limit I/O bandwidth (in KiB/s).

`compress`: `<0 | 1 | gzip | lzo | zstd>` ('default =' `0`)::

Compress dump file.

`dumpdir`: `<string>` ::

Store resulting files to specified directory.

`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 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`)::

Maximal time to wait for the global lock (minutes).

`mailnotification`: `<always | failure>` ('default =' `always`)::

Deprecated: use 'notification-policy' instead.

`mailto`: `<string>` ::

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)` ::

Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system.

`mode`: `<snapshot | stop | suspend>` ('default =' `snapshot`)::

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`

`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.

`pool`: `<string>` ::

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.

`keep-all`=`<boolean>` ;;

Keep all backups. Conflicts with the other options when true.

`keep-daily`=`<N>` ;;

Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept.

`keep-hourly`=`<N>` ;;

Keep backups for the last <N> different hours. If there is morethan one backup for a single hour, only the latest one is kept.

`keep-last`=`<N>` ;;

Keep the last <N> backups.

`keep-monthly`=`<N>` ;;

Keep backups for the last <N> different months. If there is morethan one backup for a single month, only the latest one is kept.

`keep-weekly`=`<N>` ;;

Keep backups for the last <N> different weeks. If there is morethan one backup for a single week, only the latest one is kept.

`keep-yearly`=`<N>` ;;

Keep backups for the last <N> different years. If there is morethan one backup for a single year, only the latest one is kept.

`remove`: `<boolean>` ('default =' `1`)::

Prune older backups according to 'prune-backups'.

`script`: `<string>` ::

Use specified hook script.

`stdexcludes`: `<boolean>` ('default =' `1`)::

Exclude temporary files and logs.

`stopwait`: `<integer> (0 - N)` ('default =' `10`)::

Maximal time to wait until a guest system is stopped (minutes).

`storage`: `<string>` ::

Store resulting file to this storage.

`tmpdir`: `<string>` ::

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.
Commit	Line	Data
	1	`bwlimit`: `<integer> (0 - N)` ('default =' `0`)::
	2
	3	Limit I/O bandwidth (in KiB/s).
	4
	5	`compress`: `<0 \| 1 \| gzip \| lzo \| zstd>` ('default =' `0`)::
	6
	7	Compress dump file.
	8
	9	`dumpdir`: `<string>` ::
	10
	11	Store resulting files to specified directory.
	12
	13	`exclude-path`: `<array>` ::
	14
	15	Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.
	16
	17	`ionice`: `<integer> (0 - 8)` ('default =' `7`)::
	18
	19	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.
	20
	21	`lockwait`: `<integer> (0 - N)` ('default =' `180`)::
	22
	23	Maximal time to wait for the global lock (minutes).
	24
	25	`mailnotification`: `<always \| failure>` ('default =' `always`)::
	26
	27	Deprecated: use 'notification-policy' instead.
	28
	29	`mailto`: `<string>` ::
	30
	31	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.
	32
	33	`maxfiles`: `<integer> (1 - N)` ::
	34
	35	Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system.
	36
	37	`mode`: `<snapshot \| stop \| suspend>` ('default =' `snapshot`)::
	38
	39	Backup mode.
	40
	41	`notes-template`: `<string>` ::
	42
	43	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.
	44	+
	45	NOTE: Requires option(s): `storage`
	46
	47	`notification-policy`: `<always \| failure \| never>` ('default =' `always`)::
	48
	49	Specify when to send a notification
	50
	51	`notification-target`: `<string>` ::
	52
	53	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.
	54
	55	`performance`: `[max-workers=<integer>] [,pbs-entries-max=<integer>]` ::
	56
	57	Other performance-related settings.
	58
	59	`max-workers`=`<integer> (1 - 256)` ('default =' `16`);;
	60
	61	Applies to VMs. Allow up to this many IO workers at the same time.
	62
	63	`pbs-entries-max`=`<integer> (1 - N)` ('default =' `1048576`);;
	64
	65	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.
	66
	67	`pigz`: `<integer>` ('default =' `0`)::
	68
	69	Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
	70
	71	`pool`: `<string>` ::
	72
	73	Backup all known guest systems included in the specified pool.
	74
	75	`protected`: `<boolean>` ::
	76
	77	If true, mark backup(s) as protected.
	78	+
	79	NOTE: Requires option(s): `storage`
	80
	81	`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`)::
	82
	83	Use these retention options instead of those from the storage configuration.
	84
	85	`keep-all`=`<boolean>` ;;
	86
	87	Keep all backups. Conflicts with the other options when true.
	88
	89	`keep-daily`=`<N>` ;;
	90
	91	Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept.
	92
	93	`keep-hourly`=`<N>` ;;
	94
	95	Keep backups for the last <N> different hours. If there is morethan one backup for a single hour, only the latest one is kept.
	96
	97	`keep-last`=`<N>` ;;
	98
	99	Keep the last <N> backups.
	100
	101	`keep-monthly`=`<N>` ;;
	102
	103	Keep backups for the last <N> different months. If there is morethan one backup for a single month, only the latest one is kept.
	104
	105	`keep-weekly`=`<N>` ;;
	106
	107	Keep backups for the last <N> different weeks. If there is morethan one backup for a single week, only the latest one is kept.
	108
	109	`keep-yearly`=`<N>` ;;
	110
	111	Keep backups for the last <N> different years. If there is morethan one backup for a single year, only the latest one is kept.
	112
	113	`remove`: `<boolean>` ('default =' `1`)::
	114
	115	Prune older backups according to 'prune-backups'.
	116
	117	`script`: `<string>` ::
	118
	119	Use specified hook script.
	120
	121	`stdexcludes`: `<boolean>` ('default =' `1`)::
	122
	123	Exclude temporary files and logs.
	124
	125	`stopwait`: `<integer> (0 - N)` ('default =' `10`)::
	126
	127	Maximal time to wait until a guest system is stopped (minutes).
	128
	129	`storage`: `<string>` ::
	130
	131	Store resulting file to this storage.
	132
	133	`tmpdir`: `<string>` ::
	134
	135	Store temporary files to specified directory.
	136
	137	`zstd`: `<integer>` ('default =' `1`)::
	138
	139	Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count.
	140