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