4e7edb8bda629e7fba0213a7458a92f358211d0c
[debian/amanda] / man / amtape.8
1 .\"     Title: amtape
2 .\"    Author: 
3 .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
4 .\"      Date: 02/07/2007
5 .\"    Manual: 
6 .\"    Source: 
7 .\"
8 .TH "AMTAPE" "8" "02/07/2007" "" ""
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 amtape \- user interface to Amanda tape changer controls
15 .SH "SYNOPSIS"
16 .HP 7
17 \fBamtape\fR \fIconfig\fR \fIcommand\fR [\fIcommand_options\fR...] [\fB\-o\ \fR\fIconfigoption\fR]...
18 .SH "DESCRIPTION"
19 .PP
20 \fBAmtape\fR
21 performs tape changer control operations. It uses the underlying tape changer script defined by the
22 \fBtpchanger\fR
23 option for a particular
24 \fIAmanda\fR
25 configuration as specified by the
26 \fIconfig\fR
27 argument.
28 .PP
29 Tape changers maintain a notion of the
30 \fIcurrent\fR
31 and
32 \fInext\fR
33 slot for each configuration. These may or may not correspond to an actual physical state of the device, but do tend to minimize searching through the tape storage slots. If the desired tape is in the current slot, it is likely the next tape needed is in the next slot rather than at some random position in the storage slots.
34 .PP
35 See the
36 \fBamanda\fR(8)
37 man page for more details about
38 \fIAmanda\fR.
39 .SH "COMMANDS"
40 .PP
41 \fBreset\fR
42 .RS 4
43 Reset the tape changer to a known state. The
44 \fIcurrent\fR
45 slot is set to the
46 \fIfirst\fR
47 slot. Other device\-specific side effects may occur. Some gravity stackers need to be reset to the top position by hand. This command notifies
48 \fIAmanda\fR
49 the stacker is back in that position.
50 .RE
51 .PP
52 \fBeject\fR
53 .RS 4
54 If a tape is loaded in the drive, it is ejected and returned to the slot from which it was loaded.
55 .RE
56 .PP
57 \fBclean\fR
58 .RS 4
59 If a cleaning tape is defined for the changer, it is used to clean the drive.
60 .RE
61 .PP
62 \fBshow\fR
63 .RS 4
64 Show the contents of all slots. This can be slow.
65 .RE
66 .PP
67 \fBlabel\fR \fIlabel\fR
68 .RS 4
69 Search for and load the
70 \fIAmanda\fR
71 tape with label
72 \fIlabel\fR.
73 .RE
74 .PP
75 \fBtaper\fR
76 .RS 4
77 Perform the
78 \fBtaper\fR
79 scan algorithm. Load the next tape in the configuration's tape sequence, or a fresh tape with a suitable label.
80 .RE
81 .PP
82 \fBdevice\fR
83 .RS 4
84 Display the name of the current tape device on
85 \fIstdout\fR.
86 .RE
87 .PP
88 \fBcurrent\fR
89 .RS 4
90 Display the current slot.
91 .RE
92 .PP
93 \fBupdate\fR
94 .RS 4
95 Update the changer label database, if it has one, to match the tapes now available.
96 .RE
97 .PP
98 \fBslot\fR \fIslot\fR
99 .RS 4
100 Eject any tape in the drive and put it away, then load the tape from slot
101 \fIslot\fR
102 and reset
103 \fIcurrent\fR.
104 .RE
105 .PP
106 \fBslot current\fR
107 .RS 4
108 Eject any tape in the drive and put it away, then load the tape from the current slot.
109 .RE
110 .PP
111 \fBslot prev\fR
112 .RS 4
113 Eject any tape in the drive and put it away, then load the tape from the previous slot and reset
114 \fIcurrent\fR.
115 .RE
116 .PP
117 \fBslot next\fR
118 .RS 4
119 Eject any tape in the drive and put it away, then load the tape from the next slot and reset
120 \fIcurrent\fR.
121 .RE
122 .PP
123 \fBslot first\fR
124 .RS 4
125 Eject any tape in the drive and put it away, then load the tape from the first slot and reset
126 \fIcurrent\fR.
127 .RE
128 .PP
129 \fBslot last\fR
130 .RS 4
131 Eject any tape in the drive and put it away, then load the tape from the last slot and reset
132 \fIcurrent\fR.
133 .RE
134 .PP
135 \fBslot advance\fR
136 .RS 4
137 Eject any tape in the drive and put it away. Advance
138 \fIcurrent\fR
139 to the next tape, but do not load it.
140 .RE
141 .PP
142 \fB\-o\fR \fIconfigoption\fR
143 .RS 4
144 See the "\fBCONFIGURATION OVERWRITE\fR" section in
145 \fBamanda\fR(8).
146 .RE
147 .PP
148 This is useful with non\-gravity stackers to unload the last tape used and set up
149 \fIAmanda\fR
150 for the next run. If you just use
151 \fBeject\fR, the current tape will be mounted again in the next run, where it will be rejected as being still in use, ejected and the next tape requested. Using
152 \fBslot next\fR
153 followed by
154 \fBeject\fR
155 does an unnecessary mount.
156 .PP
157 Note: most changers optimize the
158 \fBslot\fR
159 commands to not eject the loaded tape if it is the one being requested.
160 .SH "AUTHOR"
161 .PP
162 James da Silva,
163 <jds@amanda.org>
164 : Original text
165 .PP
166 Stefan G. Weichinger,
167 <sgw@amanda.org>, maintainer of the
168 \fIAmanda\fR\-documentation: XML\-conversion
169 .SH "SEE ALSO"
170 .PP
171 \fBamanda\fR(8)