doc/man-pages/pod1/rxdebug.pod

   1 =head1 NAME
   2
   3 rxdebug - Provides debugging trace of Rx activity
   4
   5 =head1 SYNOPSIS
   6
   7 B<rxdebug> B<-servers> <I<server machine>> [B<-port> <I<IP port>>]
   8     [B<-nodally>] [B<-allconnections>] [B<-rxstats>] [B<-onlyserver>]
   9     [B<-onlyclient>] [B<-onlyport> <I<show only port>>]
  10     [B<-onlyhost> <I<show only host>>]
  11     [B<-onlyauth> <I<show only auth level>>] [B<-version>]
  12     [B<-noconns>] [B<-peers>] [B<-help>]
  13
  14 B<rxdebug> B<-s> <I<server machine>> [B<-po> <I<IP port>>] [B<-nod>]
  15     [B<-a>] [B<-r>] [B<-onlys>] [B<-onlyc>] [B<-onlyp> <I<show only port>>]
  16     [B<-onlyh> <I<show only host>>] [-onlya <I<show only auth level>>]
  17     [B<-v>] [B<-noc>] [B<-pe>] [B<-h>]
  18
  19 =head1 DESCRIPTION
  20
  21 The B<rxdebug> command provides a trace of Rx activity for the server or
  22 client machine named by the B<-servers> argument. Rx is AFS's proprietary
  23 remote procedure call (RPC) protocol, so this command enables the issuer
  24 to check the status of communication between the Cache Manager or an AFS
  25 server process (as specified with the B<-port> argument) on the machine
  26 and one or more processes on other machines.
  27
  28 =head1 OPTIONS
  29
  30 =over 4
  31
  32 =item B<-servers> <I<server machine>>
  33
  34 Specifies the machine that is running the Cache Manager or server process
  35 for which to trace Rx activity. Provide the machine's IP address in dotted
  36 decimal format, its fully qualified host name (for example,
  37 C<fs1.abc.com>), or the shortest abbreviated form of its host name that
  38 distinguishes it from other machines. Successful use of an abbreviated
  39 form depends on the availability of a name resolution service (such as the
  40 Domain Name Service or a local host table) at the time the command is
  41 issued.
  42
  43 =item B<-port> <I<IP port>>
  44
  45 Specifies the process for which to trace Rx activity. Omit this argument
  46 to specify the File Server (B<fileserver> process), or provide one of the
  47 following values:
  48
  49 =over 4
  50
  51 =item C<7000> for the File Server (B<fileserver> process)
  52
  53 =item C<7001> for the Cache Manager (specifically, its callback interface)
  54
  55 =item C<7002> for the Protection Server (B<ptserver> process)
  56
  57 =item C<7003> for the Volume Location (VL) Server (B<vlserver> process)
  58
  59 =item C<7004> for the Authentication Server (B<kaserver> process)
  60
  61 =item C<7005> for the Volume Server (B<volserver> process)
  62
  63 =item C<7007> for the BOS Server (B<bosserver> process)
  64
  65 =item C<7008> for the Update Server (B<upserver> process)
  66
  67 =item C<7009> for the NFS/AFS Translator's B<rmtsysd> daemon
  68
  69 =item C<7021> for the Backup Server (B<buserver> process)
  70
  71 =back
  72
  73 Finally, specify C<7025> through C<65535> for the Backup Tape Coordinator
  74 (B<butc> process) that has the port offset number derived by subtracting
  75 7025 from this value.
  76
  77 =item B<-nodally>
  78
  79 Produces output only for connections that are not in dally mode.
  80
  81 =item B<-allconnections>
  82
  83 Produces output for all connections, even inactive ones. By default, the
  84 output includes information only for connections that are active or in
  85 dally mode when the B<rxdebug> command is issued.
  86
  87 =item B<-rxstats>
  88
  89 Produces detailed statistics about Rx history and performance (for
  90 example, counts of the number of packets of various types the process has
  91 read and sent, calculations of average and minimum roundtrip time, and so
  92 on).
  93
  94 =item B<-onlyserver>
  95
  96 Produces output only for connections in which the process designated by
  97 the B<-port> argument is acting as the server.
  98
  99 =item B<-onlyclient>
 100
 101 Produces output only for connections in which the process designated by
 102 the B<-port> argument is acting as the client.
 103
 104 =item B<-onlyport> <I<port>>
 105
 106 Produces output only for connections between the process designated by the
 107 B<-port> argument and the specified port on any another machine. Use the
 108 same port identifiers as for the B<-port> argument.
 109
 110 =item B<-onlyhost> <I<host>>
 111
 112 Produces output only for connections between the process designated by the
 113 B<-port> argument and any process on the specified machine. To identify
 114 the machine, use the same notation as for the B<-servers> argument.
 115
 116 =item B<-onlyauth>
 117
 118 Produces output only for connections that are using the specified
 119 authentication level. Provide one of the following values:
 120
 121 =over 4
 122
 123 =item auth
 124
 125 Cconnections at authentication level rxkad_auth
 126
 127 =item clear
 128
 129 Connections at authentication level rxkad_clear
 130
 131 =item crypt
 132
 133 Connections at authentication level rxkad_crypt
 134
 135 =item none
 136
 137 Unauthenticated connections (equivalents are C<null>, C<noauth>, and
 138 C<unauth>)
 139
 140 =back
 141
 142 =item B<-version>
 143
 144 Reports the AFS build level of the binary file for the process designated
 145 by the B<-port> argument (or of the kernel extensions file for port 7001,
 146 the Cache Manager's callback interface). Any other options combined with
 147 this one are ignored.
 148
 149 =item B<-noconns>
 150
 151 Produces only the standard statistics that begin the output produced by
 152 every option (other than B<-version>), without reporting on any
 153 connections. Any other options combined with this one are ignored.
 154
 155 =item B<-peers>
 156
 157 Outputs information from the I<peer structure> maintained for each port on
 158 another machine to which the process designated by the B<-port> argument
 159 has a connection. There is information about roundtrip time and numbers of
 160 packets sent and received, for example.
 161
 162 =item B<-help>
 163
 164 Prints the online help for this command. All other valid options are
 165 ignored.
 166
 167 =back
 168
 169 =head1 OUTPUT
 170
 171 If any options other than B<-version> or B<-help> are provided, the output
 172 written to the standard output stream begins with basic statistics about
 173 packet usage and availability, how many calls are waiting for a thread,
 174 how many threads are free, and so on (this is the only information
 175 provided by the B<-noconns> flag). Adding other options produces
 176 additional information as described in L<OPTIONS>. The output is intended
 177 for debugging purposes and is meaningful to someone familiar with the
 178 implementation of Rx.
 179
 180 =head1 PRIVILEGE REQUIRED
 181
 182 None.
 183
 184 =head1 SEE ALSO
 185
 186 L<afsd(8)>,
 187 L<bosserver(8)>,
 188 L<buserver(8)>,
 189 L<butc(8)>,
 190 L<fileserver(8)>,
 191 L<kaserver(8)>,
 192 L<ptserver(8)>,
 193 L<upclient(8)>,
 194 L<upserver(8)>,
 195 L<vlserver(8)>,
 196 L<volserver(8)>
 197
 198 =head1 COPYRIGHT
 199
 200 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 201
 202 This documentation is covered by the IBM Public License Version 1.0.  It was
 203 converted from HTML to POD by software written by Chas Williams and Russ
 204 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.