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