bump version to 6.2-6
[pve-docs.git] / vzdump.conf.5-opts.adoc
1 `bwlimit`: `<integer> (0 - N)` ('default =' `0`)::
2
3 Limit I/O bandwidth (KBytes per second).
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`: `<string>` ::
14
15 Exclude certain files/directories (shell globs).
16
17 `ionice`: `<integer> (0 - 8)` ('default =' `7`)::
18
19 Set CFQ ionice priority.
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 Specify when to send an email
28
29 `mailto`: `<string>` ::
30
31 Comma-separated list of email addresses that should receive email notifications.
32
33 `maxfiles`: `<integer> (1 - N)` ('default =' `1`)::
34
35 Maximal number of backup files per guest system.
36
37 `mode`: `<snapshot | stop | suspend>` ('default =' `snapshot`)::
38
39 Backup mode.
40
41 `pigz`: `<integer>` ('default =' `0`)::
42
43 Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
44
45 `pool`: `<string>` ::
46
47 Backup all known guest systems included in the specified pool.
48
49 `prune-backups`: `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
50
51 Use these retention options instead of those from the storage configuration.
52
53 `keep-daily`=`<N>` ;;
54
55 Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept.
56
57 `keep-hourly`=`<N>` ;;
58
59 Keep backups for the last <N> different hours. If there is morethan one backup for a single hour, only the latest one is kept.
60
61 `keep-last`=`<N>` ;;
62
63 Keep the last <N> backups.
64
65 `keep-monthly`=`<N>` ;;
66
67 Keep backups for the last <N> different months. If there is morethan one backup for a single month, only the latest one is kept.
68
69 `keep-weekly`=`<N>` ;;
70
71 Keep backups for the last <N> different weeks. If there is morethan one backup for a single week, only the latest one is kept.
72
73 `keep-yearly`=`<N>` ;;
74
75 Keep backups for the last <N> different years. If there is morethan one backup for a single year, only the latest one is kept.
76
77 `remove`: `<boolean>` ('default =' `1`)::
78
79 Remove old backup files if there are more than 'maxfiles' backup files.
80
81 `script`: `<string>` ::
82
83 Use specified hook script.
84
85 `stdexcludes`: `<boolean>` ('default =' `1`)::
86
87 Exclude temporary files and logs.
88
89 `stopwait`: `<integer> (0 - N)` ('default =' `10`)::
90
91 Maximal time to wait until a guest system is stopped (minutes).
92
93 `storage`: `<string>` ::
94
95 Store resulting file to this storage.
96
97 `tmpdir`: `<string>` ::
98
99 Store temporary files to specified directory.
100
101 `zstd`: `<integer>` ('default =' `1`)::
102
103 Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count.
104