doc/xml/AdminReference/sect8/bosserver.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="bosserver8">
   3   <refmeta>
   4     <refentrytitle>bosserver</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>bosserver</refname>
   9     <refpurpose>Initializes the BOS Server</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">bosserver</emphasis> [<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-log</emphasis>] [<emphasis role="bold">-enable_peer_stats</emphasis>]
  14         [<emphasis role="bold">-enable_process_stats</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
  15
  16   </refsect1>
  17   <refsect1>
  18     <title>Description</title>
  19     <para>The bosserver command initializes the Basic OverSeer (BOS) Server
  20     (<emphasis role="bold">bosserver</emphasis> process). In the conventional configuration, the binary file
  21     is located in the <replaceable>/usr/afs/bin</replaceable> directory on a file server machine.</para>
  22
  23     <para>The BOS Server must run on every file server machine and helps to automate
  24     file server administration by performing the following tasks:</para>
  25
  26     <itemizedlist>
  27       <listitem>
  28         <para>Monitors the other AFS server processes on the local machine, to make sure
  29         they are running correctly.</para>
  30
  31       </listitem>
  32       <listitem>
  33         <para>Automatically restarts failed processes, without contacting a human
  34         operator. When restarting multiple server processes simultaneously, the
  35         BOS Server takes interdependencies into account and initiates restarts in
  36         the correct order.</para>
  37
  38       </listitem>
  39       <listitem>
  40         <para>Processes commands from the bos suite that administrators issue to verify
  41         the status of server processes, install and start new processes, stop
  42         processes either temporarily or permanently, and restart halted processes.</para>
  43
  44       </listitem>
  45       <listitem>
  46         <para>Manages system configuration information: the files that list the cell's
  47         server encryption keys, database server machines, and users privileged to
  48         issue commands from the <emphasis role="bold">bos</emphasis> and <emphasis role="bold">vos</emphasis> suites.</para>
  49
  50       </listitem>
  51     </itemizedlist>
  52     <para>The BOS Server logs a default set of important events in the file
  53     <replaceable>/usr/afs/logs/BosLog</replaceable>. To record the name of any user who performs a
  54     privileged <emphasis role="bold">bos</emphasis> command (one that requires being listed in the
  55     <replaceable>/usr/afs/etc/UserList</replaceable> file), add the <emphasis role="bold">-log</emphasis> flag. To display the
  56     contents of the <emphasis role="bold">BosLog</emphasis> file, use the <emphasis role="bold">bos getlog</emphasis> command.</para>
  57
  58     <para>The first time that the BOS Server initializes on a server machine, it
  59     creates several files and subdirectories in the local <replaceable>/usr/afs</replaceable>
  60     directory, and sets their mode bits to protect them from unauthorized
  61     access. Each time it restarts, it checks that the mode bits still comply
  62     with the settings listed in the following chart. A question mark indicates
  63     that the BOS Server initially turns off the bit (sets it to the hyphen),
  64     but does not check it at restart.</para>
  65
  66     <para>If the mode bits do not comply, the BOS Server writes the following
  67     warning to the <replaceable>BosLog</replaceable> file:</para>
  68
  69 <programlisting>
  70    Bosserver reports inappropriate access on server directories
  71
  72 </programlisting>
  73       <para>However, the BOS Server does not reset the mode bits, so the administrator
  74       can set them to alternate values if desired (with the understanding that
  75       the warning message then appears at startup).</para>
  76
  77       <para>This command does not use the syntax conventions of the AFS command
  78       suites. Provide the command name and all option names in full.</para>
  79
  80     </refsect1>
  81     <refsect1>
  82       <title>Options</title>
  83       <variablelist>
  84         <varlistentry>
  85           <term><emphasis role="bold">-noauth</emphasis></term>
  86           <listitem>
  87             <para>Assigns the unprivileged identity <computeroutput>anonymous</computeroutput> to the issuer, which is
  88             useful only when authorization checking is disabled on the server machine
  89             (for instance, during the installation of a file server machine.)</para>
  90
  91           </listitem>
  92         </varlistentry>
  93         <varlistentry>
  94           <term><emphasis role="bold">-log</emphasis></term>
  95           <listitem>
  96             <para>Records in the <replaceable>/usr/afs/logs/BosLog</replaceable> file the names of all users who
  97             successfully issue a privileged <emphasis role="bold">bos</emphasis> command (one that requires being
  98             listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file).</para>
  99
 100           </listitem>
 101         </varlistentry>
 102         <varlistentry>
 103           <term><emphasis role="bold">-enable_peer_stats</emphasis></term>
 104           <listitem>
 105             <para>Activates the collection of Rx statistics and allocates memory for their
 106             storage. For each connection with a specific UDP port on another machine,
 107             a separate record is kept for each type of RPC (FetchFile, GetStatus, and
 108             so on) sent or received. To display or otherwise access the records, use
 109             the Rx Monitoring API.</para>
 110
 111           </listitem>
 112         </varlistentry>
 113         <varlistentry>
 114           <term><emphasis role="bold">-enable_process_stats</emphasis></term>
 115           <listitem>
 116             <para>Activates the collection of Rx statistics and allocates memory for their
 117             storage. A separate record is kept for each type of RPC (FetchFile,
 118             GetStatus, and so on) sent or received, aggregated over all connections to
 119             other machines. To display or otherwise access the records, use the Rx
 120             Monitoring API.</para>
 121
 122           </listitem>
 123         </varlistentry>
 124         <varlistentry>
 125           <term><emphasis role="bold">-help</emphasis></term>
 126           <listitem>
 127             <para>Prints the online help for this command. All other valid options are
 128             ignored.</para>
 129
 130           </listitem>
 131         </varlistentry>
 132       </variablelist>
 133     </refsect1>
 134     <refsect1>
 135       <title>Examples</title>
 136       <para>The following command initializes the BOS Server and logs the names of
 137       users who issue privileged <emphasis role="bold">bos</emphasis> commands.</para>
 138
 139 <programlisting>
 140    % bosserver -log &amp;
 141
 142 </programlisting>
 143       </refsect1>
 144       <refsect1>
 145         <title>Privilege Required</title>
 146         <para>The issuer most be logged onto a file server machine as the local
 147         superuser <computeroutput>root</computeroutput>.</para>
 148
 149       </refsect1>
 150       <refsect1>
 151         <title>See Also</title>
 152         <para><link linkend="BosConfig5">BosConfig(5)</link>,
 153         <link linkend="BosLog5">BosLog(5)</link>,
 154         <link linkend="bos8">bos(8)</link>,
 155         <link linkend="bos_create8">bos_create(8)</link>,
 156         <link linkend="bos_exec8">bos_exec(8)</link>,
 157         <link linkend="bos_getlog8">bos_getlog(8)</link>,
 158         <link linkend="bos_getrestart8">bos_getrestart(8)</link>,
 159         <link linkend="bos_restart8">bos_restart(8)</link>,
 160         <link linkend="bos_shutdown8">bos_shutdown(8)</link>,
 161         <link linkend="bos_start8">bos_start(8)</link>,
 162         <link linkend="bos_startup8">bos_startup(8)</link>,
 163         <link linkend="bos_status8">bos_status(8)</link>,
 164         <link linkend="bos_stop8">bos_stop(8)</link></para>
 165
 166       </refsect1>
 167       <refsect1>
 168         <title>Copyright</title>
 169         <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 170
 171         <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 172         converted from HTML to POD by software written by Chas Williams and Russ
 173         Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 174
 175       </refsect1>
 176     </refentry>