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="auarf232.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="auarf234.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="HDRSCOUT" HREF="auarf002.htm#ToC_247">scout</A></H2>
19 <A NAME="IDX5447"></A>
20 <A NAME="IDX5448"></A>
21 <A NAME="IDX5449"></A>
22 <A NAME="IDX5450"></A>
23 <A NAME="IDX5451"></A>
24 <A NAME="IDX5452"></A>
25 <A NAME="IDX5453"></A>
26 <A NAME="IDX5454"></A>
27 <A NAME="IDX5455"></A>
28 <A NAME="IDX5456"></A>
29 <P><STRONG>Purpose</STRONG>
30 <P>Monitors the File Server process
31 <P><STRONG>Synopsis</STRONG>
32 <PRE><B>scout</B> [<B>initcmd</B>] <B>-server</B> <<VAR>FileServer name(s) to monitor</VAR>><SUP>+</SUP>
33 [<B>-basename</B> <<VAR>base server name</VAR>>]
34 [<B>-frequency</B> <<VAR>poll frequency, in seconds</VAR>>] [<B>-host</B>]
35 [<B>-attention</B> <<VAR>specify attention (highlighting) level</VAR>><SUP>+</SUP>]
36 [<B>-debug</B> <<VAR>turn debugging output on to the named file</VAR>>] [<B>-help</B>]
38 <B>scout</B> [<B>i</B>] <B>-s</B> <<VAR>FileServer name(s) to monitor</VAR>><SUP>+</SUP>
39 [<B>-b</B> <<VAR>base server name</VAR>>] [<B>-f</B> <<VAR>poll frequency, in seconds</VAR>>]
40 [<B>-ho</B>] [<B>-a</B> <<VAR>specify attention (highlighting) level</VAR>><SUP>+</SUP>]
41 [<B>-d</B> <<VAR>turn debugging output on to the named file</VAR>>] [<B>-he</B>]
43 <P><STRONG>Description</STRONG>
44 <P>The <B>scout</B> command displays statistics gathered from the File
45 Server process running on each machine specified with the <B>-server</B>
46 argument. The <B>Output</B> section explains the meaning of the
47 statistics and describes how they appear in the command shell, which is
48 preferably a window managed by a window manager program.
49 <P><STRONG>Cautions</STRONG>
50 <P>The <B>scout</B> program must be able to access the <B>curses</B>
51 graphics package, which it uses to display statistics. Most UNIX
52 distributions include <B>curses</B> as a standard utility.
53 <P>Both dumb terminals and windowing systems that emulate terminals can
54 display the <B>scout</B> program's statistics. The display
55 makes use of reverse video and cursor addressing, so the display environment
56 must support those features for it to look its best (most windowing systems
57 do, most dumb terminals do not). Also, set the TERM environment
58 variable to the correct terminal type, or one with characteristics similar to
59 the actual ones. For machines running the AIX operating system, the
60 recommended setting for TERM is <B>vt100</B>, as long as the terminal is
61 similar to that. For other operating systems, the wider range of
62 acceptable values includes <B>xterm</B>, <B>xterms</B>,
63 <B>vt100</B>, <B>vt200</B>, and <B>wyse85</B>.
64 <P><STRONG>Options</STRONG>
67 </B><DD>Accommodates the command's use of the AFS command parser, and is
70 </B><DD>Specifies each file server machine running a File Server process to
71 monitor. Provide each machine's fully qualified hostname unless
72 the <B>-basename</B> argument is used. In that case, specify only
73 the unique initial part of each machine name, omitting the domain name suffix
74 (the basename) common to all the names. It is also acceptable to use
75 the shortest abbreviated form of a host name that distinguishes it from other
76 machines, but successful resolution depends on the availability of a name
77 resolution service (such as the Domain Name Service or a local host table) at
78 the time the command is issued.
80 </B><DD>Specifies the basename (domain name) suffix common to all of the file
81 server machine names specified with the <B>-server</B> argument, and is
82 automatically appended to them. This argument is normally the name of
83 the cell to which the machines belong. Do not include the period that
84 separates this suffix from the distinguishing part of each file server machine
85 name, but do include any periods that occur within the suffix itself.
86 For example, in the ABC Corporation cell, the proper value is
87 <B>abc.com</B> rather than
90 </B><DD>Indicates how often to probe the File Server processes. Specify a
91 number of seconds greater than <B>0</B> (zero). The default is 60
94 </B><DD>Displays the name of the machine that is running the <B>scout</B>
95 program, in the banner line of the display screen.
97 </B><DD>Defines a list of entries, each of which pairs a statistic and a threshold
98 value. When the value of the statistic exceeds the indicated threshold
99 value, it is highlighted (in reverse video) in the display. List the
100 pairs in any order. The acceptable values are the following:
102 <P><LI><B>conn</B> <VAR>connections</VAR>. Indicates the number of open
103 connections to client processes at which to highlight the statistic.
104 The statistic returns to regular display when the value goes back below the
105 threshold. There is no default threshold.
106 <P>An example of an acceptable value is <B>conn 300</B>.
107 <P><LI><B>disk</B>, which takes one of two types of values:
109 <P><LI><B>disk</B> <VAR>blocks_free</VAR>. Indicates the number of
110 remaining free kilobyte blocks at which to highlight the statistic. The
111 statistic returns to regular display when the value again exceeds the
112 threshold. There is no default threshold.
113 <P>An example of an acceptable value is <B>disk 5000</B>.
114 <P><LI><B>disk</B> <VAR>percent_full</VAR><B>%</B>. Indicates the
115 percentage of disk usage at which to highlight the statistic. The
116 statistic returns to regular display when the value goes back below the
117 threshold. The default threshold is 95%. Acceptable values are
118 the integers in the range from <B>0</B> to <B>99</B>, followed by the
119 percent sign (<B>%</B>) to distinguish this type of value from the one
120 described just previously.
121 <P>An example is <B>disk 90%</B>.
123 <P><LI><B>fetch</B> <VAR>fetch_RPCs</VAR>. Indicates the cumulative
124 number of fetch RPCs from client processes at which to highlight the
125 statistic. The statistic does not return to regular display until the
126 File Server process restarts, at which time the value returns to zero.
127 There is no default threshold.
128 <P>Example of a legal value: <B>fetch 6000000</B>
129 <P><LI><B>store</B> <VAR>store_RPCs</VAR>. Indicates the cumulative
130 number of store RPCs from client processes at which to highlight the
131 statistic. The statistic does not return to regular display until the
132 File Server process restarts, at which time the value returns to zero.
133 There is no default threshold.
134 <P>Example of an acceptable value: <B>store 200000</B>
135 <P><LI><B>ws</B> <VAR>active_client_machines</VAR>. Indicates the number
136 of client machines with active open connections at which to highlight the
137 statistic. An active connection is defined as one over which the File
138 Server and client have communicated in the last 15 minutes. The
139 statistic returns to regular display when the value goes back below the
140 threshold. There is no default threshold.
141 <P>Example of an acceptable value: <B>ws 65</B>
144 </B><DD>Specifies the pathname of the file into which to write a debugging
145 trace. Partial pathnames are interpreted relative to the current
148 </B><DD>Prints the online help for this command. All other valid options
151 <P><STRONG>Output</STRONG>
152 <P>The <B>scout</B> program can display statistics either in a dedicated
153 window or on a plain screen if a windowing environment is not
154 available. For best results, the window or screen needs the ability to
155 print in reverse video.
156 <P>The <B>scout</B> screen has three main parts: the banner line,
157 the statistics display region and the message/probe line.
158 <P><B><I>The Banner Line</I></B>
159 <P>By default, the string <TT>Scout</TT> appears in the banner line at the
160 top of the window or screen. Two optional arguments place additional
161 information in the banner line:
163 <P><LI>The <B>-host</B> flag displays the name of the machine where the
164 <B>scout</B> program is running. As mentioned previously, this is
165 useful when running the <B>scout</B> program on several machines but
166 displaying the results on a single machine.
167 <P>For example, when the <B>-host</B> flag is included and the
168 <B>scout</B> program is running on the machine
169 <B>client1.abc.com</B>, the banner line reads as
171 <PRE> [client1.abc.com] Scout
174 <P><LI>The <B>-basename</B> argument displays the indicated basename on the
175 banner line. For example, including the argument <B>-basename
176 abc.com</B> argument results in the following banner line:
177 <PRE> Scout for abc.com
181 <P><B><I>The Statistics Display Region</I></B>
182 <P>In this region, which occupies the majority of the window, the
183 <B>scout</B> process displays the statistics gathered for each File Server
184 process. Each process appears on its own line.
185 <P>The region is divided into six columns, labeled as indicated and displaying
186 the following information:
187 <A NAME="IDX5457"></A>
188 <A NAME="IDX5458"></A>
190 <P><LI><TT>Conn</TT>: The first column displays the number of RPC
191 connections open between the File Server process and client machines.
192 This number equals or exceeds the number in the <TT>Ws</TT> column (see the
193 fourth entry below), because each user on the machine can have several
194 separate connections open at once, and one client machine can handle several
196 <A NAME="IDX5459"></A>
197 <P><LI><TT>Fetch</TT>: The second column displays the number of
198 fetch-type RPCs (fetch data, fetch access list, and fetch status) that client
199 machines have made to the File Server process since the latter started.
200 This number is reset to zero each time the File Server process
202 <A NAME="IDX5460"></A>
203 <P><LI><TT>Store</TT>: The third column displays the number of store-type
204 RPCs (store data, store access list, and store status) that client machines
205 have made to the File Server process since the latter started. This
206 number is reset to zero each time the File Server process restarts.
207 <A NAME="IDX5461"></A>
208 <P><LI><TT>Ws</TT>: The fourth column displays the number of client
209 machines (<TT>Ws</TT> stands for workstations) that have communicated with
210 the File Server process within the last 15 minutes. Such machines are
211 termed <I>active</I>). This number is likely to be smaller than the
212 number in the first (<TT>Conn</TT>) column because a single client machine
213 can have several connections open to one File Server.
214 <A NAME="IDX5462"></A>
215 <A NAME="IDX5463"></A>
216 <A NAME="IDX5464"></A>
217 <P><LI>The fifth, unlabeled, column displays the name of the file server machine
218 on which the File Server process is running. Names of 12 characters or
219 less are displayed in full; longer names are truncated and an asterisk
220 (<TT>*</TT>) appears as the last character in the name. Using the
221 <B>-basename</B> argument is a good way to avoid truncation, but only if
222 all machine names end in a common string.
223 <P><LI><TT>Disk attn</TT>: The sixth column displays the number of
224 available kilobyte blocks on each AFS disk partition on the file server
226 <A NAME="IDX5465"></A>
227 <A NAME="IDX5466"></A>
228 <A NAME="IDX5467"></A>
229 The display for each partition has the following form:
230 <PRE> x:<VAR>free_blocks</VAR>
233 <P>where <TT>x</TT> indicates the partition name. For example,
234 <TT><B>a:8949</B></TT> specifies that the <B>/vicepa</B>
235 partition has 8,949 1-KB blocks free. Available space can be displayed
236 for up to 26 partitions. If the window is not wide enough for all
237 partition entries to appear on a single line, the <B>scout</B> process
238 automatically creates multiple lines, stacking the partition entries into
239 sub-columns within the sixth column.
240 <P>The label on the <TT>Disk</TT> <TT>attn</TT> column indicates the
241 threshold value at which entries in the column become highlighted. By
242 default, the label is
243 <PRE> Disk attn: > 95% used
246 <P>because by default the <B>scout</B> program highlights the entry for
247 any partition that is over 95% full.
249 <P>For all columns except the fifth (file server machine name), the optional
250 <B>-attention</B> argument sets the value at which entries in the column
251 are highlighted to indicate that a certain value has been exceeded.
252 Only values in the fifth and <TT>Disk attn</TT> columns ever become
253 highlighted by default.
254 <P>If the <B>scout</B> program is unable to access or otherwise obtain
255 information about a partition, it generates a message similar to the following
257 <PRE> Could not get information on server fs1.abc.com partition /vicepa
260 <P><B><I>The Message/Probe Line</I></B>
261 <P>The bottom line of the <B>scout</B> screen indicates how many times the
262 <B>scout</B> program has probed the File Server processes for
263 statistics. The statistics gathered in the latest probe appear in the
264 statistics display region. The <B>-frequency</B> argument overrides
265 the default probe frequency of 60 seconds.
266 <P><STRONG>Examples</STRONG>
267 <P>See the chapter on monitoring tools in the <I>IBM AFS Administration
268 Guide</I>, which illustrates the displays that result from different
269 combinations of options.
270 <P><STRONG>Privilege Required</STRONG>
272 <P><STRONG>Related Information</STRONG>
273 <P><A HREF="auarf059.htm#HDRAFSMONITOR">afsmonitor</A>
274 <P><A HREF="auarf169.htm#HDRFSTRACE_INTRO">fstrace</A>
276 <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="auarf232.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="auarf234.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>
277 <!-- Begin Footer Records ========================================== -->
279 <br>© <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A> All Rights Reserved
281 <!-- End Footer Records ============================================ -->
282 <A NAME="Bot_Of_Page"></A>
git://git.openafs.org / openafs.git / blob