doc/xml/AdminReference/sect8/backup_addhost.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="backup_addhost8">
   3   <refmeta>
   4     <refentrytitle>backup addhost</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>backup addhost</refname>
   9     <refpurpose>Adds a Tape Coordinator entry to the Backup Database</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">backup addhost</emphasis> <emphasis role="bold">-tapehost</emphasis> &lt;<emphasis>tape machine name</emphasis>&gt;
  14         [<emphasis role="bold">-portoffset</emphasis> &lt;<emphasis>TC port offset</emphasis>&gt;]
  15         [<emphasis role="bold">-localauth</emphasis>] [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-help</emphasis>]</para>
  16
  17     <para><emphasis role="bold">backup addh</emphasis> <emphasis role="bold">-t</emphasis> &lt;<emphasis>tape machine name</emphasis>&gt; [<emphasis role="bold">-p</emphasis> &lt;<emphasis>TC port offset</emphasis>&gt;]
  18         [<emphasis role="bold">-l</emphasis>] [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-h</emphasis>]</para>
  19
  20   </refsect1>
  21   <refsect1>
  22     <title>Description</title>
  23     <para>The <emphasis role="bold">backup addhost</emphasis> command creates a Tape Coordinator entry in the
  24     Backup Database. The entry records</para>
  25
  26     <itemizedlist>
  27       <listitem>
  28         <para>The host name of the Tape Coordinator machine where the Tape Coordinator
  29         (<emphasis role="bold">butc</emphasis>) process runs, as specified with the <emphasis role="bold">-tapehost</emphasis> argument.</para>
  30
  31       </listitem>
  32       <listitem>
  33         <para>The Tape Coordinator's port offset number, as specified with the
  34         <emphasis role="bold">-portoffset</emphasis> argument. An entry for the port offset must also appear in
  35         the <replaceable>/usr/afs/backup/tapeconfig</replaceable> file on the Tape Coordinator machine,
  36         where it is mapped to a UNIX device name (for a tape device) or pathname
  37         (for a backup data file).</para>
  38
  39       </listitem>
  40     </itemizedlist>
  41     <para>Each Tape Coordinator must have its own port offset number, and the
  42     command fails if a Backup Database entry already exists for the requested
  43     port offset number. To display existing Tape Coordinator entries, use the
  44     <emphasis role="bold">backup listhosts</emphasis> command.</para>
  45
  46   </refsect1>
  47   <refsect1>
  48     <title>Options</title>
  49     <variablelist>
  50       <varlistentry>
  51         <term><emphasis role="bold">-tapehost</emphasis> &lt;<emphasis>tape machine name</emphasis>&gt;</term>
  52         <listitem>
  53           <para>Specifies the fully-qualified hostname of the machine for which to create
  54           a Tape Coordinator entry in the Backup Database. The machine must have an
  55           entry in either the cell's naming service (such as the Domain Name
  56           Service) or the host file (<replaceable>/etc/hosts</replaceable> or equivalent) on the machine
  57           where the command is issued.</para>
  58
  59         </listitem>
  60       </varlistentry>
  61       <varlistentry>
  62         <term><emphasis role="bold">-portoffset</emphasis> &lt;<emphasis>TC port offset</emphasis>&gt;</term>
  63         <listitem>
  64           <para>Specifies the Tape Coordinator's port offset number. Provide an integer
  65           from the range <computeroutput>0</computeroutput> through <computeroutput>58510</computeroutput>, or omit this argument to use the
  66           default value of <computeroutput>0</computeroutput> (zero). The value must match the port offset number
  67           recorded for the same combination of Tape Coordinator and tape device or
  68           file in the <replaceable>/usr/afs/backup/tapeconfig</replaceable> file on the Tape Coordinator
  69           machine named by the <emphasis role="bold">-tapehost</emphasis> argument.</para>
  70
  71         </listitem>
  72       </varlistentry>
  73       <varlistentry>
  74         <term><emphasis role="bold">-localauth</emphasis></term>
  75         <listitem>
  76           <para>Constructs a server ticket using a key from the local
  77           <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">backup</emphasis> command interpreter presents
  78           it to the Backup Server, Volume Server and VL Server during mutual
  79           authentication. Do not combine this flag with the <emphasis role="bold">-cell</emphasis> argument. For
  80           more details, see <link linkend="backup8">backup(8)</link>.</para>
  81
  82         </listitem>
  83       </varlistentry>
  84       <varlistentry>
  85         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  86         <listitem>
  87           <para>Names the cell in which to run the command. Do not combine this argument
  88           with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="backup8">backup(8)</link>.</para>
  89
  90         </listitem>
  91       </varlistentry>
  92       <varlistentry>
  93         <term><emphasis role="bold">-help</emphasis></term>
  94         <listitem>
  95           <para>Prints the online help for this command. All other valid options are
  96           ignored.</para>
  97
  98         </listitem>
  99       </varlistentry>
 100     </variablelist>
 101   </refsect1>
 102   <refsect1>
 103     <title>Examples</title>
 104     <para>The following command creates an entry in the Backup Database that assigns
 105     port offset number 4 to a Tape Coordinator running on the machine
 106     <computeroutput>backup1.abc.com</computeroutput>:</para>
 107
 108 <programlisting>
 109    % backup addhost -tapehost backup1.abc.com -portoffset 4
 110
 111 </programlisting>
 112       <para>The following command creates a Backup Database entry that assigns port
 113       offset number 0 to a Tape Coordinator on the machine <computeroutput>backup3.abc.com</computeroutput>:</para>
 114
 115 <programlisting>
 116    % backup addhost backup3.abc.com
 117
 118 </programlisting>
 119       </refsect1>
 120       <refsect1>
 121         <title>Privilege Required</title>
 122         <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on every
 123         machine where the Backup Server is running, or must be logged onto a
 124         server machine as the local superuser <computeroutput>root</computeroutput> if the <emphasis role="bold">-localauth</emphasis> flag is
 125         included.</para>
 126
 127       </refsect1>
 128       <refsect1>
 129         <title>See Also</title>
 130         <para><link linkend="backup8">backup(8)</link>,
 131         <link linkend="backup_delhost8">backup_delhost(8)</link>,
 132         <link linkend="backup_listhosts8">backup_listhosts(8)</link></para>
 133
 134       </refsect1>
 135       <refsect1>
 136         <title>Copyright</title>
 137         <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 138
 139         <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 140         converted from HTML to POD by software written by Chas Williams and Russ
 141         Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 142
 143       </refsect1>
 144     </refentry>