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