doc/man-pages/pod8/bosserver.pod

   1 =head1 NAME
   2
   3 bosserver - Initializes the BOS Server
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<bosserver> [B<-noauth>] [B<-log>] [B<-enable_peer_stats>]
  11     S<<< [B<-auditlog> <I<log path>>] >>> [B<-audit-interface> (file | sysvmq)]
  12     [B<-enable_process_stats>] [B<-allow-dotted-principals>]
  13     [B<-restricted>] [B<-help>]
  14
  15 =for html
  16 </div>
  17
  18 =head1 DESCRIPTION
  19
  20 The bosserver command initializes the Basic OverSeer (BOS) Server
  21 (B<bosserver> process). In the conventional configuration, the binary file
  22 is located in the F</usr/afs/bin> directory on a file server machine.
  23
  24 The BOS Server must run on every file server machine and helps to automate
  25 file server administration by performing the following tasks:
  26
  27 =over 4
  28
  29 =item *
  30
  31 Monitors the other AFS server processes on the local machine, to make sure
  32 they are running correctly.
  33
  34 =item *
  35
  36 Automatically restarts failed processes, without contacting a human
  37 operator. When restarting multiple server processes simultaneously, the
  38 BOS Server takes interdependencies into account and initiates restarts in
  39 the correct order.
  40
  41 =item *
  42
  43 Processes commands from the bos suite that administrators issue to verify
  44 the status of server processes, install and start new processes, stop
  45 processes either temporarily or permanently, and restart halted processes.
  46
  47 =item *
  48
  49 Manages system configuration information: the files that list the cell's
  50 server encryption keys, database server machines, and users privileged to
  51 issue commands from the B<bos> and B<vos> suites.
  52
  53 =back
  54
  55 The BOS Server is configured via the F<BosConfig> configuration file.
  56 Normally, this file is managed via the B<bos> command suite rather than
  57 edited directly.  See the L<BosConfig(5)> man page for the syntax of this
  58 file.
  59
  60 The BOS Server will rewrite B<BosConfig> when shutting down, so changes
  61 made manually to it will be discarded.  Instead, to change the BOS Server
  62 configuration only for the next restart of B<bosserver>, create a file
  63 named F</usr/afs/local/BosConfig.new>.  If B<BosConfig.new> exists when
  64 B<bosserver> starts, it is renamed to F</usr/afs/local/BosConfig>,
  65 removing any existing file by that name, before B<bosserver> reads its
  66 configuration.
  67
  68 The BOS Server logs a default set of important events in the file
  69 F</usr/afs/logs/BosLog>. To record the name of any user who performs a
  70 privileged B<bos> command (one that requires being listed in the
  71 F</usr/afs/etc/UserList> file), add the B<-log> flag. To display the
  72 contents of the B<BosLog> file, use the B<bos getlog> command.
  73
  74 The first time that the BOS Server initializes on a server machine, it
  75 creates several files and subdirectories in the local F</usr/afs>
  76 directory, and sets their mode bits to protect them from unauthorized
  77 access. Each time it restarts, it checks that the mode bits still comply
  78 with the settings listed in the following chart. A question mark indicates
  79 that the BOS Server initially turns off the bit (sets it to the hyphen),
  80 but does not check it at restart.
  81
  82    /usr/afs              drwxr?xr-x
  83    /usr/afs/backup       drwx???---
  84    /usr/afs/bin          drwxr?xr-x
  85    /usr/afs/db           drwx???---
  86    /usr/afs/etc          drwxr?xr-x
  87    /usr/afs/etc/KeyFile  -rw????---
  88    /usr/afs/etc/UserList -rw?????--
  89    /usr/afs/local        drwx???---
  90    /usr/afs/logs         drwxr?xr-x
  91
  92 If the mode bits do not comply, the BOS Server writes the following
  93 warning to the F<BosLog> file:
  94
  95    Bosserver reports inappropriate access on server directories
  96
  97 However, the BOS Server does not reset the mode bits, so the administrator
  98 can set them to alternate values if desired (with the understanding that
  99 the warning message then appears at startup).
 100
 101 This command does not use the syntax conventions of the AFS command
 102 suites. Provide the command name and all option names in full.
 103
 104 =head1 OPTIONS
 105
 106 =over 4
 107
 108 =item B<-noauth>
 109
 110 Assigns the unprivileged identity C<anonymous> to the issuer, which is
 111 useful only when authorization checking is disabled on the server machine
 112 (for instance, during the installation of a file server machine.)
 113
 114 =item B<-log>
 115
 116 Records in the F</usr/afs/logs/BosLog> file the names of all users who
 117 successfully issue a privileged B<bos> command (one that requires being
 118 listed in the F</usr/afs/etc/UserList> file).
 119
 120 =item B<-auditlog> <I<log path>>
 121
 122 Turns on audit logging, and sets the path for the audit log.  The audit
 123 log records information about RPC calls, including the name of the RPC
 124 call, the host that submitted the call, the authenticated entity (user)
 125 that issued the call, the parameters for the call, and if the call
 126 succeeded or failed.
 127
 128 =item B<-audit-interface> (file | sysvmq)
 129
 130 Specifies what audit interface to use. Defaults to C<file>. See
 131 L<fileserver(8)> for an explanation of each interface.
 132
 133 =item B<-enable_peer_stats>
 134
 135 Activates the collection of Rx statistics and allocates memory for their
 136 storage. For each connection with a specific UDP port on another machine,
 137 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
 138 so on) sent or received. To display or otherwise access the records, use
 139 the Rx Monitoring API.
 140
 141 =item B<-enable_process_stats>
 142
 143 Activates the collection of Rx statistics and allocates memory for their
 144 storage. A separate record is kept for each type of RPC (FetchFile,
 145 GetStatus, and so on) sent or received, aggregated over all connections to
 146 other machines. To display or otherwise access the records, use the Rx
 147 Monitoring API.
 148
 149 =item B<-allow-dotted-principals>
 150
 151 By default, the RXKAD security layer will disallow access by Kerberos
 152 principals with a dot in the first component of their name. This is to avoid
 153 the confusion where principals user/admin and user.admin are both mapped to the
 154 user.admin PTS entry. Sites whose Kerberos realms don't have these collisions
 155 between principal names may disable this check by starting the server
 156 with this option.
 157
 158 =item B<-restricted>
 159
 160 In normal operation, the bos server allows a super user to run any command.
 161 When the bos server is running in restricted mode (either due to this
 162 command line flag, or when configured by L<bos_setrestricted(8)>) a number
 163 of commands are unavailable. Note that this flag persists across reboots.
 164 Once a server has been placed in restricted mode, it can only be opened up
 165 by sending the SIGFPE signal.
 166
 167 =item B<-help>
 168
 169 Prints the online help for this command. All other valid options are
 170 ignored.
 171
 172 =back
 173
 174 =head1 EXAMPLES
 175
 176 The following command initializes the BOS Server and logs the names of
 177 users who issue privileged B<bos> commands.
 178
 179    % bosserver -log &
 180
 181 =head1 PRIVILEGE REQUIRED
 182
 183 The issuer most be logged onto a file server machine as the local
 184 superuser C<root>.
 185
 186 =head1 SEE ALSO
 187
 188 L<BosConfig(5)>,
 189 L<BosLog(5)>,
 190 L<bos(8)>,
 191 L<bos_create(8)>,
 192 L<bos_exec(8)>,
 193 L<bos_getlog(8)>,
 194 L<bos_getrestart(8)>,
 195 L<bos_restart(8)>,
 196 L<bos_setrestricted(8)>,
 197 L<bos_shutdown(8)>,
 198 L<bos_start(8)>,
 199 L<bos_startup(8)>,
 200 L<bos_status(8)>,
 201 L<bos_stop(8)>
 202
 203 =head1 COPYRIGHT
 204
 205 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 206
 207 This documentation is covered by the IBM Public License Version 1.0.  It was
 208 converted from HTML to POD by software written by Chas Williams and Russ
 209 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.