.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "AFSMONITOR 5" .TH AFSMONITOR 5 "2023-12-24" "OpenAFS" "AFS File Reference" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" afsmonitor \- Provides instructions for the afsmonitor command .SH "DESCRIPTION" .IX Header "DESCRIPTION" The afsmonitor configuration file determines which machines the \&\fBafsmonitor\fR command probes for File Server or Cache Manager statistics and which statistics it gathers. Use the \fB\-config\fR argument to the \&\fBafsmonitor\fR command to identify the configuration file to use. .PP The instructions that can appear in the configuration file are as follows: .IP "cm <\fIhost name\fR>" 4 .IX Item "cm " Names a client machine for which to display Cache Manager statistics. The order of \f(CW\*(C`cm\*(C'\fR lines in the file determines the order in which client machines appear from top to bottom on the \f(CW\*(C`System Overview\*(C'\fR and \f(CW\*(C`Cache Managers\*(C'\fR output screens. .IP "fs <\fIhost name\fR>" 4 .IX Item "fs " Names a file server machine for which to display File Server statistics. The order of \f(CW\*(C`fs\*(C'\fR lines in the file determines the order in which file server machines appear from top to bottom on the \f(CW\*(C`System Overview\*(C'\fR and \f(CW\*(C`File Servers\*(C'\fR output screens. .IP "thresh (fs | cm) <\fIfield\fR> <\fIthresh\fR> [<\fIcmd\fR>] [<\fIarg\fR> ...]" 4 .IX Item "thresh (fs | cm) [] [ ...]" Assigns the threshold value \fIthresh\fR to the statistic \fIfield\fR, for either a File Server statistic (\f(CW\*(C`fs\*(C'\fR) or a Cache Manager statistic (\f(CW\*(C`cm\*(C'\fR). The optional \fIcmd\fR field names a binary or script to execute each time the value of the statistic changes from being below \fIthresh\fR to being at or above \fIthresh\fR. A change between two values that both exceed \&\fIthresh\fR does not retrigger the binary or script. The optional \fIarg\fR fields are additional values that the \fBafsmonitor\fR program passes as arguments to the \fIcmd\fR command. If any of them include one or more spaces, enclose the entire field in double quotes. .Sp The \fBafsmonitor\fR program passes the following parameters to the \fIcmd\fR: .Sp .Vb 1 \& (fs|cm) [ ...] .Ve .Sp The parameters \f(CW\*(C`fs\*(C'\fR, \f(CW\*(C`cm\*(C'\fR, , , and correspond to the values with the same name on the thresh line. The parameter identifies the file server or client machine where the statistic has crossed the threshold, and the parameter is the actual value of that exceeds the threshold value. .Sp Use the \f(CW\*(C`thresh\*(C'\fR line to set either a global threshold, which applies to all file server machines listed on \f(CW\*(C`fs\*(C'\fR lines or client machines listed on \f(CW\*(C`cm\*(C'\fR lines in the configuration file, or a machine-specific threshold, which applies to only one file server or client machine. .RS 4 .IP "\(bu" 4 To set a global threshold, place the thresh line before any of the \f(CW\*(C`fs\*(C'\fR or \f(CW\*(C`cm\*(C'\fR lines in the file. .IP "\(bu" 4 To set a machine-specific threshold, place the thresh line below the corresponding \f(CW\*(C`fs\*(C'\fR or \f(CW\*(C`cm\*(C'\fR line, and above any other \f(CW\*(C`fs\*(C'\fR or \f(CW\*(C`cm\*(C'\fR lines. A machine-specific threshold value always overrides the corresponding global threshold, if set. Do not place a \f(CW\*(C`thresh fs\*(C'\fR line directly after a \f(CW\*(C`cm\*(C'\fR line or a \f(CW\*(C`thresh cm\*(C'\fR line directly after a \f(CW\*(C`fs\*(C'\fR line. .RE .RS 4 .RE .IP "show (fs | cm) \fIfield/group/section\fR" 4 .IX Item "show (fs | cm) field/group/section" Specifies which individual statistic, group of statistics, or section of statistics to display on the \f(CW\*(C`File Servers\*(C'\fR screen (\f(CW\*(C`fs\*(C'\fR) or \f(CW\*(C`Cache Managers\*(C'\fR screen (\f(CW\*(C`cm\*(C'\fR) and the order in which to display them. The appendix of \fBafsmonitor\fR statistics in the \fIOpenAFS Administration Guide\fR specifies the group and section to which each statistic belongs. Include as many \f(CW\*(C`show\*(C'\fR lines as necessary to customize the screen display as desired, and place them anywhere in the file. The top-to-bottom order of the \f(CW\*(C`show\*(C'\fR lines in the configuration file determines the left-to-right order in which the statistics appear on the corresponding screen. .Sp If there are no \f(CW\*(C`show\*(C'\fR lines in the configuration file, then the screens display all statistics for both Cache Managers and File Servers. Similarly, if there are no \f(CW\*(C`show fs\*(C'\fR lines, the \f(CW\*(C`File Servers\*(C'\fR screen displays all file server statistics, and if there are no \f(CW\*(C`show cm\*(C'\fR lines, the \f(CW\*(C`Cache Managers\*(C'\fR screen displays all client statistics. .IP "# \fIcomments\fR" 4 .IX Item "# comments" Precedes a line of text that the afsmonitor program ignores because of the initial number (\f(CW\*(C`#\*(C'\fR) sign, which must appear in the very first column of the line. .IP "\fBversion\fR" 4 .IX Item "version" Print the OpenAFS command suite version and then exit. .PP For a list of the values that can appear in the \fIfield/group/section\fR field of a \f(CW\*(C`show\*(C'\fR instruction, see the \fBafsmonitor\fR statistics appendix to the \fIOpenAFS Administration Guide\fR. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBafsmonitor\fR\|(1) .SH "COPYRIGHT" .IX Header "COPYRIGHT" \&\s-1IBM\s0 Corporation 2000. All Rights Reserved. .PP This documentation is covered by the \s-1IBM\s0 Public License Version 1.0. It was converted from \s-1HTML\s0 to \s-1POD\s0 by software written by Chas Williams and Russ Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.