doc/xml/AdminReference/sect1/xstat_fs_test.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="xstat_fs_test1">
   3   <refmeta>
   4     <refentrytitle>xstat_fs_test</refentrytitle>
   5     <manvolnum>1</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>xstat_fs_test</refname>
   9     <refpurpose>Displays data collections from the File Server process</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">xstat_fs_test</emphasis> [<emphasis>initcmd</emphasis>] <emphasis role="bold">-fsname</emphasis> &lt;<emphasis>file server name(s) to monitor</emphasis>&gt;+
  14         <emphasis role="bold">-collID</emphasis> &lt;<emphasis>collection(s) to fetch</emphasis>&gt;+ [<emphasis role="bold">-onceonly</emphasis>]
  15         [<emphasis role="bold">-frequency</emphasis> &lt;<emphasis>poll frequency, in seconds</emphasis>&gt;]
  16         [<emphasis role="bold">-period</emphasis> &lt;<emphasis>data collection time, in minutes</emphasis>&gt;] [<emphasis role="bold">-debug</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
  17
  18     <para><emphasis role="bold">xstat_fs_test</emphasis> [<emphasis role="bold">initcmd</emphasis>] <emphasis role="bold">-fs</emphasis> &lt;<emphasis>File Server name(s) to monitor</emphasis>&gt;+
  19         <emphasis role="bold">-c</emphasis> &lt;<emphasis>Collection(s) to fetch</emphasis>&gt;+ [<emphasis role="bold">-o</emphasis>]
  20         [<emphasis role="bold">-fr</emphasis> &lt;<emphasis>poll frequency, in seconds</emphasis>&gt;]
  21         [<emphasis role="bold">-p</emphasis> &lt;<emphasis>data collection time, in minutes</emphasis>&gt;] [<emphasis role="bold">-d</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
  22
  23   </refsect1>
  24   <refsect1>
  25     <title>Description</title>
  26     <para>The <emphasis role="bold">xstat_fs_test</emphasis> command tests the routines in the <replaceable>libxstat_fs.a</replaceable>
  27     library and displays the data collections associated with the File Server
  28     (the <computeroutput>fs</computeroutput> process). The command executes in the foreground.</para>
  29
  30     <para>The command produces a large volume of output; to save it for later
  31     analysis, direct it to a file.</para>
  32
  33   </refsect1>
  34   <refsect1>
  35     <title>Options</title>
  36     <variablelist>
  37       <varlistentry>
  38         <term><emphasis>initcmd</emphasis></term>
  39         <listitem>
  40           <para>Accommodates the command's use of the AFS command parser, and is optional.</para>
  41
  42         </listitem>
  43       </varlistentry>
  44       <varlistentry>
  45         <term><emphasis role="bold">-fsname</emphasis> &lt;<emphasis>file server name to monitor</emphasis>&gt;+</term>
  46         <listitem>
  47           <para>Specifies the fully qualified hostname of each file server machine for
  48           which to monitor the File Server process.</para>
  49
  50         </listitem>
  51       </varlistentry>
  52       <varlistentry>
  53         <term><emphasis role="bold">-collID</emphasis> &lt;<emphasis>collection to fetch</emphasis>&gt;+</term>
  54         <listitem>
  55           <para>Specifies each data collection to return, which defines the type and
  56           amount of data the command interpreter gathers about the File Server.
  57           Data is returned in a predefined data structure.</para>
  58
  59           <para>There are three acceptable values:</para>
  60
  61           <variablelist>
  62             <varlistentry>
  63               <term>0</term>
  64               <listitem>
  65                 <para>Provides profiling information about the numbers of times different
  66                 internal File Server routines were called since the File Server
  67                 started. This value is not currently implemented; it returns no data.</para>
  68
  69               </listitem>
  70             </varlistentry>
  71             <varlistentry>
  72               <term>1</term>
  73               <listitem>
  74                 <para>Reports various internal performance statistics related to the File Server
  75                 (for example, vnode cache entries and Rx protocol activity).</para>
  76
  77               </listitem>
  78             </varlistentry>
  79             <varlistentry>
  80               <term>2</term>
  81               <listitem>
  82                 <para>Reports all of the internal performance statistics provided by the <computeroutput>1</computeroutput>
  83                 setting, plus some additional, detailed performance figures about the File
  84                 Server (for example, minimum, maximum, and cumulative statistics regarding
  85                 File Server RPCs, how long they take to complete, and how many succeed).</para>
  86
  87               </listitem>
  88             </varlistentry>
  89           </variablelist>
  90         </listitem>
  91       </varlistentry>
  92       <varlistentry>
  93         <term><emphasis role="bold">-onceonly</emphasis></term>
  94         <listitem>
  95           <para>Gathers statistics just one time. Omit this flag to have the command
  96           continue to probe the Cache Manager for statistics at the frequency
  97           specified by the <emphasis role="bold">-frequency</emphasis> argument; in this case press Ctrl-C to stop
  98           the probes.</para>
  99
 100         </listitem>
 101       </varlistentry>
 102       <varlistentry>
 103         <term><emphasis role="bold">-frequency</emphasis> &lt;<emphasis>poll frequency</emphasis>&gt;</term>
 104         <listitem>
 105           <para>Sets the frequency in seconds at which the program initiates probes to the
 106           Cache Manager. The default is 30 seconds.</para>
 107
 108         </listitem>
 109       </varlistentry>
 110       <varlistentry>
 111         <term><emphasis role="bold">-period</emphasis> &lt;<emphasis>data collection time</emphasis>&gt;</term>
 112         <listitem>
 113           <para>Sets the number of minutes the program runs; at the end of this period of
 114           time, the program exits. The default is 10 minutes.</para>
 115
 116         </listitem>
 117       </varlistentry>
 118       <varlistentry>
 119         <term><emphasis role="bold">-debug</emphasis></term>
 120         <listitem>
 121           <para>Displays a trace on the standard output stream as the command runs.</para>
 122
 123         </listitem>
 124       </varlistentry>
 125       <varlistentry>
 126         <term><emphasis role="bold">-help</emphasis></term>
 127         <listitem>
 128           <para>Prints the online help for this command. All other valid options are
 129           ignored.</para>
 130
 131         </listitem>
 132       </varlistentry>
 133     </variablelist>
 134   </refsect1>
 135   <refsect1>
 136     <title>See Also</title>
 137     <para><link linkend="xstat_cm_test1">xstat_cm_test(1)</link></para>
 138
 139   </refsect1>
 140   <refsect1>
 141     <title>Copyright</title>
 142     <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 143
 144     <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 145     converted from HTML to POD by software written by Chas Williams and Russ
 146     Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 147
 148   </refsect1>
 149 </refentry>