doc/man-pages/pod/bosserver.pod

   1 =head1 NAME
   2
   3 bosserver - Initializes the BOS Server
   4
   5 =head1 SYNOPSIS
   6
   7 bosserver [B<-noauth>]  [B<-log>]  [B<-enable_peer_stats>]  [B<-enable_process_stats>]
   8 [B<-help>]
   9
  10 This command does not use the syntax conventions of the AFS command
  11 suites. Provide the command name and all option names in full.
  12
  13 =head1 DESCRIPTION
  14
  15 The C<bosserver> command initializes the Basic OverSeer (BOS) Server
  16 (B<bosserver> process). In the conventional configuration, the binary
  17 file is located in the B</usr/afs/bin> directory on a file server
  18 machine.
  19
  20 The BOS Server must run on every file server machine and helps to
  21 automate file server administration by performing the following tasks:
  22
  23 =over
  24
  25 =item *
  26
  27 Monitors the other AFS server processes on the local machine, to
  28 make sure they are running correctly.
  29
  30 =item *
  31
  32 Automatically restarts failed processes, without contacting a
  33 human operator. When restarting multiple server processes
  34 simultaneously, the BOS Server takes interdependencies into
  35 account and initiates restarts in the correct order.
  36
  37 =item *
  38
  39 Processes commands from the B<bos> suite that administrators issue to
  40 verify the status of server processes, install and start new
  41 processes, stop processes either temporarily or permanently, and
  42 restart halted processes.
  43
  44 =item *
  45
  46 Manages system configuration information: the files that list the
  47 cell's server encryption keys, database server machines, and users
  48 privileged to issue commands from the B<bos> and B<vos> suites.
  49
  50 =back
  51
  52 The BOS Server logs a default set of important events in the file
  53 B</usr/afs/logs/BosLog>. To record the name of any user who performs a
  54 privileged B<bos> command (one that requires being listed in the
  55 B</usr/afs/etc/UserList> file), add the B<-log> flag. To display the
  56 contents of the B<BosLog> file, use the C<bos getlog> command.
  57
  58 The first time that the BOS Server initializes on a server machine, it
  59 creates several files and subdirectories in the local B</usr/afs>
  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
  62 comply with the settings listed in the following chart. A question
  63 mark indicates that the BOS Server initially turns off the bit (sets
  64 it to the hyphen), but does not check it at restart.
  65
  66  /usr/afs                drwxr?xr-x
  67  /usr/afs/backup         drwx???---
  68  /usr/afs/bin            drwxr?xr-x
  69  /usr/afs/db             drwx???---
  70  /usr/afs/etc            drwxr?xr-x
  71  /usr/afs/etc/KeyFile    -rw????---
  72  /usr/afs/etc/UserList   -rw?????--
  73  /usr/afs/local          drwx???---
  74  /usr/afs/logs           drwxr?xr-x
  75
  76 If the mode bits do not comply, the BOS Server writes the following
  77 warning to the B<BosLog> file:
  78
  79   Bosserver reports inappropriate access on server directories
  80
  81 However, the BOS Server does not reset the mode bits, so the
  82 administrator can set them to alternate values if desired (with the
  83 understanding that the warning message then appears at startup).
  84
  85 =head1 OPTIONS
  86
  87 =over 4
  88
  89 =item B<-noauth>
  90
  91 Assigns the unprivileged identity B<anonymous> to the issuer,
  92 which is useful only when authorization checking is disabled on
  93 the server machine (for instance, during the installation of a
  94 file server machine.)
  95
  96 =item B<-log>
  97
  98 Records in the B</usr/afs/logs/BosLog> file the names of all users
  99 who successfully issue a privileged B<bos> command (one that
 100 requires being listed in the B</usr/afs/etc/UserList> file).
 101
 102 =item B<-enable_peer_stats>
 103
 104 Activates the collection of Rx statistics and allocates memory
 105 for their storage. For each connection with a specific UDP port
 106 on another machine, a separate record is kept for each type of
 107 RPC (FetchFile, GetStatus, and so on) sent or received. To
 108 display or otherwise access the records, use the Rx Monitoring
 109 API.
 110
 111 =item B<-enable_process_stats>
 112
 113 Activates the collection of Rx statistics and allocates memory
 114 for their storage. A separate record is kept for each type of
 115 RPC (FetchFile, GetStatus, and so on) sent or received,
 116 aggregated over all connections to other machines. To display
 117 or otherwise access the records, use the Rx Monitoring API.
 118
 119 =item B<-help>
 120
 121 Prints the online help for this command. All other valid
 122 options are ignored.
 123
 124 =back
 125
 126 =head1 EXAMPLES
 127
 128 The following command initializes the BOS Server and logs the names of
 129 users who issue privileged B<bos> commands.
 130
 131     bosserver -log &
 132
 133 =head1 PRIVILEGE REQUIRED
 134
 135 The issuer most be logged onto a file server machine as the local
 136 superuser B<root>.
 137
 138 =head1 COPYRIGHT
 139
 140 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 141
 142 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
 143 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
 144 Stanford Linear Accelerator Center, a department of Stanford University.
 145
 146 =head1 SEE ALSO
 147
 148 L<BosConfig(1)>,
 149 L<BosLog(1)>,
 150 L<bos(1)>,
 151 L<bos_create(1)>,
 152 L<bos_exec(1)>,
 153 L<bos_getlog(1)>,
 154 L<bos_getrestart(1)>,
 155 L<bos_restart(1)>,
 156 L<bos_shutdown(1)>,
 157 L<bos_start(1)>,
 158 L<bos_startup(1)>,
 159 L<bos_status(1)>,
 160 L<bos_stop(1)>
 161
 162 =cut