]>
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 | |
c6d5bae8 | 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 | |
c6d5bae8 | 27 | Deprecated: use notification targets/matchers instead. Specify when to send a notification mail |
d083d3d3 | 28 | |
013dc89f | 29 | `mailto`: `<string>` :: |
d083d3d3 | 30 | |
c6d5bae8 | 31 | Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications. |
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 | ||
c6d5bae8 TL |
47 | `notification-mode`: `<auto | legacy-sendmail | notification-system>` ('default =' `auto`):: |
48 | ||
49 | Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. | |
50 | ||
82551b2b TL |
51 | `notification-policy`: `<always | failure | never>` ('default =' `always`):: |
52 | ||
c6d5bae8 | 53 | Deprecated: Do not use |
82551b2b TL |
54 | |
55 | `notification-target`: `<string>` :: | |
56 | ||
c6d5bae8 | 57 | Deprecated: Do not use |
82551b2b TL |
58 | |
59 | `performance`: `[max-workers=<integer>] [,pbs-entries-max=<integer>]` :: | |
4e7f60c2 TL |
60 | |
61 | Other performance-related settings. | |
62 | ||
63 | `max-workers`=`<integer> (1 - 256)` ('default =' `16`);; | |
64 | ||
65 | Applies to VMs. Allow up to this many IO workers at the same time. | |
66 | ||
82551b2b TL |
67 | `pbs-entries-max`=`<integer> (1 - N)` ('default =' `1048576`);; |
68 | ||
69 | 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. | |
70 | ||
013dc89f | 71 | `pigz`: `<integer>` ('default =' `0`):: |
d083d3d3 | 72 | |
c2993fe5 | 73 | Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. |
d083d3d3 | 74 | |
9226ccbc TL |
75 | `pool`: `<string>` :: |
76 | ||
77 | Backup all known guest systems included in the specified pool. | |
78 | ||
7af2edf9 TL |
79 | `protected`: `<boolean>` :: |
80 | ||
81 | If true, mark backup(s) as protected. | |
82 | + | |
83 | NOTE: Requires option(s): `storage` | |
84 | ||
0695fdaf | 85 | `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 |
86 | |
87 | Use these retention options instead of those from the storage configuration. | |
88 | ||
4772952b TL |
89 | `keep-all`=`<boolean>` ;; |
90 | ||
91 | Keep all backups. Conflicts with the other options when true. | |
92 | ||
739d4d64 TL |
93 | `keep-daily`=`<N>` ;; |
94 | ||
95 | Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept. | |
96 | ||
97 | `keep-hourly`=`<N>` ;; | |
98 | ||
99 | Keep backups for the last <N> different hours. If there is morethan one backup for a single hour, only the latest one is kept. | |
100 | ||
101 | `keep-last`=`<N>` ;; | |
102 | ||
103 | Keep the last <N> backups. | |
104 | ||
105 | `keep-monthly`=`<N>` ;; | |
106 | ||
107 | Keep backups for the last <N> different months. If there is morethan one backup for a single month, only the latest one is kept. | |
108 | ||
109 | `keep-weekly`=`<N>` ;; | |
110 | ||
111 | Keep backups for the last <N> different weeks. If there is morethan one backup for a single week, only the latest one is kept. | |
112 | ||
113 | `keep-yearly`=`<N>` ;; | |
114 | ||
115 | Keep backups for the last <N> different years. If there is morethan one backup for a single year, only the latest one is kept. | |
116 | ||
013dc89f | 117 | `remove`: `<boolean>` ('default =' `1`):: |
d083d3d3 | 118 | |
0695fdaf | 119 | Prune older backups according to 'prune-backups'. |
d083d3d3 | 120 | |
013dc89f | 121 | `script`: `<string>` :: |
d083d3d3 DM |
122 | |
123 | Use specified hook script. | |
124 | ||
013dc89f | 125 | `stdexcludes`: `<boolean>` ('default =' `1`):: |
d083d3d3 DM |
126 | |
127 | Exclude temporary files and logs. | |
128 | ||
013dc89f | 129 | `stopwait`: `<integer> (0 - N)` ('default =' `10`):: |
d083d3d3 DM |
130 | |
131 | Maximal time to wait until a guest system is stopped (minutes). | |
132 | ||
013dc89f | 133 | `storage`: `<string>` :: |
d083d3d3 DM |
134 | |
135 | Store resulting file to this storage. | |
136 | ||
013dc89f | 137 | `tmpdir`: `<string>` :: |
d083d3d3 DM |
138 | |
139 | Store temporary files to specified directory. | |
140 | ||
c5aa7e14 TL |
141 | `zstd`: `<integer>` ('default =' `1`):: |
142 | ||
c6d5bae8 | 143 | Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. |
c5aa7e14 | 144 |