doc/man-pages/pod8/buserver.pod

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