[hcoop/debian/openafs.git] / doc / man-pages / pod5 / afsmonitor.pod

=head1 NAME

afsmonitor - Provides instructions for the afsmonitor command

=head1 DESCRIPTION

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

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

=over 4

=item cm <I<host name>>

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

=item fs <I<host name>>

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

=item thresh (fs | cm) <I<field>> <I<thresh>> [<I<cmd>>] [<I<arg>> ...]

Assigns the threshold value I<thresh> to the statistic I<field>, for
either a File Server statistic (C<fs>) or a Cache Manager statistic
(C<cm>). The optional I<cmd> field names a binary or script to execute
each time the value of the statistic changes from being below I<thresh> to
being at or above I<thresh>. A change between two values that both exceed
I<thresh> does not retrigger the binary or script. The optional I<arg>
fields are additional values that the B<afsmonitor> program passes as
arguments to the I<cmd> command. If any of them include one or more
spaces, enclose the entire field in double quotes.

The B<afsmonitor> program passes the following parameters to the I<cmd>:

    <hostname> (fs|cm) <field> <thresh> <actual> [<arg> ...]

The parameters C<fs>, C<cm>, <field>, <thresh>, and <arg> correspond to
the values with the same name on the thresh line. The <hostname> parameter
identifies the file server or client machine where the statistic has
crossed the threshold, and the <actual> parameter is the actual value of
<field> that exceeds the threshold value.

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

=over 4

=item *

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

=item *

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

=back

=item show (fs | cm) I<field/group/section>

Specifies which individual statistic, group of statistics, or section of
statistics to display on the C<File Servers> screen (C<fs>) or C<Cache
Managers> screen (C<cm>) and the order in which to display them. The
appendix of B<afsmonitor> statistics in the I<OpenAFS Administration
Guide> specifies the group and section to which each statistic
belongs. Include as many C<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 C<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 C<show> lines in the configuration file, then the screens
display all statistics for both Cache Managers and File
Servers. Similarly, if there are no C<show fs> lines, the C<File Servers>
screen displays all file server statistics, and if there are no C<show cm>
lines, the C<Cache Managers> screen displays all client statistics.

=item # I<comments>

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

=item B<version>

Print the OpenAFS command suite version and then exit.

=back

For a list of the values that can appear in the I<field/group/section>
field of a C<show> instruction, see the B<afsmonitor> statistics appendix
to the I<OpenAFS Administration Guide>.

=head1 SEE ALSO

L<afsmonitor(1)>

=head1 COPYRIGHT

IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.

This documentation is covered by the IBM Public License Version 1.0.  It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.
Commit	Line	Data
805e021f CE	1	=head1 NAME
	2
	3	afsmonitor - Provides instructions for the afsmonitor command
	4
	5	=head1 DESCRIPTION
	6
	7	The afsmonitor configuration file determines which machines the
	8	B<afsmonitor> command probes for File Server or Cache Manager statistics
	9	and which statistics it gathers. Use the B<-config> argument to the
	10	B<afsmonitor> command to identify the configuration file to use.
	11
	12	The instructions that can appear in the configuration file are as follows:
	13
	14	=over 4
	15
	16	=item cm <I<host name>>
	17
	18	Names a client machine for which to display Cache Manager statistics. The
	19	order of C<cm> lines in the file determines the order in which client
	20	machines appear from top to bottom on the C<System Overview> and C<Cache
	21	Managers> output screens.
	22
	23	=item fs <I<host name>>
	24
	25	Names a file server machine for which to display File Server
	26	statistics. The order of C<fs> lines in the file determines the order in
	27	which file server machines appear from top to bottom on the C<System
	28	Overview> and C<File Servers> output screens.
	29
	30	=item thresh (fs \| cm) <I<field>> <I<thresh>> [<I<cmd>>] [<I<arg>> ...]
	31
	32	Assigns the threshold value I<thresh> to the statistic I<field>, for
	33	either a File Server statistic (C<fs>) or a Cache Manager statistic
	34	(C<cm>). The optional I<cmd> field names a binary or script to execute
	35	each time the value of the statistic changes from being below I<thresh> to
	36	being at or above I<thresh>. A change between two values that both exceed
	37	I<thresh> does not retrigger the binary or script. The optional I<arg>
	38	fields are additional values that the B<afsmonitor> program passes as
	39	arguments to the I<cmd> command. If any of them include one or more
	40	spaces, enclose the entire field in double quotes.
	41
	42	The B<afsmonitor> program passes the following parameters to the I<cmd>:
	43
	44	<hostname> (fs\|cm) <field> <thresh> <actual> [<arg> ...]
	45
	46	The parameters C<fs>, C<cm>, <field>, <thresh>, and <arg> correspond to
	47	the values with the same name on the thresh line. The <hostname> parameter
	48	identifies the file server or client machine where the statistic has
	49	crossed the threshold, and the <actual> parameter is the actual value of
	50	<field> that exceeds the threshold value.
	51
	52	Use the C<thresh> line to set either a global threshold, which applies to
	53	all file server machines listed on C<fs> lines or client machines listed
	54	on C<cm> lines in the configuration file, or a machine-specific threshold,
	55	which applies to only one file server or client machine.
	56
	57	=over 4
	58
	59	=item *
	60
	61	To set a global threshold, place the thresh line before any of the C<fs>
	62	or C<cm> lines in the file.
	63
	64	=item *
65
66	To set a machine-specific threshold, place the thresh line below the
67	corresponding C<fs> or C<cm> line, and above any other C<fs> or C<cm>
68	lines. A machine-specific threshold value always overrides the
69	corresponding global threshold, if set. Do not place a C<thresh fs> line
70	directly after a C<cm> line or a C<thresh cm> line directly after a C<fs>
71	line.
72
73	=back
74
75	=item show (fs \| cm) I<field/group/section>
76
77	Specifies which individual statistic, group of statistics, or section of
78	statistics to display on the C<File Servers> screen (C<fs>) or C<Cache
79	Managers> screen (C<cm>) and the order in which to display them. The
80	appendix of B<afsmonitor> statistics in the I<OpenAFS Administration
81	Guide> specifies the group and section to which each statistic
82	belongs. Include as many C<show> lines as necessary to customize the
83	screen display as desired, and place them anywhere in the file. The
84	top-to-bottom order of the C<show> lines in the configuration file
85	determines the left-to-right order in which the statistics appear on the
86	corresponding screen.
87
88	If there are no C<show> lines in the configuration file, then the screens
89	display all statistics for both Cache Managers and File
90	Servers. Similarly, if there are no C<show fs> lines, the C<File Servers>
91	screen displays all file server statistics, and if there are no C<show cm>
92	lines, the C<Cache Managers> screen displays all client statistics.
93
94	=item # I<comments>
95
96	Precedes a line of text that the afsmonitor program ignores because of the
97	initial number (C<#>) sign, which must appear in the very first column of
98	the line.
99
100	=item B<version>
101
102	Print the OpenAFS command suite version and then exit.
103
104	=back
105
106	For a list of the values that can appear in the I<field/group/section>
107	field of a C<show> instruction, see the B<afsmonitor> statistics appendix
108	to the I<OpenAFS Administration Guide>.
109
110	=head1 SEE ALSO
111
112	L<afsmonitor(1)>
113
114	=head1 COPYRIGHT
115
116	IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
117
118	This documentation is covered by the IBM Public License Version 1.0. It was
119	converted from HTML to POD by software written by Chas Williams and Russ
120	Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.