Imported Upstream version 3.2.1
[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: 12/14/2010
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 3.2.1
8 .\"  Language: English
9 .\"
10 .TH "AMLABEL" "8" "12/14/2010" "Amanda 3\&.2\&.1" "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 Amanda tape
23 .SH "SYNOPSIS"
24 .HP \w'\fBamlabel\fR\ 'u
25 \fBamlabel\fR [\fB\-f\fR] [\fB\-\-version\fR] [\fB\-o\fR\ \fIconfigoption\fR...] \fIconfig\fR \fIlabel\fR [slot\ \fIslot\fR]
26 .SH "DESCRIPTION"
27 .PP
28 This command applies a label to an Amanda volume, erasing the volume in the process\&.
29 .PP
30 Amanda uses labels to identify volumes:
31 \fBamdump\fR(8)
32 and
33 \fBamflush\fR(8)
34 verify the label before writing to make sure the proper volume is loaded, and the recovery programs use the label to ensure they are reading the data they expect\&.
35 .PP
36 If no
37 [\fIslot\fR]
38 is given, then
39 \fBamlabel\fR
40 labels the tape in the current slot of the default changer\&. If a slot is given, it labels the volume in that slot\&.
41 \fILabel\fR
42 may be any string that does not contain whitespace and that matches the
43 \fBlabelstr\fR
44 (see
45 \fBamanda.conf\fR(5))\&.
46 .PP
47 This command also appends the new volume to the
48 \fBtapelist\fR(5)
49 file, so that they will be used in the order they are labeled (depending on the taperscan in use \(em see
50 \fBamanda-taperscan\fR(7))\&.
51 .PP
52 As a precaution,
53 \fBamlabel\fR
54 will not write a label if the volume already contains an active label or if the label specified is on an active tape\&. The
55 [\-f]
56 (force) flag bypasses these verifications\&.
57 .SH "OPTIONS"
58 .PP
59 \fB\-f\fR
60 .RS 4
61 Force the label operation; see above
62 .RE
63 .PP
64 \fB\-\-version\fR
65 .RS 4
66 Output version information
67 .RE
68 .PP
69 \fB\-o \fR\fB\fIconfigoption\fR\fR
70 .RS 4
71 See the "CONFIGURATION OVERRIDE" section in
72 \fBamanda\fR(8)\&.
73 .RE
74 .SH "EXAMPLE"
75 .PP
76 Write an Amanda label with the string "DMP000" on the current volume:
77 .nf
78 % amlabel daily DMP000 
79 .fi
80 .PP
81 Label the tape in slot 3 of the changer with the label "DMP003":
82 .nf
83 % amlabel daily DMP003 slot 3 
84 .fi
85 .SH "MESSAGES"
86 .PP
87 Label \'\fIlabel\fR\' doesn\'t match labelstr \'\fIlabelstr\fR\'
88 .RS 4
89 The given label does not match the configured labelstr\&. Even with
90 \fB\-f\fR, this is an error\&.
91 .RE
92 .PP
93 Label \'\fIlabel\fR\' already on a volume
94 .RS 4
95 The given label is already on another volume in the tapelist, and Amanda will not write it to this volume unless forced\&.
96 .RE
97 .PP
98 Found label \'\fIlabel\fR\', but it is not from configuration \fIconfig\fR\&.
99 .RS 4
100 The label
101 \fBamlabel\fR
102 found on the volume does not match this configuration\'s
103 \fBlabelstr\fR, so it is probably part of a different Amanda configuration\&. Amanda will not overwrite the label unless it is forced\&.
104 .RE
105 .PP
106 Volume with label \'\fIlabel\fR\' contains data from this configuration\&.
107 .RS 4
108 The label
109 \fBamlabel\fR
110 found on the volume still has valid data on it and Amanda will not overwrite it unless forced\&. Note that this does not distinguish between active and inactive volumes\&.
111 .RE
112 .PP
113 .RS 4
114 .RE
115 .SH "SEE ALSO"
116 .PP
117 \fBamanda\fR(8),
118 \fBamanda.conf\fR(5),
119 \fBtapelist\fR(5),
120 \fBamanda-taperscan\fR(7),
121 \fBamdump\fR(8),
122 \fBamflush\fR(8)
123 .PP
124 The Amanda Wiki:
125 : http://wiki.zmanda.com/
126 .SH "AUTHORS"
127 .PP
128 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
129 .PP
130 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>
131 .PP
132 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
133 .RS 4
134 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
135 .RE