doc/man-pages/pod8/buserver.pod

   1 =head1 NAME
   2
   3 buserver - Initializes the Backup Server
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<buserver> S<<< [B<-database> <I<database directory>>] >>>
  11     S<<< [B<-cellservdb> <I<cell configuration directory>>] >>> [B<-resetdb>]
  12     [B<-noauth>] [B<-smallht>] [-servers <I<list of ubik database servers>>+]
  13     [B<-enable_peer_stats>]  [-enable_process_stats] [B<-help>]
  14
  15 =for html
  16 </div>
  17
  18 =head1 DESCRIPTION
  19
  20 The B<buserver> command initializes the Backup Server, which runs on
  21 database server machines and maintains the Backup Database. In the
  22 conventional configuration, the binary file is located in the
  23 F</usr/afs/bin> directory on a file server machine.
  24
  25 The B<buserver> command is not normally issued at the command shell
  26 prompt, but rather placed into a database server machine's
  27 F</usr/afs/local/BosConfig> file with the B<bos create> command. If it is
  28 ever issued at the command shell prompt, the issuer must be logged onto a
  29 file server machine as the local superuser C<root>.
  30
  31 As it initializes, the Backup Server process creates the two files that
  32 constitute the Backup Database, F<bdb.DB0> and F<bdb.DBSYS1>, in the
  33 F</usr/afs/db> directory if they do not already exist. The Backup Database
  34 houses information about volume sets and entries, the dump hierarchy, Tape
  35 Coordinators, and previously performed dump sets. Use the commands in the
  36 B<backup> suite to administer the database.
  37
  38 The Backup Server records a trace of its activity in the
  39 F</usr/afs/logs/BackupLog> file. Use the B<bos getlog> command to display
  40 the contents of the file.
  41
  42 This command does not use the syntax conventions of the AFS command
  43 suites. Provide the command name and all option names in full.
  44
  45 =head1 CAUTIONS
  46
  47 The B<buserver> process reserves port 7021 for its use. Unexpected
  48 behavior can occur if another process tries to reserve this port while the
  49 B<buserver> process is running.
  50
  51 =head1 OPTIONS
  52
  53 =over 4
  54
  55 =item B<-database> <I<database directory>>
  56
  57 Specifies the pathname of an alternate directory for the Backup Database
  58 files, ending in a final slash (C</>). If this argument is not provided,
  59 the default is the F</usr/afs/db> directory.
  60
  61 =item B<-cellservdb> <I<cell configuration directory>>
  62
  63 Specifies the pathname of the directory from which the Backup Server reads
  64 in an alternate version of the F<CellServDB> file. This argument is
  65 mandatory for correct functioning when the Backup Server is running on a
  66 subset of the cell's database server machines that is not a majority of
  67 the machines listed in the standard F</usr/afs/etc/CellServDB> file (which
  68 the Backup Server consults if this argument is not provided). It is not
  69 appropriate in any other circumstances.
  70
  71 =item B<-resetdb>
  72
  73 Removes all of the information in the Backup Database files in the
  74 F</usr/afs/db> directory, leaving zero-length versions of them.  The
  75 backup operator must recreate the configuration entries in the database
  76 (for volume sets, the dump hierarchy and so on) before performing backup
  77 operations.
  78
  79 =item B<-noauth>
  80
  81 Establishes an unauthenticated connection between the issuer and the
  82 Backup Server, in which the Backup Server treats the issuer as the
  83 unprivileged user C<anonymous>. It is useful only when authorization
  84 checking is disabled on the database server machine. In normal
  85 circumstances, the Backup Server allows only authorized (privileged) users
  86 to issue commands that affect or contact the Backup Database, and refuses
  87 to perform such an action even if the B<-noauth> flag is used.
  88
  89 =item B<-smallht>
  90
  91 Directs the Backup Server to use smaller internal hash tables for the
  92 Backup Database, which reduces memory requirements but can make data
  93 access take longer.
  94
  95 =item B<-servers> <I<list of ubik database servers>>+
  96
  97 Specifies the database server machines on which to start the Backup
  98 Server. Use this argument if running the Backup Server on a subset of the
  99 database server machines that is not a majority of the machines listed in
 100 the F</usr/afs/etc/CellServDB> file.
 101
 102 =item B<-enable_peer_stats>
 103
 104 Activates the collection of Rx statistics and allocates memory for their
 105 storage. For each connection with a specific UDP port on another machine,
 106 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
 107 so on) sent or received. To display or otherwise access the records, use
 108 the Rx Monitoring API.
 109
 110 =item B<-enable_process_stats>
 111
 112 Activates the collection of Rx statistics and allocates memory for their
 113 storage. A separate record is kept for each type of RPC (FetchFile,
 114 GetStatus, and so on) sent or received, aggregated over all connections to
 115 other machines. To display or otherwise access the records, use the Rx
 116 Monitoring API.
 117
 118 =item B<-help>
 119
 120 Prints the online help for this command. All other valid options are
 121 ignored.
 122
 123 =back
 124
 125 =head1 EXAMPLES
 126
 127 The following example B<bos create> command creates a C<buserver> process
 128 on the file server machine C<fs3.abc.com>. It appears here on two lines
 129 only for legibility.
 130
 131    % bos create -server fs3.abc.com -instance buserver \
 132                 -type simple -cmd /usr/afs/bin/buserver
 133
 134 =head1 PRIVILEGE REQUIRED
 135
 136 The issuer must be logged in as the superuser C<root> on a file server
 137 machine to issue the command at a command shell prompt. It is conventional
 138 instead to create and start the process by issuing the B<bos create>
 139 command.
 140
 141 =head1 SEE ALSO
 142
 143 L<BackupLog(5)>,
 144 L<BosConfig(5)>,
 145 L<CellServDB(5)>,
 146 L<bdb.DB0(5)>,
 147 L<backup(8)>,
 148 L<bos_create(8)>,
 149 L<bos_getlog(8)>
 150
 151 =head1 COPYRIGHT
 152
 153 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 154
 155 This documentation is covered by the IBM Public License Version 1.0.  It was
 156 converted from HTML to POD by software written by Chas Williams and Russ
 157 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.