3e2101d2b079fbed008554c93c62dfe761d1f4a8
[debian/amanda] / man / amdevcheck.8
1 '\" t
2 .\"     Title: amdevcheck
3 .\"    Author: Ian Turner <ian@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
5 .\"      Date: 11/05/2009
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 2.6.1p2
8 .\"  Language: English
9 .\"
10 .TH "AMDEVCHECK" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
15 .nh
16 .\" disable justification (adjust text to left margin only)
17 .ad l
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
21 .SH "NAME"
22 amdevcheck \- Validate an \fIAmanda\fR device and volume\&.
23 .SH "SYNOPSIS"
24 .HP \w'\fBamdevcheck\fR\ 'u
25 \fBamdevcheck\fR \fIconfig\fR [\fIdevice\ name\fR] [\-o\ \fIconfigoption\fR]...
26 .SH "DESCRIPTION"
27 .PP
28
29 \fBAmdevcheck\fR
30 provides a way to check that a particular
31 \fIAmanda\fR
32 device is accessible, whether or not it contains a volume, and whether or not that volume is labeled\&. Some devices can\'t distinguish between all of these cases; a missing volume and an unlabeled volume might generate the same error code, for example\&. In those cases, this tool reports all possible causes of the error\&.
33 .PP
34 See the
35 \fBamanda\fR(8)
36 man page for more details about
37 \fIAmanda\fR\&. See
38 \fBamanda-devices\fR(7)
39 for more information on devices\&.
40 .SH "OPTIONS"
41 .PP
42 \fIconfig\fR
43 .RS 4
44
45 \fIAmanda\fR
46 configuration to use\&. Note that
47 \fBamdevcheck\fR
48 ignores any tape changer configuration\&.
49 .RE
50 .PP
51 \fI device\fR
52 .RS 4
53
54 \fIAmanda\fR
55 device to use\&. This option overrides any tapedev configuration specified in the configuration file\&.
56 .RE
57 .PP
58 \fB\-o\fR \fIclientconfigoption\fR
59 .RS 4
60 See the "\fBCONFIGURATION OVERRIDE\fR" section in
61 \fBamanda\fR(8)\&.
62 .RE
63 .SH "OUTPUT"
64 \fBAmdevcheck\fR returns one or more of the following lines\&. If multiple lines appear, then at least one, but not necessarily all of
65 the messages apply\&.  This situation can occur when working with hardware or
66 operating systems which cannot distinguish, for example, between a
67 malfunctioning drive and a functional but unloaded drive\&.
68 .PP
69 \fBSUCCESS\fR
70 .RS 4
71 A tape is ready\&.
72 .RE
73 .PP
74 \fBDEVICE_ERROR\fR
75 .RS 4
76 A device error has occurred\&.
77 .RE
78 .PP
79 \fBDEVICE_BUSY\fR
80 .RS 4
81 The device is busy\&.
82 .RE
83 .PP
84 \fBVOLUME_MISSING\fR
85 .RS 4
86 No tape is loaded in the drive\&.
87 .RE
88 .PP
89 \fBVOLUME_UNLABELED\fR
90 .RS 4
91 The tape in the drive is unlabeled\&.
92 .RE
93 .PP
94 \fBVOLUME_ERROR\fR
95 .RS 4
96 A volume error has occurred\&.
97 .RE
98 .PP
99 \fBMESSAGE\fR \fItext\fR
100 .RS 4
101 Where text provides a human\-readable description of the problem\&.
102 .RE
103 .SH "SEE ALSO"
104 .PP
105
106 \fBamanda\fR(8),
107 \fBammt\fR(8),
108 : http://wiki.zmanda.com
109 .SH "AUTHOR"
110 .PP
111 \fBIan Turner\fR <\&ian@zmanda\&.com\&>
112 .RS 4
113 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
114 .RE