afsmonitor-document-stat-entries-correctly-20040729
[openafs.git] / doc / html / AdminReference / auarf121.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="auarf120.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="auarf122.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="HDRBOS_STATUS" HREF="auarf002.htm#ToC_135">bos status</A></H2>
19 <A NAME="IDX4656"></A>
20 <A NAME="IDX4657"></A>
21 <A NAME="IDX4658"></A>
22 <A NAME="IDX4659"></A>
23 <A NAME="IDX4660"></A>
24 <A NAME="IDX4661"></A>
25 <A NAME="IDX4662"></A>
26 <P><STRONG>Purpose</STRONG>
27 <P>Displays the status of server processes
28 <P><STRONG>Synopsis</STRONG>
29 <PRE><B>bos status -server</B> &lt;<VAR>machine&nbsp;name</VAR>>  [<B>-instance</B> &lt;<VAR>server&nbsp;process&nbsp;name</VAR>><SUP>+</SUP>]  
30            [<B>-long</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-help</B>] 
31     
32 <B>bos stat -s</B> &lt;<VAR>machine&nbsp;name</VAR>>  [<B>-i</B> &lt;<VAR>server&nbsp;process&nbsp;name</VAR>><SUP>+</SUP>] 
33          [<B>-lon</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-loc</B>]  [<B>-h</B>] 
34 </PRE>
35 <P><STRONG>Description</STRONG>
36 <P>The <B>bos status</B> command reports the status of processes on the
37 server machine named by the <B>-server</B> argument, either 
38 <UL>
39 <P><LI>All of the AFS server processes listed in the
40 <B>/usr/afs/local/BosConfig</B> file
41 <P><LI>Only these processes named by the <B>-instance</B> argument
42 </UL>
43 <P><STRONG>Options</STRONG>
44 <DL>
45 <P><DT><B><B>-server</B>
46 </B><DD>Indicates the server machine for which to report server process
47 status. Identify the machine by IP address or its host name (either
48 fully-qualified or abbreviated unambiguously). For details, see the
49 introductory reference page for the <B>bos</B> command suite.
50 <P><DT><B><B>-instance</B>
51 </B><DD>Names each process for which to report status. Use the process name
52 assigned with the <B>-instance</B> argument to the <B>bos</B>
53 command. The output from the <B>bos status</B> command lists the
54 names.
55 <P><DT><B><B>-long</B>
56 </B><DD>Produces more detailed status information.
57 <P><DT><B><B>-cell</B>
58 </B><DD>Names the cell in which to run the command. Do not combine this
59 argument with the <B>-localauth</B> flag. For more details, see the
60 introductory <B>bos</B> reference page.
61 <P><DT><B><B>-noauth</B>
62 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
63 issuer. Do not combine this flag with the <B>-localauth</B>
64 flag. For more details, see the introductory <B>bos</B> reference
65 page.
66 <P><DT><B><B>-localauth</B>
67 </B><DD>Constructs a server ticket using a key from the local
68 <B>/usr/afs/etc/KeyFile</B> file. The <B>bos</B> command
69 interpreter presents the ticket to the BOS Server during mutual
70 authentication. Do not combine this flag with the <B>-cell</B> or
71 <B>-noauth</B> options. For more details, see the introductory
72 <B>bos</B> reference page.
73 <P><DT><B>-help
74 </B><DD>Prints the online help for this command. All other valid options
75 are ignored.
76 </DL>
77 <P><STRONG>Output</STRONG>
78 <P>The output for a process includes at least one line, which reports one of
79 the following as the process's current status:
80 <UL>
81 <P><LI><TT>currently running normally</TT>. The process's status
82 flag in the <B>BosConfig</B> file is <TT>Run</TT>. For
83 <B>cron</B> entries, this message indicates only that the command is
84 scheduled to run, not necessarily that it was executing when the <B>bos
85 status</B> command was issued.
86 <P><LI><TT>disabled</TT>. The process is not running, and its
87 <B>BosConfig</B> status flag is <TT>NotRun</TT>.
88 <P><LI><TT>temporarily disabled</TT>. The process is not running
89 although its status flag in the <B>BosConfig</B> file is
90 <TT>Run</TT>. Either an administrator used the <B>bos
91 shutdown</B> command to stop it, or the
92 <P><LI>BOS Server stopped trying to restart it after numerous failed
93 attempts. In the second case, the auxiliary message is <TT>stopped for
94  too many errors</TT>.
95 <P><LI><TT>temporarily enabled</TT>. The process is running although its
96 status flag in the <B>BosConfig</B> file is <TT>NotRun</TT>. An
97 administrator has used the <B>bos startup</B> command to start it.
98 </UL>
99 <P>If one of the following special circumstances applies to the process, the
100 indicated message appears in its entry:
101 <UL>
102 <P><LI><TT>has core file</TT>. The process failed and created a core
103 file in the <B>/usr/afs/logs</B> directory. If the BOS Server was
104 able to restart the process after the failure, the primary status is
105 <TT>currently running normally</TT>.
106 <P><LI><TT>stopped for too many  errors</TT>. The reason for the primary
107 status <TT>temporarily  disabled</TT> is that the BOS Server's attempts
108 to restart the process all failed.
109 </UL>
110 <P>The entry for the <B>fs</B> process always includes a second line to
111 report the process's <TT>Auxiliary status</TT>, which is one of the
112 following:
113 <UL>
114 <P><LI><TT>file server running</TT>. The File Server and Volume Server
115 components of the File Server process are running normally.
116 <P><LI><TT>salvaging file system</TT>. The Salvager is running, so the
117 File Server and Volume Server are temporarily disabled. The BOS Server
118 restarts them as soon as the Salvager is finished.
119 </UL>
120 <P>The entry for a <B>cron</B> process includes an <TT>Auxiliary 
121 status</TT> that reports when the command will next execute.
122 <P>If the <B>-long</B> flag is used, each entry includes the following
123 additional information:
124 <UL>
125 <P><LI>The process's type (<TT>simple</TT>, <TT>fs</TT>, or
126 <TT>cron</TT>).
127 <P><LI>The day and time the process last started or restarted.
128 <P><LI>The number of <TT>proc starts</TT>, which is how many times the BOS
129 Server has started or restarted the process since it started itself.
130 <P><LI>The <TT>Last exit</TT> time when the process (or one of the component
131 processes in the <B>fs</B> process) last terminated. This line does
132 not appear if the process has not terminated since the BOS Server
133 started.
134 <P><LI>The <TT>Last error exit</TT> time when the process (or one of the
135 component processes in the <B>fs</B> process) last failed due to an
136 error. A further explanation such as <TT>due to shutdown request</TT>
137 sometimes appears. This line does not appear if the process has not
138 failed since the BOS Server started.
139 <P><LI>Each command that the BOS Server invokes to start the process, as
140 specified by the <B>-cmd</B> argument to the <B>bos create</B>
141 command.
142 <P><LI>The pathname of the notifier program that the BOS Server invokes when the
143 process terminates (if any), as specified by the <B>-notifier</B> argument
144 to the <B>bos create</B> command.
145 </UL>
146 <P>If the <B>-long</B> flag is provided and the BOS Server discovers that
147 the mode bits on files and subdirectories in the local <B>/usr/afs</B>
148 directory differ from the expected values, it prints the following warning
149 message:
150 <PRE>   Bosserver reports inappropriate access on server directories
151    
152 </PRE>
153 <P>The following chart summarizes the expected mode bit settings. A
154 question mark indicates that the BOS Server does not check that bit.
155 <BR>
156 <TABLE WIDTH="100%">
157 <TR>
158 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs</B>
159 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>drwxr</TT>?<TT>xr-x</TT>
160 </TD></TR><TR>
161 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs/backup</B>
162 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>drwx</TT>???<TT>---</TT>
163 </TD></TR><TR>
164 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs/bin</B>
165 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>drwxr</TT>?<TT>xr-x</TT>
166 </TD></TR><TR>
167 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs/db</B>
168 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>drwx</TT>???<TT>---</TT>
169 </TD></TR><TR>
170 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs/etc</B>
171 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>drwxr</TT>?<TT>xr-x</TT>
172 </TD></TR><TR>
173 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs/etc/KeyFile</B>
174 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>-rw</TT>????<TT>---</TT>
175 </TD></TR><TR>
176 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs/etc/UserList</B>
177 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>-rw</TT>?????<TT>--</TT>
178 </TD></TR><TR>
179 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs/local</B>
180 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>drwx</TT>???<TT>---</TT>
181 </TD></TR><TR>
182 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs/logs</B>
183 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>drwxr</TT>?<TT>xr-x</TT>
184 </TD></TR></TABLE>
185 <P><STRONG>Examples</STRONG>
186 <P>The following example command displays the status of processes on the
187 machine <B>fs3.abc.com</B>:
188 <PRE>   %<B> bos status fs3.abc.com</B>
189    Instance buserver, currently running normally.
190    Instance kaserver, currently running normally.
191    Instance ptserver, currently running normally.
192    Instance vlserver, currently running normally.
193    Instance fs, has core file, currently running normally.
194        Auxiliary status is: file server running.
195    Instance upserver, currently running normally.
196    Instance runntp, currently running normally.
197    
198 </PRE>
199 <P>The following example command displays a detailed status report for the
200 <B>fs</B> and <B>ptserver</B> processes on the machine
201 <B>fs1.abc.com</B>.
202 <PRE>   % <B>bos status -server fs1.abc.com -instance fs ptserver -long</B>
203    Instance fs, (type is fs), currently running normally.
204       Auxiliary status is: file server running.
205       Process last started at Wed Jan 7 5:34:49 1998 (3 proc starts)
206       Last exit at Wed Jan 7 5:34:49 1998 
207       Last error exit at Wed Jan 7 5:34:49 1998, due to shutdown 
208           request
209       Command 1 is '/usr/afs/bin/fileserver'
210       Command 2 is '/usr/afs/bin/volserver'
211       Command 3 is '/usr/afs/bin/salvager'
212    Instance ptserver, (type is simple) currently running normally.
213       Process last started at Tue Jan 6 8:29:19 1998 (1 proc starts)
214       Command 1 is '/usr/afs/bin/ptserver'
215    
216 </PRE>
217 <P><STRONG>Privilege Required</STRONG>
218 <P>None
219 <P><STRONG>Related Information</STRONG>
220 <P><A HREF="auarf016.htm#HDRBOSCONFIG">BosConfig</A>
221 <P><A HREF="auarf023.htm#HDRKEYFILE">KeyFile</A>
222 <P><A HREF="auarf093.htm#HDRBOS_INTRO">bos</A>
223 <P><A HREF="auarf098.htm#HDRBOS_CREATE">bos create</A>
224 <P><A HREF="auarf118.htm#HDRBOS_SHUTDOWN">bos shutdown</A>
225 <P><A HREF="auarf120.htm#HDRBOS_STARTUP">bos startup</A>
226 <P><A HREF="#HDRBOS_STATUS">bos status</A>
227 <P>
228 <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="auarf120.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="auarf122.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> 
229 <!-- Begin Footer Records  ========================================== -->
230 <P><HR><B> 
231 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
232 </B> 
233 <!-- End Footer Records  ============================================ -->
234 <A NAME="Bot_Of_Page"></A>
235 </BODY></HTML>