]>
Commit | Line | Data |
---|---|---|
013dc89f | 1 | `bwlimit`: `<integer> (0 - N)` ('default =' `0`):: |
d083d3d3 | 2 | |
4a407cfd | 3 | Limit I/O bandwidth (in KiB/s). |
d083d3d3 | 4 | |
c5aa7e14 | 5 | `compress`: `<0 | 1 | gzip | lzo | zstd>` ('default =' `0`):: |
d083d3d3 DM |
6 | |
7 | Compress dump file. | |
8 | ||
013dc89f | 9 | `dumpdir`: `<string>` :: |
d083d3d3 DM |
10 | |
11 | Store resulting files to specified directory. | |
12 | ||
4a407cfd | 13 | `exclude-path`: `<array>` :: |
d083d3d3 | 14 | |
d2656385 | 15 | Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. |
d083d3d3 | 16 | |
013dc89f | 17 | `ionice`: `<integer> (0 - 8)` ('default =' `7`):: |
d083d3d3 | 18 | |
159464a9 | 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. |
d083d3d3 | 20 | |
013dc89f | 21 | `lockwait`: `<integer> (0 - N)` ('default =' `180`):: |
d083d3d3 DM |
22 | |
23 | Maximal time to wait for the global lock (minutes). | |
24 | ||
013dc89f | 25 | `mailnotification`: `<always | failure>` ('default =' `always`):: |
d083d3d3 | 26 | |
82551b2b | 27 | Deprecated: use 'notification-policy' instead. |
d083d3d3 | 28 | |
013dc89f | 29 | `mailto`: `<string>` :: |
d083d3d3 | 30 | |
82551b2b | 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. |
d083d3d3 | 32 | |
0695fdaf | 33 | `maxfiles`: `<integer> (1 - N)` :: |
d083d3d3 | 34 | |
0695fdaf | 35 | Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system. |
d083d3d3 | 36 | |
013dc89f | 37 | `mode`: `<snapshot | stop | suspend>` ('default =' `snapshot`):: |
d083d3d3 DM |
38 | |
39 | Backup mode. | |
40 | ||
7af2edf9 TL |
41 | `notes-template`: `<string>` :: |
42 | ||
4e7f60c2 | 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. |
7af2edf9 TL |
44 | + |
45 | NOTE: Requires option(s): `storage` | |
46 | ||
82551b2b TL |
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>]` :: | |
4e7f60c2 TL |
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 | ||
82551b2b TL |
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 | ||
013dc89f | 67 | `pigz`: `<integer>` ('default =' `0`):: |
d083d3d3 | 68 | |
c2993fe5 | 69 | Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. |
d083d3d3 | 70 | |
9226ccbc TL |
71 | `pool`: `<string>` :: |
72 | ||
73 | Backup all known guest systems included in the specified pool. | |
74 | ||
7af2edf9 TL |
75 | `protected`: `<boolean>` :: |
76 | ||
77 | If true, mark backup(s) as protected. | |
78 | + | |
79 | NOTE: Requires option(s): `storage` | |
80 | ||
0695fdaf | 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`):: |
739d4d64 TL |
82 | |
83 | Use these retention options instead of those from the storage configuration. | |
84 | ||
4772952b TL |
85 | `keep-all`=`<boolean>` ;; |
86 | ||
87 | Keep all backups. Conflicts with the other options when true. | |
88 | ||
739d4d64 TL |
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 | ||
013dc89f | 113 | `remove`: `<boolean>` ('default =' `1`):: |
d083d3d3 | 114 | |
0695fdaf | 115 | Prune older backups according to 'prune-backups'. |
d083d3d3 | 116 | |
013dc89f | 117 | `script`: `<string>` :: |
d083d3d3 DM |
118 | |
119 | Use specified hook script. | |
120 | ||
013dc89f | 121 | `stdexcludes`: `<boolean>` ('default =' `1`):: |
d083d3d3 DM |
122 | |
123 | Exclude temporary files and logs. | |
124 | ||
013dc89f | 125 | `stopwait`: `<integer> (0 - N)` ('default =' `10`):: |
d083d3d3 DM |
126 | |
127 | Maximal time to wait until a guest system is stopped (minutes). | |
128 | ||
013dc89f | 129 | `storage`: `<string>` :: |
d083d3d3 DM |
130 | |
131 | Store resulting file to this storage. | |
132 | ||
013dc89f | 133 | `tmpdir`: `<string>` :: |
d083d3d3 DM |
134 | |
135 | Store temporary files to specified directory. | |
136 | ||
c5aa7e14 TL |
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 |