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