doc/xml/AdminReference/sect8/backup_delhost.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="backup_delhost8">
   3   <refmeta>
   4     <refentrytitle>backup delhost</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>backup delhost</refname>
   9     <refpurpose>Deletes a Tape Coordinator entry from the Backup Database</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">backup delhost</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;] [<emphasis role="bold">-localauth</emphasis>]
  15         [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-help</emphasis>]</para>
  16
  17     <para><emphasis role="bold">backup delh</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 delhost</emphasis> command deletes the indicated Tape Coordinator entry
  24     from the Backup Database. It is then impossible to submit backup
  25     operations to that Tape Coordinator, even if it is still running. To keep
  26     configuration information consistent, also remove the corresponding entry
  27     from the <replaceable>/usr/afs/backup/tapeconfig</replaceable> file on the Tape Coordinator
  28     machine.</para>
  29
  30     <para>To list the Tape Coordinator machines and port offsets defined in the
  31     Backup Database, issue the <emphasis role="bold">backup listhosts</emphasis> command.</para>
  32
  33   </refsect1>
  34   <refsect1>
  35     <title>Options</title>
  36     <variablelist>
  37       <varlistentry>
  38         <term><emphasis role="bold">-tapehost</emphasis> &lt;<emphasis>tape machine name</emphasis>&gt;</term>
  39         <listitem>
  40           <para>Specifies the hostname of the machine housing the Tape Coordinator to
  41           delete.</para>
  42
  43         </listitem>
  44       </varlistentry>
  45       <varlistentry>
  46         <term><emphasis role="bold">-portoffset</emphasis> &lt;<emphasis>TC port offset</emphasis>&gt;</term>
  47         <listitem>
  48           <para>Specifies the port offset number of the Tape Coordinator to delete.  If
  49           omitted, it defaults to <computeroutput>0</computeroutput>. If provided, it is an integer between <computeroutput>0</computeroutput>
  50           (zero) and <computeroutput>58510</computeroutput>, and must match the port offset number assigned to the
  51           same combination of Tape Coordinator and tape device or file in the
  52           <replaceable>/usr/afs/backup/tapeconfig</replaceable> file on the Tape Coordinator machine
  53           indicated by the <emphasis role="bold">-tapehost</emphasis> argument.</para>
  54
  55         </listitem>
  56       </varlistentry>
  57       <varlistentry>
  58         <term><emphasis role="bold">-localauth</emphasis></term>
  59         <listitem>
  60           <para>Constructs a server ticket using a key from the local
  61           <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">backup</emphasis> command interpreter presents
  62           it to the Backup Server, Volume Server and VL Server during mutual
  63           authentication. Do not combine this flag with the <emphasis role="bold">-cell</emphasis> argument. For
  64           more details, see <link linkend="backup8">backup(8)</link>.</para>
  65
  66         </listitem>
  67       </varlistentry>
  68       <varlistentry>
  69         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  70         <listitem>
  71           <para>Names the cell in which to run the command. Do not combine this argument
  72           with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="backup8">backup(8)</link>.</para>
  73
  74         </listitem>
  75       </varlistentry>
  76       <varlistentry>
  77         <term><emphasis role="bold">-help</emphasis></term>
  78         <listitem>
  79           <para>Prints the online help for this command. All other valid options are
  80           ignored.</para>
  81
  82         </listitem>
  83       </varlistentry>
  84     </variablelist>
  85   </refsect1>
  86   <refsect1>
  87     <title>Examples</title>
  88     <para>The following command deletes the Backup Database entry for the Tape
  89     Coordinator with port offset 2 on the Tape Coordinator machine
  90     <computeroutput>backup3.abc.com</computeroutput>:</para>
  91
  92 <programlisting>
  93    % backup delhost -tapehost backup3.abc.com -portoffset 2
  94
  95 </programlisting>
  96     </refsect1>
  97     <refsect1>
  98       <title>Privilege Required</title>
  99       <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on every
 100       machine where the Backup Server is running, or must be logged onto a
 101       server machine as the local superuser <computeroutput>root</computeroutput> if the <emphasis role="bold">-localauth</emphasis> flag is
 102       included.</para>
 103
 104     </refsect1>
 105     <refsect1>
 106       <title>See Also</title>
 107       <para><link linkend="backup8">backup(8)</link>,
 108       <link linkend="backup_addhost8">backup_addhost(8)</link>,
 109       <link linkend="backup_listhosts8">backup_listhosts(8)</link></para>
 110
 111     </refsect1>
 112     <refsect1>
 113       <title>Copyright</title>
 114       <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 115
 116       <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 117       converted from HTML to POD by software written by Chas Williams and Russ
 118       Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 119
 120     </refsect1>
 121   </refentry>