]>
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 | Specify when to send an email | |
28 | ||
29 | `mailto`: `<string>` :: | |
30 | ||
31 | Comma-separated list of email addresses or users that should receive email notifications. | |
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 | `performance`: `[max-workers=<integer>]` :: | |
48 | ||
49 | Other performance-related settings. | |
50 | ||
51 | `max-workers`=`<integer> (1 - 256)` ('default =' `16`);; | |
52 | ||
53 | Applies to VMs. Allow up to this many IO workers at the same time. | |
54 | ||
55 | `pigz`: `<integer>` ('default =' `0`):: | |
56 | ||
57 | Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. | |
58 | ||
59 | `pool`: `<string>` :: | |
60 | ||
61 | Backup all known guest systems included in the specified pool. | |
62 | ||
63 | `protected`: `<boolean>` :: | |
64 | ||
65 | If true, mark backup(s) as protected. | |
66 | + | |
67 | NOTE: Requires option(s): `storage` | |
68 | ||
69 | `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`):: | |
70 | ||
71 | Use these retention options instead of those from the storage configuration. | |
72 | ||
73 | `keep-all`=`<boolean>` ;; | |
74 | ||
75 | Keep all backups. Conflicts with the other options when true. | |
76 | ||
77 | `keep-daily`=`<N>` ;; | |
78 | ||
79 | Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept. | |
80 | ||
81 | `keep-hourly`=`<N>` ;; | |
82 | ||
83 | Keep backups for the last <N> different hours. If there is morethan one backup for a single hour, only the latest one is kept. | |
84 | ||
85 | `keep-last`=`<N>` ;; | |
86 | ||
87 | Keep the last <N> backups. | |
88 | ||
89 | `keep-monthly`=`<N>` ;; | |
90 | ||
91 | Keep backups for the last <N> different months. If there is morethan one backup for a single month, only the latest one is kept. | |
92 | ||
93 | `keep-weekly`=`<N>` ;; | |
94 | ||
95 | Keep backups for the last <N> different weeks. If there is morethan one backup for a single week, only the latest one is kept. | |
96 | ||
97 | `keep-yearly`=`<N>` ;; | |
98 | ||
99 | Keep backups for the last <N> different years. If there is morethan one backup for a single year, only the latest one is kept. | |
100 | ||
101 | `remove`: `<boolean>` ('default =' `1`):: | |
102 | ||
103 | Prune older backups according to 'prune-backups'. | |
104 | ||
105 | `script`: `<string>` :: | |
106 | ||
107 | Use specified hook script. | |
108 | ||
109 | `stdexcludes`: `<boolean>` ('default =' `1`):: | |
110 | ||
111 | Exclude temporary files and logs. | |
112 | ||
113 | `stopwait`: `<integer> (0 - N)` ('default =' `10`):: | |
114 | ||
115 | Maximal time to wait until a guest system is stopped (minutes). | |
116 | ||
117 | `storage`: `<string>` :: | |
118 | ||
119 | Store resulting file to this storage. | |
120 | ||
121 | `tmpdir`: `<string>` :: | |
122 | ||
123 | Store temporary files to specified directory. | |
124 | ||
125 | `zstd`: `<integer>` ('default =' `1`):: | |
126 | ||
127 | Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count. | |
128 |