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