afsmonitor-document-usage-20040729
[openafs.git] / doc / html / AdminReference / auarf130.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="auarf129.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="auarf131.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="HDRFMS" HREF="auarf002.htm#ToC_144">fms</A></H2>
19 <A NAME="IDX4705"></A>
20 <A NAME="IDX4706"></A>
21 <A NAME="IDX4707"></A>
22 <A NAME="IDX4708"></A>
23 <A NAME="IDX4709"></A>
24 <A NAME="IDX4710"></A>
25 <A NAME="IDX4711"></A>
26 <A NAME="IDX4712"></A>
27 <A NAME="IDX4713"></A>
28 <A NAME="IDX4714"></A>
29 <P><STRONG>Purpose</STRONG>
30 <P>Determine a tape's capacity and a tape device's filemark size
31 <P><STRONG>Synopsis</STRONG>
32 <PRE><B>fms -tape</B> &lt;<VAR>tape&nbsp;special&nbsp;file</VAR>>  [<B>-help</B>]
33     
34 <B>fms  -t</B> &lt;<VAR>tape&nbsp;special&nbsp;file</VAR>>  [<B>-h</B>]
35 </PRE>
36 <P><STRONG>Description</STRONG>
37 <P>The <B>fms</B> command determines the capacity of the tape currently in
38 the tape device identified by the <B>-tape</B> argument, along with the
39 size of the filemark for the device. The filemark is also referred to
40 as the device's end-of-file (EOF) marker, and can differ for each
41 combination of tape and tape device.
42 <P>As the Tape Coordinator writes a dump, it writes a filemark between the
43 data included from each volume and also tracks the amount of space left before
44 the end of the tape (EOT). For some tape devices, the filemark is large
45 enough (multiple megabytes) that failure to consider it leads the Tape
46 Coordinator significantly to overestimate the available space.
47 <P>The intended use of this command is to determine tape capacity and filemark
48 size values that can be specified in a tape device's entry in the
49 <B>/usr/afs/backup/tapeconfig</B> file. For certain types of tape
50 drives, the Tape Coordinator operates more efficiently when the
51 <B>tapeconfig</B> file lists accurate values. For further
52 discussion, see the <I>IBM AFS Administration Guide</I> chapter on
53 configuring the Backup System.
54 <P>Insert a tape in the drive before issuing this command.
55 <P><STRONG>Cautions</STRONG>
56 <P>Do not use this command on compressing tape devices in compression mode or
57 with tape devices that handle tapes of multigigabyte (or multiterabyte)
58 capacity. It does not produce accurate results in those cases.
59 For alternate suggestions on the values to record in the <B>tapeconfig</B>
60 file for compressing drives, see the <I>IBM AFS Administration Guide</I>
61 chapter on configuring the Backup System.
62 <P>Running the command completely overwrites the tape, so use a blank one or
63 one that can be recycled.
64 <P>Because it writes filemarks to the complete length of the tape, the command
65 can take from several hours to more than a day to complete.
66 <P><STRONG>Options</STRONG>
67 <DL>
68 <P><DT><B>-tape
69 </B><DD>Specifies the UNIX device name of the tape device for which to determine
70 filemark size and the capacity of the tape it currently contains. The
71 format varies on different system types, but usually begins with
72 <B>/dev</B>; an example is <B>/dev/sd0a</B>.
73 <P><DT><B>-help
74 </B><DD>Prints the online help for this command. All other valid options
75 are ignored.
76 </DL>
77 <P><STRONG>Output</STRONG>
78 <P>The command generates output both on the standard output stream and in the
79 <B>fms.log</B> file that it creates in the current working
80 directory. The output reports the capacity of the tape in the device
81 and the device's filemark size.
82 <P>The first few lines of output include status information about the
83 execution of the command, including such information as the number of blocks
84 and the number of file marks written to the tape by the command. The
85 last two lines of both screen and file output provide the following
86 information:
87 <UL>
88 <P><LI><TT>Tape capacity is</TT> <VAR>number</VAR> <TT>bytes</TT>:
89 specifies the size, in bytes, of the tape in the device.
90 <P><LI><TT>File marks are</TT> <VAR>number</VAR> <TT>bytes</TT>:
91 specifies the device's filemark size in bytes.
92 </UL>
93 <P>The following message indicates that the <B>fms</B> command interpreter
94 cannot access the tape device. The command halts.
95 <PRE>   Can't open tape drive <VAR>device</VAR>
96    
97 </PRE>
98 <P>The following message indicates that the command interpreter cannot create
99 the <B>fms.log</B> log file. Again, the command
100 halts.
101 <PRE>   Can't open log file
102    
103 </PRE>
104 <P><STRONG>Examples</STRONG>
105 <P>The following command illustrates the output for the device called
106 <B>/dev/rmt1h</B>:
107 <PRE>   % <B>fms /dev/rmt1h</B>
108    wrote block: 130408
109    Finished data capacity test - rewinding
110    wrote 1109 blocks, 1109 file marks
111    Finished file mark test
112    Tape capacity is 2136604672 bytes
113    File marks are 1910205 bytes
114    
115 </PRE>
116 <P>The following appears in the <B>fms.log</B> file:
117 <PRE>   fms test started
118    wrote 9230 blocks
119    Finished file mark test
120    Tape capacity is 151224320 bytes
121    File marks are 2375680 bytes
122    
123 </PRE>
124 <P><STRONG>Privilege Required</STRONG>
125 <P>The issuer must be able to insert and write to files in the currently
126 working directory, if the <B>fms.log</B> file does not already
127 exist. If it already exists, the issuer need only be able to write to
128 it.
129 <P><STRONG>Related Information</STRONG>
130 <P><A HREF="auarf044.htm#HDRFMSLOG">fms.log</A>
131 <P><A HREF="auarf050.htm#HDRTAPECONFIG">tapeconfig</A>
132 <P>
133 <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="auarf129.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="auarf131.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> 
134 <!-- Begin Footer Records  ========================================== -->
135 <P><HR><B> 
136 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
137 </B> 
138 <!-- End Footer Records  ============================================ -->
139 <A NAME="Bot_Of_Page"></A>
140 </BODY></HTML>