fix-fs-error-string-printing-20010623
[openafs.git] / doc / html / AdminReference / auarf231.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf230.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf232.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
17 <P>
18 <H2><A NAME="HDRRXDEBUG" HREF="auarf002.htm#ToC_245">rxdebug</A></H2>
19 <A NAME="IDX5440"></A>
20 <A NAME="IDX5441"></A>
21 <A NAME="IDX5442"></A>
22 <P><STRONG>Purpose</STRONG>
23 <P>Provides debugging trace of Rx activity
24 <P><STRONG>Synopsis</STRONG>
25 <PRE><B>rxdebug -servers</B> &lt;<VAR>server&nbsp;machine</VAR>>  [<B>-port</B> &lt;<VAR>IP&nbsp;port</VAR>>]  [<B>-nodally</B>]  
26         [<B>-allconnections</B>]  [<B>-rxstats</B>] [<B>-onlyserver</B>]  [<B>-onlyclient</B>]  
27         [<B>-onlyport</B> &lt;<VAR>show&nbsp;only&nbsp;&lt;port></VAR>>]  [<B>-onlyhost</B> &lt;<VAR>show&nbsp;only&nbsp;&lt;host></VAR>>]  
28         [<B>-onlyauth</B> &lt;<VAR>show&nbsp;only&nbsp;&lt;auth&nbsp;level></VAR>>]  [<B>-version</B>]  [<B>-noconns</B>]  
29         [<B>-peers</B>]  [<B>-help</B>] 
30    
31 <B>rxdebug -s</B> &lt;<VAR>server&nbsp;machine</VAR>>  [<B>-po</B> &lt;<VAR>IP&nbsp;port</VAR>>]  [<B>-nod</B>]  [<B>-a</B>]  [<B>-r</B>]  
32         [<B>-onlys</B>]  [<B>-onlyc</B>]   [<B>-onlyp</B> &lt;<VAR>show&nbsp;only&nbsp;&lt;port></VAR>>]  
33         [<B>-onlyh</B> &lt;<VAR>show&nbsp;only&nbsp;&lt;host></VAR>>]  [<B>-onlya</B> &lt;<VAR>show&nbsp;only&nbsp;&lt;auth&nbsp;level></VAR>>]  
34         [<B>-v</B>]  [<B>-noc</B>]  [<B>-pe</B>]  [<B>-h</B>] 
35 </PRE>
36 <P><STRONG>Description</STRONG>
37 <P>The <B>rxdebug</B> command provides a trace of Rx activity for the
38 server or client machine named by the <B>-servers</B> argument. Rx
39 is AFS's proprietary remote procedure call (RPC) protocol, so this
40 command enables the issuer to check the status of communication between the
41 Cache Manager or an AFS server process (as specified with the <B>-port</B>
42 argument) on the machine and one or more processes on other machines.
43 <P><STRONG>Options</STRONG>
44 <DL>
45 <P><DT><B>-servers
46 </B><DD>Specifies the machine that is running the Cache Manager or server process
47 for which to trace Rx activity. Provide the machine's IP address
48 in dotted decimal format, its fully qualified host name (for example,
49 <B>fs1.abc.com</B>), or the shortest abbreviated form of its
50 host name that distinguishes it from other machines. Successful use of
51 an abbreviated form depends on the availability of a name resolution service
52 (such as the Domain Name Service or a local host table) at the time the
53 command is issued.
54 <P><DT><B>-port
55 </B><DD>Specifies the process for which to trace Rx activity. Omit this
56 argument to specify the File Server (<B>fileserver</B> process), or
57 provide one of the following values:
58 <DL>
59 <DD><P><B>7000</B> for the File Server (<B>fileserver</B> process)
60 <DD><P><B>7001</B> for the Cache Manager (specifically, its callback
61 interface)
62 <DD><P><B>7002</B> for the Protection Server (<B>ptserver</B> process)
63 <DD><P><B>7003</B> for the Volume Location (VL) Server (<B>vlserver</B>
64 process)
65 <DD><P><B>7004</B> for the Authentication Server (<B>kaserver</B>
66 process)
67 <DD><P><B>7005</B> for the Volume Server (<B>volserver</B> process)
68 <DD><P><B>7007</B> for the BOS Server (<B>bosserver</B> process)
69 <DD><P><B>7008</B> for the Update Server (<B>upserver</B> process)
70 <DD><P><B>7009</B> for the NFS/AFS Translator's <B>rmtsysd</B>
71 daemon
72 <DD><P><B>7021</B> for the Backup Server (<B>buserver</B> process)
73 <DD><P><B>7025</B> through <B>65535</B> for the Backup Tape Coordinator
74 (<B>butc</B> process) that has the port offset number derived by
75 subtracting 7025 from this value
76 </DL>
77 <P><DT><B>-nodally
78 </B><DD>Produces output only for connections that are not in dally mode.
79 <P><DT><B>-allconnections
80 </B><DD>Produces output for all connections, even inactive ones. By
81 default, the output includes information only for connections that are active
82 or in dally mode when the <B>rxdebug</B> command is issued.
83 <P><DT><B>-rxstats
84 </B><DD>Produces detailed statistics about Rx history and performance (for
85 example, counts of the number of packets of various types the process has read
86 and sent, calculations of average and minimum roundtrip time, and so
87 on).
88 <P><DT><B>-onlyserver
89 </B><DD>Produces output only for connections in which the process designated by
90 the <B>-port</B> argument is acting as the server.
91 <P><DT><B>-onlyclient
92 </B><DD>Produces output only for connections in which the process designated by
93 the <B>-port</B> argument is acting as the client.
94 <P><DT><B>-onlyport
95 </B><DD>Produces output only for connections between the process designated by the
96 <B>-port</B> argument and the specified port on any another
97 machine. Use the same port identifiers as for the <B>-port</B>
98 argument.
99 <P><DT><B>-onlyhost
100 </B><DD>Produces output only for connections between the process designated by the
101 <B>-port</B> argument and any process on the specified machine. To
102 identify the machine, use the same notation as for the <B>-servers</B>
103 argument.
104 <P><DT><B>-onlyauth
105 </B><DD>Produces output only for connections that are using the specified
106 authentication level. Provide one of the following values:
107 <UL>
108 <P><LI><B>auth</B> for connections at authentication level
109 <B>rxkad_auth</B>
110 <P><LI><B>clear</B> for connections at authentication level
111 <B>rxkad_clear</B>
112 <P><LI><B>crypt</B> for connections at authentication level
113 <B>rxkad_crypt</B>
114 <P><LI><B>none</B> for unauthenticated connections (equivalents are
115 <B>null</B>, <B>noauth</B>, and <B>unauth</B>)
116 </UL>
117 <P><DT><B>-version
118 </B><DD>Reports the AFS build level of the binary file for the process designated
119 by the <B>-port</B> argument (or of the kernel extensions file for port
120 7001, the Cache Manager's callback interface). Any other options
121 combined with this one are ignored.
122 <P><DT><B>-noconns
123 </B><DD>Produces only the standard statistics that begin the output produced by
124 every option (other than <B>-version</B>), without reporting on any
125 connections. Any other options combined with this one are
126 ignored.
127 <P><DT><B>-peers
128 </B><DD>Outputs information from the <I>peer structure</I> maintained for each
129 port on another machine to which the process designated by the
130 <B>-port</B> argument has a connection. There is information about
131 roundtrip time and numbers of packets sent and received, for example.
132 <P><DT><B>-help
133 </B><DD>Prints the online help for this command. All other valid options
134 are ignored.
135 </DL>
136 <P><STRONG>Output</STRONG>
137 <P>If any options other than <B>-version</B> or <B>-help</B> are
138 provided, the output written to the standard output stream begins with basic
139 statistics about packet usage and availability, how many calls are waiting for
140 a thread, how many threads are free, and so on (this is the only information
141 provided by the <B>-noconns</B> flag). Adding other options
142 produces additional information as described in the preceding
143 <B>Options</B> section of this reference page. The output is
144 intended for debugging purposes and is meaningful to someone familiar with the
145 implementation of Rx.
146 <P><STRONG>Privilege Required</STRONG>
147 <P>None.
148 <P><STRONG>Related Information</STRONG>
149 <P><A HREF="auarf058.htm#HDRAFSD">afsd</A>
150 <P><A HREF="auarf124.htm#HDRBOSSERVER">bosserver</A>
151 <P><A HREF="auarf125.htm#HDRBUSERVER">buserver</A>
152 <P><A HREF="auarf126.htm#HDRBUTC">butc</A>
153 <P><A HREF="auarf129.htm#HDRFILESERVER">fileserver</A>
154 <P><A HREF="auarf198.htm#HDRKASERVER">kaserver</A>
155 <P><A HREF="auarf227.htm#HDRPTSERVER">ptserver</A>
156 <P><A HREF="auarf240.htm#HDRUPCLIENT">upclient</A>
157 <P><A HREF="auarf241.htm#HDRUPSERVER">upserver</A>
158 <P><A HREF="auarf249.htm#HDRVLSERVER">vlserver</A>
159 <P><A HREF="auarf251.htm#HDRVOLSERVER">volserver</A>
160 <P>
161 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf230.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf232.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
162 <!-- Begin Footer Records  ========================================== -->
163 <P><HR><B> 
164 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
165 </B> 
166 <!-- End Footer Records  ============================================ -->
167 <A NAME="Bot_Of_Page"></A>
168 </BODY></HTML>