NAME

cmdebug - The Cache Manager Debugging Tool

SYNOPSIS

cmdebug -servers <machine> [-port <IP port>] [-long] [-refcounts] [-callbacks] [-ctime] [-addrs] [-cache] [-cellservdb] [-help]

DESCRIPTION

The cmdebug command displays information about a Cache Manager and its status on a local or remote client machine. By default, it displays all locked cache entries, but other information can be requested via various options.

OPTIONS

-servers <machine>

The name of the client machine for which to display Cache Manager status. Provide the machine's IP address in dotted decimal format, its fully qualified host name (for example, client.your-cell-name.com), or the shortest abbreviated form of its host name that distinguishes it from other machines. The name "localhost" can often be used to indicate the machine on which cmdebug is executed.

-port <IP port>

Identifies the port on which to contact the Cache Manager. By default cache managers listen on port 7001 and cmdebug will use port 7001 if an explicit port is not specifed.

-long

Report the status of all locks and all cache entries. If -long is not specified only held locks and locked cache entries are printed. This option cannot be combined with -refcounts, -callbacks, -addrs, -cache, or -cellservdb.

-refcounts

Report the status of cache entries with non-zero reference counts. this option cannot be combined with with -long, -callbacks, -addrs, or -cache.

-callbacks

Report the status of cache entries with registered callbacks. This option cannot be combined with -long, -refcounts, -addrs, or -cache.

-ctime

Print cache entry callback expiration times in human-readable format. When not specified callback expiration times are reported as the number of seconds since the UNIX epoch, 1 January 1970 00:00:00. This cache option cannot be combined with with -addrs or -cache.

-addrs

This option disables the querying of lock and cache entry status. Instead it displays the Cache Manager's universally unique identifier, the list of network interfaces the Cache Manager answers on including their netmasks and MTUs, and its Capabilities. This is useful for analyzing clients that are experiencing communication difficulties with cell services. This option cannot be combined with -long, -refcounts, -callbacks, or -cache.

-cache

This option disables the querying of lock and cache entry status. Instead it displays the cache configuration. The information displayed matches the afsd configuraiton. This option cannot be combined with -long, -refcounts, -callbacks, or -addrs.

-cellservdb

This option disables the querying of lock and cache entry status. Instead it displays all known location servers in a CellServDB-compatible format. This option can be used to see if a client has the most recent cellservdb information for a cell. This option cannot be combined with -long, -refcounts, -callbacks, or -cache.

-help

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

EXAMPLES

Displays all of the locked cache entries on client1.your-cell-name.com:

    % cmdebug client1.your-cell-name.com

Displays the cache configuration for client1.your-cell-name.com:

    % cmdebug client1.your-cell-name.com -cache

Displays all cache entries for client2.your-cell-name.com:

    % cmdebug client2.your-cell-name.com -long

PRIVILEGE REQUIRED

None

SEE ALSO

afsd(8), CellServDB(5), fs_newcell(1)

COPYRIGHT

Portions Copyright 2005 Russ Allbery <rra@stanford.edu>

This documentation is covered by the IBM Public License Version 1.0. This man page was written by Russ Allbery for OpenAFS.

ACKNOWLEDGEMENTS

"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.