kaauxdb-fix-silly-comment-substitution-20010711
[openafs.git] / doc / html / AdminReference / auarf133.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="auarf132.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="auarf134.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="HDRFS_CHECKSERVERS" HREF="auarf002.htm#ToC_147">fs checkservers</A></H2>
19 <A NAME="IDX4728"></A>
20 <A NAME="IDX4729"></A>
21 <A NAME="IDX4730"></A>
22 <A NAME="IDX4731"></A>
23 <A NAME="IDX4732"></A>
24 <A NAME="IDX4733"></A>
25 <A NAME="IDX4734"></A>
26 <A NAME="IDX4735"></A>
27 <P><STRONG>Purpose</STRONG>
28 <P>Displays the status of server machines
29 <P><STRONG>Synopsis</STRONG>
30 <PRE><B>fs checkservers</B> [<B>-cell</B> &lt;<VAR>cell&nbsp;to&nbsp;check</VAR>>]  [<B>-all</B>]  [<B>-fast</B>]  
31                 [<B>-interval</B> &lt;<VAR>seconds&nbsp;between&nbsp;probes</VAR>>]  [<B>-help</B>]
32    
33 <B>fs checks</B> [<B>-c</B> &lt;<VAR>cell&nbsp;to&nbsp;check</VAR>>]  [<B>-a</B>]  [<B>-f</B>]  
34           [<B>-i</B> &lt;<VAR>seconds&nbsp;between&nbsp;probes</VAR>>]  [<B>-h</B>]
35 </PRE>
36 <P><STRONG>Description</STRONG>
37 <P>The <B>fs checkservers</B> command reports whether certain AFS server
38 machines are accessible from the local client machine. The machines
39 belong to one of two classes, and the Cache Manager maintains a list of them
40 in kernel memory:
41 <UL>
42 <P><LI>The database server machines in every cell listed in the local
43 <B>/usr/vice/etc/CellServDB file</B>, plus any machines added to the
44 memory list by the <B>fs newcell</B> command since the last reboot.
45 <P><LI>All file server machines the Cache Manager has recently contacted, and
46 which it probably needs to contact again soon. In most cases, the Cache
47 Manager holds a callback on a file or volume fetched from the machine.
48 </UL>
49 <P>If the Cache Manager is unable to contact the <B>vlserver</B> process
50 on a database server machine or the <B>fileserver</B> process on a file
51 server machine, it marks the machine as inaccessible. (Actually, if a
52 file server machine is multihomed, the Cache Manager attempts to contact all
53 of the machine's interfaces, and only marks the machine as down if the
54 <B>fileserver</B> fails to reply via any of them.) The Cache
55 Manager then periodically (by default, every three minutes) sends a probe to
56 each marked machine, to see if it is still inaccessible. If a
57 previously inaccessible machine responds, the Cache Manager marks it as
58 accessible and no longer sends the periodic probes to it.
59 <P>The <B>fs checkservers</B> command updates the list of inaccessible
60 machines by having the Cache Manager probe a specified set of them:
61 <UL>
62 <P><LI>By default, only machines that are marked inaccessible and belong to the
63 local cell (the cell listed in the local <B>/usr/vice/etc/ThisCell</B>
64 file)
65 <P><LI>If the <B>-cell</B> argument is included, only machines that are
66 marked inaccessible and belong to the specified cell
67 <P><LI>If the <B>-all</B> flag is included, all machines marked inaccessible
68 </UL>
69 <P>If the <B>-fast</B> flag is included, the Cache Manager does not probe
70 any machines, but instead reports the results of the most recent previous
71 probe.
72 <P>To set the interval between probes rather than produce a list of
73 inaccessible machines, use the <B>-interval</B> argument. The
74 non-default setting persists until the machine reboots; to preserve it
75 across reboots, put the appropriate <B>fs checkservers</B> command in the
76 machine's AFS initialization files.
77 <P><STRONG>Cautions</STRONG>
78 <P>The command can take quite a while to complete, if a number of machines do
79 not respond to the Cache Manager's probe. The Cache Manager probes
80 machines sequentially and waits a standard timeout period before marking the
81 machine as unresponsive, to allow for slow network communication. To
82 make the command shell prompt return quickly, put the command in the
83 background. It is harmless to interrupt the command by typing
84 <B>Ctrl-c</B> or another interrupt signal.
85 <P>Note that the Cache Manager probes only server machines marked inaccessible
86 in its memory list. A server machine's absence from the output
87 does not necessarily mean that it is functioning, because it possibly is not
88 included in the memory list at all (if, for example, the Cache Manager has not
89 contacted it recently). For the same reason, the output is likely to
90 vary on different client machines.
91 <P>Unlike most <B>fs</B> commands, the <B>fs checkservers</B> command
92 does not refer to the AFSCELL environment variable.
93 <P><STRONG>Options</STRONG>
94 <DL>
95 <P><DT><B>-cell
96 </B><DD>Names each cell in which to probe server machines marked as
97 inaccessible. Provide the fully qualified domain name, or a shortened
98 form that disambiguates it from the other cells listed in the local
99 <B>/usr/vice/etc/CellServDB</B> file. Combine this argument with
100 the <B>-fast</B> flag if desired, but not with the <B>-all</B>
101 flag. Omit both this argument and the <B>-all</B> flag to probe
102 machines in the local cell only.
103 <P><DT><B>-all
104 </B><DD>Probes all machines in the Cache Manager's memory list that are
105 marked inaccessible. Combine this argument with the <B>-fast</B>
106 flag if desired, but not with the <B>-cell</B> argument. Omit both
107 this flag and the <B>-cell</B> argument to probe machines in the local
108 cell only.
109 <P><DT><B>-fast
110 </B><DD>Displays the Cache Manager's current list of machines that are
111 inaccessible, rather than sending new probes. The output can as old as
112 the current setting of the probe interval (by default three minutes, and
113 maximum ten minutes).
114 <P><DT><B>-interval
115 </B><DD>Sets or reports the number of seconds between the Cache Manager's
116 probes to machines in the memory list that are marked inaccessible: 
117 <UL>
118 <P><LI>To set the interval, specify a value from the range between <B>1</B>
119 and <B>600</B> (10 minutes); the default is <B>180</B> (three
120 minutes). The issuer must be logged in as the local superuser
121 <B>root</B>. The altered setting persists until again changed with
122 this command, or until the machine reboots, at which time the setting returns
123 to the default.
124 <P><LI>Provide a value of <B>0</B> (zero) to display the current interval
125 setting. No privilege is required. Do not combine this argument
126 with any other.
127 </UL>
128 <P><DT><B>-help
129 </B><DD>Prints the online help for this command. All other valid options
130 are ignored.
131 </DL>
132 <P><STRONG>Output</STRONG>
133 <P>If there are no machines marked as inaccessible, or if all of them now
134 respond to the Cache Manager's probe, the output is:
135 <PRE>   All servers are running.
136    
137 </PRE>
138 <P>Note that this message does not mean that all server machines in each
139 relevant cell are running. The output indicates the status of only
140 those machines that the Cache Manager probes.
141 <P>If a machine fails to respond to the probe within the timeout period, the
142 output begins with the string
143 <PRE>   These servers unavailable due to network or server problems:
144    
145 </PRE>
146 <P>and lists the hostname of each machine on its own line. The Cache
147 Manager stores machine records by Internet address, so the format of each
148 hostname (uppercase or lowercase letters, or an Internet address in dotted
149 decimal format) depends on how the local cell's name service translates
150 it at the time the command is issued. If a server machine is
151 multihomed, the output lists only one of its interfaces (usually, the
152 currently most preferred one).
153 <P>If the <B>-interval</B> argument is provided with a value between
154 <B>1</B> and <B>600</B>, there is no output. If the value is
155 <B>0</B>, the output reports the probe interval as follows:
156 <PRE>   The current down server probe interval is <VAR>interval</VAR> secs
157    
158 </PRE>
159 <P><STRONG>Examples</STRONG>
160 <P>The following command displays the Cache Manager's current list of
161 unresponsive machines in the local cell, rather than probing them
162 again. The output indicates that if there were any machines marked
163 inaccessible, they all responded to the previous probe.
164 <PRE>   % <B>fs checkservers -fast</B>
165    All servers are running.
166    
167 </PRE>
168 <P>The following example probes machines in the Cache Manager's memory
169 list that belong to the <B>stateu.edu</B> cell:
170 <PRE>   % <B>fs checkservers -cell stateu.edu</B>
171    All servers are running.
172    
173 </PRE>
174 <P>The following example probes all server machines in the Cache
175 Manager's memory list. It reports that two machines did not
176 respond to the probe.
177 <PRE>   % <B>fs checkservers -all</B>
178    These servers unavailable due to network or server problems:
179    fs1.abc.com SV3.STATE.EDU.
180    
181 </PRE>
182 <P><STRONG>Privilege Required</STRONG>
183 <P>To set the probe interval, the issuer must be logged in as the local
184 superuser <B>root</B>. Otherwise, no privilege is required.
185 <P><STRONG>Related Information</STRONG>
186 <P><A HREF="auarf019.htm#HDRCLI_CSDB">CellServDB (client version)</A>
187 <P><A HREF="auarf032.htm#HDRCLI_THISCELL">ThisCell (client version)</A>
188 <P><A HREF="auarf154.htm#HDRFS_NEWCELL">fs newcell</A>
189 <P>
190 <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="auarf132.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="auarf134.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> 
191 <!-- Begin Footer Records  ========================================== -->
192 <P><HR><B> 
193 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
194 </B> 
195 <!-- End Footer Records  ============================================ -->
196 <A NAME="Bot_Of_Page"></A>
197 </BODY></HTML>