59431333a72528b82bed2ad90e42b7c9e6e8c600
[openafs.git] / doc / man-pages / pod1 / xstat_cm_test.pod
1 =head1 NAME
2
3 xstat_cm_test - Displays data collections from the Cache Manager
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<xstat_cm_test> [I<initcmd>]
11     S<<< B<-cmname> <I<cache manager name(s) to monitor>>+ >>>
12     S<<< B<-collID> <I<collection(s) to fetch>>+ >>> [B<-onceonly>]
13     S<<< [B<-frequency> <I<poll frequency, in seconds>>] >>>
14     S<<< [B<-period> <I<data collection time, in minutes>>] >>> [B<-debug>]
15     [B<-help>]
16
17 B<xstat_cm_test> [I<i>] S<<< B<-cm> <I<cache manager name(s) to monitor>>+ >>>
18     S<<< B<-co> <I<collection(s) to fetch>>+ >>> [B<-o>]
19     S<<< [B<-f> <I<poll frequency, in seconds>>] >>>
20     S<<< [B<-p> <I<data collection time, in minutes>>] >>> [B<-d>] [B<-h>]
21
22 =for html
23 </div>
24
25 =head1 DESCRIPTION
26
27 The B<xstat_cm_test> command tests the routines in the F<libxstat_cm.a>
28 library and displays the data collections associated with the Cache
29 Manager. The command executes in the foreground.
30
31 The command produces a large volume of output; to save it for later
32 analysis, direct it to a file.
33
34 =head1 OPTIONS
35
36 =over 4
37
38 =item I<initcmd>
39
40 Accommodates the command's use of the AFS command parser, and is optional.
41
42 =item B<-cmname> <I<cache manager name to monitor>>+
43
44 Specifies the fully qualified hostname of each client machine for which to
45 monitor the Cache Manager.
46
47 =item B<-collID> <I<collection to fetch>>+
48
49 Specifies each data collection to return, which defines the type and
50 amount of data the command interpreter gathers about the Cache Manager.
51 Data is returned in a predefined data structure.
52
53 There are three acceptable values:
54
55 =over 4
56
57 =item 0
58
59 Provides profiling information about the numbers of times different
60 internal Cache Manager routines were called since the Cache Manager
61 started.
62
63 =item 1
64
65 Reports various internal performance statistics related to the Cache
66 Manager (for example, statistics about how effectively the cache is being
67 used and the quantity of intracell and intercell data access).
68
69 =item 2
70
71 Reports all of the internal performance statistics provided by the C<1>
72 setting, plus some additional, detailed performance figures (for example,
73 statistics about the number of RPCs sent by the Cache Manager and how long
74 they take to complete, and statistics regarding authentication, access,
75 and PAG information associated with data access).
76
77 =back
78
79 =item B<-onceonly>
80
81 Gathers statistics just one time. Omit this flag to have the command
82 continue to probe the Cache Manager for statistics at the frequency
83 specified by the B<-frequency> argument; in this case press Ctrl-C to stop
84 the probes.
85
86 =item B<-frequency> <I<poll frequency>>
87
88 Sets the frequency in seconds at which the program initiates probes to the
89 Cache Manager. The default is 30 seconds.
90
91 =item B<-period> <I<data collection time>>
92
93 Sets the number of minutes the program runs; at the end of this period of
94 time, the program exits. The default is 10 minutes.
95
96 =item B<-debug>
97
98 Displays a trace on the standard output stream as the command runs.
99
100 =item B<-help>
101
102 Prints the online help for this command. All other valid options are
103 ignored.
104
105 =back
106
107 =head1 SEE ALSO
108
109 L<xstat_fs_test(1)>
110
111 =head1 COPYRIGHT
112
113 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
114
115 This documentation is covered by the IBM Public License Version 1.0.  It was
116 converted from HTML to POD by software written by Chas Williams and Russ
117 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.