xstat_cm - Displays data collections from the Cache Manager


xstat_cm [initcmd] -cmname <cache manager name(s) to monitor>+ -collID <collection(s) to fetch>+ [-onceonly] [-frequency <poll frequency, in seconds>] [-period <data collection time, in minutes>] [-port <port number>] [-debug] [-format] [-help]


The xstat_cm command displays the data collections associated with the Cache Manager. The command executes in the foreground.

The command produces a large volume of output; to save it for later analysis, direct it to a file.



Accommodates the command's use of the AFS command parser, and is optional.

-cmname <cache manager name to monitor>+

Specifies the fully qualified hostname of each client machine for which to monitor the Cache Manager.

-collID <collection to fetch>+

Specifies each data collection to return, which defines the type and amount of data the command interpreter gathers about the Cache Manager. Data is returned in a predefined data structure.

There are three acceptable values:


Provides profiling information about the numbers of times different internal Cache Manager routines were called since the Cache Manager started.


Reports various internal performance statistics related to the Cache Manager (for example, statistics about how effectively the cache is being used and the quantity of intracell and intercell data access).


Reports all of the internal performance statistics provided by the 1 setting, plus some additional, detailed performance figures (for example, statistics about the number of RPCs sent by the Cache Manager and how long they take to complete, and statistics regarding authentication, access, and PAG information associated with data access).


Gathers statistics just one time. Omit this flag to have the command continue to probe the Cache Manager for statistics at the frequency specified by the -frequency argument; in this case press Ctrl-C to stop the probes.

-frequency <poll frequency>

Sets the frequency in seconds at which the program initiates probes to the Cache Manager. The default is 30 seconds.

-period <data collection time>

Sets the number of minutes the program runs; at the end of this period of time, the program exits. The default is 10 minutes.

-port <port number>

Specifies the port number to use to contact the Cache Manager. This can be used if the Cache Manager needs to be contacted with a port other than the default (7001), for instance when the default port was in use and the Cache Manager is using a dynamic port, or when NAT/PAT occurs between the caller and the target machine.


Displays a trace on the standard output stream as the command runs.


Generates tab separated formatted output.


Prints the online help for this command. All other valid options are ignored.




IBM Corporation 2000. All Rights Reserved.

This documentation is covered by the IBM Public License Version 1.0. It was converted from HTML to POD by software written by Chas Williams and Russ Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.


"AFS" is a registered mark of International Business Machines Corporation, used under license. (USPTO Registration 1598389)

"OpenAFS" is a registered mark of International Business Machines Corporation. (USPTO Registration 4577045)

The "AuriStor" name, log 'S' brand mark, and icon are registered marks of AuriStor, Inc. (USPTO Registrations 4849419, 4849421, and 4928460) (EUIPO Registration 015539653).

"Your File System" is a registered mark of AuriStor, Inc. (USPTO Registrations 4801402 and 4849418).

"YFS" and "AuriStor File System" are trademarks of AuriStor, Inc.