Imported Upstream version 2.5.1p3
[debian/amanda] / man / amadmin.8
1 .\"     Title: amadmin
2 .\"    Author: 
3 .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
4 .\"      Date: 02/07/2007
5 .\"    Manual: 
6 .\"    Source: 
7 .\"
8 .TH "AMADMIN" "8" "02/07/2007" "" ""
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 amadmin \- administrative interface to control Amanda backups
15 .SH "SYNOPSIS"
16 .HP 8
17 \fBamadmin\fR \fIconfig\fR \fIcommand\fR [\fIcommand_options\fR...] [\fB\-o\ \fR\fIconfigoption\fR]...
18 .SH "DESCRIPTION"
19 .PP
20 \fBAmadmin\fR
21 performs various administrative tasks on the
22 \fIconfig\fR
23 \fIAmanda\fR
24 configuration.
25 .PP
26 See the
27 \fBamanda\fR(8)
28 man page for more details about
29 \fIAmanda\fR.
30 .SH "COMMANDS"
31 .PP
32 Commands that take a
33 \fIhostname\fR
34 [
35 \fIdisks\fR
36 ] parameter pair operate on all disks in the
37 \fIdisklist\fR
38 for that
39 \fIhostname\fR
40 if no disks are specified. Where
41 \fIhostname\fR
42 is also marked as being optional, the command operates on all hosts and disks in the
43 \fIdisklist\fR. Both
44 \fIhostname\fR
45 and
46 \fIdisks\fR
47 are special expressions, see the "HOST & DISK EXPRESSION" section of
48 \fBamanda\fR(8)
49 for a description.
50 .PP
51 \fBversion\fR
52 .RS 4
53 Show the current version and some compile time and runtime parameters. The
54 \fIconfig\fR
55 parameter must be present but is ignored.
56 .RE
57 .PP
58 \fBforce\-bump\fR [ \fIhostname\fR [ \fIdisks\fR ]* ]+
59 .RS 4
60 Force the
61 \fIdisks\fR
62 on
63 \fIhostname\fR
64 to bump to a new incremental level during the next
65 \fIAmanda\fR
66 run.
67 .RE
68 .PP
69 \fBforce\-no\-bump\fR [ \fIhostname\fR [ \fIdisks\fR ]* ]+
70 .RS 4
71 Force the
72 \fIdisks\fR
73 on
74 \fIhostname\fR
75 to not bump to a new incremental level during the next
76 \fIAmanda\fR
77 run.
78 .RE
79 .PP
80 \fBunforce\-bump\fR [ \fIhostname\fR [ \fIdisks\fR ]* ]+
81 .RS 4
82 Undo a previous
83 \fBforce\-bump\fR
84 or
85 \fBforce\-no\-bump\fR
86 command.
87 .RE
88 .PP
89 \fBforce\fR [ \fIhostname\fR [ \fIdisks\fR ]* ]+
90 .RS 4
91 Force the
92 \fIdisks\fR
93 on
94 \fIhostname\fR
95 to do a full (level 0) backup during the next
96 \fIAmanda\fR
97 run.
98 .RE
99 .PP
100 \fBunforce\fR [ \fIhostname\fR [ \fIdisks\fR ]* ]+
101 .RS 4
102 Undo a previous
103 \fBforce\fR
104 command.
105 .RE
106 .PP
107 \fBreuse\fR \fItapelabel\fR [ ... ]
108 .RS 4
109 The tapes listed will be available for reuse at their point in the tape cycle.
110 .RE
111 .PP
112 \fBno\-reuse\fR \fItapelabel\fR [ ... ]
113 .RS 4
114 The tapes listed will not be reused when their turn comes up again in the tape cycle. Note that if this causes the number of reusable tapes to drop below the
115 \fBamanda.conf\fR
116 \fItapecycle\fR
117 value,
118 \fIAmanda\fR
119 will request new tapes until the count is satisfied again.
120 .RE
121 .PP
122 \fBdue\fR [ \fIhostname\fR [ \fIdisks\fR ]* ]*
123 .RS 4
124 Show when the next full dump is due.
125 .RE
126 .PP
127 \fBfind\fR [ \fB\-\-sort\fR \fIhkdlpb\fR ] [ \fIhostname\fR [ \fIdisks\fR ]* ]*
128 .RS 4
129 Display all backups currently on tape or in the holding disk. The tape label or holding disk filename, file number, and status are displayed.
130 .sp
131 The
132 \fB\-\-sort\fR
133 option changes the sort order using the following flags:
134 .sp
135 .RS 4
136 .nf
137 \fIh\fR: host name
138 \fIk\fR: disk name
139 \fId\fR: dump date
140 \fIl\fR: backup level
141 \fIp\fR: dump part
142 \fIb\fR: tape label
143 .fi
144 .RE
145 .sp
146 An uppercase letter reverses the sort order for that key. The default sort order is
147 \fBhkdlpb\fR.
148 .RE
149 .PP
150 \fBdelete\fR [ \fIhostname\fR [ \fIdisks\fR ]* ]+
151 .RS 4
152 Delete the specified
153 \fIdisks\fR
154 on
155 \fIhostname\fR
156 from the
157 \fIAmanda\fR
158 database.
159 .sp
160 .it 1 an-trap
161 .nr an-no-space-flag 1
162 .nr an-break-flag 1
163 .br
164 \fBNote\fR
165 If you do not also remove the disk from the
166 \fIdisklist\fR
167 file,
168 \fIAmanda\fR
169 will treat it as a new disk during the next run.
170 .RE
171 .PP
172 \fBtape\fR
173 .RS 4
174 Display the tape(s)
175 \fIAmanda\fR
176 expects to write to during the next run. See also
177 \fBamcheck\fR(8).
178 .RE
179 .PP
180 \fBbumpsize\fR
181 .RS 4
182 Display the current bump threshold parameters, calculated for all backup levels.
183 .RE
184 .PP
185 \fBbalance\fR [ \fB\-\-days\fR \fI<num>\fR ]
186 .RS 4
187 Display the distribution of full backups throughout the dump schedule.
188 .RE
189 .PP
190 \fBexport\fR [ \fIhostname\fR [ \fIdisks\fR ]* ]*
191 .RS 4
192 Convert records from the
193 \fIAmanda\fR
194 database to a text format that may be transmitted to another
195 \fIAmanda\fR
196 machine and
197 \fBimport\fRed.
198 .RE
199 .PP
200 \fBimport\fR
201 .RS 4
202 Convert
203 \fBexport\fRed records read from standard input to a form
204 \fIAmanda\fR
205 uses and insert them into the database on this machine.
206 .RE
207 .PP
208 \fBdisklist\fR [ \fIhostname\fR [ \fIdisks\fR ]* ]*
209 .RS 4
210 Display the
211 \fIdisklist\fR
212 information for each of the
213 \fIdisks\fR
214 on
215 \fIhostname\fR
216 (or all hosts). Mostly used for debugging.
217 .RE
218 .PP
219 \fBinfo\fR [ \fIhostname\fR [ \fIdisks\fR ]* ]*
220 .RS 4
221 Display the database record for each of the
222 \fIdisks\fR
223 on
224 \fIhostname\fR
225 (or all hosts). Mostly used for debugging.
226 .RE
227 .PP
228 \fB\-o\fR \fIconfigoption\fR
229 .RS 4
230 See the "\fBCONFIGURATION OVERWRITE\fR" section in
231 \fBamanda\fR(8).
232 .RE
233 .SH "EXAMPLES"
234 .PP
235 Request three specific file systems on
236 \fImachine\-a\fR
237 get a full level 0 backup during the next
238 \fIAmanda\fR
239 run.
240 .sp
241 .RS 4
242 .nf
243 $ amadmin daily force machine\-a / /var /usr
244 amadmin: machine\-a:/ is set to a forced level 0 tonight.
245 amadmin: machine\-a:/var is set to a forced level 0 tonight.
246 amadmin: machine\-a:/usr is set to a forced level 0 tonight.
247 .fi
248 .RE
249 .PP
250 Request all file systems on
251 \fImachine\-b\fR
252 get a full level 0 backup during the next
253 \fIAmanda\fR
254 run.
255 .sp
256 .RS 4
257 .nf
258 $ amadmin daily force machine\-b
259 amadmin: machine\-b:/ is set to a forced level 0 tonight.
260 amadmin: machine\-b:/var is set to a forced level 0 tonight.
261 amadmin: machine\-b:/usr is set to a forced level 0 tonight.
262 amadmin: machine\-b:/home is set to a forced level 0 tonight.
263 .fi
264 .RE
265 .PP
266 Undo the previous
267 \fBforce\fR
268 request for
269 \fI/home\fR
270 on
271 \fImachine\-b\fR. The other file systems will still get a full level 0 backup.
272 .sp
273 .RS 4
274 .nf
275 $ amadmin daily unforce machine\-b /home
276 amadmin: force command for machine\-b:/home cleared.
277 .fi
278 .RE
279 .PP
280 Locate backup images of
281 \fI/var\fR
282 from
283 \fImachine\-c\fR. The
284 \fItape or file\fR
285 column displays either a tape label or a filename depending on whether the image is on tape or is still in the holding disk. If the image is on tape, the
286 \fIfile\fR
287 column tells you which file on the tape has the image (file number zero is a tape label). This column shows zero and is not meaningful if the image is still in the holding disk. The
288 \fIstatus\fR
289 column tells you whether the backup was successful or had some type of error.
290 .sp
291 .RS 4
292 .nf
293 $ amadmin daily find machine\-c /var
294 date        host      disk lv tape or file                 file part  status
295 2000\-11\-09  machine\-c /var  0 000110                       9   \-\-  OK
296 2000\-11\-08  machine\-c /var  2 000109                       2   \-\-  OK
297 2000\-11\-07  machine\-c /var  2 /amanda/20001107/machine\-c._var.2  0 OK
298 2000\-11\-06  machine\-c /var  2 000107                       2   \-\-  OK
299 2000\-11\-05  machine\-c /var  2 000106                       3   \-\-  OK
300 2000\-11\-04  machine\-c /var  2 000105                       2   \-\-  OK
301 2000\-11\-03  machine\-c /var  2 000104                       2   \-\-  OK
302 2000\-11\-02  machine\-c /var  2 000103                       2   \-\-  OK
303 2000\-11\-01  machine\-c /var  1 000102                       5   \-\-  OK
304 2000\-10\-31  machine\-c /var  1 000101                       3   \-\-  OK
305 .fi
306 .RE
307 .PP
308 Forget about the
309 \fI/workspace\fR
310 disk on
311 \fImachine\-d\fR. If you do not also remove the disk from the
312 \fIdisklist\fR
313 file,
314 \fIAmanda\fR
315 will treat it as a new disk during the next run.
316 .sp
317 .RS 4
318 .nf
319 $ amadmin daily delete machine\-d /workspace
320 amadmin: machine\-d:/workspace deleted from database.
321 amadmin: NOTE: you'll have to remove these from the disklist yourself.
322 .fi
323 .RE
324 .PP
325 Find the next tape
326 \fIAmanda\fR
327 will use (in this case,
328 123456).
329 .sp
330 .RS 4
331 .nf
332 $ amadmin daily tape
333 The next \fIAmanda\fR run should go onto tape 123456 or a new tape.
334 .fi
335 .RE
336 .PP
337 Show how well full backups are balanced across the dump cycle. The
338 \fIdue\-date\fR
339 column is the day the backups are due for a full backup.
340 \fI#fs\fR
341 shows the number of filesystems doing full backups that night, and
342 \fIorig KB\fR
343 and
344 \fIout KB\fR
345 show the estimated total size of the backups before and after any compression, respectively.
346 .PP
347 The
348 \fIbalance\fR
349 column shows how far off that night's backups are from the average size (shown at the bottom of the balance column).
350 \fIAmanda\fR
351 tries to keep the backups within +/\- 5%, but since the amount of data on each filesystem is always changing, and
352 \fIAmanda\fR
353 will never delay backups just to rebalance the schedule, it is common for the schedule to fluctuate by larger percentages. In particular, in the case of a tape or backup failure, a bump will occur the following night, which will not be smoothed out until the next pass through the schedule.
354 .PP
355 The last line also shows an estimate of how many
356 \fIAmanda\fR
357 runs will be made between full backups for a file system. In the example, a file system will probably have a full backup done every eight times
358 \fIAmanda\fR
359 is run (e.g. every eight days).
360 .sp
361 .RS 4
362 .nf
363 $ amadmin daily balance
364  due\-date  #fs   orig KB    out KB  balance
365 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
366 11/10 Mon   21    930389    768753    +5.1%
367 11/11 Tue   29   1236272    733211    +0.2%
368 11/12 Wed   31   1552381    735796    +0.6%
369 11/13 Thu   23   1368447    684552    \-6.4%
370 11/14 Fri   32   1065603    758155    +3.6%
371 11/15 Sat   14   1300535    738430    +0.9%
372 11/16 Sun   31   1362696    740365    +1.2%
373 11/17 Mon   30   1427936    773397    +5.7%
374 11/18 Tue   11   1059191    721786    \-1.3%
375 11/19 Wed   19   1108737    661867    \-9.5%
376 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
377 TOTAL      241  12412187   7316312   731631  (estimated 8 runs per dumpcycle)
378 .fi
379 .RE
380 .SH "FILES"
381 .PP
382 /usr/local/etc/amanda/\fIconfig\fR/amanda.conf
383 .SH "AUTHOR"
384 .PP
385 James da Silva,
386 <jds@amanda.org>
387 : Original text
388 .PP
389 Stefan G. Weichinger,
390 <sgw@amanda.org>, maintainer of the
391 \fIAmanda\fR\-documentation: XML\-conversion
392 .SH "SEE ALSO"
393 .PP
394 \fBamanda\fR(8),
395 \fBamcheck\fR(8),
396 \fBamdump\fR(8),
397 \fBamrestore\fR(8),
398 \fBamfetchdump\fR(8)