1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
5 <!-- entities files to use -->
6 <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
10 <!-- lifted from troff+man by doclifter -->
11 <refentry id='amcheck.8'>
14 <refentrytitle>amcheck</refentrytitle>
15 <manvolnum>8</manvolnum>
18 <refname>amcheck</refname>
19 <refpurpose>run &A; self-checks</refpurpose>
21 <!-- body begins here -->
24 <command>amcheck</command>
25 <arg choice='opt'>-mwsclt </arg>
26 <arg choice='opt'>-Maddress </arg>
27 <arg choice='plain'><replaceable>config</replaceable></arg>
28 <arg choice='opt' rep='repeat'><arg choice='plain'><replaceable>host</replaceable></arg><arg choice='opt' rep='repeat'><replaceable>disk</replaceable></arg></arg>
34 <refsect1><title>DESCRIPTION</title>
35 <para><emphasis remap='B'>Amcheck</emphasis>
36 runs a number of self-checks on both the &A; tape server host and
37 the &A; client hosts.</para>
39 <para>On the tape server host,
40 <command>amcheck</command>
41 can go through the same tape checking used at the start of the nightly
42 <emphasis remap='B'>amdump</emphasis>
43 run to verify the correct tape for the next run is mounted.</para>
45 <para><emphasis remap='B'>Amcheck</emphasis>
46 can also do a self-check on all client hosts
47 to make sure each host is running and that permissions
48 on filesystems to be backed up are correct.</para>
50 <para>You can specify many host/disk expressions, only disks that
51 match an expression will be checked. All disks are checked if no
52 expressions are given.</para>
55 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
56 man page for more details about &A;.</para>
59 <refsect1><title>OPTIONS</title>
60 <variablelist remap='TP'>
62 <term><option>-s</option></term>
64 <para>Run the tape server local and tape checks (same as
65 <option>-lt</option>).</para>
69 <term><option>-c</option></term>
71 <para>Run the client host checks.</para>
75 <term><option>-l</option></term>
77 <para>Run the local tests (e.g. permissions) on the server host.</para>
81 <term><option>-t</option></term>
83 <para>Run the tape tests on the server host.</para>
87 <term><option>-w</option></term>
89 <para>Enables a DESTRUCTIVE check for write-protection on the
90 tape (which would otherwise cause the subsequent
91 <emphasis remap='B'>amdump</emphasis>
94 is writable, this check causes all data after the tape label to be
95 erased. If the label_new_tapes option is enabled, this check may ERASE
96 any non-Amanda tape in the drive or changer.
99 and is only made if the tape is otherwise correct.</para>
103 <term><option>-m</option></term>
105 <para>Nothing is printed, but mail is sent if any errors are detected.
107 <emphasis remap='B'>mailto</emphasis>
108 address specified in the
109 <emphasis remap='I'>amanda.conf</emphasis>
111 <emphasis remap='I'>address</emphasis>
118 <term><option>-a</option></term>
122 but the mail is always sent.</para>
126 <term><option>-M</option><replaceable>address</replaceable></term>
128 <para>Mail the report to
129 <emphasis remap='I'>address</emphasis>
131 <emphasis remap='B'>mailto</emphasis>
133 <emphasis remap='I'>amanda.conf</emphasis>.
135 <option>-m</option>.</para>
141 <option>-cs</option>.</para>
144 <refsect1><title>EXAMPLES</title>
145 <para>In this example, both the tape server and client tests are run.
146 The results are displayed on standard output.</para>
150 &A; Tape Server Host Check
151 -----------------------------
152 /amanda2/amanda/work: 911475 KB disk space available, that's plenty.
153 NOTE: skipping tape-writable test.
155 Server check took 34.966 seconds.
157 &A; Backup Client Hosts Check
158 --------------------------------
159 WARNING: northstar: selfcheck request timed out. Host down?
160 WARNING: drinkme: selfcheck request timed out. Host down?
161 WARNING: scruffy: selfcheck request timed out. Host down?
162 Client check: 136 hosts checked in 51.945 seconds, 3 problems found.
164 (brought to you by &A; 2.5.0)
167 <para>In this example, if the line
168 <emphasis remap='B'>mailto csd-amanda</emphasis>
170 <emphasis remap='I'>amanda.conf</emphasis>,
172 <emphasis remap='B'>csd-amanda</emphasis>
173 if the server check returns an error.</para>
176 % amcheck -s -m daily
180 <refsect1><title>MESSAGES</title>
181 <variablelist remap='TP'>
183 <term>fatal slot <emphasis remap='I'>slot</emphasis>: <emphasis remap='I'>error message</emphasis></term>
186 The tape changer detected some kind of fatal error while trying to load slot
187 <emphasis remap='I'>slot</emphasis>.</para>
191 <term>slot <emphasis remap='I'>slot</emphasis>: <emphasis remap='I'>error message</emphasis></term>
194 The tape changer detected some kind of non-fatal error
195 (e.g. an empty slot was detected)
196 while trying to load slot
197 <emphasis remap='I'>slot</emphasis>,
198 or an error was detected trying to read the tape label.</para>
202 <term>slot <emphasis remap='I'>slot</emphasis>: date <emphasis remap='I'>YYYYMMDD</emphasis> label <emphasis remap='I'>label</emphasis> (<emphasis remap='I'>result</emphasis>)</term>
206 <emphasis remap='I'>label</emphasis>
208 <emphasis remap='I'>slot</emphasis>
209 was loaded and found to have been last written on
210 <emphasis remap='I'>YYYYMMDD</emphasis>.
211 If the tape is new, the date field will be an
212 <emphasis remap='I'>X</emphasis>.
214 <emphasis remap='I'>result</emphasis>
215 may be one of:</para>
217 <variablelist remap='TP'>
219 <term>exact label match</term>
221 <para>This is the expected tape.</para>
225 <term>no match</term>
227 <para>This label does not match the
228 <emphasis remap='B'>labelstr</emphasis>
230 <emphasis remap='I'>amanda.conf</emphasis>.
231 Tape scanning will continue.</para>
235 <term>active tape</term>
237 <para>This tape is still active and cannot be overwritten.
238 Tape scanning will continue.</para>
242 <term>first labelstr match</term>
244 <para>This tape is the first one that matches the
245 <emphasis remap='B'>labelstr</emphasis>
247 <emphasis remap='I'>amanda.conf</emphasis>.
248 Tape scanning will continue if necessary.</para>
252 <term>labelstr match</term>
254 <para>This tape is the next one that matches the
255 <emphasis remap='B'>labelstr</emphasis>
257 <emphasis remap='I'>amanda.conf</emphasis>.
258 Tape scanning will continue.</para>
266 <term>ERROR: cannot look up dump user <emphasis remap='I'>user</emphasis></term>
270 <emphasis remap='I'>user</emphasis>
272 <emphasis remap='I'>amanda.conf</emphasis>
273 could not be found in the system password information.</para>
277 <term>ERROR: cannot look up my own uid (<emphasis remap='I'>uid</emphasis>)</term>
281 <emphasis remap='I'>uid</emphasis>
283 <command>amcheck</command>
284 could not be found in the system password information.</para>
288 <term>ERROR: running as user <emphasis remap='I'>runuser</emphasis> instead of <emphasis remap='I'>dumpuser</emphasis></term>
291 <emphasis remap='B'>Amcheck</emphasis>
292 should be run as the dump user
293 <emphasis remap='I'>dumpuser</emphasis>
295 <emphasis remap='I'>amanda.conf</emphasis>
297 <emphasis remap='I'>runuser</emphasis>.</para>
301 <term>ERROR: program dir <emphasis remap='I'>directory</emphasis>: not accessible</term>
304 The directory &A; expects to find its auxiliary programs in,
305 <emphasis remap='I'>directory</emphasis>,
306 is not accessible.</para>
310 <term>ERROR: program <emphasis remap='I'>program</emphasis>: does not exist</term>
314 <emphasis remap='I'>program</emphasis>
315 needed on the tape server could not be found.</para>
319 <term>ERROR: program <emphasis remap='I'>program</emphasis>: not a file</term>
323 <emphasis remap='I'>program</emphasis>
324 needed on the tape server exists but is not a file.</para>
328 <term>ERROR: program <emphasis remap='I'>program</emphasis>: not executable</term>
332 <emphasis remap='I'>program</emphasis>
333 needed on the tape server exists but is not executable.</para>
337 <term>WARNING: program <emphasis remap='I'>program</emphasis>: not setuid-root</term>
341 <emphasis remap='I'>program</emphasis>
342 needed on the tape server exists but should be owned by user "root"
347 <term>ERROR: <emphasis remap='I'>XXX</emphasis> dir <emphasis remap='I'>directory</emphasis>: not writable</term>
351 <emphasis remap='I'>directory</emphasis>
352 is either not writable,
353 i.e. the dump user will not be able to create or remove files,
354 or cannot be accessed, perhaps because a parent directory
355 does not allow search permission.
357 <emphasis remap='I'>XXX</emphasis>
360 <variablelist remap='TP'>
364 <para>for the &A; log directory (see
365 <emphasis remap='B'>logdir</emphasis>
367 <emphasis remap='B'>amanda.conf</emphasis>)</para>
373 <para>for the directory that holds the old log files (see
374 <emphasis remap='B'>logdir</emphasis>
376 <emphasis remap='B'>amanda.conf</emphasis>)</para>
382 <para>for an &A; database information directory (see
383 <emphasis remap='B'>curinfo</emphasis>
385 <emphasis remap='B'>amanda.conf</emphasis>)
392 <para>for an &A; index directory (see
393 <emphasis remap='B'>indexdir</emphasis>
395 <emphasis remap='B'>amanda.conf</emphasis>)</para>
399 <term>tapelist</term>
401 <para>for the &A; tapelist directory (see
402 <emphasis remap='B'>tapelist</emphasis>
404 <emphasis remap='B'>amanda.conf</emphasis>)</para>
412 <term>NOTE: <emphasis remap='I'>XXX</emphasis> dir <emphasis remap='I'>directory</emphasis>: does not exist</term>
415 A database (info) or index directory does not exist or cannot be accessed.
416 This might just mean this is a new client or disk,
417 but if that is not the case, this should be treated as an error.</para>
421 <term>NOTE: it will be created on the next run</term>
424 This indicates the info directory listed in the previous message
425 will be created on the next run.</para>
429 <term>ERROR: <emphasis remap='I'>XXX</emphasis> dir <emphasis remap='I'>name</emphasis>: not a directory</term>
432 <emphasis remap='B'>Amcheck</emphasis>
434 <emphasis remap='I'>name</emphasis>
436 but it is something else (e.g. file).</para>
440 <term>WARNING: info file <filename>file</filename>: does not exist</term>
444 <emphasis remap='I'>file</emphasis>
445 does not exist in the text format database.
446 Since the parent directories do exist,
447 the file should already have been created.</para>
451 <term>ERROR: info file <filename>name</filename>: not a file</term>
454 <emphasis remap='B'>Amcheck</emphasis>
456 <emphasis remap='I'>name</emphasis>
458 but it is something else (e.g. file).</para>
462 <term>ERROR: info file <filename>file</filename>: not readable</term>
465 The text format database file
466 <emphasis remap='I'>file</emphasis>
467 is not readable.</para>
471 <term>ERROR: log file <filename>file</filename>: not writable</term>
475 <emphasis remap='I'>file</emphasis>
477 <emphasis remap='B'>log</emphasis>
479 <emphasis remap='B'>logdir</emphasis>
481 <emphasis remap='B'>amanda.conf</emphasis>)
482 is either not writable,
483 or cannot be accessed, perhaps because a parent directory
484 does not allow search permission.</para>
488 <term>ERROR: tape list <emphasis remap='I'>tapelist</emphasis>: not writable</term>
492 <emphasis remap='I'>tapelist</emphasis>
494 <emphasis remap='B'>tapelist</emphasis>
496 <emphasis remap='B'>amanda.conf</emphasis>)
497 is not writable or was not found.</para>
501 <term>ERROR: tape list <emphasis remap='I'>tapelist</emphasis>: parse error</term>
505 <emphasis remap='I'>tapelist</emphasis>
507 <emphasis remap='B'>tapelist</emphasis>
509 <emphasis remap='B'>amanda.conf</emphasis>)
510 could not be read or parsed.</para>
514 <term>WARNING: tapedev is /dev/null, dumps will be thrown away</term>
518 <emphasis remap='B'>tapedev</emphasis>
520 <emphasis remap='B'>amanda.conf</emphasis>
522 <filename>/dev/null</filename>
523 and &A; uses that when debugging to throw all the dump images away.</para>
527 <term>WARNING: hold file <filename>file</filename> exists</term>
531 <emphasis remap='I'>file</emphasis>
532 exists and will cause
533 <emphasis remap='B'>amdump</emphasis>
534 to pause at the beginning until it is removed.</para>
538 <term>ERROR: holding disk <emphasis remap='I'>disk</emphasis>: statfs: <emphasis remap='I'>error message</emphasis></term>
541 An error was returned from the
542 <emphasis remap='I'>statfs</emphasis>
543 system call on holding disk
544 <emphasis remap='I'>disk</emphasis>
545 (maybe because it does not exist).</para>
549 <term>ERROR: holding disk <emphasis remap='I'>disk</emphasis>: not writable</term>
553 <emphasis remap='I'>disk</emphasis>,
555 probably because the caller does not have write permission
556 or a parent directory does not allow search permission.</para>
560 <term>WARNING: holding disk <emphasis remap='I'>disk</emphasis>: available space unknown <emphasis remap='I'>N</emphasis> KB requested.</term>
563 <emphasis remap='B'>Amcheck</emphasis>
564 could not determine the amount of available space on holding disk
565 <emphasis remap='I'>disk</emphasis>
566 to see if there were at least
567 <emphasis remap='I'>N</emphasis>
568 KBytes available.</para>
572 <term>WARNING: holding disk <emphasis remap='I'>disk</emphasis>: only <emphasis remap='I'>F</emphasis> KB free (<emphasis remap='I'>R</emphasis> KB requested).</term>
575 <emphasis remap='I'>amanda.conf</emphasis>
577 <emphasis remap='I'>R</emphasis>
578 KBytes of free space on holding disk
579 <emphasis remap='I'>disk</emphasis>,
581 <emphasis remap='I'>F</emphasis>
582 KBytes were available.
583 10 MBytes is subtracted for each backup process
585 <emphasis remap='B'>inparallel</emphasis>
586 <emphasis remap='I'>amanda.conf</emphasis>
588 to allow for unexpected overruns.</para>
589 <note>Even though this message is listed as a warning, it causes &amcheck; to exit with a non-zero status.</note>
594 <variablelist remap='TP'>
596 <term>Holding disk <emphasis remap='I'>disk</emphasis>: <emphasis remap='I'>N</emphasis> KB disk space available, that's plenty.</term>
599 There was sufficient free space on holding disk
600 <emphasis remap='I'>disk</emphasis>.</para>
604 <term>WARNING: holding disk <emphasis remap='I'>disk</emphasis>: only <emphasis remap='I'>F</emphasis> KB free, using nothing</term>
608 <emphasis remap='I'>disk</emphasis>
610 <emphasis remap='I'>F</emphasis>
611 KBytes of free space, but that is not enough for what is requested in
612 <emphasis remap='I'>amanda.conf</emphasis>.</para>
616 <term>Holding disk <emphasis remap='I'>disk</emphasis>: <emphasis remap='I'>F</emphasis> KB disk space available, using <emphasis remap='I'>U</emphasis> KB</term>
620 <emphasis remap='I'>disk</emphasis>
622 <emphasis remap='I'>F</emphasis>
623 KBytes of free space and &A; will be using up to
624 <emphasis remap='I'>U</emphasis>
629 <term>WARNING: if a tape changer is not available, runtapes must be set to 1.</term>
633 <emphasis remap='B'>runtapes</emphasis>
634 <emphasis remap='I'>amanda.conf</emphasis>
635 option must be set to 1 if the
636 <emphasis remap='B'>tpchanger</emphasis>
637 <emphasis remap='I'>amanda.conf</emphasis>
638 option is not set.</para>
642 <term>ERROR: <emphasis remap='I'>error message</emphasis>.</term>
645 An error was detected while initializing the tape changer.</para>
649 <term>ERROR: <emphasis remap='I'>tape device</emphasis>: <emphasis remap='I'>error message</emphasis>.</term>
652 An error was detected while processing the tape label.</para>
656 <term>ERROR: cannot overwrite active tape <emphasis remap='I'>label</emphasis>.</term>
660 <emphasis remap='I'>label</emphasis>
661 is still active and cannot be used.</para>
665 <term>ERROR: label <emphasis remap='I'>label</emphasis> doesn't match labelstr <emphasis remap='I'>pattern</emphasis> .</term>
669 <emphasis remap='I'>label</emphasis>
671 <emphasis remap='B'>labelstr</emphasis>
672 <emphasis remap='I'>amanda.conf</emphasis>
677 <term>(expecting a new tape)</term>
680 The tape is not OK and a new tape was expected.</para>
684 <term>(expecting tape <emphasis remap='I'>label</emphasis> or a new tape)</term>
687 The tape is not OK and either tape
688 <emphasis remap='I'>label</emphasis>
689 or a new tape was expected.</para>
693 <term>ERROR: tape <emphasis remap='I'>label</emphasis> label ok, but is not writable.</term>
697 <emphasis remap='I'>label</emphasis>
698 is OK, but the write enable test failed.</para>
702 <term>Tape <emphasis remap='I'>label</emphasis> is writable.</term>
706 <emphasis remap='I'>label</emphasis>
707 is OK and the write enable test succeeded.</para>
711 <term>NOTE: skipping tape-writable test.</term>
714 The tape write test (see the
716 option) was not enabled.</para>
720 <term>WARNING: skipping tape test because amdump or amflush seem to be running</term>
721 <term>WARNING: if they are not, you must run amcleanup</term>
725 <command>amcheck</command>
727 <emphasis remap='B'>amdump</emphasis>
729 <emphasis remap='B'>amflush</emphasis>
730 were running because a log file or amdump file exists.
731 If they are not running, you probably need to run
732 <emphasis remap='B'>amcleanup</emphasis>
733 to clear up a previous failure.
734 Otherwise, you need to wait until they complete before running
735 <command>amcheck</command><literal>.</literal></para>
739 <term>NOTE: skipping tape checks</term>
742 The tape tests are being skipped because you used the
744 command line option.</para>
748 <term>WARNING: <emphasis remap='I'>compress</emphasis> is not executable, server-compression and indexing will not work</term>
752 <emphasis remap='I'>compress</emphasis>
754 so compression on the tape server host and creating index files will not work.</para>
758 <term>Tape <emphasis remap='I'>label</emphasis> label ok.</term>
762 <emphasis remap='I'>label</emphasis>
768 <term>Server check took <emphasis remap='I'>S</emphasis> seconds.</term>
771 Reports how long the tape server host checks took.</para>
775 <term>ERROR: <emphasis remap='I'>host</emphasis>: could not resolve hostname</term>
778 Could not look up client hostname
779 <emphasis remap='I'>host</emphasis>.</para>
783 <term>Client check: <emphasis remap='I'>H</emphasis> hosts checked in <emphasis remap='I'>S</emphasis> seconds, <emphasis remap='I'>N</emphasis> problems found.</term>
786 Reports the number of client hosts checked,
787 how long it took and the number of errors detected.</para>
791 <term>WARNING: <emphasis remap='I'>host</emphasis>: selfcheck request timed out. Host down?</term>
794 There was no response from
795 <emphasis remap='I'>host</emphasis>
796 when trying to do the client checks.
797 The host might really be down or it might not be configured properly.</para>
801 <term>ERROR: <emphasis remap='I'>host</emphasis> NAK: <emphasis remap='I'>message</emphasis></term>
804 <emphasis remap='I'>Host</emphasis>
805 reported a negative acknowledgment error of
806 <emphasis remap='I'>message</emphasis>
807 to the status check request.</para>
811 <term>ERROR: <emphasis remap='I'>host</emphasis> NAK: [NAK parse failed]</term>
814 <emphasis remap='B'>Amcheck</emphasis>
815 could not parse the negative acknowledgment error from
816 <emphasis remap='I'>host</emphasis>.
817 There might be an &A; version mismatch between the host running
818 <command>amcheck</command>
820 <emphasis remap='I'>host</emphasis>.</para>
824 <term>ERROR: <emphasis remap='I'>host</emphasis> [mutual-authentication failed]</term>
827 Kerberos authentication failed while contacting
828 <emphasis remap='I'>host</emphasis>.</para>
832 <term>ERROR: <emphasis remap='I'>host</emphasis>: <emphasis remap='I'>message</emphasis></term>
836 <emphasis remap='I'>message</emphasis>
837 was reported by the status check on
838 <emphasis remap='I'>host</emphasis>.</para>
844 <refsect1><title>AUTHOR</title>
845 <para>James da Silva, &email.jds; : Original text</para>
846 <para>&maintainer.sgw;: XML-conversion</para>
849 <refsect1><title>SEE ALSO</title>
850 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
851 <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>