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