doc/xml/AdminReference/sect8/buserver.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="buserver8">
   3   <refmeta>
   4     <refentrytitle>buserver</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>buserver</refname>
   9     <refpurpose>Initializes the Backup Server</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">buserver</emphasis> [<emphasis role="bold">-database</emphasis> &lt;<emphasis>database directory</emphasis>&gt;]
  14         [<emphasis role="bold">-cellservdb</emphasis> &lt;<emphasis>cell configuration directory</emphasis>&gt;] [<emphasis role="bold">-resetdb</emphasis>]
  15         [<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-smallht</emphasis>] [-servers &lt;<emphasis>list of ubik database servers</emphasis>&gt;+]
  16         [<emphasis role="bold">-enable_peer_stats</emphasis>]  [-enable_process_stats] [<emphasis role="bold">-help</emphasis>]</para>
  17
  18   </refsect1>
  19   <refsect1>
  20     <title>Description</title>
  21     <para>The <emphasis role="bold">buserver</emphasis> command initializes the Backup Server, which runs on
  22     database server machines and maintains the Backup Database. In the
  23     conventional configuration, the binary file is located in the
  24     <replaceable>/usr/afs/bin</replaceable> directory on a file server machine.</para>
  25
  26     <para>The <emphasis role="bold">buserver</emphasis> command is not normally issued at the command shell
  27     prompt, but rather placed into a database server machine's
  28     <replaceable>/usr/afs/local/BosConfig</replaceable> file with the <emphasis role="bold">bos create</emphasis> command. If it is
  29     ever issued at the command shell prompt, the issuer must be logged onto a
  30     file server machine as the local superuser <computeroutput>root</computeroutput>.</para>
  31
  32     <para>As it initializes, the Backup Server process creates the two files that
  33     constitute the Backup Database, <replaceable>bdb.DB0</replaceable> and <replaceable>bdb.DBSYS1</replaceable>, in the
  34     <replaceable>/usr/afs/db</replaceable> directory if they do not already exist. The Backup Database
  35     houses information about volume sets and entries, the dump hierarchy, Tape
  36     Coordinators, and previously performed dump sets. Use the commands in the
  37     <emphasis role="bold">backup</emphasis> suite to administer the database.</para>
  38
  39     <para>The Backup Server records a trace of its activity in the
  40     <replaceable>/usr/afs/logs/BackupLog</replaceable> file. Use the <emphasis role="bold">bos getlog</emphasis> command to display
  41     the contents of the file.</para>
  42
  43     <para>This command does not use the syntax conventions of the AFS command
  44     suites. Provide the command name and all option names in full.</para>
  45
  46   </refsect1>
  47   <refsect1>
  48     <title>Cautions</title>
  49     <para>The <emphasis role="bold">buserver</emphasis> process reserves port 7021 for its use. Unexpected
  50     behavior can occur if another process tries to reserve this port while the
  51     <emphasis role="bold">buserver</emphasis> process is running.</para>
  52
  53   </refsect1>
  54   <refsect1>
  55     <title>Options</title>
  56     <variablelist>
  57       <varlistentry>
  58         <term><emphasis role="bold">-database</emphasis> &lt;<emphasis>database directory</emphasis>&gt;</term>
  59         <listitem>
  60           <para>Specifies the pathname of an alternate directory for the Backup Database
  61           files, ending in a final slash (<computeroutput>/</computeroutput>). If this argument is not provided,
  62           the default is the <replaceable>/usr/afs/db</replaceable> directory.</para>
  63
  64         </listitem>
  65       </varlistentry>
  66       <varlistentry>
  67         <term><emphasis role="bold">-cellservdb</emphasis> &lt;<emphasis>cell configuration directory</emphasis>&gt;</term>
  68         <listitem>
  69           <para>Specifies the pathname of the directory from which the Backup Server reads
  70           in an alternate version of the <replaceable>CellServDB</replaceable> file. This argument is
  71           mandatory for correct functioning when the Backup Server is running on a
  72           subset of the cell's database server machines that is not a majority of
  73           the machines listed in the standard <replaceable>/usr/afs/etc/CellServDB</replaceable> file (which
  74           the Backup Server consults if this argument is not provided). It is not
  75           appropriate in any other circumstances.</para>
  76
  77         </listitem>
  78       </varlistentry>
  79       <varlistentry>
  80         <term><emphasis role="bold">-resetdb</emphasis></term>
  81         <listitem>
  82           <para>Removes all of the information in the Backup Database files in the
  83           <replaceable>/usr/afs/db</replaceable> directory, leaving zero-length versions of them.  The
  84           backup operator must recreate the configuration entries in the database
  85           (for volume sets, the dump hierarchy and so on) before performing backup
  86           operations.</para>
  87
  88         </listitem>
  89       </varlistentry>
  90       <varlistentry>
  91         <term><emphasis role="bold">-noauth</emphasis></term>
  92         <listitem>
  93           <para>Establishes an unauthenticated connection between the issuer and the
  94           Backup Server, in which the Backup Server treats the issuer as the
  95           unprivileged user <computeroutput>anonymous</computeroutput>. It is useful only when authorization
  96           checking is disabled on the database server machine. In normal
  97           circumstances, the Backup Server allows only authorized (privileged) users
  98           to issue commands that affect or contact the Backup Database, and refuses
  99           to perform such an action even if the <emphasis role="bold">-noauth</emphasis> flag is used.</para>
 100
 101         </listitem>
 102       </varlistentry>
 103       <varlistentry>
 104         <term><emphasis role="bold">-smallht</emphasis></term>
 105         <listitem>
 106           <para>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.</para>
 109
 110         </listitem>
 111       </varlistentry>
 112       <varlistentry>
 113         <term><emphasis role="bold">-servers</emphasis> &lt;<emphasis>list of ubik database servers</emphasis>&gt;+</term>
 114         <listitem>
 115           <para>Specifies the database server machines on which to start the Backup
 116           Server. Use this argument if running the Backup Server on a subset of the
 117           database server machines that is not a majority of the machines listed in
 118           the <replaceable>/usr/afs/etc/CellServDB</replaceable> file.</para>
 119
 120         </listitem>
 121       </varlistentry>
 122       <varlistentry>
 123         <term><emphasis role="bold">-enable_peer_stats</emphasis></term>
 124         <listitem>
 125           <para>Activates the collection of Rx statistics and allocates memory for their
 126           storage. For each connection with a specific UDP port on another machine,
 127           a separate record is kept for each type of RPC (FetchFile, GetStatus, and
 128           so on) sent or received. To display or otherwise access the records, use
 129           the Rx Monitoring API.</para>
 130
 131         </listitem>
 132       </varlistentry>
 133       <varlistentry>
 134         <term><emphasis role="bold">-enable_process_stats</emphasis></term>
 135         <listitem>
 136           <para>Activates the collection of Rx statistics and allocates memory for their
 137           storage. A separate record is kept for each type of RPC (FetchFile,
 138           GetStatus, and so on) sent or received, aggregated over all connections to
 139           other machines. To display or otherwise access the records, use the Rx
 140           Monitoring API.</para>
 141
 142         </listitem>
 143       </varlistentry>
 144       <varlistentry>
 145         <term><emphasis role="bold">-help</emphasis></term>
 146         <listitem>
 147           <para>Prints the online help for this command. All other valid options are
 148           ignored.</para>
 149
 150         </listitem>
 151       </varlistentry>
 152     </variablelist>
 153   </refsect1>
 154   <refsect1>
 155     <title>Examples</title>
 156     <para>The following example <emphasis role="bold">bos create</emphasis> command creates a <computeroutput>buserver</computeroutput> process
 157     on the file server machine <computeroutput>fs3.abc.com</computeroutput>. It appears here on two lines
 158     only for legibility.</para>
 159
 160 <programlisting>
 161    % bos create -server fs3.abc.com -instance buserver \
 162                 -type simple -cmd /usr/afs/bin/buserver
 163
 164 </programlisting>
 165     </refsect1>
 166     <refsect1>
 167       <title>Privilege Required</title>
 168       <para>The issuer must be logged in as the superuser <computeroutput>root</computeroutput> on a file server
 169       machine to issue the command at a command shell prompt. It is conventional
 170       instead to create and start the process by issuing the <emphasis role="bold">bos create</emphasis>
 171       command.</para>
 172
 173     </refsect1>
 174     <refsect1>
 175       <title>See Also</title>
 176       <para><link linkend="BackupLog5">BackupLog(5)</link>,
 177       <link linkend="BosConfig5">BosConfig(5)</link>,
 178       <link linkend="CellServDB5">CellServDB(5)</link>,
 179       <link linkend="bdb_DB05">bdb.DB0(5)</link>,
 180       <link linkend="backup8">backup(8)</link>,
 181       <link linkend="bos_create8">bos_create(8)</link>,
 182       <link linkend="bos_getlog8">bos_getlog(8)</link></para>
 183
 184     </refsect1>
 185     <refsect1>
 186       <title>Copyright</title>
 187       <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 188
 189       <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 190       converted from HTML to POD by software written by Chas Williams and Russ
 191       Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 192
 193     </refsect1>
 194   </refentry>