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>] [B<-help>]
  13
  14 =for html
  15 </div>
  16
  17 =head1 DESCRIPTION
  18
  19 The bosserver command initializes the Basic OverSeer (BOS) Server
  20 (B<bosserver> process). In the conventional configuration, the binary file
  21 is located in the F</usr/afs/bin> directory on a file server machine.
  22
  23 The BOS Server must run on every file server machine and helps to automate
  24 file server administration by performing the following tasks:
  25
  26 =over 4
  27
  28 =item *
  29
  30 Monitors the other AFS server processes on the local machine, to make sure
  31 they are running correctly.
  32
  33 =item *
  34
  35 Automatically restarts failed processes, without contacting a human
  36 operator. When restarting multiple server processes simultaneously, the
  37 BOS Server takes interdependencies into account and initiates restarts in
  38 the correct order.
  39
  40 =item *
  41
  42 Processes commands from the bos suite that administrators issue to verify
  43 the status of server processes, install and start new processes, stop
  44 processes either temporarily or permanently, and restart halted processes.
  45
  46 =item *
  47
  48 Manages system configuration information: the files that list the cell's
  49 server encryption keys, database server machines, and users privileged to
  50 issue commands from the B<bos> and B<vos> suites.
  51
  52 =back
  53
  54 The BOS Server logs a default set of important events in the file
  55 F</usr/afs/logs/BosLog>. To record the name of any user who performs a
  56 privileged B<bos> command (one that requires being listed in the
  57 F</usr/afs/etc/UserList> file), add the B<-log> flag. To display the
  58 contents of the B<BosLog> file, use the B<bos getlog> command.
  59
  60 The first time that the BOS Server initializes on a server machine, it
  61 creates several files and subdirectories in the local F</usr/afs>
  62 directory, and sets their mode bits to protect them from unauthorized
  63 access. Each time it restarts, it checks that the mode bits still comply
  64 with the settings listed in the following chart. A question mark indicates
  65 that the BOS Server initially turns off the bit (sets it to the hyphen),
  66 but does not check it at restart.
  67
  68 If the mode bits do not comply, the BOS Server writes the following
  69 warning to the F<BosLog> file:
  70
  71    Bosserver reports inappropriate access on server directories
  72
  73 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).
  76
  77 This command does not use the syntax conventions of the AFS command
  78 suites. Provide the command name and all option names in full.
  79
  80 =head1 OPTIONS
  81
  82 =over 4
  83
  84 =item B<-noauth>
  85
  86 Assigns the unprivileged identity C<anonymous> to the issuer, which is
  87 useful only when authorization checking is disabled on the server machine
  88 (for instance, during the installation of a file server machine.)
  89
  90 =item B<-log>
  91
  92 Records in the F</usr/afs/logs/BosLog> file the names of all users who
  93 successfully issue a privileged B<bos> command (one that requires being
  94 listed in the F</usr/afs/etc/UserList> file).
  95
  96 =item B<-auditlog> <I<log path>>
  97
  98 Turns on audit logging, and sets the path for the audit log.
  99
 100 =item B<-audit-interface> (file | sysvmq)
 101
 102 Specifies what audit interface to use. Defaults to C<file>. See
 103 L<fileserver(8)> for an explanation of each interface.
 104
 105 =item B<-enable_peer_stats>
 106
 107 Activates the collection of Rx statistics and allocates memory for their
 108 storage. For each connection with a specific UDP port on another machine,
 109 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
 110 so on) sent or received. To display or otherwise access the records, use
 111 the Rx Monitoring API.
 112
 113 =item B<-enable_process_stats>
 114
 115 Activates the collection of Rx statistics and allocates memory for their
 116 storage. A separate record is kept for each type of RPC (FetchFile,
 117 GetStatus, and so on) sent or received, aggregated over all connections to
 118 other machines. To display or otherwise access the records, use the Rx
 119 Monitoring API.
 120
 121 =item B<-allow-dotted-principals>
 122
 123 By default, the RXKAD security layer will disallow access by Kerberos
 124 principals with a dot in the first component of their name. This is to avoid
 125 the confusion where principals user/admin and user.admin are both mapped to the
 126 user.admin PTS entry. Sites whose Kerberos realms don't have these collisions
 127 between principal names may disable this check by starting the server
 128 with this option.
 129
 130 =item B<-help>
 131
 132 Prints the online help for this command. All other valid options are
 133 ignored.
 134
 135 =back
 136
 137 =head1 EXAMPLES
 138
 139 The following command initializes the BOS Server and logs the names of
 140 users who issue privileged B<bos> commands.
 141
 142    % bosserver -log &
 143
 144 =head1 PRIVILEGE REQUIRED
 145
 146 The issuer most be logged onto a file server machine as the local
 147 superuser C<root>.
 148
 149 =head1 SEE ALSO
 150
 151 L<BosConfig(5)>,
 152 L<BosLog(5)>,
 153 L<bos(8)>,
 154 L<bos_create(8)>,
 155 L<bos_exec(8)>,
 156 L<bos_getlog(8)>,
 157 L<bos_getrestart(8)>,
 158 L<bos_restart(8)>,
 159 L<bos_shutdown(8)>,
 160 L<bos_start(8)>,
 161 L<bos_startup(8)>,
 162 L<bos_status(8)>,
 163 L<bos_stop(8)>
 164
 165 =head1 COPYRIGHT
 166
 167 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 168
 169 This documentation is covered by the IBM Public License Version 1.0.  It was
 170 converted from HTML to POD by software written by Chas Williams and Russ
 171 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.