mirror of
https://git.openafs.org/openafs.git
synced 2025-01-20 07:51:00 +00:00
1cc8feb6fc
There were several different real and made-up hostnames and company names used throughout our documentation examples. The IETF has reserved "example.com" and other "example" TLDs for use in examples (RFC 2606). Replace almost all references to ABC Corporation, DEF Corporation, and State University, as well as "abc.com", "bigcell.com", "def.com", "def.gov", "ghi.com", "ghi.gov", "jkl.com", "mit.edu", "stanford.edu", "state.edu", "stateu.edu", "uncc.edu", and "xyz.com". Standardize on "Example Corporation", "Example Network", "Example Organization" (example.com, example.net, and example.org). The Scout documentation in the Admin Guide contains PNG images that contain the old cell names, so I left those references until the images can be replaced. Change-Id: I4e44815b2d2ffe204810b7fd850842248f67c367 Reviewed-on: http://gerrit.openafs.org/6697 Reviewed-by: Jeffrey Altman <jaltman@secure-endpoints.com> Tested-by: Jeffrey Altman <jaltman@secure-endpoints.com>
183 lines
6.6 KiB
Plaintext
183 lines
6.6 KiB
Plaintext
=head1 NAME
|
|
|
|
buserver - Initializes the Backup Server
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
=for html
|
|
<div class="synopsis">
|
|
|
|
B<buserver> S<<< [B<-database> <I<database directory>>] >>>
|
|
S<<< [B<-auditlog> <I<log path>>] >>> [B<-audit-interface> (file | sysvmq)]
|
|
S<<< [B<-cellservdb> <I<cell configuration directory>>] >>> [B<-resetdb>]
|
|
[B<-noauth>] [B<-smallht>] [B<-servers> <I<list of ubik database servers>>+]
|
|
[B<-enable_peer_stats>] [B<-enable_process_stats>] [B<-rxbind>]
|
|
[B<-p> <I<number of threads>>] [B<-help>]
|
|
|
|
=for html
|
|
</div>
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<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
|
|
F</usr/afs/bin> directory on a file server machine.
|
|
|
|
The B<buserver> command is not normally issued at the command shell
|
|
prompt, but rather placed into a database server machine's
|
|
F</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 C<root>.
|
|
|
|
As it initializes, the Backup Server process creates the two files that
|
|
constitute the Backup Database, F<bdb.DB0> and F<bdb.DBSYS1>, in the
|
|
F</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
|
|
F</usr/afs/logs/BackupLog> file. Use the B<bos getlog> command to display
|
|
the contents of the file.
|
|
|
|
This command does not use the syntax conventions of the AFS command
|
|
suites. Provide the command name and all option names in full.
|
|
|
|
=head1 CAUTIONS
|
|
|
|
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 B<-database> <I<database directory>>
|
|
|
|
Specifies the pathname of an alternate directory for the Backup Database
|
|
files, ending in a final slash (C</>). If this argument is not provided,
|
|
the default is the F</usr/afs/db> directory.
|
|
|
|
=item B<-auditlog> <I<log path>>
|
|
|
|
Turns on audit logging, and sets the path for the audit log. The audit
|
|
log records information about RPC calls, including the name of the RPC
|
|
call, the host that submitted the call, the authenticated entity (user)
|
|
that issued the call, the parameters for the call, and if the call
|
|
succeeded or failed.
|
|
|
|
=item B<-audit-interface> (file | sysvmq)
|
|
|
|
Specifies what audit interface to use. Defaults to C<file>. See
|
|
L<fileserver(8)> for an explanation of each interface.
|
|
|
|
=item B<-cellservdb> <I<cell configuration directory>>
|
|
|
|
Specifies the pathname of the directory from which the Backup Server reads
|
|
in an alternate version of the F<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 F</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 B<-resetdb>
|
|
|
|
Removes all of the information in the Backup Database files in the
|
|
F</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 B<-noauth>
|
|
|
|
Establishes an unauthenticated connection between the issuer and the
|
|
Backup Server, in which the Backup Server treats the issuer as the
|
|
unprivileged user C<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 B<-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 B<-servers> <I<list of ubik database 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 F</usr/afs/etc/CellServDB> file.
|
|
|
|
=item B<-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 B<-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 B<-rxbind>
|
|
|
|
Bind the Rx socket to the primary interface only. (If not specified, the
|
|
Rx socket will listen on all interfaces.)
|
|
|
|
=item B<-p> <I<number of threads>>
|
|
|
|
Sets the number of server lightweight processes (LWPs or pthreads) to run.
|
|
Provide a positive integer from the range 3 to 16. The default value is 3.
|
|
|
|
=item B<-help>
|
|
|
|
Prints the online help for this command. All other valid options are
|
|
ignored.
|
|
|
|
=back
|
|
|
|
=head1 EXAMPLES
|
|
|
|
The following example B<bos create> command creates a C<buserver> process
|
|
on the file server machine C<fs3.example.com>. It appears here on two lines
|
|
only for legibility.
|
|
|
|
% bos create -server fs3.example.com -instance buserver \
|
|
-type simple -cmd /usr/afs/bin/buserver
|
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
The issuer must be logged in as the superuser C<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(5)>,
|
|
L<BosConfig(5)>,
|
|
L<CellServDB(5)>,
|
|
L<bdb.DB0(5)>,
|
|
L<backup(8)>,
|
|
L<bos_create(8)>,
|
|
L<bos_getlog(8)>
|
|
|
|
=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.
|