afsmonitor-document-stat-entries-correctly-20040729
[openafs.git] / doc / html / AdminReference / auarf126.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="auarf125.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="auarf127.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="HDRBUTC" HREF="auarf002.htm#ToC_140">butc</A></H2>
19 <A NAME="IDX4691"></A>
20 <A NAME="IDX4692"></A>
21 <A NAME="IDX4693"></A>
22 <A NAME="IDX4694"></A>
23 <A NAME="IDX4695"></A>
24 <A NAME="IDX4696"></A>
25 <P><STRONG>Purpose</STRONG>
26 <P>Initializes the Tape Coordinator process
27 <P><STRONG>Synopsis</STRONG>
28 <PRE><B>butc</B> [<B>-port</B> &lt;<VAR>port&nbsp;offset</VAR>>]  [<B>-debuglevel</B> &lt; <B>0</B> | <B>1</B> | <B>2</B> >]  
29      [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-noautoquery</B>]  
30      [<B>-localauth</B>]  [<B>-help</B>]
31         
32 <B>butc</B> [<B>-p</B> &lt;<VAR>port&nbsp;offset</VAR>>]  [<B>-d</B> &lt; <B>0</B> | <B>1</B> | <B>2</B> >]  
33      [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-l</B>]  [<B>-h</B>]
34 </PRE>
35 <P><STRONG>Description</STRONG>
36 <P>The <B>butc</B> command initializes a Tape Coordinator process on a
37 Tape Coordinator machine, enabling an operator to direct Backup System
38 requests to the associated tape device or backup data file. (The Tape
39 Coordinator controls a backup data file if the <B>FILE YES</B> instruction
40 appears in the <B>/usr/afs/backup/CFG_</B><VAR>device_name</VAR> file that
41 corresponds to the Tape Coordinator's entry in the
42 <B>/usr/afs/backup/tapeconfig</B> file. For the sake of simplicity,
43 the following discusses tape devices only.)
44 <P>It is conventional to start and run the Tape Coordinator in the
45 foreground. In this case, it runs on its own connection, which is
46 unavailable for any other use and must remain open the entire time the Tape
47 Coordinator is to accept backup requests and while it is executing
48 them. (When using a window manager, the connection corresponds to a
49 separate command shell window.) The Tape Coordinator can run in the
50 background if the <B>CFG_</B><VAR>device_name</VAR> file is configured to
51 eliminate any need for the Tape Coordinator to prompt the operator. In
52 both the foreground and background, the Tape Coordinator writes operation
53 traces and other output to the standard output stream on the connection over
54 which it was started. Use the <B>-debuglevel</B> argument to
55 control the amount of information that appears. The Tape Coordinator
56 also writes traces and error messages to two files in the local
57 <B>/usr/afs/backup</B> directory:
58 <UL>
59 <P><LI>The <B>TE_</B><VAR>device_name</VAR> file records problems that the Tape
60 Coordinator encounters as it executes backup operations.
61 <P><LI>The <B>TL_</B><VAR>device_name</VAR> file records a trace of operations
62 as well as the same errors written to the <B>TE_</B><VAR>device_name</VAR>
63 file.
64 </UL>
65 <P>The Tape Coordinator creates the files automatically as it
66 initializes. If there are existing files, the Tape Coordinator renames
67 them with a <B>.old</B> extension, overwriting the existing
68 <B>.old</B> files if they exist. It derives the
69 <VAR>device_name</VAR> part of the file names by stripping off the device
70 name's <B>/dev/</B> prefix and replacing any other slashes with
71 underscores. For example, the files are called <B>TE_rmt_4m</B> and
72 <B>TL_rmt_4m</B> for a device called <B>/dev/rmt/4m</B>.
73 <P>By default, at the beginning of each operation the Tape Coordinator prompts
74 for the operator to insert the first tape into the drive and press
75 &lt;<B>Return</B>>. To suppress this prompt, include the
76 <B>-noautoquery</B> flag on the command line or the instruction
77 <B>AUTOQUERY NO</B> in the
78 <B>/usr/afs/backup/CFG_</B><VAR>device_name</VAR> file. When the
79 prompt is suppressed, the first required tape must be in the drive before a
80 <B>backup</B> command is issued. For subsequent tapes, the Tape
81 Coordinator uses its normal tape acquisition routine: if the
82 <B>/usr/afs/backup/CFG_</B><VAR>device_name</VAR> file includes a
83 <B>MOUNT</B> instruction, the Tape Coordinator invokes the indicated
84 command; otherwise, it prompts the operator for the next tape.
85 <P>To stop the Tape Coordinator process, enter an interrupt signal such as
86 &lt;<B>Ctrl-c</B>> over the dedicated connection (in the command shell
87 window).
88 <P>To cancel a <B>backup</B> operation that involves a tape before it
89 begins (assuming the initial tape prompt has not been suppressed), enter the
90 letter <B>a</B> (for <B>abort</B>) and press &lt;<B>Return</B>> at
91 the Tape Coordinator's prompt for the first tape.
92 <P>Tape Coordinator operation depends on the correct configuration of certain
93 files, as described in the following list:
94 <UL>
95 <P><LI>The local <B>/usr/afs/backup/tapeconfig</B> file must include an entry
96 for the Tape Coordinator that specifies its device name and port offset
97 number, among other information; for details, see the
98 <B>tapeconfig</B> reference page.
99 <P><LI>The port offset number recorded in the Tape Coordinator's entry in
100 the Backup Database must match the one in the <B>tapeconfig</B>
101 file. Create the Backup Database entry by using the <B>backup
102 addhost</B> command.
103 <P><LI>The optional <B>/usr/afs/backup/CFG_</B><VAR>device_name</VAR> file can
104 contain instructions for mounting and unmounting tapes automatically (when
105 using a tape stacker or jukebox, for instance) or automating other aspects of
106 the backup process. The <VAR>device_name</VAR> part of the name is
107 derived as described previously for the <B>TE_</B><VAR>device_name</VAR> and
108 <B>TL_</B><VAR>device_name</VAR> files.
109 </UL>
110 <P><STRONG>Cautions</STRONG>
111 <P>If the Tape Coordinator machine is an AIX machine, use the <B>SMIT</B>
112 utility to set the device's block size to 0 (zero), indicating variable
113 block size. Otherwise, tape devices attached to machines running other
114 operating systems sometimes cannot read tapes written on AIX machines.
115 For instructions, see the <I>IBM AFS Administration Guide</I> chapter
116 about configuring the Backup System.
117 <P><STRONG>Options</STRONG>
118 <DL>
119 <P><DT><B>-port
120 </B><DD>Specifies the port offset number of the Tape Coordinator to
121 initialize.
122 <P><DT><B>-debuglevel
123 </B><DD>Controls the amount and type of messages the Tape Coordinator displays on
124 the standard output stream. Provide one of three acceptable
125 values: 
126 <UL>
127 <P><LI><B>0</B> to display the minimum level of detail required to describe
128 Tape Coordinator operations, including prompts for tapes, messages that
129 indicate the beginning and end of operations, and error messages. This
130 is the default value.
131 <P><LI><B>1</B> to display the names of the volumes being dumped or restored
132 as well as the information displayed at level 0.
133 <P><LI><B>2</B> to display all messages also being written to the
134 <B>TL_</B><VAR>device_name</VAR> log file.
135 </UL>
136 <P><DT><B>-cell
137 </B><DD>Names the cell in which the Tape Coordinator operates (the cell to which
138 the file server machines that house affected volumes belong). If this
139 argument is omitted, the Tape Coordinator runs in the local cell as defined in
140 the local <B>/usr/vice/etc/ThisCell</B> file. Do not combine this
141 flag with the <B>-localauth</B> argument.
142 <P><DT><B>-noautoquery
143 </B><DD>Suppresses the Tape Coordinator's prompt for insertion of the first
144 tape needed for an operation. The operator must insert the tape into
145 the drive before issuing the <B>backup</B> command that initializes the
146 operation.
147 <P><DT><B>-localauth
148 </B><DD>Constructs a server ticket using the server encryption key with the
149 highest key version number in the local
150 <B>/usr/afs/etc/KeyFile</B>. The <B>butc</B> command
151 interpreter presents the ticket, which never expires, to the Volume Server and
152 Volume Location Server to use in mutual authentication. 
153 <P>Do not combine this argument with the <B>-cell</B> flag, and use it
154 only when logged on to a server machine as the local superuser
155 <B>root</B>; client machines do not have
156 <B>/usr/afs/etc/KeyFile</B> file.
157 <P><DT><B>-help
158 </B><DD>Prints the online help for this command. All other valid options
159 are ignored.
160 </DL>
161 <P><STRONG>Examples</STRONG>
162 <P>The following command starts the Tape Coordinator with port offset
163 <B>7</B> at debug level <B>1</B>, meaning the Tape Coordinator reports
164 the names of volumes it is dumping or restoring.
165 <PRE>   % <B>butc -port 7 -debuglevel 1</B>
166    
167 </PRE>
168 <P><STRONG>Privilege Required</STRONG>
169 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
170 every machine where the Backup Server or Volume Location (VL) Server is
171 running, and on every file server machine that houses a volume to be backed
172 up. If the <B>-localauth</B> flag is included, the issuer must
173 instead be logged on to the Tape Coordinator machine as the local superuser
174 <B>root.</B> In addition, the issuer must be able to read and write
175 to the log and configuration files in the local <B>/usr/afs/backup</B>
176 directory.
177 <P><STRONG>Related Information</STRONG>
178 <P><A HREF="auarf018.htm#HDRCFG">CFG_<I>device_name</I></A>
179 <P><A HREF="auarf023.htm#HDRKEYFILE">KeyFile</A>
180 <P><A HREF="auarf031.htm#HDRTE">TE_<I>device_name</I></A>
181 <P><A HREF="auarf032.htm#HDRCLI_THISCELL">ThisCell (client version)</A>
182 <P><A HREF="auarf034.htm#HDRTL">TL_<I>device_name</I></A>
183 <P><A HREF="auarf035.htm#HDRUSERLIST">UserList</A>
184 <P><A HREF="auarf050.htm#HDRTAPECONFIG">tapeconfig</A>
185 <P><A HREF="auarf062.htm#HDRBK_ADDHOST">backup addhost</A>
186 <P>
187 <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="auarf125.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="auarf127.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> 
188 <!-- Begin Footer Records  ========================================== -->
189 <P><HR><B> 
190 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
191 </B> 
192 <!-- End Footer Records  ============================================ -->
193 <A NAME="Bot_Of_Page"></A>
194 </BODY></HTML>