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