]>
Commit | Line | Data |
---|---|---|
274b47fc DM |
1 | *pmgbackup* `<COMMAND> [ARGS] [OPTIONS]` |
2 | ||
3 | *pmgbackup backup* `[OPTIONS]` | |
4 | ||
5 | Backup the system configuration. | |
6 | ||
c5ccf1ab TL |
7 | `--notify` `<always | error | never>` ('default =' `never`):: |
8 | ||
9 | Specify when to notify via e-mail | |
10 | ||
274b47fc DM |
11 | `--statistic` `<boolean>` ('default =' `1`):: |
12 | ||
13 | Backup statistic databases. | |
14 | ||
b81b1f95 | 15 | *pmgbackup help* `[OPTIONS]` |
274b47fc DM |
16 | |
17 | Get help about specified command. | |
18 | ||
b81b1f95 | 19 | `--extra-args` `<array>` :: |
274b47fc | 20 | |
b81b1f95 | 21 | Shows help for a specific command |
274b47fc DM |
22 | |
23 | `--verbose` `<boolean>` :: | |
24 | ||
25 | Verbose output format. | |
26 | ||
274b47fc DM |
27 | *pmgbackup list* |
28 | ||
29 | List all stored backups (files named proxmox-backup_{DATE}.tgz). | |
30 | ||
c5ccf1ab | 31 | *pmgbackup proxmox-backup backup* `<remote>` `[OPTIONS]` |
ab2b846b TL |
32 | |
33 | Create a new backup and prune the backup group afterwards, if configured. | |
34 | ||
35 | `<remote>`: `<string>` :: | |
36 | ||
37 | Proxmox Backup Server ID. | |
38 | ||
c5ccf1ab TL |
39 | `--notify` `<always | error | never>` ('default =' `never`):: |
40 | ||
41 | Specify when to notify via e-mail | |
42 | ||
43 | `--statistic` `<boolean>` ('default =' `1`):: | |
44 | ||
45 | Backup statistic databases. | |
46 | ||
ab2b846b TL |
47 | *pmgbackup proxmox-backup forget* `<remote> <backup-id> <backup-time>` |
48 | ||
49 | Forget a snapshot | |
50 | ||
51 | `<remote>`: `<string>` :: | |
52 | ||
53 | Proxmox Backup Server ID. | |
54 | ||
55 | `<backup-id>`: `<string>` :: | |
56 | ||
57 | ID (hostname) of backup snapshot | |
58 | ||
59 | `<backup-time>`: `<string>` :: | |
60 | ||
61 | Backup time in RFC 3339 format | |
62 | ||
63 | *pmgbackup proxmox-backup job create* `<remote>` `[OPTIONS]` | |
64 | ||
65 | Create backup schedule | |
66 | ||
67 | `<remote>`: `<string>` :: | |
68 | ||
69 | Proxmox Backup Server ID. | |
70 | ||
71 | `--delay` `[0-9a-zA-Z. ]+` ('default =' `5min`):: | |
72 | ||
73 | Randomized delay to add to the starttime (RandomizedDelaySec setting of the systemd.timer) | |
74 | ||
75 | `--schedule` `[0-9a-zA-Z*.:,\-/ ]+` ('default =' `daily`):: | |
76 | ||
77 | Schedule for the backup (OnCalendar setting of the systemd.timer) | |
78 | ||
79 | *pmgbackup proxmox-backup job delete* `<remote>` | |
80 | ||
81 | Delete backup schedule | |
82 | ||
83 | `<remote>`: `<string>` :: | |
84 | ||
85 | Proxmox Backup Server ID. | |
86 | ||
87 | *pmgbackup proxmox-backup job show* `<remote>` `[FORMAT_OPTIONS]` | |
88 | ||
89 | Get timer specification | |
90 | ||
91 | `<remote>`: `<string>` :: | |
92 | ||
93 | Proxmox Backup Server ID. | |
94 | ||
95 | *pmgbackup proxmox-backup list* `<remote>` `[FORMAT_OPTIONS]` | |
96 | ||
97 | Get snapshots stored on remote. | |
98 | ||
99 | `<remote>`: `<string>` :: | |
100 | ||
101 | Proxmox Backup Server ID. | |
102 | ||
103 | *pmgbackup proxmox-backup remote add* `<remote> --datastore <string> --server <string>` `[OPTIONS]` | |
104 | ||
105 | Add Proxmox Backup Server remote instance. | |
106 | ||
107 | `<remote>`: `<string>` :: | |
108 | ||
109 | Proxmox Backup Server ID. | |
110 | ||
0b9926d3 | 111 | `--datastore` `(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)` :: |
ab2b846b TL |
112 | |
113 | Proxmox Backup Server datastore name. | |
114 | ||
115 | `--disable` `<boolean>` :: | |
116 | ||
117 | Flag to disable (deactivate) the entry. | |
118 | ||
119 | `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` :: | |
120 | ||
121 | Certificate SHA 256 fingerprint. | |
122 | ||
c5ccf1ab TL |
123 | `--include-statistics` `<boolean>` :: |
124 | ||
125 | Include statistics in scheduled backups | |
126 | ||
ab2b846b TL |
127 | `--keep-daily` `<N>` :: |
128 | ||
129 | Keep backups for the last <N> different days. If there is more than one backup for a single day, only the latest one is kept. | |
130 | ||
131 | `--keep-hourly` `<N>` :: | |
132 | ||
133 | Keep backups for the last <N> different hours. If there is more than one backup for a single hour, only the latest one is kept. | |
134 | ||
135 | `--keep-last` `<N>` :: | |
136 | ||
137 | Keep the last <N> backups. | |
138 | ||
139 | `--keep-monthly` `<N>` :: | |
140 | ||
141 | Keep backups for the last <N> different months. If there is more than one backup for a single month, only the latest one is kept. | |
142 | ||
143 | `--keep-weekly` `<N>` :: | |
144 | ||
145 | Keep backups for the last <N> different weeks. If there ismore than one backup for a single week, only the latest one is kept. | |
146 | ||
147 | `--keep-yearly` `<N>` :: | |
148 | ||
149 | Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept. | |
150 | ||
0b9926d3 TL |
151 | `--namespace` `(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*))?` :: |
152 | ||
153 | Proxmox Backup Server namespace in the datastore, defaults to the root NS. | |
154 | ||
c5ccf1ab TL |
155 | `--notify` `<always | error | never>` :: |
156 | ||
157 | Specify when to notify via e-mail | |
158 | ||
ab2b846b TL |
159 | `--password` `<password>` :: |
160 | ||
161 | Password or API token secret for the user on the Proxmox Backup Server. | |
162 | ||
163 | `--server` `<string>` :: | |
164 | ||
165 | Proxmox Backup Server address. | |
166 | ||
c5ccf1ab | 167 | `--username` `(?:[^\s\\@]+\@[^\s\/\\@]+)` :: |
ab2b846b TL |
168 | |
169 | Username or API token ID on the Proxmox Backup Server | |
170 | ||
171 | *pmgbackup proxmox-backup remote list* `[FORMAT_OPTIONS]` | |
172 | ||
173 | List all configured Proxmox Backup Server instances. | |
174 | ||
175 | *pmgbackup proxmox-backup remote remove* `<remote>` | |
176 | ||
177 | Delete an PBS remote | |
178 | ||
179 | `<remote>`: `<string>` :: | |
180 | ||
181 | Profile ID. | |
182 | ||
183 | *pmgbackup proxmox-backup remote set* `<remote>` `[OPTIONS]` | |
184 | ||
185 | Update PBS remote settings. | |
186 | ||
187 | `<remote>`: `<string>` :: | |
188 | ||
189 | Proxmox Backup Server ID. | |
190 | ||
0b9926d3 | 191 | `--datastore` `(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)` :: |
ab2b846b TL |
192 | |
193 | Proxmox Backup Server datastore name. | |
194 | ||
195 | `--delete` `<string>` :: | |
196 | ||
197 | A list of settings you want to delete. | |
198 | ||
199 | `--digest` `<string>` :: | |
200 | ||
201 | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | |
202 | ||
203 | `--disable` `<boolean>` :: | |
204 | ||
205 | Flag to disable (deactivate) the entry. | |
206 | ||
207 | `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` :: | |
208 | ||
209 | Certificate SHA 256 fingerprint. | |
210 | ||
c5ccf1ab TL |
211 | `--include-statistics` `<boolean>` :: |
212 | ||
213 | Include statistics in scheduled backups | |
214 | ||
ab2b846b TL |
215 | `--keep-daily` `<N>` :: |
216 | ||
217 | Keep backups for the last <N> different days. If there is more than one backup for a single day, only the latest one is kept. | |
218 | ||
219 | `--keep-hourly` `<N>` :: | |
220 | ||
221 | Keep backups for the last <N> different hours. If there is more than one backup for a single hour, only the latest one is kept. | |
222 | ||
223 | `--keep-last` `<N>` :: | |
224 | ||
225 | Keep the last <N> backups. | |
226 | ||
227 | `--keep-monthly` `<N>` :: | |
228 | ||
229 | Keep backups for the last <N> different months. If there is more than one backup for a single month, only the latest one is kept. | |
230 | ||
231 | `--keep-weekly` `<N>` :: | |
232 | ||
233 | Keep backups for the last <N> different weeks. If there ismore than one backup for a single week, only the latest one is kept. | |
234 | ||
235 | `--keep-yearly` `<N>` :: | |
236 | ||
237 | Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept. | |
238 | ||
0b9926d3 TL |
239 | `--namespace` `(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*))?` :: |
240 | ||
241 | Proxmox Backup Server namespace in the datastore, defaults to the root NS. | |
242 | ||
c5ccf1ab TL |
243 | `--notify` `<always | error | never>` :: |
244 | ||
245 | Specify when to notify via e-mail | |
246 | ||
ab2b846b TL |
247 | `--password` `<password>` :: |
248 | ||
249 | Password or API token secret for the user on the Proxmox Backup Server. | |
250 | ||
251 | `--server` `<string>` :: | |
252 | ||
253 | Proxmox Backup Server address. | |
254 | ||
c5ccf1ab | 255 | `--username` `(?:[^\s\\@]+\@[^\s\/\\@]+)` :: |
ab2b846b TL |
256 | |
257 | Username or API token ID on the Proxmox Backup Server | |
258 | ||
259 | *pmgbackup proxmox-backup restore* `<remote> <backup-id> <backup-time>` `[OPTIONS]` | |
260 | ||
261 | Restore the system configuration. | |
262 | ||
263 | `<remote>`: `<string>` :: | |
264 | ||
265 | Proxmox Backup Server ID. | |
266 | ||
267 | `<backup-id>`: `<string>` :: | |
268 | ||
269 | backup-id (hostname) of backup snapshot | |
270 | ||
271 | `<backup-time>`: `<string>` :: | |
272 | ||
273 | backup-time to restore | |
274 | ||
275 | `--config` `<boolean>` ('default =' `0`):: | |
276 | ||
277 | Restore system configuration. | |
278 | ||
279 | `--database` `<boolean>` ('default =' `1`):: | |
280 | ||
281 | Restore the rule database. This is the default. | |
282 | ||
283 | `--statistic` `<boolean>` ('default =' `0`):: | |
284 | ||
285 | Restore statistic databases. Only considered when you restore the 'database'. | |
286 | ||
274b47fc DM |
287 | *pmgbackup restore* `--filename <string>` `[OPTIONS]` |
288 | ||
289 | Restore the system configuration. | |
290 | ||
291 | `--config` `<boolean>` ('default =' `0`):: | |
292 | ||
293 | Restore system configuration. | |
294 | ||
295 | `--database` `<boolean>` ('default =' `1`):: | |
296 | ||
297 | Restore the rule database. This is the default. | |
298 | ||
299 | `--filename` `pmg-backup_[0-9A-Za-z_-]+\.tgz` :: | |
300 | ||
301 | The backup file name. | |
302 | ||
303 | `--statistic` `<boolean>` ('default =' `0`):: | |
304 | ||
305 | Restore statistic databases. Only considered when you restore the 'database'. | |
306 | ||
307 |