initial-html-documentation-20010606
[openafs.git] / doc / html / AdminReference / auarf052.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="auarf051.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="auarf053.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="HDRAFSMONCONFIG" HREF="auarf002.htm#ToC_50">afsmonitor Configuration File</A></H2>
19 <P><STRONG>Purpose</STRONG>
20 <A NAME="IDX4036"></A>
21 <A NAME="IDX4037"></A>
22 <P>Provides instructions for the <B>afsmonitor</B> command
23 <P><STRONG>Description</STRONG>
24 <P>The <B>afsmonitor</B> configuration file determines which machines the
25 <B>afsmonitor</B> command probes for File Server or Cache Manager
26 statistics and which statistics it gathers. Use the <B>-config</B>
27 argument to the <B>afsmonitor</B> command to identify the configuration
28 file to use.
29 <P>The instructions that can appear in the configuration file are as
30 follows:
31 <DL>
32 <P><DT><B><TT>cm  <VAR>host_name</VAR></TT>
33 </B><DD>Names a client machine for which to display Cache Manager
34 statistics. The order of <B>cm</B> lines in the file determines the
35 order in which client machines appear from top to bottom on the <TT>System
36 Overview</TT> and <TT>Cache Managers</TT> output screens.
37 <P><DT><B><TT>fs  <VAR>host_name</VAR></TT>
38 </B><DD>Names a file server machine for which to display File Server
39 statistics. The order of <B>fs</B> lines in the file determines the
40 order in which file server machines appear from top to bottom on the
41 <TT>System Overview</TT> and <TT>File Servers</TT> output screens.
42 <P><DT><B><TT>thresh  fs | cm  <VAR>field_name</VAR>  <VAR>thresh_val</VAR> 
43 [<VAR>cmd_to_run</VAR>]  [<VAR>arg</VAR><SUB>1</SUB>] . . .
44 [<VAR>arg</VAR><SUB>n</SUB>]</TT>
45 </B><DD>Assigns the threshold value <VAR>thresh_val</VAR> to the statistic
46 <VAR>field_name</VAR>, for either a File Server statistic (<B>fs</B>) or a
47 Cache Manager statistic (<B>cm</B>). The optional
48 <VAR>cmd_to_execute</VAR> field names a binary or script to execute each time
49 the value of the statistic changes from being below <VAR>thresh_val</VAR> to
50 being at or above <VAR>thresh_val</VAR>. A change between two values that
51 both exceed <VAR>thresh_val</VAR> does not retrigger the binary or
52 script. The optional <VAR>arg</VAR><SUB>1</SUB> through
53 <VAR>arg</VAR><SUB>n</SUB> fields are additional values that the
54 <B>afsmonitor</B> program passes as arguments to the
55 <VAR>cmd_to_execute</VAR> command. If any of them include one or more
56 spaces, enclose the entire field in double quotes.
57 <P>The parameters <B>fs</B>, <B>cm</B>, <VAR>field_name</VAR>,
58 <VAR>threshold_val</VAR>, and <VAR>arg</VAR><SUB>1</SUB> through
59 <VAR>arg</VAR><SUB>n</SUB> correspond to the values with the same name on the
60 <B>thresh</B> line. The <VAR>host_name</VAR> parameter identifies the
61 file server or client machine where the statistic has crossed the threshold,
62 and the <VAR>actual_val</VAR> parameter is the actual value of
63 <VAR>field_name</VAR> that equals or exceeds the threshold value.
64 <P>Use the <B>thresh</B> line to set either a global threshold, which
65 applies to all file server machines listed on <B>fs</B> lines or client
66 machines listed on <B>cm</B> lines in the configuration file, or a
67 machine-specific threshold, which applies to only one file server or client
68 machine.
69 <UL>
70 <P><LI>To set a global threshold, place the <B>thresh</B> line before any of
71 the <B>fs</B> or <B>cm</B> lines in the file.
72 <P><LI>To set a machine-specific threshold, place the <B>thresh</B> line
73 below the corresponding <B>fs</B> or <B>cm</B> line, and above any
74 other <B>fs</B> or <B>cm</B> lines. A machine-specific
75 threshold value always overrides the corresponding global threshold, if
76 set. Do not place a <B>thresh fs</B> line directly after a
77 <B>cm</B> line or a <B>thresh cm</B> line directly after a
78 <B>fs</B> line.
79 </UL>
80 <P><DT><B><TT>show  fs | cm  <VAR>field/group/section</VAR></TT>
81 </B><DD>Specifies which individual statistic, group of statistics, or section of
82 statistics to display on the <TT>File Servers</TT> screen (<B>fs</B>) or
83 <TT>Cache Managers</TT> screen (<B>cm</B>) and the order in which to
84 display them. The appendix of <B>afsmonitor</B> statistics in the
85 <I>IBM AFS Administration Guide</I> specifies the group and section to
86 which each statistic belongs. Include as many <B>show</B> lines as
87 necessary to customize the screen display as desired, and place them anywhere
88 in the file. The top-to-bottom order of the <B>show</B> lines in
89 the configuration file determines the left-to-right order in which the
90 statistics appear on the corresponding screen.
91 <P>If there are no <B>show</B> lines in the configuration file, then the
92 screens display all statistics for both Cache Managers and File
93 Servers. Similarly, if there are no <B>show fs</B> lines, the
94 <TT>File Servers</TT> screen displays all file server statistics, and if
95 there are no <B>show cm</B> lines, the <TT>Cache Managers</TT> screen
96 displays all client statistics.
97 <P><DT><B># <VAR>comments</VAR>
98 </B><DD>Precedes a line of text that the <B>afsmonitor</B> program ignores
99 because of the initial number (<B>#</B>) sign, which must appear in the
100 very first column of the line.
101 </DL>
102 <P>For a list of the values that can appear in the
103 <VAR>field/group/section</VAR> field of a <B>show</B> instruction, see the
104 <B>afsmonitor</B> statistics appendix to the <I>IBM AFS Administration
105 Guide</I>.
106 <P><STRONG>Related Information</STRONG>
107 <P><A HREF="auarf059.htm#HDRAFSMONITOR">afsmonitor</A>
108 <P>
109 <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="auarf051.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="auarf053.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> 
110 <!-- Begin Footer Records  ========================================== -->
111 <P><HR><B> 
112 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
113 </B> 
114 <!-- End Footer Records  ============================================ -->
115 <A NAME="Bot_Of_Page"></A>
116 </BODY></HTML>