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 <b>afsmonitor</b> program passes the following parameters to the
  58 <var>cmd_to_execute</var>&#58;
  59 <p><dt><b><var>host_name</var> fs|cm <var>field_name</var>
  60 <var>threshold_val</var>
  61 <var>actual_val</var> [&lt;<var>arg</var><sub>1</sub>>]
  62 . . . [&lt;<var>arg</var><sub>n</sub>>]</b>
  63 <P>The parameters <B>fs</B>, <B>cm</B>, <VAR>field_name</VAR>,
  64 <VAR>threshold_val</VAR>, and <VAR>arg</VAR><SUB>1</SUB> through
  65 <VAR>arg</VAR><SUB>n</SUB> correspond to the values with the same name on the
  66 <B>thresh</B> line. The <VAR>host_name</VAR> parameter identifies the
  67 file server or client machine where the statistic has crossed the threshold,
  68 and the <VAR>actual_val</VAR> parameter is the actual value of
  69 <VAR>field_name</VAR> that exceeds the threshold value.
  70 <P>Use the <B>thresh</B> line to set either a global threshold, which
  71 applies to all file server machines listed on <B>fs</B> lines or client
  72 machines listed on <B>cm</B> lines in the configuration file, or a
  73 machine-specific threshold, which applies to only one file server or client
  74 machine.
  75 <UL>
  76 <P><LI>To set a global threshold, place the <B>thresh</B> line before any of
  77 the <B>fs</B> or <B>cm</B> lines in the file.
  78 <P><LI>To set a machine-specific threshold, place the <B>thresh</B> line
  79 below the corresponding <B>fs</B> or <B>cm</B> line, and above any
  80 other <B>fs</B> or <B>cm</B> lines. A machine-specific
  81 threshold value always overrides the corresponding global threshold, if
  82 set. Do not place a <B>thresh fs</B> line directly after a
  83 <B>cm</B> line or a <B>thresh cm</B> line directly after a
  84 <B>fs</B> line.
  85 </UL>
  86 <P><DT><B><TT>show  fs | cm  <VAR>field/group/section</VAR></TT>
  87 </B><DD>Specifies which individual statistic, group of statistics, or section of
  88 statistics to display on the <TT>File Servers</TT> screen (<B>fs</B>) or
  89 <TT>Cache Managers</TT> screen (<B>cm</B>) and the order in which to
  90 display them. The appendix of <B>afsmonitor</B> statistics in the
  91 <I>IBM AFS Administration Guide</I> specifies the group and section to
  92 which each statistic belongs. Include as many <B>show</B> lines as
  93 necessary to customize the screen display as desired, and place them anywhere
  94 in the file. The top-to-bottom order of the <B>show</B> lines in
  95 the configuration file determines the left-to-right order in which the
  96 statistics appear on the corresponding screen.
  97 <P>If there are no <B>show</B> lines in the configuration file, then the
  98 screens display all statistics for both Cache Managers and File
  99 Servers. Similarly, if there are no <B>show fs</B> lines, the
 100 <TT>File Servers</TT> screen displays all file server statistics, and if
 101 there are no <B>show cm</B> lines, the <TT>Cache Managers</TT> screen
 102 displays all client statistics.
 103 <P><DT><B># <VAR>comments</VAR>
 104 </B><DD>Precedes a line of text that the <B>afsmonitor</B> program ignores
 105 because of the initial number (<B>#</B>) sign, which must appear in the
 106 very first column of the line.
 107 </DL>
 108 <P>For a list of the values that can appear in the
 109 <VAR>field/group/section</VAR> field of a <B>show</B> instruction, see the
 110 <B>afsmonitor</B> statistics appendix to the <I>IBM AFS Administration
 111 Guide</I>.
 112 <P><STRONG>Related Information</STRONG>
 113 <P><A HREF="auarf059.htm#HDRAFSMONITOR">afsmonitor</A>
 114 <P>
 115 <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>
 116 <!-- Begin Footer Records  ========================================== -->
 117 <P><HR><B>
 118 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved
 119 </B>
 120 <!-- End Footer Records  ============================================ -->
 121 <A NAME="Bot_Of_Page"></A>
 122 </BODY></HTML>