admin-doc-sysname-20040713
[openafs.git] / doc / html / AdminReference / auarf074.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
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">
10 </HEAD><BODY>
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="auarf073.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="auarf075.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> 
17 <P>
18 <H2><A NAME="HDRBK_DUMPINFO" HREF="auarf002.htm#ToC_88">backup dumpinfo</A></H2>
19 <A NAME="IDX4316"></A>
20 <A NAME="IDX4317"></A>
21 <A NAME="IDX4318"></A>
22 <A NAME="IDX4319"></A>
23 <A NAME="IDX4320"></A>
24 <A NAME="IDX4321"></A>
25 <A NAME="IDX4322"></A>
26 <A NAME="IDX4323"></A>
27 <P><STRONG>Purpose</STRONG>
28 <P>Displays a dump record from the Backup Database
29 <P><STRONG>Synopsis</STRONG>
30 <PRE><B>backup dumpinfo</B> [<B>-ndumps</B> &lt;<VAR>no.&nbsp;of&nbsp;dumps</VAR>>]  [<B>-id</B> &lt;<VAR>dump&nbsp;id</VAR>>]
31                 [<B>-verbose</B>]  [<B>-localauth</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-help</B> ]
32    
33 <B>backup dumpi</B> [<B>-n</B> &lt;<VAR>no.&nbsp;of&nbsp;dumps</VAR>>]  [<B>-i</B> &lt;<VAR>dump&nbsp;id</VAR>>]
34              [<B>-v</B>]  [<B>-l</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-h</B>]
35 </PRE>
36 <P><STRONG>Description</STRONG>
37 <P>The <B>backup dumpinfo</B> command formats and displays the Backup
38 Database record for the specified dumps. To specify how many of the
39 most recent dumps to display, starting with the newest one and going back in
40 time, use the <B>-ndumps</B> argument. To display more detailed
41 information about a single dump, use the <B>-id</B> argument. To
42 display the records for the 10 most recent dumps, omit both the
43 <B>-ndumps</B> and <B>-id</B> arguments.
44 <P>The <B>-verbose</B> flag produces very detailed information that is
45 useful mostly for debugging purposes. It can be combined only with the
46 <B>-id</B> argument.
47 <P><STRONG>Options</STRONG>
48 <DL>
49 <P><DT><B>-ndumps
50 </B><DD>Displays the Backup Database record for each of the specified number of
51 dumps that were most recently performed. If the database contains fewer
52 dumps than are requested, the output includes the records for all existing
53 dumps. Do not combine this argument with the <B>-id</B> or
54 <B>-verbose</B> options; omit all options to display the records for
55 the last 10 dumps.
56 <P><DT><B>-id
57 </B><DD>Specifies the dump ID number of a single dump for which to display the
58 Backup Database record. Precede the <VAR>dump id</VAR> value with the
59 <B>-id</B> switch; otherwise, the command interpreter interprets it
60 as the value of the <B>-ndumps</B> argument. Combine this argument
61 with the <B>-verbose</B> flag, but not with the <B>-ndumps</B>
62 argument; omit all options to display the records for the last 10
63 dumps.
64 <P><DT><B>-verbose
65 </B><DD>Provides more detailed information about the dump specified with the
66 <B>-id</B> argument, which must be provided along with it. Do not
67 combine this flag with the <B>-ndumps</B> argument.
68 <P><DT><B>-localauth
69 </B><DD>Constructs a server ticket using a key from the local
70 <B>/usr/afs/etc/KeyFile</B> file. The <B>backup</B> command
71 interpreter presents it to the Backup Server, Volume Server and VL Server
72 during mutual authentication. Do not combine this flag with the
73 <B>-cell</B> argument. For more details, see the introductory
74 <B>backup</B> reference page.
75 <P><DT><B>-cell
76 </B><DD>Names the cell in which to run the command. Do not combine this
77 argument with the <B>-localauth</B> flag. For more details, see the
78 introductory <B>backup</B> reference page.
79 <P><DT><B>-help
80 </B><DD>Prints the online help for this command. All other valid options
81 are ignored.
82 </DL>
83 <P><STRONG>Output</STRONG>
84 <P>If the <B>-ndumps</B> argument is provided, the output presents the
85 following information in table form, with a separate line for each dump:
86 <DL>
87 <P><DT><B><TT>dumpid</TT>
88 </B><DD>The dump ID number.
89 <P><DT><B><TT>parentid</TT>
90 </B><DD>The dump ID number of the dump's parent dump. A value of
91 <TT>0</TT> (zero) identifies a full dump.
92 <P><DT><B><TT>lv</TT>
93 </B><DD>The depth in the dump hierarchy of the dump level used to create the
94 dump. A value of <TT>0</TT> (zero) identifies a full dump, in which
95 case the value in the <TT>parentid</TT> field is also <TT>0</TT>. A
96 value of <TT>1</TT> or greater indicates an incremental dump made at the
97 corresponding level in the dump hierarchy.
98 <P><DT><B><TT>created</TT>
99 </B><DD>The date and time at which the Backup System started the dump operation
100 that created the dump.
101 <P><DT><B><TT>nt</TT>
102 </B><DD>The number of tapes that contain the data in the dump. A value of
103 <TT>0</TT> (zero) indicates that the dump operation was terminated or
104 failed. Use the <B>backup deletedump</B> command to remove such
105 entries.
106 <P><DT><B><TT>nvols</TT>
107 </B><DD>The number of volumes from which the dump includes data. If a
108 volume spans tapes, it is counted twice. A value of <TT>0</TT> (zero)
109 indicates that the dump operation was terminated or failed; the value in
110 the <TT>nt</TT> field is also <TT>0</TT> in this case.
111 <P><DT><B><TT>dump name</TT>
112 </B><DD>The dump name in the form 
113 <PRE>   <VAR>volume_set_name</VAR>.<VAR>dump_level_name</VAR> (<VAR>initial_dump_ID</VAR>)
114    
115 </PRE>
116 <P>
117 <P>where <VAR>volume_set_name</VAR> is the name of the volume set, and
118 <VAR>dump_level_name</VAR> is the last element in the dump level pathname at
119 which the volume set was dumped.
120 <P>The <VAR>initial_dump_ID</VAR>, if displayed, is the dump ID of the initial
121 dump in the dump set to which this dump belongs. If there is no value
122 in parentheses, the dump is the initial dump in a dump set that has no
123 appended dumps.
124 </DL>
125 <P>If the <B>-id</B> argument is provided alone, the first line of output
126 begins with the string <TT>Dump</TT> and reports information for the entire
127 dump in the following fields:
128 <DL>
129 <P><DT><B><TT>id</TT>
130 </B><DD>The dump ID number.
131 <P><DT><B><TT>level</TT>
132 </B><DD>The depth in the dump hierarchy of the dump level used to create the
133 dump. A value of <TT>0</TT> (zero) identifies a full dump. A
134 value of <TT>1</TT> (one) or greater indicates an incremental dump made at
135 the specified level in the dump hierarchy.
136 <P><DT><B><TT>volumes</TT>
137 </B><DD>The number of volumes for which the dump includes data.
138 <P><DT><B><TT>created</TT>
139 </B><DD>The date and time at which the dump operation began.
140 </DL>
141 <P>If an XBSA server was the backup medium for the dump (rather than a tape
142 device or backup data file), the following line appears next:
143 <PRE>   Backup Service: <VAR>XBSA_program</VAR>: Server: <VAR>hostname</VAR>
144 </PRE>
145 <P>where <VAR>XBSA_program</VAR> is the name of the XBSA-compliant program and
146 <VAR>hostname</VAR> is the name of the machine on which the program runs.
147 <P>Next the output includes an entry for each tape that houses volume data
148 from the dump. Following the string <TT>Tape</TT>, the first two
149 lines of each entry report information about that tape in the following
150 fields:
151 <DL>
152 <P><DT><B><TT>name</TT>
153 </B><DD>The tape's permanent name if it has one, or its AFS tape name
154 otherwise, and its tape ID number in parentheses.
155 <P><DT><B><TT>nVolumes</TT>
156 </B><DD>The number of volumes for which this tape includes dump data.
157 <P><DT><B><TT>created</TT>
158 </B><DD>The date and time at which the Tape Coordinator began writing data to this
159 tape.
160 </DL>
161 <P>Following another blank line, the tape-specific information concludes with
162 a table that includes a line for each volume dump on the tape. The
163 information appears in columns with the following headings:
164 <DL>
165 <P><DT><B><TT>Pos</TT>
166 </B><DD>The relative position of each volume in this tape or file. On a
167 tape, the counter begins at position 2 (the tape label occupies position 1),
168 and increments by one for each volume. For volumes in a backup data
169 file, the position numbers start with 1 and do not usually increment only by
170 one, because each is the ordinal of the 16 KB offset in the file at which the
171 volume's data begins. The difference between the position numbers
172 therefore indicates how many 16 KB blocks each volume's data
173 occupies. For example, if the second volume is at position 5 and the
174 third volume in the list is at position 9, that means that the dump of the
175 second volume occupies 64 KB (four 16-KB blocks) of space in the file.
176 <P><DT><B><TT>Clone time</TT>
177 </B><DD>For a backup or read-only volume, the time at which it was cloned from its
178 read/write source. For a Read/Write volume, it is the same as the dump
179 creation date reported on the first line of the output.
180 <P><DT><B><TT>Nbytes</TT>
181 </B><DD>The number of bytes of data in the dump of the volume.
182 <P><DT><B><TT>Volume</TT>
183 </B><DD>The volume name, complete with <TT>.backup</TT> or
184 <TT>.readonly</TT> extension if appropriate.
185 </DL>
186 <P>If both the <B>-id</B> and <B>-verbose</B> options are provided,
187 the output is divided into several sections:
188 <UL>
189 <P><LI>The first section, headed by the underlined string <TT>Dump</TT>,
190 includes information about the entire dump. The fields labeled
191 <TT>id</TT>, <TT>level</TT>, <TT>created</TT>, and <TT>nVolumes</TT>
192 report the same values (though in a different order) as appear on the first
193 line of output when the <B>-id</B> argument is provided by itself.
194 Other fields of potential interest to the backup operator are: 
195 <DL>
196 <P><DT><B><TT>Group id</TT>
197 </B><DD>The dump's <I>group ID number</I>, which is recorded in the
198 dump's Backup Database record if the <B>GROUPID</B> instruction
199 appears in the Tape Coordinator's <B>
200 /usr/afs/backup/CFG_</B><VAR>tcid</VAR> file when the dump is created.
201 <P><DT><B><TT>maxTapes</TT>
202 </B><DD>The number of tapes that contain the dump set to which this dump
203 belongs.
204 <P><DT><B><TT>Start Tape Seq</TT>
205 </B><DD>The ordinal of the tape on which this dump begins in the set of tapes that
206 contain the dump set.
207 </DL>
208 <P><LI>For each tape that contains data from this dump, there follows a section
209 headed by the underlined string <TT>Tape</TT>. The fields labeled
210 <TT>name</TT>, <TT>written</TT>, and <TT>nVolumes</TT> report the same
211 values (though in a different order) as appear on the second and third lines
212 of output when the <B>-id</B> argument is provided by itself. Other
213 fields of potential interest to the backup operator are: 
214 <DL>
215 <P><DT><B><TT>expires</TT>
216 </B><DD>The date and time when this tape can be recycled, because all dumps it
217 contains have expired.
218 <P><DT><B><TT>nMBytes Data</TT> and <TT>nBytes Data</TT>
219 </B><DD>Summed together, these fields represent the total amount of dumped data
220 actually from volumes (as opposed to labels, filemarks, and other
221 markers).
222 <P><DT><B><TT>KBytes Tape Used</TT>
223 </B><DD>The number of kilobytes of tape (or disk space, for a backup data file)
224 used to store the dump data. It is generally larger than the sum of the
225 values in the <TT>nMBytes Data</TT> and <TT>nBytes Data</TT> fields,
226 because it includes the space required for the label, file marks and other
227 markers, and because the Backup System writes data at 16 KB offsets, even if
228 the data in a given block doesn't fill the entire 16 KB.
229 </DL>
230 <P><LI>For each volume on a given tape, there follows a section headed by the
231 underlined string <TT>Volume</TT>. The fields labeled
232 <TT>name</TT>, <TT>position</TT>, <TT>clone</TT>, and <TT>nBytes</TT>
233 report the same values (though in a different order) as appear in the table
234 that lists the volumes in each tape when the <B>-id</B> argument is
235 provided by itself. Other fields of potential interest to the backup
236 operator are: 
237 <DL>
238 <P><DT><B><TT>id</TT>
239 </B><DD>The volume ID.
240 <P><DT><B><TT>tape</TT>
241 </B><DD>The name of the tape containing this volume data.
242 </DL>
243 </UL>
244 <P><STRONG>Examples</STRONG>
245 <P>The following example displays information about the last five dumps:
246 <PRE>   % <B>backup dumpinfo -ndumps 5</B>
247       dumpid   parentid lv created          nt nvols dump name
248    924424000          0 0  04/18/1999 04:26  1    22 usr.sun (924424000)
249    924685000  924424000 1  04/21/1999 04:56  1    62 usr.wed (924424000)
250    924773000  924424000 1  04/22/1999 05:23  1    46 usr.thu (924424000)
251    924860000  924424000 1  04/23/1999 05:33  1    58 usr.fri (924424000)
252    925033000          0 0  04/25/1999 05:36  2    73 sys.week
253    
254 </PRE>
255 <P>The following example displays a more detailed record for a single
256 dump.
257 <PRE>   % <B>backup dumpinfo -id 922097346</B>
258    Dump: id 922097346, level 0, volumes 1, created Mon Mar 22 05:09:06 1999
259    Tape: name monday.user.backup (922097346)
260    nVolumes 1, created 03/22/1999 05:09
261     Pos       Clone time   Nbytes Volume
262       1 03/22/1999 04:43 27787914 user.pat.backup
263    
264 </PRE>
265 <P>The following example displays even more detailed information about the
266 dump displayed in the previous example (dump ID 922097346). This
267 example includes only one exemplar of each type of section (<TT>Dump</TT>,
268 <TT>Tape</TT>, and <TT>Volume</TT>):
269 <PRE>   % <B>backup dumpinfo -id 922097346 -verbose</B>
270    Dump
271    ----
272    id = 922097346
273    Initial id = 0
274    Appended id = 922099568
275    parent = 0
276    level = 0
277    flags = 0x0
278    volumeSet = user
279    dump path = /monday1
280    name = user.monday1
281    created = Mon Mar 22 05:09:06 1999
282    nVolumes = 1
283    id  = 0
284    tapeServer =
285    format= user.monday1.%d
286    maxTapes = 1
287    Start Tape Seq = 1
288    name = pat
289    instance =
290    cell =
291    Tape
292    ----
293    tape name = monday.user.backup
294    AFS tape name = user.monday1.1
295    flags = 0x20
296    written = Mon Mar 22 05:09:06 1999
297    expires = NEVER
298    kBytes Tape Used = 121
299    nMBytes Data = 0
300    nBytes  Data = 19092
301    nFiles = 0
302    nVolumes = 1
303    seq = 1
304    tapeid = 0
305    useCount = 1
306    dump = 922097346
307    Volume
308    ------
309    name = user.pat.backup
310    flags = 0x18
311    id = 536871640
312    server =
313    partition = 0
314    nFrags = 1
315    position = 2
316    clone = Mon Mar 22 04:43:06 1999
317    startByte = 0
318    nBytes = 19092
319    seq = 0
320    dump = 922097346
321    tape = user.monday1.1
322    
323 </PRE>
324 <P><STRONG>Privilege Required</STRONG>
325 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
326 every machine where the Backup Server is running, or must be logged onto a
327 server machine as the local superuser <B>root</B> if the
328 <B>-localauth</B> flag is included.
329 <P><STRONG>Related Information</STRONG>
330 <P><A HREF="auarf060.htm#HDRBK_INTRO">backup</A>
331 <P><A HREF="auarf068.htm#HDRBK_DELETEDUMP">backup deletedump</A>
332 <P>
333 <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="auarf073.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="auarf075.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> 
334 <!-- Begin Footer Records  ========================================== -->
335 <P><HR><B> 
336 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
337 </B> 
338 <!-- End Footer Records  ============================================ -->
339 <A NAME="Bot_Of_Page"></A>
340 </BODY></HTML>