1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30 -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
11 <!-- (C) IBM Corporation 2000. All Rights Reserved -->
12 <BODY bgcolor="ffffff">
13 <!-- End Header Records ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf083.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf085.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
18 <H2><A NAME="HDRBK_READLABEL" HREF="auarf002.htm#ToC_98">backup readlabel</A></H2>
19 <A NAME="IDX4386"></A>
20 <A NAME="IDX4387"></A>
21 <A NAME="IDX4388"></A>
22 <A NAME="IDX4389"></A>
23 <A NAME="IDX4390"></A>
24 <A NAME="IDX4391"></A>
25 <A NAME="IDX4392"></A>
26 <A NAME="IDX4393"></A>
27 <P><STRONG>Purpose</STRONG>
28 <P>Reads and displays a tape's label
29 <P><STRONG>Synopsis</STRONG>
30 <PRE><B>backup readlabel</B> [<B>-portoffset</B> <<VAR>TC port offset</VAR>>]
31 [<B>-localauth</B>] [<B>-cell</B> <<VAR>cell name</VAR>>] [<B>-help</B>]
33 <B>backup rea</B> [<B>-p</B> <<VAR>TC port offset</VAR>>] [<B>-l</B>] [<B>-c</B> <<VAR>cell name</VAR>>] [<B>-h</B>]
35 <P><STRONG>Description</STRONG>
36 <P>The <B>backup readlabel</B> command displays information from the
37 magnetic tape label of a tape. The information includes the tape's
38 name (either a <I>permanent name</I>, or an <I>AFS tape name</I> that
39 reflects the tape's contents in a prescribed format) and its
41 <P>If the <B>FILE YES</B> instruction appears in the
42 <B>/usr/afs/backup/CFG_</B><VAR>device_name</VAR> file associated with the
43 specified port offset, then the <B>backup readlabel</B> command reads the
44 label information from the first 16 KB block in the backup data file listed
45 for that port offset in the Tape Coordinator's
46 <B>/usr/afs/backup/tapeconfig</B> file, rather than from the beginning of
48 <P>The Tape Coordinator's default response to this command is to access
49 the tape by invoking the <B>MOUNT</B> instruction in the local
50 <B>/usr/afs/backup/CFG_</B><VAR>device_name</VAR> file, or by prompting the
51 backup operator to insert the tape if there is no <B>MOUNT</B>
52 instruction. However, if the <B>AUTOQUERY NO</B> instruction
53 appears in the <B>CFG_</B><VAR>device_name</VAR> file, or if the issuer of
54 the <B>butc</B> command included the <B>-noautoquery</B> flag, the
55 Tape Coordinator instead expects the tape to be in the device already.
56 If it is not, the Tape Coordinator invokes the <B>MOUNT</B> instruction or
58 <P><STRONG>Options</STRONG>
61 </B><DD>Specifies the port offset number of the Tape Coordinator handling the
62 tapes for this operation.
64 </B><DD>Constructs a server ticket using a key from the local
65 <B>/usr/afs/etc/KeyFile</B> file. The <B>backup</B> command
66 interpreter presents it to the Backup Server, Volume Server and VL Server
67 during mutual authentication. Do not combine this flag with the
68 <B>-cell</B> argument. For more details, see the introductory
69 <B>backup</B> reference page.
71 </B><DD>Names the cell in which to run the command. Do not combine this
72 argument with the <B>-localauth</B> flag. For more details, see the
73 introductory <B>backup</B> reference page.
75 </B><DD>Prints the online help for this command. All other valid options
78 <P><STRONG>Output</STRONG>
79 <P>Output from this command appears in both the shell window where the command
80 is issued, and in the Tape Coordinator window.
81 <P>If the tape is unlabeled or if the specified tape device is empty, the
83 <PRE> Failed to read tape label.
86 <P>Otherwise, the output in the shell window has the following format:
87 <PRE> Tape read was labelled: <VAR>tape name</VAR> (<VAR>dump id</VAR>)
88 size: <VAR>size</VAR> Kbytes
91 <P>where <VAR>tape name</VAR> is the permanent name if the tape has one, or the
92 AFS tape name otherwise. The <VAR>dump ID</VAR> is dump ID of the initial
93 dump on the tape, and <VAR>size</VAR> is the recorded capacity of the tape in
95 <P>The output in the Tape Coordinator windows is bounded by an underlined
96 <TT>Tape</TT> <TT>label</TT> header at the top, and the following string
98 <PRE> -- End of tape label --
101 <P>In between are lines reporting the following information:
103 <P><DT><B><TT>tape name</TT>
104 </B><DD>The permanent name assigned by using the <B>-pname</B> argument of the
105 <B>backup labeltape</B> command. This name remains on the tape
106 until that argument is used again, no matter how many times the tape is
107 recycled or otherwise relabeled. If the tape does not have a permanent
108 name, the value <TT><NULL></TT> appears in this field.
109 <P><DT><B><TT>AFS tape name</TT>
110 </B><DD>A tape name in one of the following prescribed formats. The Backup
111 System automatically writes the appropriate AFS tape name to the label as part
112 of a <B>backup dump</B> or <B>backup savedb</B> operation, or the
113 operator can assign it with the <B>-name</B> argument to the <B>backup
114 labeltape</B> command.
116 <P><LI><VAR>volume_set_name</VAR><B>.</B><VAR>dump_level_name</VAR><B>.</B><VAR>tape_index</VAR>,
117 if the tape contains volume data. The <VAR>volume_set_name</VAR> is the
118 name of the volume set that was dumped to create the initial dump in the dump
119 set of to which this tape belongs; <VAR>dump_level_name</VAR> is the last
120 pathname element of the dump level at which the initial dump was backed
121 up; and <VAR>tape_index</VAR> is the numerical position of the tape in the
123 <P><LI><TT>Ubik.db.dump.</TT><VAR>tape_index</VAR> if the
124 tape contains a dump of the Backup Database, created with the <B>backup
125 savedb</B> command. The <VAR>tape_index</VAR> is the ordinal of the
126 tape in the dump set.
127 <P><LI><TT><NULL></TT> if the tape has no AFS tape name. This is
128 normally the case if the <B>-name</B> argument was not included the last
129 time the <B>backup labeltape</B> command was used on this tape, and no
130 data has been written to it since.
132 <P><DT><B><TT>creationTime</TT>
133 </B><DD>The date and time at which the Backup System started performing the dump
134 operation that created the initial dump.
135 <P><DT><B><TT>cell</TT>
136 </B><DD>The cell in which the dump set was created. This is the cell whose
137 Backup Database contains a record of the dump set.
138 <P><DT><B><TT>size</TT>
139 </B><DD>The tape's capacity (in kilobytes) as recorded on the label, rather
140 than the amount of data on the tape. The value is assigned by the
141 <B>-size</B> argument to the <B>backup labeltape</B> command or
142 derived from the <B>/usr/afs/backup/tapeconfig</B> file on the Tape
143 Coordinator machine, not from a measurement of the tape.
144 <P><DT><B><TT>dump path</TT>
145 </B><DD>The dump level of the initial dump in the dump set
146 <P><DT><B><TT>dump id</TT>
147 </B><DD>The dump ID number of the initial dump in the dump set, as recorded in the
149 <P><DT><B><TT>useCount</TT>
150 </B><DD>The number of times a dump has been written to the tape, or it has been
153 <P>The message <TT>ReadLabel: Finished</TT> indicates the completion
155 <P><STRONG>Examples</STRONG>
156 <P>The following example shows the output for the tape with permanent name
157 <B>oct.guest.dump</B> and capacity 2 MB, expressed in
158 kilobyte units (2097152 equals 2 times 1024<SUP>2</SUP>).
159 <PRE> % <B>backup readlabel -portoffset 6</B>
160 Tape read was labelled: oct.guest.dump (907215000)
164 <P>The output in the Tape Coordinator window reads:
167 tape name = oct.guest.dump
168 AFS tape name = guests.monthly.3
169 creationTime = Thu Oct 1 00:10:00 1998
171 size = 2097152 Kbytes
175 ---- End of tape label ----
178 <P>The following example is for a tape that does not have a permanent
180 <PRE> % backup readlabel -portoffset 6
181 Tape read was labelled: guests.monthly.2 (909899900)
185 <P>The output in the Tape Coordinator window reads:
188 tape name = <NULL>
189 AFS tape name = guests.monthly.2
190 creationTime = Sun Nov 1 00:58:20 1998
192 size = 2097152 Kbytes
196 ---- End of tape label ----
199 <P><STRONG>Privilege Required</STRONG>
200 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
201 every machine where the Backup Server is running, or must be logged onto a
202 server machine as the local superuser <B>root</B> if the
203 <B>-localauth</B> flag is included.
204 <P><STRONG>Related Information</STRONG>
205 <P><A HREF="auarf060.htm#HDRBK_INTRO">backup</A>
206 <P><A HREF="auarf079.htm#HDRBK_LABELTAPE">backup labeltape</A>
207 <P><A HREF="auarf126.htm#HDRBUTC">butc</A>
209 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf083.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf085.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
210 <!-- Begin Footer Records ========================================== -->
212 <br>© <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A> All Rights Reserved
214 <!-- End Footer Records ============================================ -->
215 <A NAME="Bot_Of_Page"></A>