doc/man-pages/pod8/bosserver.pod

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