NAME

rxdebug - Provides debugging trace of Rx activity

SYNOPSIS

rxdebug -servers <server machine> [-port <IP port>] [-nodally] [-allconnections] [-rxstats] [-onlyserver] [-onlyclient] [-onlyport <show only port>] [-onlyhost <show only host>] [-onlyauth <show only auth level>] [-version] [-noconns] [-peers] [-long] [-help]

DESCRIPTION

Rx is the remote procedure call (RPC) protocol that is used for all communication between AFS and AuriStor File System client and server components. Each Rx connection has two parties, an initiator (or client) and an acceptor (or server), which are also referred to as Rx peers.

The rxdebug command collects status information on Rx connections, Rx statistics from the contacted Rx peer, statistics about peers of the contacted Rx peer.

OPTIONS

-rxpeer <Rx peer>

Specifies the Rx peer that is running the Cache Manager or service instance from which Rx status information or statistics should be collected. Provide a fully qualified hostname or an IP address.

-port <UDP port>

Specifies the UDP port from which to collect Rx status information and statistics. When this parameter is ommitted, UDP port 7000 will be used. The standard UDP port numbers used by AuriStor File System (and AFS) services are:

7000 for the File Server (fileserver process)
7001 for the Cache Manager (afsd process)
7002 for the Protection Server (ptserver process)
7003 for the Location Server (vlserver process)
7005 for the Volume Server (volserver process)
7007 for the BOS Server (bosserver process)
7008 for the Update Server (upserver process)
7009 for the Rx Performance Testing (rxperf process)
7021 for the Backup Server (buserver process)

-item 7025 and above for the Backup Tape Coordinator (butc process)

-nodally

Produces output only for connections that are not in dally mode.

-allconnections

Produces output for all connections, even inactive ones. By default, the output includes information only for connections that are active or in dally mode when the rxdebug command is issued.

-rxstats

Produces detailed statistics about Rx history and performance (for example, counts of the number of packets of various types the process has read and sent, calculations of average and minimum roundtrip time, and so on).

-onlyserver

Produces output only for connections in which the process designated by the -port argument is acting as the server.

-onlyclient

Produces output only for connections in which the process designated by the -port argument is acting as the client.

-onlyport <UDP port>

Produces output only for connections between the process designated by the -port argument and the specified port on any another Rx peer. Use the same port identifiers as for the -port argument.

-onlyhost <Rx peer>

Produces output only for connections between the process designated by the -port argument and any process on the specified Rx peer. To identify the Rx peer specify a fully qualified hostname or an IP address.

-onlyauth

Produces output only for connections that are using the specified authentication level. Provide one of the following values:

rxgk

Connections using any rxgk authentication level

auth

Connections at authentication level rxkad_auth

clear

Connections at authentication level rxkad_clear

crypt

Connections at authentication level rxkad_crypt

none

Unauthenticated connections (equivalents are null, noauth, and unauth)

The -onlyauth option does not currently permit filtering yfs-rxgk security class connections.

-version

Reports the version string returned by the Rx peer. Any other options combined with -version are ignored.

-noconns

Produces only the standard statistics that begin the output produced by every option (other than -version), without reporting on any connections. Any other options combined with this one are ignored.

-peers

Outputs information from the peer structure maintained for each port on another Rx peer to which the Rx peer designated by the -port argument has a connection. There is information about roundtrip time and numbers of packets sent and received, for example. The timeout value will always be zero for a AuriStor File System Rx peer.

-long

When combined with -peers, show more information about each peer. This includes information about the packet skew, congestion window, MTU, and allowable jumbogram size. The in/out packet skew values will always be zero for a AuriStor File System Rx peer.

-help

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

OUTPUT

If any options other than -version or -help are provided, the output written to the standard output stream begins with basic statistics about packet usage and availability, how many calls are waiting for a thread, how many threads are free, and so on (this is the only information provided by the -noconns flag). Adding other options produces additional information as described in "OPTIONS". The output is intended for debugging purposes and is meaningful to someone familiar with the implementation of the Rx protocol.

EXAMPLES

The following command shows Rx statistics on the server 192.168.1.100:

   % rxdebug  192.168.1.100
   Trying 192.168.1.100 (port 7000):
   Free packets: 265/1029, packet reclaims: 0, calls: 0, used FDs: 34
   not waiting for packets.
   0 calls waiting for a thread
   1 threads are idle
   0 calls have waited for a thread
   Done.

The following command shows the version string reported by the Rx peer on 192.168.1.100 port 7000:

   % rxdebug  192.168.1.100 -version
   Trying 192.168.1.100 (port 7000):
   Version:  AuriStor File System 1.0

PRIVILEGE REQUIRED

None.

SEE ALSO

afsd(8), bosserver(8), buserver(8), butc(8), fileserver(8), ptserver(8), rxperf(1), upclient(8), upserver(8), vlserver(8), volserver(8)

COPYRIGHT

IBM Corporation 2000. http://www.ibm.com/ 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.

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.