Imported Upstream version 2.4.4p3
[debian/amanda] / man / amtape.8
1 .\"
2 .de CO
3 \fB\\$1\fP \fI\\$2\fP
4 ..
5 .TH AMTAPE 8
6 .SH NAME
7 amtape \- user interface to Amanda tape changer controls
8 .SH SYNOPSIS
9 .B amtape
10 .I config
11 .I command
12 [
13 .I command options
14 ]
15 .SH DESCRIPTION
16 .B Amtape
17 performs tape changer control operations.
18 It uses the underlying tape changer script defined by the
19 .B tpchanger
20 option for a particular Amanda
21 configuration as specified by the
22 .I config
23 argument.
24 .LP
25 Tape changers maintain a notion of the
26 .I current
27 and
28 .I next
29 slot for each configuration.
30 These may or may not correspond to an actual physical state of the device,
31 but do tend to minimize searching through the tape storage slots.
32 If the desired tape is in the current slot,
33 it is likely the next tape needed is in the next slot
34 rather than at some random position in the storage slots.
35 .LP
36 See the
37 .IR amanda (8)
38 man page for more details about Amanda.
39 .SH COMMANDS
40 .TP
41 .B reset
42 Reset the tape changer to a known state.
43 The
44 .I current
45 slot is set to the
46 .I first
47 slot.
48 Other device-specific side effects may occur.
49 Some gravity stackers need to be reset to the top position by hand.
50 This command notifies Amanda the stacker is back in that position.
51 .TP
52 .B eject
53 If a tape is loaded in the drive, it is ejected and returned to the
54 slot from which it was loaded.
55 .TP
56 .B clean
57 If a cleaning tape is defined for the changer,
58 it is used to clean the drive.
59 .TP
60 .B show
61 Show the contents of all slots.
62 This can be slow.
63 .TP
64 .CO label label
65 Search for and load the Amanda tape with label
66 .IR label .
67 .TP
68 .B taper
69 Perform the
70 .B taper
71 scan algorithm.
72 Load the next tape in the configuration's tape sequence,
73 or a fresh tape with a suitable label.
74 .TP
75 .B device
76 Display the name of the current tape device on
77 .IR stdout .
78 .TP
79 .B current
80 Display the current slot.
81 .TP
82 .B update
83 Update the changer label database, if it has one,
84 to match the tapes now available.
85 .TP
86 .CO slot slot
87 Eject any tape in the drive and put it away,
88 then load the tape from slot
89 .I slot
90 and reset
91 .IR current .
92 .TP
93 .B slot current
94 Eject any tape in the drive and put it away,
95 then load the tape from the current slot.
96 .TP
97 .B slot prev
98 Eject any tape in the drive and put it away,
99 then load the tape from the previous slot and reset
100 .IR current .
101 .TP
102 .B slot next
103 Eject any tape in the drive and put it away,
104 then load the tape from the next slot and reset
105 .IR current .
106 .TP
107 .B slot first
108 Eject any tape in the drive and put it away,
109 then load the tape from the first slot and reset
110 .IR current .
111 .TP
112 .B slot last
113 Eject any tape in the drive and put it away,
114 then load the tape from the last slot and reset
115 .IR current .
116 .TP
117 .B slot advance
118 Eject any tape in the drive and put it away.
119 Advance
120 .I current
121 to the next tape, but do not load it.
122 .IP
123 This is useful with non-gravity stackers to unload the last tape used
124 and set up Amanda for the next run.
125 If you just use
126 .BR eject ,
127 the current tape will be mounted again in the next run,
128 where it will be rejected as being still in use,
129 ejected and the next tape requested.
130 Using
131 .B slot next
132 followed by
133 .B eject
134 does an unnecessary mount.
135 .LP
136 Note: most changers optimize the
137 .B slot
138 commands to not eject the loaded tape if it is the one being requested.
139 .SH AUTHOR
140 James da Silva <jds@cs.umd.edu>
141 .br
142 University of Maryland, College Park
143 .SH "SEE ALSO"
144 amanda(8)