Imported Upstream version 2.4.4p3
[debian/amanda] / man / amcheck.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 .TH AMCHECK 8
11 .SH NAME
12 amcheck \- run Amanda self\-checks
13 .SH SYNOPSIS
14 .B amcheck
15 [
16 .B \-mwsclt
17 ]
18 [
19 .BI \-M address
20 ]
21 .I config
22 [
23 .I host
24 [
25 .I disk
26 ]*
27 ]*
28 .SH DESCRIPTION
29 .B Amcheck
30 runs a number of self\-checks on both the Amanda tape server host and
31 the Amanda client hosts.
32 .LP
33 On the tape server host,
34 .B amcheck
35 can go through the same tape checking used at the start of the nightly
36 .B amdump
37 run to verify the correct tape for the next run is mounted.
38 .LP
39 .B Amcheck
40 can also do a self\-check on all client hosts
41 to make sure each host is running and that permissions
42 on filesystems to be backed up are correct.
43 .LP
44 You can specify many host/disk expressions, only  disks that
45 match an expression will be checked. All disk are checked if no
46 expression are given.
47 .LP
48 See the
49 .IR amanda (8)
50 man page for more details about Amanda.
51 .SH OPTIONS
52 .TP
53 .B \-s
54 Run the tape server local and tape checks
55 (same as
56 .BR \-lt ).
57 .TP
58 .B \-c
59 Run the client host checks.
60 .TP
61 .B \-l
62 Run the local tests (e.g. permissions) on the server host.
63 .TP
64 .B \-t
65 Run the tape tests on the server host.
66 .TP
67 .B \-w
68 Enables a destructive check for write\-protection on the
69 tape (which would otherwise cause the subsequent
70 .B amdump
71 to fail).
72 If the tape
73 is writable, this check causes all data after the tape label to be
74 erased (actually depends on the device driver: there is no portable
75 non\-destructive way to check for write\-protection).
76 The check implies
77 .B \-t
78 and is only made if the tape is otherwise correct.
79 .TP
80 .B \-m
81 Nothing is printed, but mail is sent
82 if any errors are detected.
83 The mail goes to the
84 .B mailto
85 address specified in the
86 .I amanda.conf
87 file or the
88 .I address
89 value if
90 .B \-M
91 is set.
92 .TP
93 .B \-a
94 Like
95 .B \-m
96 but the mail is always sent.
97 .TP
98 .BI \-M address
99 Mail the report to
100 .I address
101 instead of the
102 .B mailto
103 value from
104 .IR amanda.conf .
105 Implies
106 .BR \-m .
107 .LP
108 The default is
109 .BR \-cs .
110 .SH EXAMPLES
111 In this example, both the tape server and client tests are run.
112 The results are displayed on standard output.
113 .LP
114 .RS
115 .EX
116 % amcheck @DEFAULT_CONFIG@
117 Amanda Tape Server Host Check
118 -----------------------------
119 /amanda2/amanda/work: 911475 KB disk space available, that's plenty.
120 NOTE: skipping tape-writable test.
121 Tape VOL10 label ok.
122 Server check took 34.966 seconds.
123
124 Amanda Backup Client Hosts Check
125 --------------------------------
126 WARNING: northstar: selfcheck request timed out.  Host down?
127 WARNING: drinkme: selfcheck request timed out.  Host down?
128 WARNING: scruffy: selfcheck request timed out.  Host down?
129 Client check: 136 hosts checked in 51.945 seconds, 3 problems found.
130
131 (brought to you by Amanda 2.4.2)
132 .EE
133 .RE
134 .LP
135 In this example, if the line
136 .B mailto csd-amanda
137 is in
138 .IR amanda.conf ,
139 mail will be sent to
140 .B csd-amanda
141 if the server check returns an error.
142 .LP
143 .RS
144 .EX
145 % amcheck \-s \-m @DEFAULT_CONFIG@
146 .EE
147 .RE
148 .SH MESSAGES
149 .TP
150 fatal slot \fIslot\fP: \fIerror message\fP
151 (error)
152 The tape changer detected some kind of fatal error
153 while trying to load slot
154 .IR slot .
155 .TP
156 slot \fIslot\fP: \fIerror message\fP
157 (warning)
158 The tape changer detected some kind of non-fatal error
159 (e.g. an empty slot was detected)
160 while trying to load slot
161 .IR slot ,
162 or an error was detected trying to read the tape label.
163 .TP
164 slot \fIslot\fP: date \fIYYYYMMDD\fP label \fIlabel\fP (\fIresult\fP)
165 (info)
166 Tape
167 .I label
168 in slot
169 .I slot
170 was loaded and found to have been last written on
171 .IR YYYYMMDD .
172 If the tape is new, the date field will be an
173 .IR X .
174 The
175 .I result
176 may be one of:
177 .RS
178 .TP
179 exact label match
180 This is the expected tape.
181 .TP
182 no match
183 This label does not match the
184 .B labelstr
185 pattern in
186 .IR amanda.conf .
187 Tape scanning will continue.
188 .TP
189 active tape
190 This tape is still active and cannot be overwritten.
191 Tape scanning will continue.
192 .TP
193 first labelstr match
194 This tape is the first one that matches the
195 .B labelstr
196 pattern in
197 .IR amanda.conf .
198 Tape scanning will continue if necessary.
199 .TP
200 labelstr match
201 This tape is the next one that matches the
202 .B labelstr
203 pattern in
204 .IR amanda.conf .
205 Tape scanning will continue.
206 .RE
207 .TP
208 ERROR: cannot look up dump user "\fIuser\fP"
209 (error)
210 Dump user
211 .I user
212 from
213 .I amanda.conf
214 could not be found in the system password information.
215 .TP
216 ERROR: cannot look up my own uid (\fIuid\fP)
217 (error)
218 User id
219 .I uid
220 running
221 .B amcheck
222 could not be found in the system password information.
223 .TP
224 ERROR: running as user "\fIrunuser\fP" instead of "\fIdumpuser\fP"
225 (error)
226 .B Amcheck
227 should be run as the dump user
228 .I dumpuser
229 from
230 .I amanda.conf
231 instead of
232 .IR runuser .
233 .TP
234 ERROR: program dir \fIdirectory\fP: not accessible
235 (error)
236 The directory Amanda expects to find its auxiliary programs in,
237 .IR directory ,
238 is not accessible.
239 .TP
240 ERROR: program \fIprogram\fP: does not exist
241 (error)
242 Program
243 .I program
244 needed on the tape server could not be found.
245 .TP
246 ERROR: program \fIprogram\fP: not a file
247 (error)
248 Program
249 .I program
250 needed on the tape server exists but is not a file.
251 .TP
252 ERROR: program \fIprogram\fP: not executable
253 (error)
254 Program
255 .I program
256 needed on the tape server exists but is not executable.
257 .TP
258 WARNING: program \fIprogram\fP: not setuid-root
259 (warning)
260 Program
261 .I program
262 needed on the tape server exists but should be owned by user "root"
263 and setuid.
264 .TP
265 ERROR: \fIXXX\fP dir \fIdirectory\fP: not writable
266 (error)
267 Directory
268 .I directory
269 is either not writable,
270 i.e. the dump user will not be able to create or remove files,
271 or cannot be accessed, perhaps because a parent directory
272 does not allow search permission.
273 The
274 .I XXX
275 may be:
276 .RS
277 .TP
278 log
279 for the Amanda log directory (see
280 .B logdir
281 in
282 .BR amanda.conf )
283 .TP
284 oldlog
285 for the directory that holds the old log files (see
286 .B logdir
287 in
288 .BR amanda.conf )
289 .TP
290 info
291 for an Amanda database information directory (see
292 .B curinfo
293 in
294 .BR amanda.conf )
295 or
296 .TP
297 index
298 for an Amanda index directory (see
299 .B indexdir
300 in
301 .BR amanda.conf )
302 .TP
303 tapelist
304 for the Amanda tapelist directory (see
305 .B tapelist
306 in
307 .BR amanda.conf )
308 .RE
309 .TP
310 NOTE: \fIXXX\fP dir \fIdirectory\fP: does not exist
311 (info)
312 A database (info) or index directory does not exist or cannot be accessed.
313 This might just mean this is a new client or disk,
314 but if that is not the case,
315 this should be treated as an error.
316 .TP
317 NOTE: it will be created on the next run
318 (info)
319 This indicates the info directory listed in the previous message
320 will be created on the next run.
321 .TP
322 ERROR: \fIXXX\fP dir \fIname\fP: not a directory
323 (error)
324 .B Amcheck
325 expected
326 .I name
327 to be a directory,
328 but it is something else (e.g. file).
329 .TP
330 WARNING: info file \fIfile\fP: does not exist
331 (warning)
332 File
333 .I file
334 does not exist in the text format database.
335 Since the parent directories do exist,
336 the file should already have been created.
337 .TP
338 ERROR: info file \fIname\fP: not a file
339 (error)
340 .B Amcheck
341 expected
342 .I name
343 to be a file,
344 but it is something else (e.g. file).
345 .TP
346 ERROR: info file \fIfile\fP: not readable
347 (error)
348 The text format database file
349 .I file
350 is not readable.
351 .TP
352 ERROR: log file \fIfile\fP: not writable
353 (error)
354 Log file
355 .I file
356 (file
357 .B log
358 in
359 .B logdir
360 from
361 .BR amanda.conf )
362 is either not writable,
363 or cannot be accessed, perhaps because a parent directory
364 does not allow search permission.
365 .TP
366 ERROR: tape list \fItapelist\fP: not writable
367 (error)
368 Amanda tape list file
369 .I tapelist
370 (see
371 .B tapelist
372 in
373 .BR amanda.conf )
374 is not writable or was not found.
375 .TP
376 ERROR: tape list \fItapelist\fP: parse error
377 (error)
378 Amanda tape list file
379 .I tapelist
380 (see
381 .B tapelist
382 in
383 .BR amanda.conf )
384 could not be read or parsed.
385 .TP
386 WARNING: tapedev is /dev/null, dumps will be thrown away
387 (warning)
388 The
389 .B tapedev
390 parameter in
391 .B amanda.conf
392 is set to
393 .B /dev/null
394 and Amanda uses that when debugging to throw all the dump images away.
395 .TP
396 WARNING: hold file \fIfile\fP exists
397 (info)
398 Hold file
399 .I file
400 exists and will cause
401 .B amdump
402 to pause at the beginning until it is removed.
403 .TP
404 ERROR: holding disk \fIdisk\fP: statfs: \fIerror message\fP
405 (error)
406 An error was returned from the
407 .I statfs
408 system call on holding disk
409 .I disk
410 (maybe because it does not exist).
411 .TP
412 ERROR: holding disk \fIdisk\fP: not writable
413 (error)
414 Holding disk
415 .IR disk ,
416 is not writable,
417 probably because the caller does not have write permission
418 or a parent directory does not allow search permission.
419 .TP
420 WARNING: holding disk \fIdisk\fP: available space unknown \fIN\fP KB requested.
421 (warning)
422 .B Amcheck
423 could not determine the amount of available space on holding disk
424 .I disk
425 to see if there were at least
426 .I N
427 KBytes available.
428 .TP
429 WARNING: holding disk \fIdisk\fP: only \fIF\fP KB free (\fIR\fP KB requested).
430 (warning)
431 .I Amanda.conf
432 requested
433 .I R
434 KBytes of free space on holding disk
435 .IR disk ,
436 but only
437 .I F
438 KBytes were available.
439 10 MBytes is subtracted for each backup process
440 (see the
441 .B inparallel
442 .I amanda.conf
443 option)
444 to allow for unexpected overruns.
445 .IP
446 Note:
447 even though this message is listed as a warning, it causes
448 .B amcheck
449 to exit with a non-zero status.
450 .TP
451 Holding disk \fIdisk\fP: \fIN\fP KB disk space available, that's plenty.
452 (info)
453 There was sufficient free space on holding disk
454 .IR disk .
455 .TP
456 WARNING: holding disk \fIdisk\fP: only \fIF\fP KB free, using nothing
457 (warning)
458 Holding disk
459 .I disk
460 has
461 .I F
462 KBytes of free space, but that is not enough for what is requested in
463 .IR amanda.conf .
464 .TP
465 Holding disk \fIdisk\fP: \fIF\fP KB disk space available, using \fIU\fP KB
466 (info)
467 Holding disk
468 .I disk
469 has
470 .I F
471 KBytes of free space and Amanda will be using up to
472 .I U
473 Kbytes.
474 .TP
475 WARNING: if a tape changer is not available, runtapes must be set to 1.
476 (warning)
477 The
478 .B runtapes
479 .I amanda.conf
480 option must be set to 1 if the
481 .B tpchanger
482 .I amanda.conf
483 option is not set.
484 .TP
485 ERROR: \fIerror message\fP.
486 (error)
487 An error was detected while initializing the tape changer.
488 .TP
489 ERROR: \fItape device\fP: \fIerror message\fP.
490 (error)
491 An error was detected while processing the tape label.
492 .TP
493 ERROR: cannot overwrite active tape \fIlabel\fP.
494 (error)
495 Tape
496 .I label
497 is still active and cannot be used.
498 .TP
499 ERROR: label \fIlabel\fP doesn't match labelstr "\fIpattern\fP".
500 (error)
501 The label on tape
502 .I label
503 does not match the
504 .B labelstr
505 .I amanda.conf
506 option.
507 .TP
508 (expecting a new tape)
509 (info)
510 The tape is not OK and a new tape was expected.
511 .TP
512 (expecting tape \fIlabel\fP or a new tape)
513 (info)
514 The tape is not OK and either tape
515 .I label
516 or a new tape was expected.
517 .TP
518 ERROR: tape \fIlabel\fP label ok, but is not writable.
519 (error)
520 Tape
521 .I label
522 is OK, but the write enable test failed.
523 .TP
524 Tape \fIlabel\fP is writable.
525 (info)
526 Tape
527 .I label
528 is OK and the write enable test succeeded.
529 .TP
530 NOTE: skipping tape-writable test.
531 (info)
532 The tape write test (see the
533 .B \-w
534 option) was not enabled.
535 .TP
536 WARNING: skipping tape test because amdump or amflush seem to be running
537 .TP
538 WARNING: if they are not, you must run amcleanup
539 (warning)
540 It looked to
541 .B amcheck
542 like either
543 .B amdump
544 or
545 .B amflush
546 were running because a log file or amdump file exists.
547 If they are not running, you probably need to run
548 .B amcleanup
549 to clear up a previous failure.
550 Otherwise, you need to wait until they complete before running
551 .BI amcheck .
552 .TP
553 NOTE: skipping tape checks
554 (info)
555 The tape tests are being skipped because you used the
556 .B \-t
557 command line option.
558 .TP
559 WARNING: \fIcompress\fP is not executable, server-compression and indexing will not work
560 (warning)
561 Compression program
562 .I compress
563 is not executable,
564 so compression on the tape server host and creating index files will not work.
565 .TP
566 Tape \fIlabel\fP label ok.
567 (info)
568 Tape
569 .I label
570 is OK for the next
571 run.
572 .TP
573 Server check took \fIS\fP seconds.
574 (info)
575 Reports how long the tape server host checks took.
576 .TP
577 ERROR: \fIhost\fP: could not resolve hostname
578 (error)
579 Could not look up client hostname
580 .IR host .
581 .TP
582 Client check: \fIH\fP hosts checked in \fIS\fP seconds, \fIN\fP problems found.
583 (info)
584 Reports the number of client hosts checked,
585 how long it took and the number of errors detected.
586 .TP
587 WARNING: \fIhost\fP: selfcheck request timed out.  Host down?
588 (warning)
589 There was no response from
590 .I host
591 when trying to do the client checks.
592 The host might really be down or it might not be configured properly.
593 .TP
594 ERROR: \fIhost\fP NAK: \fImessage\fP
595 (error)
596 .I Host
597 reported a negative acknowledgment error of
598 .I message
599 to the status check request.
600 .TP
601 ERROR: \fIhost\fP NAK: [NAK parse failed]
602 (error)
603 .B Amcheck
604 could not parse the negative acknowledgment error from
605 .IR host .
606 There might be an Amanda version mismatch between the host running
607 .B amcheck
608 and
609 .IR host .
610 .TP
611 ERROR: \fIhost\fP [mutual-authentication failed]
612 (error)
613 Kerberos authentication failed while contacting
614 .IR host .
615 .TP
616 ERROR: \fIhost\fP: \fImessage\fP
617 (error)
618 Error
619 .I message
620 was reported by the status check on
621 .IR host .
622 .SH AUTHOR
623 James da Silva <jds@cs.umd.edu>
624 .br
625 University of Maryland, College Park
626 .SH "SEE ALSO"
627 amanda(8),
628 amdump(8)