# Administration Reference

## afsmonitor Configuration File

Purpose

Provides instructions for the afsmonitor command

Description

The afsmonitor configuration file determines which machines the afsmonitor command probes for File Server or Cache Manager statistics and which statistics it gathers. Use the -config argument to the afsmonitor command to identify the configuration file to use.

The instructions that can appear in the configuration file are as follows:

`cm host_name`
  Names a client machine for which to display Cache Manager statistics. The order of cm lines in the file determines the order in which client machines appear from top to bottom on the `System Overview` and `Cache Managers` output screens.

`fs host_name`
  Names a file server machine for which to display File Server statistics. The order of fs lines in the file determines the order in which file server machines appear from top to bottom on the `System Overview` and `File Servers` output screens.

`thresh fs | cm field_name thresh_val [cmd_to_run] [arg1] . . . [argn]`
  Assigns the threshold value thresh_val to the statistic field_name, for either a File Server statistic (fs) or a Cache Manager statistic (cm). The optional cmd_to_execute field names a binary or script to execute each time the value of the statistic changes from being below thresh_val to being at or above thresh_val. A change between two values that both exceed thresh_val does not retrigger the binary or script. The optional arg1 through argn fields are additional values that the afsmonitor program passes as arguments to the cmd_to_execute command. If any of them include one or more spaces, enclose the entire field in double quotes.

  The parameters fs, cm, field_name, threshold_val, and arg1 through argn correspond to the values with the same name on the thresh line. The host_name parameter identifies the file server or client machine where the statistic has crossed the threshold, and the actual_val parameter is the actual value of field_name that equals or exceeds the threshold value.

  Use the thresh line to set either a global threshold, which applies to all file server machines listed on fs lines or client machines listed on cm lines in the configuration file, or a machine-specific threshold, which applies to only one file server or client machine.

  - To set a global threshold, place the thresh line before any of the fs or cm lines in the file.

  - To set a machine-specific threshold, place the thresh line below the corresponding fs or cm line, and above any other fs or cm lines. A machine-specific threshold value always overrides the corresponding global threshold, if set. Do not place a thresh fs line directly after a cm line or a thresh cm line directly after a fs line.

`show fs | cm field/group/section`
  Specifies which individual statistic, group of statistics, or section of statistics to display on the `File Servers` screen (fs) or `Cache Managers` screen (cm) and the order in which to display them. The appendix of afsmonitor statistics in the AFS Administration Guide specifies the group and section to which each statistic belongs. Include as many show lines as necessary to customize the screen display as desired, and place them anywhere in the file. The top-to-bottom order of the show lines in the configuration file determines the left-to-right order in which the statistics appear on the corresponding screen.

  If there are no show lines in the configuration file, then the screens display all statistics for both Cache Managers and File Servers. Similarly, if there are no show fs lines, the `File Servers` screen displays all file server statistics, and if there are no show cm lines, the `Cache Managers` screen displays all client statistics.

# comments
  Precedes a line of text that the afsmonitor program ignores because of the initial number (#) sign, which must appear in the very first column of the line.

For a list of the values that can appear in the field/group/section field of a show instruction, see the afsmonitor statistics appendix to the AFS Administration Guide.

Related Information

afsmonitor

© IBM Corporation 2000. All Rights Reserved