doc/xml/AdminReference/sect8/backup_status.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="backup_status8">
   3   <refmeta>
   4     <refentrytitle>backup status</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>backup status</refname>
   9     <refpurpose>Reports a Tape Coordinator's status</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">backup status</emphasis> [<emphasis role="bold">-portoffset</emphasis> &lt;<emphasis>TC port offset</emphasis>&gt;] [<emphasis role="bold">-localauth</emphasis>]
  14         [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-help</emphasis>]</para>
  15
  16     <para><emphasis role="bold">backup st</emphasis> [<emphasis role="bold">-p</emphasis> &lt;<emphasis>TC port offset</emphasis>&gt;] [<emphasis role="bold">-l</emphasis>] [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;]
  17         [<emphasis role="bold">-h</emphasis>]</para>
  18
  19   </refsect1>
  20   <refsect1>
  21     <title>Description</title>
  22     <para>The <emphasis role="bold">backup status</emphasis> command displays which operation, if any, the
  23     indicated Tape Coordinator is currently executing.</para>
  24
  25   </refsect1>
  26   <refsect1>
  27     <title>Options</title>
  28     <variablelist>
  29       <varlistentry>
  30         <term><emphasis role="bold">-portoffset</emphasis> &lt;<emphasis>TC port offset</emphasis>&gt;</term>
  31         <listitem>
  32           <para>Specifies the port offset number of the Tape Coordinator for which to
  33           report the status.</para>
  34
  35         </listitem>
  36       </varlistentry>
  37       <varlistentry>
  38         <term><emphasis role="bold">-localauth</emphasis></term>
  39         <listitem>
  40           <para>Constructs a server ticket using a key from the local
  41           <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">backup</emphasis> command interpreter presents
  42           it to the Backup Server, Volume Server and VL Server during mutual
  43           authentication. Do not combine this flag with the <emphasis role="bold">-cell</emphasis> argument. For
  44           more details, see <link linkend="backup8">backup(8)</link>.</para>
  45
  46         </listitem>
  47       </varlistentry>
  48       <varlistentry>
  49         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  50         <listitem>
  51           <para>Names the cell in which to run the command. Do not combine this argument
  52           with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="backup8">backup(8)</link>.</para>
  53
  54         </listitem>
  55       </varlistentry>
  56       <varlistentry>
  57         <term><emphasis role="bold">-help</emphasis></term>
  58         <listitem>
  59           <para>Prints the online help for this command. All other valid options are
  60           ignored.</para>
  61
  62         </listitem>
  63       </varlistentry>
  64     </variablelist>
  65   </refsect1>
  66   <refsect1>
  67     <title>Output</title>
  68     <para>The following message indicates that the Tape Coordinator is not currently
  69     performing an operation:</para>
  70
  71 <programlisting>
  72    Tape coordinator is idle
  73
  74 </programlisting>
  75       <para>Otherwise, the output includes a message of the following format for each
  76       running or pending operation:</para>
  77
  78 <programlisting>
  79    Task &amp;lt;task_ID&amp;gt;:  &amp;lt;operation&amp;gt;:   &amp;lt;status&amp;gt;
  80
  81 </programlisting>
  82         <para>where</para>
  83
  84         <variablelist>
  85           <varlistentry>
  86             <term>&lt;task_ID&gt;</term>
  87             <listitem>
  88               <para>Is a task identification number assigned by the Tape Coordinator.  It
  89               begins with the Tape Coordinator's port offset number.</para>
  90
  91             </listitem>
  92           </varlistentry>
  93           <varlistentry>
  94             <term>&lt;operation&gt;</term>
  95             <listitem>
  96               <para>Identifies the operation the Tape Coordinator is performing, which is
  97               initiated by the indicated command:</para>
  98
  99               <variablelist>
 100                 <varlistentry>
 101                   <term>Dump</term>
 102                   <listitem>
 103                     <para>The <emphasis role="bold">backup dump</emphasis> command.</para>
 104
 105                   </listitem>
 106                 </varlistentry>
 107                 <varlistentry>
 108                   <term>Restore</term>
 109                   <listitem>
 110                     <para>The <emphasis role="bold">backup diskrestore</emphasis>, <emphasis role="bold">backup volrestore</emphasis>, or <emphasis role="bold">backup
 111                     volsetrestore</emphasis> commands.</para>
 112
 113                   </listitem>
 114                 </varlistentry>
 115                 <varlistentry>
 116                   <term>Labeltape</term>
 117                   <listitem>
 118                     <para>The <emphasis role="bold">backup labeltape</emphasis> command.</para>
 119
 120                   </listitem>
 121                 </varlistentry>
 122                 <varlistentry>
 123                   <term>Scantape</term>
 124                   <listitem>
 125                     <para>The <emphasis role="bold">backup scantape</emphasis> command.</para>
 126
 127                   </listitem>
 128                 </varlistentry>
 129                 <varlistentry>
 130                   <term>SaveDb</term>
 131                   <listitem>
 132                     <para>The <emphasis role="bold">backup savedb</emphasis> command.</para>
 133
 134                   </listitem>
 135                 </varlistentry>
 136                 <varlistentry>
 137                   <term>RestoreDb</term>
 138                   <listitem>
 139                     <para>The <emphasis role="bold">backup restoredb</emphasis> command.</para>
 140
 141                   </listitem>
 142                 </varlistentry>
 143               </variablelist>
 144             </listitem>
 145           </varlistentry>
 146           <varlistentry>
 147             <term>&lt;status&gt;</term>
 148             <listitem>
 149               <para>Indicates the job's current status in one of the following messages.</para>
 150
 151               <variablelist>
 152                 <varlistentry>
 153                   <term><emphasis>number</emphasis> Kbytes transferred, volume <emphasis>volume_name</emphasis></term>
 154                   <listitem>
 155                     <para>For a running dump operation, indicates the number of kilobytes copied to
 156                     tape or a backup data file so far, and the volume currently being dumped.</para>
 157
 158                   </listitem>
 159                 </varlistentry>
 160                 <varlistentry>
 161                   <term><emphasis>number</emphasis> Kbytes, restore.volume</term>
 162                   <listitem>
 163                     <para>For a running restore operation, indicates the number of kilobytes copied
 164                     into AFS from a tape or a backup data file so far.</para>
 165
 166                   </listitem>
 167                 </varlistentry>
 168                 <varlistentry>
 169                   <term>[abort requested]</term>
 170                   <listitem>
 171                     <para>The <emphasis role="bold">backup kill</emphasis> command was issued, but the termination signal has yet
 172                     to reach the Tape Coordinator.</para>
 173
 174                   </listitem>
 175                 </varlistentry>
 176                 <varlistentry>
 177                   <term>[abort sent]</term>
 178                   <listitem>
 179                     <para>The operation is canceled by the <emphasis role="bold">backup kill</emphasis> command.  Once the Backup
 180                     System removes an operation from the queue or stops it from running, it no
 181                     longer appears at all in the output from the command.</para>
 182
 183                   </listitem>
 184                 </varlistentry>
 185                 <varlistentry>
 186                   <term>[butc contact lost]</term>
 187                   <listitem>
 188                     <para>The <emphasis role="bold">backup</emphasis> command interpreter cannot reach the Tape Coordinator. The
 189                     message can mean either that the Tape Coordinator handling the operation
 190                     was terminated or failed while the operation was running, or that the
 191                     connection to the Tape Coordinator timed out.</para>
 192
 193                   </listitem>
 194                 </varlistentry>
 195                 <varlistentry>
 196                   <term>[done]</term>
 197                   <listitem>
 198                     <para>The Tape Coordinator has finished the operation.</para>
 199
 200                   </listitem>
 201                 </varlistentry>
 202                 <varlistentry>
 203                   <term>[drive wait]</term>
 204                   <listitem>
 205                     <para>The operation is waiting for the specified tape drive to become free.</para>
 206
 207                   </listitem>
 208                 </varlistentry>
 209                 <varlistentry>
 210                   <term>[operator wait]</term>
 211                   <listitem>
 212                     <para>The Tape Coordinator is waiting for the backup operator to insert a tape
 213                     in the drive.</para>
 214
 215                   </listitem>
 216                 </varlistentry>
 217               </variablelist>
 218             </listitem>
 219           </varlistentry>
 220         </variablelist>
 221         <para>If the Tape Coordinator is communicating with an XBSA server (a
 222         third-party backup utility that implements the Open Group's Backup Service
 223         API [XBSA]), the following message appears last in the output:</para>
 224
 225 <programlisting>
 226    &amp;lt;XBSA_program&amp;gt; Tape coordinator
 227
 228 </programlisting>
 229           <para>where &lt;XBSA_program&gt; is the name of the XBSA-compliant program.</para>
 230
 231         </refsect1>
 232         <refsect1>
 233           <title>Examples</title>
 234           <para>The following example shows that the Tape Coordinator with port offset 4
 235           has so far dumped about 1.5 MB of data for the current dump operation, and
 236           is currently dumping the volume named <computeroutput>user.pat.backup</computeroutput>:</para>
 237
 238 <programlisting>
 239    % backup status -portoffset 4
 240    Task 4001:  Dump:   1520 Kbytes transferred,  volume user.pat.backup
 241
 242 </programlisting>
 243           </refsect1>
 244           <refsect1>
 245             <title>Privilege Required</title>
 246             <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on every
 247             machine where the Backup Server is running, or must be logged onto a
 248             server machine as the local superuser <computeroutput>root</computeroutput> if the <emphasis role="bold">-localauth</emphasis> flag is
 249             included.</para>
 250
 251           </refsect1>
 252           <refsect1>
 253             <title>See Also</title>
 254             <para><link linkend="backup8">backup(8)</link>,
 255             <link linkend="butc8">butc(8)</link></para>
 256
 257           </refsect1>
 258           <refsect1>
 259             <title>Copyright</title>
 260             <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 261
 262             <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 263             converted from HTML to POD by software written by Chas Williams and Russ
 264             Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 265
 266           </refsect1>
 267         </refentry>