2005-12-08 12:14:33 +00:00
|
|
|
=head1 NAME
|
|
|
|
|
|
|
|
rxdebug - Provides debugging trace of Rx activity
|
|
|
|
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
|
2006-03-01 05:02:29 +00:00
|
|
|
=for html
|
|
|
|
<div class="synopsis">
|
|
|
|
|
|
|
|
B<rxdebug> S<<< B<-servers> <I<server machine>> >>> S<<< [B<-port> <I<IP port>>] >>>
|
2005-12-09 14:48:56 +00:00
|
|
|
[B<-nodally>] [B<-allconnections>] [B<-rxstats>] [B<-onlyserver>]
|
2006-03-01 05:02:29 +00:00
|
|
|
[B<-onlyclient>] S<<< [B<-onlyport> <I<show only port>>] >>>
|
|
|
|
S<<< [B<-onlyhost> <I<show only host>>] >>>
|
|
|
|
S<<< [B<-onlyauth> <I<show only auth level>>] >>> [B<-version>]
|
2013-07-27 03:00:14 +01:00
|
|
|
[B<-noconns>] [B<-peers>] [B<-long>] [B<-help>]
|
2005-12-09 14:48:56 +00:00
|
|
|
|
2006-03-01 05:02:29 +00:00
|
|
|
B<rxdebug> S<<< B<-s> <I<server machine>> >>> S<<< [B<-po> <I<IP port>>] >>> [B<-nod>]
|
|
|
|
[B<-a>] [B<-r>] [B<-onlys>] [B<-onlyc>] S<<< [B<-onlyp> <I<show only port>>] >>>
|
2006-08-04 05:55:39 +01:00
|
|
|
S<<< [B<-onlyh> <I<show only host>>] >>> S<<< [B<-onlya> <I<show only auth level>>] >>>
|
2013-07-27 03:00:14 +01:00
|
|
|
[B<-v>] [B<-noc>] [B<-pe>] [B<-l>] [B<-h>]
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2006-03-01 05:02:29 +00:00
|
|
|
=for html
|
|
|
|
</div>
|
|
|
|
|
2005-12-08 12:14:33 +00:00
|
|
|
=head1 DESCRIPTION
|
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
The B<rxdebug> command provides a trace of Rx activity for the server or
|
|
|
|
client machine named by the B<-servers> argument. Rx is AFS's proprietary
|
|
|
|
remote procedure call (RPC) protocol, so this command enables the issuer
|
|
|
|
to check the status of communication between the Cache Manager or an AFS
|
|
|
|
server process (as specified with the B<-port> argument) on the machine
|
|
|
|
and one or more processes on other machines.
|
2005-12-08 12:14:33 +00:00
|
|
|
|
|
|
|
=head1 OPTIONS
|
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item B<-servers> <I<server machine>>
|
2005-12-08 12:14:33 +00:00
|
|
|
|
|
|
|
Specifies the machine that is running the Cache Manager or server process
|
2005-12-09 14:48:56 +00:00
|
|
|
for which to trace Rx activity. Provide the machine's IP address in dotted
|
|
|
|
decimal format, its fully qualified host name (for example,
|
doc: replace hostnames with IETF example hostnames
There were several different real and made-up hostnames and company names used
throughout our documentation examples.
The IETF has reserved "example.com" and other "example" TLDs for use in
examples (RFC 2606). Replace almost all references to ABC Corporation, DEF
Corporation, and State University, as well as "abc.com", "bigcell.com",
"def.com", "def.gov", "ghi.com", "ghi.gov", "jkl.com", "mit.edu",
"stanford.edu", "state.edu", "stateu.edu", "uncc.edu", and "xyz.com".
Standardize on "Example Corporation", "Example Network", "Example
Organization" (example.com, example.net, and example.org).
The Scout documentation in the Admin Guide contains PNG images that contain
the old cell names, so I left those references until the images can be
replaced.
Change-Id: I4e44815b2d2ffe204810b7fd850842248f67c367
Reviewed-on: http://gerrit.openafs.org/6697
Reviewed-by: Jeffrey Altman <jaltman@secure-endpoints.com>
Tested-by: Jeffrey Altman <jaltman@secure-endpoints.com>
2012-02-11 16:43:30 +00:00
|
|
|
C<fs1.example.com>), or the shortest abbreviated form of its host name that
|
2005-12-09 14:48:56 +00:00
|
|
|
distinguishes it from other machines. Successful use of an abbreviated
|
|
|
|
form depends on the availability of a name resolution service (such as the
|
|
|
|
Domain Name Service or a local host table) at the time the command is
|
|
|
|
issued.
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item B<-port> <I<IP port>>
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
Specifies the process for which to trace Rx activity. Omit this argument
|
|
|
|
to specify the File Server (B<fileserver> process), or provide one of the
|
|
|
|
following values:
|
2005-12-08 12:14:33 +00:00
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item C<7000> for the File Server (B<fileserver> process)
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item C<7001> for the Cache Manager (specifically, its callback interface)
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item C<7002> for the Protection Server (B<ptserver> process)
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item C<7003> for the Volume Location (VL) Server (B<vlserver> process)
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item C<7004> for the Authentication Server (B<kaserver> process)
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item C<7005> for the Volume Server (B<volserver> process)
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item C<7007> for the BOS Server (B<bosserver> process)
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item C<7008> for the Update Server (B<upserver> process)
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item C<7009> for the NFS/AFS Translator's B<rmtsysd> daemon
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item C<7021> for the Backup Server (B<buserver> process)
|
2005-12-08 12:14:33 +00:00
|
|
|
|
|
|
|
=back
|
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
Finally, specify C<7025> through C<65535> for the Backup Tape Coordinator
|
|
|
|
(B<butc> process) that has the port offset number derived by subtracting
|
|
|
|
7025 from this value.
|
|
|
|
|
|
|
|
=item B<-nodally>
|
2005-12-08 12:14:33 +00:00
|
|
|
|
|
|
|
Produces output only for connections that are not in dally mode.
|
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item B<-allconnections>
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
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 B<rxdebug> command is issued.
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item B<-rxstats>
|
2005-12-08 12:14:33 +00:00
|
|
|
|
|
|
|
Produces detailed statistics about Rx history and performance (for
|
2005-12-09 14:48:56 +00:00
|
|
|
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
|
2005-12-08 12:14:33 +00:00
|
|
|
on).
|
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item B<-onlyserver>
|
2005-12-08 12:14:33 +00:00
|
|
|
|
|
|
|
Produces output only for connections in which the process designated by
|
|
|
|
the B<-port> argument is acting as the server.
|
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item B<-onlyclient>
|
2005-12-08 12:14:33 +00:00
|
|
|
|
|
|
|
Produces output only for connections in which the process designated by
|
|
|
|
the B<-port> argument is acting as the client.
|
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item B<-onlyport> <I<port>>
|
2005-12-08 12:14:33 +00:00
|
|
|
|
|
|
|
Produces output only for connections between the process designated by the
|
2005-12-09 14:48:56 +00:00
|
|
|
B<-port> argument and the specified port on any another machine. Use the
|
|
|
|
same port identifiers as for the B<-port> argument.
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item B<-onlyhost> <I<host>>
|
2005-12-08 12:14:33 +00:00
|
|
|
|
|
|
|
Produces output only for connections between the process designated by the
|
2005-12-09 14:48:56 +00:00
|
|
|
B<-port> argument and any process on the specified machine. To identify
|
|
|
|
the machine, use the same notation as for the B<-servers> argument.
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item B<-onlyauth>
|
2005-12-08 12:14:33 +00:00
|
|
|
|
|
|
|
Produces output only for connections that are using the specified
|
|
|
|
authentication level. Provide one of the following values:
|
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item auth
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2011-02-03 20:22:02 +00:00
|
|
|
Connections at authentication level rxkad_auth
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item clear
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
Connections at authentication level rxkad_clear
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item crypt
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
Connections at authentication level rxkad_crypt
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item none
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
Unauthenticated connections (equivalents are C<null>, C<noauth>, and
|
|
|
|
C<unauth>)
|
2005-12-08 12:14:33 +00:00
|
|
|
|
|
|
|
=back
|
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item B<-version>
|
2005-12-08 12:14:33 +00:00
|
|
|
|
|
|
|
Reports the AFS build level of the binary file for the process designated
|
2005-12-09 14:48:56 +00:00
|
|
|
by the B<-port> argument (or of the kernel extensions file for port 7001,
|
|
|
|
the Cache Manager's callback interface). Any other options combined with
|
|
|
|
this one are ignored.
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item B<-noconns>
|
2005-12-08 12:14:33 +00:00
|
|
|
|
|
|
|
Produces only the standard statistics that begin the output produced by
|
|
|
|
every option (other than B<-version>), without reporting on any
|
2005-12-09 14:48:56 +00:00
|
|
|
connections. Any other options combined with this one are ignored.
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item B<-peers>
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
Outputs information from the I<peer structure> maintained for each port on
|
|
|
|
another machine to which the process designated by the B<-port> argument
|
|
|
|
has a connection. There is information about roundtrip time and numbers of
|
|
|
|
packets sent and received, for example.
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2013-07-27 03:00:14 +01:00
|
|
|
=item B<-long>
|
|
|
|
|
|
|
|
When combined with B<-peers>, show more information about each peer. This
|
|
|
|
includes information about the packet skew, congestion window, MTU, and
|
|
|
|
allowable jumbogram size.
|
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
=item B<-help>
|
2005-12-08 12:14:33 +00:00
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
Prints the online help for this command. All other valid options are
|
|
|
|
ignored.
|
2005-12-08 12:14:33 +00:00
|
|
|
|
|
|
|
=back
|
|
|
|
|
|
|
|
=head1 OUTPUT
|
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
If any options other than B<-version> or B<-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 B<-noconns> flag). Adding other options produces
|
2011-06-10 02:14:05 +01:00
|
|
|
additional information as described in L</OPTIONS>. The output is intended
|
2005-12-09 14:48:56 +00:00
|
|
|
for debugging purposes and is meaningful to someone familiar with the
|
2005-12-08 12:14:33 +00:00
|
|
|
implementation of Rx.
|
|
|
|
|
2007-12-25 22:15:07 +00:00
|
|
|
=head1 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, packet reclaims: 0, calls: 0, used FDs: 34
|
|
|
|
not waiting for packets.
|
|
|
|
0 calls waiting for a thread
|
|
|
|
11 threads are idle
|
|
|
|
Done.
|
|
|
|
|
|
|
|
The following command shows the OpenAFS version running on the server
|
|
|
|
192.168.1.100:
|
|
|
|
|
|
|
|
% rxdebug 192.168.1.100 -version
|
|
|
|
Trying 192.168.1.100 (port 7000):
|
|
|
|
AFS version: OpenAFS 1.4.2fc2 built 2006-08-31
|
|
|
|
|
2005-12-08 12:14:33 +00:00
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
|
|
|
|
None.
|
|
|
|
|
|
|
|
=head1 SEE ALSO
|
|
|
|
|
2005-12-09 14:48:56 +00:00
|
|
|
L<afsd(8)>,
|
|
|
|
L<bosserver(8)>,
|
|
|
|
L<buserver(8)>,
|
|
|
|
L<butc(8)>,
|
|
|
|
L<fileserver(8)>,
|
|
|
|
L<kaserver(8)>,
|
|
|
|
L<ptserver(8)>,
|
|
|
|
L<upclient(8)>,
|
|
|
|
L<upserver(8)>,
|
|
|
|
L<vlserver(8)>,
|
|
|
|
L<volserver(8)>
|
2005-12-08 12:14:33 +00:00
|
|
|
|
|
|
|
=head1 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.
|