afsmonitor-document-usage-20040729
[openafs.git] / doc / html / AdminReference / auarf124.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="auarf123.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="auarf125.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="HDRBOSSERVER" HREF="auarf002.htm#ToC_138">bosserver</A></H2>
19 <A NAME="IDX4680"></A>
20 <A NAME="IDX4681"></A>
21 <A NAME="IDX4682"></A>
22 <P><STRONG>Purpose</STRONG>
23 <P>Initializes the BOS Server
24 <P><STRONG>Synopsis</STRONG>
25 <PRE><B>bosserver</B> [<B>-noauth</B>]  [<B>-log</B>]  [<B>-enable_peer_stats</B>]  [<B>-enable_process_stats</B>]  
26           [<B>-help</B>]
27 </PRE>
28 <P>This command does not use the syntax conventions of the AFS command
29 suites. Provide the command name and all option names in full.
30 <P><STRONG>Description</STRONG>
31 <P>The <B>bosserver</B> command initializes the Basic OverSeer (BOS)
32 Server (<B>bosserver</B> process). In the conventional
33 configuration, the binary file is located in the <B>/usr/afs/bin</B>
34 directory on a file server machine.
35 <P>The BOS Server must run on every file server machine and helps to automate
36 file server administration by performing the following tasks:
37 <UL>
38 <P><LI>Monitors the other AFS server processes on the local machine, to make sure
39 they are running correctly.
40 <P><LI>Automatically restarts failed processes, without contacting a human
41 operator. When restarting multiple server processes simultaneously, the
42 BOS Server takes interdependencies into account and initiates restarts in the
43 correct order.
44 <A NAME="IDX4683"></A>
45 <A NAME="IDX4684"></A>
46 <P><LI>Processes commands from the <B>bos</B> suite that administrators issue
47 to verify the status of server processes, install and start new processes,
48 stop processes either temporarily or permanently, and restart halted
49 processes.
50 <P><LI>Manages system configuration information: the files that list the
51 cell's server encryption keys, database server machines, and users
52 privileged to issue commands from the <B>bos</B> and <B>vos</B>
53 suites.
54 </UL>
55 <P>The BOS Server logs a default set of important events in the file
56 <B>/usr/afs/logs/BosLog</B>. To record the name of any user who
57 performs a privileged <B>bos</B> command (one that requires being listed
58 in the <B>/usr/afs/etc/UserList</B> file), add the <B>-log</B>
59 flag. To display the contents of the <B>BosLog</B> file, use the
60 <B>bos getlog</B> command.
61 <P>The first time that the BOS Server initializes on a server machine, it
62 creates several files and subdirectories in the local <B>/usr/afs</B>
63 directory, and sets their mode bits to protect them from unauthorized
64 access. Each time it restarts, it checks that the mode bits still
65 comply with the settings listed in the following chart. A question mark
66 indicates that the BOS Server initially turns off the bit (sets it to the
67 hyphen), but does not check it at restart.
68 <BR>
69 <TABLE WIDTH="100%">
70 <TR>
71 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs</B>
72 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>drwxr</TT>?<TT>xr-x</TT>
73 </TD></TR><TR>
74 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs/backup</B>
75 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>drwx</TT>???<TT>---</TT>
76 </TD></TR><TR>
77 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs/bin</B>
78 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>drwxr</TT>?<TT>xr-x</TT>
79 </TD></TR><TR>
80 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs/db</B>
81 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>drwx</TT>???<TT>---</TT>
82 </TD></TR><TR>
83 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs/etc</B>
84 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>drwxr</TT>?<TT>xr-x</TT>
85 </TD></TR><TR>
86 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs/etc/KeyFile</B>
87 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>-rw</TT>????<TT>---</TT>
88 </TD></TR><TR>
89 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs/etc/UserList</B>
90 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>-rw</TT>?????<TT>--</TT>
91 </TD></TR><TR>
92 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs/local</B>
93 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>drwx</TT>???<TT>---</TT>
94 </TD></TR><TR>
95 <TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><B>/usr/afs/logs</B>
96 </TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%"><TT>drwxr</TT>?<TT>xr-x</TT>
97 </TD></TR></TABLE>
98 <P>If the mode bits do not comply, the BOS Server writes the following warning
99 to the <B>BosLog</B> file:
100 <PRE>   Bosserver reports inappropriate access on server directories
101    
102 </PRE>
103 <P>However, the BOS Server does not reset the mode bits, so the administrator
104 can set them to alternate values if desired (with the understanding that the
105 warning message then appears at startup).
106 <P><STRONG>Options</STRONG>
107 <DL>
108 <P><DT><B>-noauth
109 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the issuer,
110 which is useful only when authorization checking is disabled on the server
111 machine (for instance, during the installation of a file server
112 machine.)
113 <P><DT><B>-log
114 </B><DD>Records in the <B>/usr/afs/logs/BosLog</B> file the names of all users
115 who successfully issue a privileged <B>bos</B> command (one that requires
116 being listed in the <B>/usr/afs/etc/UserList</B> file).
117 <P><DT><B>-enable_peer_stats
118 </B><DD>Activates the collection of Rx statistics and allocates memory for their
119 storage. For each connection with a specific UDP port on another
120 machine, a separate record is kept for each type of RPC (FetchFile, GetStatus,
121 and so on) sent or received. To display or otherwise access the
122 records, use the Rx Monitoring API.
123 <P><DT><B>-enable_process_stats
124 </B><DD>Activates the collection of Rx statistics and allocates memory for their
125 storage. A separate record is kept for each type of RPC (FetchFile,
126 GetStatus, and so on) sent or received, aggregated over all connections to
127 other machines. To display or otherwise access the records, use the Rx
128 Monitoring API.
129 <P><DT><B>-help
130 </B><DD>Prints the online help for this command. All other valid options
131 are ignored.
132 </DL>
133 <P><STRONG>Examples</STRONG>
134 <P>The following command initializes the BOS Server and logs the names of
135 users who issue privileged <B>bos</B> commands.
136 <PRE>   % <B>bosserver -log &amp;</B>
137    
138 </PRE>
139 <P><STRONG>Privilege Required</STRONG>
140 <P>The issuer most be logged onto a file server machine as the local superuser
141 <B>root</B>.
142 <P><STRONG>Related Information</STRONG>
143 <P><A HREF="auarf016.htm#HDRBOSCONFIG">BosConfig</A>
144 <P><A HREF="auarf015.htm#HDRBOSLOG">BosLog</A>
145 <P><A HREF="auarf093.htm#HDRBOS_INTRO">bos</A>
146 <P><A HREF="auarf098.htm#HDRBOS_CREATE">bos create</A>
147 <P><A HREF="auarf100.htm#HDRBOS_EXEC">bos exec</A>
148 <P><A HREF="auarf102.htm#HDRBOS_GETLOG">bos getlog</A>
149 <P><A HREF="auarf103.htm#HDRBOS_GETRESTART">bos getrestart</A>
150 <P><A HREF="auarf113.htm#HDRBOS_RESTART">bos restart</A>
151 <P><A HREF="auarf118.htm#HDRBOS_SHUTDOWN">bos shutdown</A>
152 <P><A HREF="auarf119.htm#HDRBOS_START">bos start</A>
153 <P><A HREF="auarf120.htm#HDRBOS_STARTUP">bos startup</A>
154 <P><A HREF="auarf121.htm#HDRBOS_STATUS">bos status</A>
155 <P><A HREF="auarf122.htm#HDRBOS_STOP">bos stop</A>
156 <P>
157 <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="auarf123.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="auarf125.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> 
158 <!-- Begin Footer Records  ========================================== -->
159 <P><HR><B> 
160 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
161 </B> 
162 <!-- End Footer Records  ============================================ -->
163 <A NAME="Bot_Of_Page"></A>
164 </BODY></HTML>