060cbba40dba2fc19eb1937454c8d50b47084238
[debian/amanda] / man / amlabel.8
1 '\" t
2 .\"     Title: amlabel
3 .\"    Author: James da Silva <jds@amanda.org>
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 "AMLABEL" "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 amlabel \- label an \fIAmanda\fR tape
23 .SH "SYNOPSIS"
24 .HP \w'\fBamlabel\fR\ 'u
25 \fBamlabel\fR [\-f] \fIconfig\fR \fIlabel\fR [slot\ \fIslot\fR] [\-o\ \fIconfigoption\fR]...
26 .SH "DESCRIPTION"
27 .PP
28 All
29 \fIAmanda\fR
30 tapes must be pre\-labeled before they are used\&.
31 \fIAmanda\fR
32 verifies the label in
33 \fBamdump\fR
34 and
35 \fBamflush\fR
36 before writing to make sure the proper tape is loaded\&.
37 .PP
38 \fBAmlabel\fR
39 writes an
40 \fIAmanda\fR
41 label on the tape in the device specified by the
42 \fIamanda\&.conf\fR
43 file in /usr/local/etc/amanda/\fIconfig\fR\&.
44 \fILabel\fR
45 may be any string that does not contain whitespace and that matches the
46 \fIamanda\&.conf\fR
47 \fBlabelstr\fR
48 regular expression option\&. It is up to the system administrator to define a naming convention\&.
49 .PP
50 \fBAmlabel\fR
51 appends the new tape to the
52 \fBtapelist\fR(5)
53 file so it will be used by
54 \fIAmanda\fR
55 before it reuses any other tapes\&. When you
56 \fBamlabel\fR
57 multiple tapes, they will be used in the order you
58 \fBamlabel\fR
59 them\&.
60 .PP
61 \fBAmlabel\fR
62 will not write the label if the tape contains an active
63 \fIAmanda\fR
64 tape or if the label specified is on an active tape\&. The
65 \fB\-f\fR
66 (force) flag bypasses these verifications\&.
67 .PP
68 An optional
69 \fIslot\fR
70 may be specified after the tape label\&. If a tape changer is in use,
71 \fBamlabel\fR
72 will label the tape in the specified slot instead of the currently loaded tape\&.
73 .PP
74 See the
75 \fBamanda\fR(8)
76 man page for more details about
77 \fIAmanda\fR\&.
78 .SH "OPTIONS"
79 .PP
80 \fB\-o\fR \fIconfigoption\fR
81 .RS 4
82 See the "\fBCONFIGURATION OVERRIDE\fR" section in
83 \fBamanda\fR(8)\&.
84 .RE
85 .SH "EXAMPLE"
86 .PP
87 Write an
88 \fIAmanda\fR
89 label with the string "DMP000" on the tape loaded in the device named in the
90 \fBtapedev\fR
91 option in /usr/local/etc/amanda/daily/amanda\&.conf:
92 .nf
93 % amlabel daily DMP000 
94 .fi
95 .PP
96 Label the tape in slot 3 of the currently configured tape changer with the string "DMP003":
97 .nf
98 % amlabel daily DMP003 slot 3 
99 .fi
100 .SH "MESSAGES"
101 .PP
102 label \fIlabel\fR doesn\'t match labelstr \fIstr\fR
103 .RS 4
104 Label
105 \fIlabel\fR
106 on the command line does not match the
107 \fIlabelstr\fR
108 regular expression
109 \fIstr\fR
110 from
111 \fIamanda\&.conf\fR\&.
112 .RE
113 .PP
114 label \fIlabel\fR already on a tape
115 .RS 4
116 Label
117 \fIlabel\fR
118 is already listed as an active
119 \fIAmanda\fR
120 tape\&.
121 .RE
122 .PP
123 no tpchanger specified in \fIpath\fR , so slot command invalid
124 .RS 4
125 The command line has the
126 \fBslot\fR
127 parameter but the
128 \fIamanda\&.conf\fR
129 file in
130 \fIpath\fR
131 does not have a tape changer configured\&.
132 .RE
133 .PP
134 reading label \fIlabel\fR, tape is in another amanda configuration
135 .RS 4
136 This tape appears to be a valid
137 \fIAmanda\fR
138 tape, but label does not match
139 \fBlabelstr\fR
140 for this configuration so it is probably part of a different
141 \fIAmanda\fR
142 configuration\&.
143 .RE
144 .PP
145 reading label \fIlabel\fR, tape is active
146 .RS 4
147 Tape
148 \fIlabel\fR
149 appears to already be part of this
150 \fIAmanda\fR
151 configuration and active, i\&.e\&. has valid data on it\&.
152 .RE
153 .PP
154 no label found, are you sure \fItape\fR is non\-rewinding?
155 .RS 4
156 While checking that the label was written correctly,
157 \fBamlabel\fR
158 got an error that might be caused by mis\-configuring
159 \fIAmanda\fR
160 with a rewinding tape device name instead of a non\-rewinding device name for
161 \fItape\&.\fR
162 .RE
163 .SH "SEE ALSO"
164 .PP
165 \fBamanda\fR(8),
166 \fBamdump\fR(8),
167 \fBamflush\fR(8),
168 : http://wiki.zmanda.com
169 .SH "AUTHORS"
170 .PP
171 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
172 .PP
173 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>