Initial IBM OpenAFS 1.0 tree
[openafs.git] / src / WINNT / doc / install / Documentation / en_US / html / CmdRef / auarf282.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3190/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 5 Nov 1999 at 13:58:29                -->
7 <META HTTP-EQUIV="updated" CONTENT="Fri, 05 Nov 1999 13:58:29">
8 <META HTTP-EQUIV="review" CONTENT="Sun, 05 Nov 2000 13:58:29">
9 <META HTTP-EQUIV="expires" CONTENT="Mon, 05 Nov 2001 13:58:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf281.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf283.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
17 <P>
18 <H2><A NAME="HDRXSTAT_CM_TEST" HREF="auarf002.htm#ToC_296">xstat_cm_test</A></H2>
19 <A NAME="IDX5869"></A>
20 <A NAME="IDX5870"></A>
21 <P><STRONG>Purpose</STRONG>
22 <P>Displays data collections from the Cache Manager
23 <P><STRONG>Synopsis</STRONG>
24 <PRE><B>xstat_cm_test</B> [<B>initcmd</B>] <B>-cmname</B> &lt;<VAR>Cache&nbsp;Manager&nbsp;name(s)&nbsp;to&nbsp;monitor</VAR>><SUP>+</SUP>
25               <B>-collID</B> &lt;<VAR>Collection(s)&nbsp;to&nbsp;fetch</VAR>><SUP>+</SUP>  [<B>-onceonly</B>]  
26               [<B>-frequency</B> &lt;<VAR>poll&nbsp;frequency,&nbsp;in&nbsp;seconds</VAR>>]  
27               [<B>-period</B> &lt;<VAR>data&nbsp;collection&nbsp;time,&nbsp;in&nbsp;minutes</VAR>>]  [<B>-debug</B>]  [<B>-help</B>]
28    
29 <B>xstat_cm_test</B> [<B>i</B>] <B>-cm</B> &lt;<VAR>Cache&nbsp;Manager&nbsp;name(s)&nbsp;to&nbsp;monitor</VAR>><SUP>+</SUP>
30               <B>-co</B> &lt;<VAR>Collection(s)&nbsp;to&nbsp;fetch</VAR>><SUP>+</SUP>  [<B>-o</B>]  
31               [<B>-f</B> &lt;<VAR>poll&nbsp;frequency,&nbsp;in&nbsp;seconds</VAR>>]  
32               [<B>-p</B> &lt;<VAR>data&nbsp;collection&nbsp;time,&nbsp;in&nbsp;minutes</VAR>>]  [<B>-d</B>]  [<B>-h</B>]
33 </PRE>
34 <P><STRONG>Description</STRONG>
35 <P>The <B>xstat_cm_test</B> command tests the routines in the
36 <B>libxstat_cm.a</B> library and displays the data collections
37 associated with the Cache Manager. The command executes in the
38 foreground.
39 <P>The command produces a large volume of output; to save it for later
40 analysis, direct it to a file.
41 <P><STRONG>Options</STRONG>
42 <DL>
43 <P><DT><B>initcmd
44 </B><DD>Accommodates the command&#39;s use of the AFS command parser, and is
45 optional.
46 <P><DT><B>-cmname
47 </B><DD>Specifies the fully qualified hostname of each client machine for which to
48 monitor the Cache Manager.
49 <P><DT><B>-collID
50 </B><DD>Specifies each data collection to return, which defines the type and
51 amount of data the command interpreter gathers about the Cache Manager.
52 Data is returned in a predefined data structure.
53 <P>There are three acceptable values&#58; 
54 <DL>
55 <P><DT><B>0
56 </B><DD>Provides profiling information about the numbers of times different
57 internal Cache Manager routines were called since the Cache Manager
58 started.
59 <P><DT><B>1
60 </B><DD>Reports various internal performance statistics related to the Cache
61 Manager (for example, statistics about how effectively the cache is being used
62 and the quantity of intracell and intercell data access).
63 <P><DT><B>2
64 </B><DD>Reports all of the internal performance statistics provided by the
65 <B>1</B> setting, plus some additional, detailed performance figures (for
66 example, statistics about the number of RPCs sent by the Cache Manager and how
67 long they take to complete, and statistics regarding authentication, access,
68 and PAG information associated with data access).
69 </DL>
70 <P><DT><B>-onceonly
71 </B><DD>Gathers statistics just one time. Omit this flag to have the
72 command continue to probe the Cache Manager for statistics at the frequency
73 specified by the <B>-frequency</B> argument; in this case press
74 &lt;<B>Ctrl-c</B>> to stop the probes.
75 <P><DT><B>-frequency
76 </B><DD>Sets the frequency in seconds at which the program initiates probes to the
77 Cache Manager. The default is 30 seconds.
78 <P><DT><B>-period
79 </B><DD>Sets the number of minutes the program runs; at the end of this
80 period of time, the program exits. The default is 10 minutes.
81 <P><DT><B>-debug
82 </B><DD>Displays a trace on the standard output stream as the command runs.
83 <P><DT><B>-help
84 </B><DD>Prints the online help for this command. All other valid options
85 are ignored.
86 </DL>
87 <P><STRONG>Related Information</STRONG>
88 <P><A HREF="auarf283.htm#HDRXSTAT_FS_TEST">xstat_fs_test</A>
89 <P>
90 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf281.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf283.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
91 <!-- Begin Footer Records  ========================================== -->
92 <P><HR><B> 
93 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
94 </B> 
95 <!-- End Footer Records  ============================================ -->
96 <A NAME="Bot_Of_Page"></A>
97 </BODY></HTML>