fix-fs-error-string-printing-20010623
[openafs.git] / doc / html / AdminReference / auarf125.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf124.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf126.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
17 <P>
18 <H2><A NAME="HDRBUSERVER" HREF="auarf002.htm#ToC_139">buserver</A></H2>
19 <A NAME="IDX4685"></A>
20 <A NAME="IDX4686"></A>
21 <A NAME="IDX4687"></A>
22 <A NAME="IDX4688"></A>
23 <A NAME="IDX4689"></A>
24 <A NAME="IDX4690"></A>
25 <P><STRONG>Purpose</STRONG>
26 <P>Initializes the Backup Server
27 <P><STRONG>Synopsis</STRONG>
28 <PRE><B>buserver</B> [<B>-database</B> &lt;<VAR>database&nbsp;directory</VAR>>] 
29          [<B>-cellservdb</B> &lt;<VAR>cell&nbsp;configuration&nbsp;directory</VAR>>]
30          [<B>-resetdb</B>]  [<B>-noauth</B>]  [<B>-smallht</B>] 
31          [<B>-servers</B> &lt;<VAR>list&nbsp;of&nbsp;ubik&nbsp;database&nbsp;servers</VAR>><SUP>+</SUP>]  
32          [<B>-enable_peer_stats</B>]  [<B>-enable_process_stats</B>] 
33          [<B>-help</B>]
34 </PRE>
35 <P>This command does not use the syntax conventions of the AFS command
36 suites. Provide the command name and all option names in full.
37 <P><STRONG>Description</STRONG>
38 <P>The <B>buserver</B> command initializes the Backup Server, which runs
39 on database server machines and maintains the Backup Database. In the
40 conventional configuration, the binary file is located in the
41 <B>/usr/afs/bin</B> directory on a file server machine.
42 <P>The <B>buserver</B> command is not normally issued at the command shell
43 prompt, but rather placed into a database server machine's
44 <B>/usr/afs/local/BosConfig</B> file with the <B>bos create</B>
45 command. If it is ever issued at the command shell prompt, the issuer
46 must be logged onto a file server machine as the local superuser
47 <B>root</B>.
48 <P>As it initializes, the Backup Server process creates the two files that
49 constitute the Backup Database, <B>bdb.DB0</B> and
50 <B>bdb.DBSYS1</B>, in the <B>/usr/afs/db</B> directory if they
51 do not already exist. The Backup Database houses information about
52 volume sets and entries, the dump hierarchy, Tape Coordinators, and previously
53 performed dump sets. Use the commands in the <B>backup</B> suite to
54 administer the database.
55 <P>The Backup Server records a trace of its activity in the
56 <B>/usr/afs/logs/BackupLog</B> file. Use the <B>bos getlog</B>
57 command to display the contents of the file.
58 <P><STRONG>Cautions</STRONG>
59 <P>The <B>buserver</B> process reserves port <B>7021</B> for its
60 use. Unexpected behavior can occur if another process tries to reserve
61 this port while the <B>buserver</B> process is running.
62 <P><STRONG>Options</STRONG>
63 <DL>
64 <P><DT><B>-database
65 </B><DD>Specifies the pathname of an alternate directory for the Backup Database
66 files, ending in a final slash (<B>/</B>). If this argument is not
67 provided, the default is the <B>/usr/afs/db</B> directory.
68 <P><DT><B>-cellservdb
69 </B><DD>Specifies the pathname of the directory from which the Backup Server reads
70 in an alternate version of the <B>CellServDB</B> file. This
71 argument is mandatory for correct functioning when the Backup Server is
72 running on a subset of the cell's database server machines that is not a
73 majority of the machines listed in the standard
74 <B>/usr/afs/etc/CellServDB</B> file (which the Backup Server consults if
75 this argument is not provided). It is not appropriate in any other
76 circumstances.
77 <P><DT><B>-resetdb
78 </B><DD>Removes all of the information in the Backup Database files in the
79 <B>/usr/afs/db</B> directory, leaving zero-length versions of them.
80 The backup operator must recreate the configuration entries in the database
81 (for volume sets, the dump hierarchy and so on) before performing backup
82 operations.
83 <P><DT><B>-noauth
84 </B><DD>Establishes an unauthenticated connection between the issuer and the
85 Backup Server, in which the Backup Server treats the issuer as the
86 unprivileged user <B>anonymous</B>. It is useful only when
87 authorization checking is disabled on the database server machine. In
88 normal circumstances, the Backup Server allows only authorized (privileged)
89 users to issue commands that affect or contact the Backup Database, and
90 refuses to perform such an action even if the <B>-noauth</B> flag is
91 used.
92 <P><DT><B>-smallht
93 </B><DD>Directs the Backup Server to use smaller internal hash tables for the
94 Backup Database, which reduces memory requirements but can make data access
95 take longer.
96 <P><DT><B>-servers
97 </B><DD>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</B> file.
101 <P><DT><B>-enable_peer_stats
102 </B><DD>Activates the collection of Rx statistics and allocates memory for their
103 storage. For each connection with a specific UDP port on another
104 machine, a separate record is kept for each type of RPC (FetchFile, GetStatus,
105 and so on) sent or received. To display or otherwise access the
106 records, use the Rx Monitoring API.
107 <P><DT><B>-enable_process_stats
108 </B><DD>Activates the collection of Rx statistics and allocates memory for their
109 storage. A separate record is kept for each type of RPC (FetchFile,
110 GetStatus, and so on) sent or received, aggregated over all connections to
111 other machines. To display or otherwise access the records, use the Rx
112 Monitoring API.
113 <P><DT><B>-help
114 </B><DD>Prints the online help for this command. All other valid options
115 are ignored.
116 </DL>
117 <P><STRONG>Examples</STRONG>
118 <P>The following example <B>bos create</B> command creates a
119 <B>buserver</B> process on the file server machine
120 <B>fs3.abc.com</B>. It appears here on two lines only
121 for legibility.
122 <PRE>   % <B>bos create -server fs3.abc.com -instance buserver</B>  \
123                 <B>-type simple -cmd /usr/afs/bin/buserver</B>
124    
125 </PRE>
126 <P><STRONG>Privilege Required</STRONG>
127 <P>The issuer must be logged in as the superuser <B>root</B> on a file
128 server machine to issue the command at a command shell prompt. It is
129 conventional instead to create and start the process by issuing the <B>bos
130 create</B> command.
131 <P><STRONG>Related Information</STRONG>
132 <P><A HREF="auarf014.htm#HDRBACKUPLOG">BackupLog</A>
133 <P><A HREF="auarf016.htm#HDRBOSCONFIG">BosConfig</A>
134 <P><A HREF="auarf020.htm#HDRSV_CSDB">CellServDB (server version)</A>
135 <P><A HREF="auarf042.htm#HDRBDBDB">bdb.DB0 and bdb.DBSYS1</A>
136 <P><A HREF="auarf060.htm#HDRBK_INTRO">backup</A>
137 <P><A HREF="auarf098.htm#HDRBOS_CREATE">bos create</A>
138 <P><A HREF="auarf102.htm#HDRBOS_GETLOG">bos getlog</A>
139 <P>
140 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf124.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf126.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
141 <!-- Begin Footer Records  ========================================== -->
142 <P><HR><B> 
143 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
144 </B> 
145 <!-- End Footer Records  ============================================ -->
146 <A NAME="Bot_Of_Page"></A>
147 </BODY></HTML>