mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 15:30:14 +00:00
e3dfba8e6c
This is the initial conversion of the AFS Adminstrators Reference into POD for use as man pages. The man pages are now generated via pod2man from regen.sh so that only those working from CVS have to have pod2man available. The Makefile only installs. The pages have also been sorted out into pod1, pod5, and pod8 directories, making conversion to the right section of man page easier without maintaining a separate list and allowing for names to be duplicated between pod5 and pod1 or pod8 (which will likely be needed in a few cases). This reconversion is done with a new script based on work by Chas Williams. In some cases, the output is worse than the previous POD pages, but this is a more comprehensive conversion. This is only the first step, and this initial conversion has various problems. In addition, the file man pages that didn't have simple names have not been converted in this pass and will be added later. Some of the man pages have syntax problems and all of them have formatting errors. The next editing pass, coming shortly, will clean up most of the remaining mess.
161 lines
5.5 KiB
Plaintext
161 lines
5.5 KiB
Plaintext
=head1 NAME
|
|
|
|
buserver - Initializes the Backup Server
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<buserver> [-database <I<database directory>>]
|
|
[B<-cellservdb> <I<cell configuration directory>>]
|
|
[B<-resetdb>] [B<-noauth>] [-smallht]
|
|
[-servers <I<list of ubik database servers>>+]
|
|
[B<-enable_peer_stats>] [-enable_process_stats]
|
|
[-help]
|
|
|
|
This command does not use the syntax conventions of the AFS command
|
|
suites. Provide the command name and all option names in full.
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The buserver command initializes the Backup Server, which runs
|
|
on database server machines and maintains the Backup Database. In the
|
|
conventional configuration, the binary file is located in the
|
|
B</usr/afs/bin> directory on a file server machine.
|
|
|
|
The buserver command is not normally issued at the command shell
|
|
prompt, but rather placed into a database server machine's
|
|
B</usr/afs/local/BosConfig> file with the B<bos create>
|
|
command. If it is ever issued at the command shell prompt, the issuer
|
|
must be logged onto a file server machine as the local superuser
|
|
B<root>.
|
|
|
|
As it initializes, the Backup Server process creates the two files that
|
|
constitute the Backup Database, B<bdb.DB0> and
|
|
B<bdb.DBSYS1>, in the B</usr/afs/db> directory if they
|
|
do not already exist. The Backup Database houses information about
|
|
volume sets and entries, the dump hierarchy, Tape Coordinators, and previously
|
|
performed dump sets. Use the commands in the B<backup> suite to
|
|
administer the database.
|
|
|
|
The Backup Server records a trace of its activity in the
|
|
B</usr/afs/logs/BackupLog> file. Use the B<bos getlog>
|
|
command to display the contents of the file.
|
|
|
|
=head1 CAVEATS
|
|
|
|
The B<buserver> process reserves port 7021 for its
|
|
use. Unexpected behavior can occur if another process tries to reserve
|
|
this port while the B<buserver> process is running.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item -database
|
|
|
|
Specifies the pathname of an alternate directory for the Backup Database
|
|
files, ending in a final slash (B</>). If this argument is not
|
|
provided, the default is the B</usr/afs/db> directory.
|
|
|
|
=item -cellservdb
|
|
|
|
Specifies the pathname of the directory from which the Backup Server reads
|
|
in an alternate version of the B<CellServDB> file. This
|
|
argument is mandatory for correct functioning when the Backup Server is
|
|
running on a subset of the cell's database server machines that is not a
|
|
majority of the machines listed in the standard
|
|
B</usr/afs/etc/CellServDB> file (which the Backup Server consults if
|
|
this argument is not provided). It is not appropriate in any other
|
|
circumstances.
|
|
|
|
=item -resetdb
|
|
|
|
Removes all of the information in the Backup Database files in the
|
|
B</usr/afs/db> directory, leaving zero-length versions of them.
|
|
The backup operator must recreate the configuration entries in the database
|
|
(for volume sets, the dump hierarchy and so on) before performing backup
|
|
operations.
|
|
|
|
=item -noauth
|
|
|
|
Establishes an unauthenticated connection between the issuer and the
|
|
Backup Server, in which the Backup Server treats the issuer as the
|
|
unprivileged user B<anonymous>. It is useful only when
|
|
authorization checking is disabled on the database server machine. In
|
|
normal circumstances, the Backup Server allows only authorized (privileged)
|
|
users to issue commands that affect or contact the Backup Database, and
|
|
refuses to perform such an action even if the B<-noauth> flag is
|
|
used.
|
|
|
|
=item -smallht
|
|
|
|
Directs the Backup Server to use smaller internal hash tables for the
|
|
Backup Database, which reduces memory requirements but can make data access
|
|
take longer.
|
|
|
|
=item -servers
|
|
|
|
Specifies the database server machines on which to start the Backup
|
|
Server. Use this argument if running the Backup Server on a subset of
|
|
the database server machines that is not a majority of the machines listed in
|
|
the B</usr/afs/etc/CellServDB> file.
|
|
|
|
=item -enable_peer_stats
|
|
|
|
Activates the collection of Rx statistics and allocates memory for their
|
|
storage. For each connection with a specific UDP port on another
|
|
machine, a separate record is kept for each type of RPC (FetchFile, GetStatus,
|
|
and so on) sent or received. To display or otherwise access the
|
|
records, use the Rx Monitoring API.
|
|
|
|
=item -enable_process_stats
|
|
|
|
Activates the collection of Rx statistics and allocates memory for their
|
|
storage. A separate record is kept for each type of RPC (FetchFile,
|
|
GetStatus, and so on) sent or received, aggregated over all connections to
|
|
other machines. To display or otherwise access the records, use the Rx
|
|
Monitoring API.
|
|
|
|
=item -help
|
|
|
|
Prints the online help for this command. All other valid options
|
|
are ignored.
|
|
|
|
=back
|
|
|
|
=head1 EXAMPLES
|
|
|
|
The following example bos create command creates a
|
|
B<buserver> process on the file server machine
|
|
B<fs3.abc.com>. It appears here on two lines only
|
|
for legibility.
|
|
|
|
% bos create -server fs3.abc.com -instance buserver \
|
|
-type simple -cmd /usr/afs/bin/buserver
|
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
The issuer must be logged in as the superuser root on a file
|
|
server machine to issue the command at a command shell prompt. It is
|
|
conventional instead to create and start the process by issuing the B<bos
|
|
create> command.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<BackupLog(1)>,
|
|
L<BosConfig(1)>,
|
|
L<CellServDB (server version)(1)>
|
|
|
|
L<bdb.DB0 and bdb.DBSYS1(1)>
|
|
|
|
L<backup(1)>,
|
|
L<bos_create(1)>,
|
|
L<bos_getlog(1)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
|
|
|
|
This documentation is covered by the IBM Public License Version 1.0. It was
|
|
converted from HTML to POD by software written by Chas Williams and Russ
|
|
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.
|