afsmonitor-document-stat-entries-correctly-20040729
[openafs.git] / doc / html / AdminReference / auarf016.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="auarf015.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="auarf017.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="HDRBOSCONFIG" HREF="auarf002.htm#ToC_14">BosConfig</A></H2>
19 <P><STRONG>Purpose</STRONG>
20 <A NAME="IDX3880"></A>
21 <A NAME="IDX3881"></A>
22 <A NAME="IDX3882"></A>
23 <A NAME="IDX3883"></A>
24 <P>Defines server processes for the BOS Server to monitor
25 <P><STRONG>Description</STRONG>
26 <P>The <B>BosConfig</B> file lists the processes that the Basic OverSeer
27 (BOS) Server monitors on its server machine, and thus defines which AFS server
28 processes run on the machine. It specifies how the BOS Server reacts
29 when a process fails, and also defines the times at which the BOS Server
30 automatically restarts processes as part of performance maintenance.
31 The file must reside in the <B>/usr/afs/local</B> directory on each AFS
32 server machine.
33 <P>A server process entry in the <B>BosConfig</B> file records the
34 following information:
35 <UL>
36 <P><LI>The<VAR> entry type</VAR>, which is one of the following: 
37 <A NAME="IDX3884"></A>
38 <A NAME="IDX3885"></A>
39 <DL>
40 <P><DT><B>cron
41 <A NAME="IDX3886"></A>
42 </B><DD>Designates a server process that runs periodically instead of
43 continuously. The BOS Server starts a cron process only at specified
44 times, not whenever it fails. All standard AFS process entries except
45 <B>fs</B> are simple (there are no standard cron processes).
46 <P><DT><B>fs
47 <A NAME="IDX3887"></A>
48 <A NAME="IDX3888"></A>
49 <A NAME="IDX3889"></A>
50 <A NAME="IDX3890"></A>
51 </B><DD>Designates a group of interdependent server processes. If one of
52 the processes fails, the BOS Server must coordinate its restart with the
53 restart of the other processes in the group, possibly by stopping them
54 first. 
55 <P>There is only one standard entry of this type, for which the conventional
56 name is <B>fs</B>. It combines three server processes: the
57 File Server (<B>fileserver</B> process), the Volume Server
58 (<B>volserver</B> process), and the Salvager (<B>salvager</B>
59 process). These processes all operate on the same data--the AFS
60 data stored on an AFS server machine's <B>/vicep</B> partitions and
61 mounted in the AFS filespace--but in different ways. Grouping the
62 processes prevents them from attempting to access the same data
63 simultaneously, which can cause corruption. 
64 <P>During normal operation, the Salvager process is not active. If the
65 File Server process fails, however, the BOS Server stops the Volume Server
66 process and runs the Salvager process to correct any corruption that resulted
67 from the failure. (The administrator can also issue the <B>bos
68 salvage</B> command to invoke the Salvager process.) If the Volume
69 Server fails, the BOS Server can restart it without stopping the File Server
70 or running the Salvager.
71 <P><DT><B>simple
72 <A NAME="IDX3891"></A>
73 </B><DD>Designates a server process that runs independently of any other on the
74 server machine. If a simple process fails, the BOS Server does not have
75 to coordinate its restart with any other process.
76 </DL>
77 <P><LI>The <VAR>entry name</VAR>. The conventional name for an entry in the
78 <B>BosConfig</B> file and the associated process matches the binary
79 filename. When issuing any <B>bos</B> command that takes the
80 <B>-instance</B> argument, identify each process by the name used in the
81 <B>BosConfig</B> file. For a list of the names, see the <B>bos
82 create</B> reference page.
83 <P><LI>The process's <VAR>status flag</VAR>, which determines whether the BOS
84 Server attempts to start the process in two cases: each time the BOS
85 Server itself restarts, and when the process fails. The
86 <B>BosConfig</B> file currently uses a binary notation to indicate whether
87 the BOS Server attempts to restart the process as necessary or does not
88 monitor it at all. For the sake of clarity, the AFS documentation
89 refers to the flags as <B>Run</B> and <B>NotRun</B> instead.
90 Only a system administrator, not the BOS Server, can change the flag.
91 <A NAME="IDX3892"></A>
92 <A NAME="IDX3893"></A>
93 <P><LI>One or more <VAR>command parameters</VAR> which the BOS Server invokes to
94 start the process or processes associated with the entry: 
95 <UL>
96 <P><LI>A <B>cron</B> entry has two command parameters, the first the complete
97 pathname to the program, and the second the time at which the BOS Server
98 invokes the program.
99 <P><LI>The <B>fs</B> entry has three command parameters, each the complete
100 pathname to the <B>fileserver</B>, <B>volserver</B>, and
101 <B>salvager</B> programs, in that order.
102 <P><LI>A <B>simple</B> entry has only one command parameter, the complete
103 pathname to the program.
104 </UL>
105 </UL>
106 <P>In addition to server process entries, the <B>BosConfig</B> file
107 specifies the times at which the BOS Server performs two types of automatic
108 process restarts:
109 <UL>
110 <P><LI>The <VAR>general restart</VAR> time at which the BOS Server restarts itself
111 and then each process for which the entry in the <B>BosConfig</B> file has
112 status flag <B>Run</B>. The default setting is Sunday at 4:00
113 a.m.
114 <P><LI>The <VAR>binary restart</VAR> time at which the BOS Server restarts any
115 server process for which the time stamp on the binary file in the
116 <B>/usr/afs/bin</B> directory is later than the last restart time for the
117 process. The default is 5:00 a.m.
118 </UL>
119 <P>Although the <B>BosConfig</B> file is in ASCII format, do not use a
120 text editor to alter it. Its format is subject to change and
121 incorrectly formatted entries can prevent server startup in ways that are
122 difficult to diagnose. Instead always use the appropriate commands from
123 the <B>bos</B> command suite:
124 <UL>
125 <P><LI>The <B>bos create</B> command to create an entry in the file and start
126 the associated process
127 <P><LI>The <B>bos delete</B> command to remove an entry from the file after
128 the <B>bos stop</B> command is used to stop the associated process
129 <P><LI>The <B>bos getrestart</B> command to display the times at which the
130 BOS Server performs automatic restarts
131 <P><LI>The <B>bos setrestart</B> command to set the times at which the BOS
132 Server performs automatic process restarts
133 <P><LI>The <B>bos start</B> command to change an entry's status flag to
134 <B>Run</B> and start the associated process
135 <P><LI>The <B>bos status</B> command to display all processes listed in the
136 file
137 <P><LI>The <B>bos stop</B> command to change an entry's status flag to
138 <B>NotRun</B> and stop the associated process
139 </UL>
140 <P>There are also <B>bos</B> commands that start and stop processes
141 without changing entries in the <B>BosConfig</B> file. The BOS
142 Server reads the <B>BosConfig</B> file only when it starts, transferring
143 the information into its memory. Thus a process's status as
144 represented in the BOS Server's memory can diverge from its status in the
145 <B>BosConfig</B> file. The following commands change a
146 process's status in the BOS Server's memory only:
147 <A NAME="IDX3894"></A>
148 <A NAME="IDX3895"></A>
149 <A NAME="IDX3896"></A>
150 <UL>
151 <P><LI>The <B>bos restart</B> command restarts a specified set of processes,
152 all processes, or all processes other than the BOS Server
153 <P><LI>The <B>bos shutdown</B> command stops a process
154 <P><LI>The <B>bos startup</B> command starts a process
155 </UL>
156 <P><STRONG>Related Information</STRONG>
157 <P><A HREF="auarf098.htm#HDRBOS_CREATE">bos create</A>
158 <P><A HREF="auarf099.htm#HDRBOS_DELETE">bos delete</A>
159 <P><A HREF="auarf103.htm#HDRBOS_GETRESTART">bos getrestart</A>
160 <P><A HREF="auarf113.htm#HDRBOS_RESTART">bos restart</A>
161 <P><A HREF="auarf117.htm#HDRBOS_SETRESTART">bos setrestart</A>
162 <P><A HREF="auarf118.htm#HDRBOS_SHUTDOWN">bos shutdown</A>
163 <P><A HREF="auarf119.htm#HDRBOS_START">bos start</A>
164 <P><A HREF="auarf120.htm#HDRBOS_STARTUP">bos startup</A>
165 <P><A HREF="auarf121.htm#HDRBOS_STATUS">bos status</A>
166 <P><A HREF="auarf122.htm#HDRBOS_STOP">bos stop</A>
167 <P><A HREF="auarf114.htm#HDRBOS_SALVAGE">bos salvage</A>
168 <P><A HREF="auarf129.htm#HDRFILESERVER">fileserver</A>
169 <P><A HREF="auarf232.htm#HDRSALVAGER">salvager</A>
170 <P><A HREF="auarf251.htm#HDRVOLSERVER">volserver</A>
171 <P>
172 <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="auarf015.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="auarf017.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> 
173 <!-- Begin Footer Records  ========================================== -->
174 <P><HR><B> 
175 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
176 </B> 
177 <!-- End Footer Records  ============================================ -->
178 <A NAME="Bot_Of_Page"></A>
179 </BODY></HTML>