doc/xml/AdminReference/sect8/backup_jobs.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="backup_jobs8">
   3   <refmeta>
   4     <refentrytitle>backup jobs</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>backup jobs</refname>
   9     <refpurpose>Lists pending and running operations in interactive mode</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">jobs</emphasis> [<emphasis role="bold">-help</emphasis>]</para>
  14
  15     <para><emphasis role="bold">j</emphasis> [<emphasis role="bold">-h</emphasis>]</para>
  16
  17   </refsect1>
  18   <refsect1>
  19     <title>Description</title>
  20     <para>The <emphasis role="bold">backup jobs</emphasis> command lists the job ID number and status of each
  21     <emphasis role="bold">backup</emphasis> operation running or pending in the current interactive session.</para>
  22
  23     <para>This command can be issued in interactive mode only. If the issuer of the
  24     <emphasis role="bold">backup interactive</emphasis> command included the <emphasis role="bold">-localauth</emphasis> flag, the
  25     <emphasis role="bold">-cell</emphasis> argument, or both, those settings apply to this command also.</para>
  26
  27     <para>To terminate operations that appear in the output, issue the <emphasis role="bold">backup
  28     kill</emphasis> command and identify the operation to cancel with the job ID number
  29     from this command's output.</para>
  30
  31     <para>To check the status of a Tape Coordinator, rather than of a certain
  32     operation, use the <emphasis role="bold">backup status</emphasis> command.</para>
  33
  34   </refsect1>
  35   <refsect1>
  36     <title>Options</title>
  37     <variablelist>
  38       <varlistentry>
  39         <term><emphasis role="bold">-help</emphasis></term>
  40         <listitem>
  41           <para>Prints the online help for this command. All other valid options are
  42           ignored.</para>
  43
  44         </listitem>
  45       </varlistentry>
  46     </variablelist>
  47   </refsect1>
  48   <refsect1>
  49     <title>Output</title>
  50     <para>The output always includes the expiration date and time of the tokens that
  51     the <emphasis role="bold">backup</emphasis> command interpreter is using during the current interactive
  52     session, in the following format:</para>
  53
  54 <programlisting>
  55    &amp;lt;date&amp;gt;   &amp;lt;time&amp;gt;: TOKEN EXPIRATION
  56
  57 </programlisting>
  58       <para>If the execution date and time specified for a scheduled dump operation is
  59       later than &lt;date time&gt;, then its individual line (as described in the
  60       following paragraphs) appears below this line to indicate that the current
  61       tokens will not be available to it.</para>
  62
  63       <para>If the issuer of the backup command included the <emphasis role="bold">-localauth</emphasis> flag when
  64       entering interactive mode, the line instead reads as follows:</para>
  65
  66 <programlisting>
  67    :  TOKEN NEVER EXPIRES
  68
  69 </programlisting>
  70         <para>The entry for a scheduled dump operation has the following format:</para>
  71
  72 <programlisting>
  73    Job &amp;lt;job_ID&amp;gt;:  &amp;lt;timestamp&amp;gt;:  dump  &amp;lt;volume_set&amp;gt;  &amp;lt;dump_level&amp;gt;
  74
  75 </programlisting>
  76           <para>where</para>
  77
  78           <variablelist>
  79             <varlistentry>
  80               <term>&lt;job_ID&gt;</term>
  81               <listitem>
  82                 <para>Is a job identification number assigned by the Backup System.</para>
  83
  84               </listitem>
  85             </varlistentry>
  86             <varlistentry>
  87               <term>&lt;timestamp&gt;</term>
  88               <listitem>
  89                 <para>Indicates the date and time the dump operation is to begin, in the format
  90                 <emphasis>month</emphasis>/<emphasis>date</emphasis>/<emphasis>year</emphasis> <emphasis>hours</emphasis>:<emphasis>minutes</emphasis> (in 24-hour format)</para>
  91
  92               </listitem>
  93             </varlistentry>
  94             <varlistentry>
  95               <term>&lt;volume_set&gt;</term>
  96               <listitem>
  97                 <para>Indicates the volume set to dump.</para>
  98
  99               </listitem>
 100             </varlistentry>
 101             <varlistentry>
 102               <term>&lt;dump_level&gt;</term>
 103               <listitem>
 104                 <para>Indicates the dump level at which to perform the dump operation.</para>
 105
 106               </listitem>
 107             </varlistentry>
 108           </variablelist>
 109           <para>The line for a pending or running operation of any other type has the
 110           following format:</para>
 111
 112 <programlisting>
 113    Job &amp;lt;job_ID&amp;gt;:  &amp;lt;operation&amp;gt;  &amp;lt;status&amp;gt;
 114
 115 </programlisting>
 116             <para>where</para>
 117
 118             <variablelist>
 119               <varlistentry>
 120                 <term>&lt;job_ID&gt;</term>
 121                 <listitem>
 122                   <para>Is a job identification number assigned by the Backup System.</para>
 123
 124                 </listitem>
 125               </varlistentry>
 126               <varlistentry>
 127                 <term>&lt;operation&gt;</term>
 128                 <listitem>
 129                   <para>Identifies the operation the Tape Coordinator is performing, which is
 130                   initiated by the indicated command:</para>
 131
 132                   <variablelist>
 133                     <varlistentry>
 134                       <term>Dump (<emphasis>dump name</emphasis>)</term>
 135                       <listitem>
 136                         <para>Initiated by the backup dump command. The <emphasis>dump name</emphasis> has the following
 137                         format:</para>
 138
 139 <programlisting>
 140     &amp;lt;volume_set_name&amp;gt;.&amp;lt;dump_level_name&amp;gt;
 141
 142 </programlisting>
 143                         </listitem>
 144                       </varlistentry>
 145                       <varlistentry>
 146                         <term>Restore</term>
 147                         <listitem>
 148                           <para>Initiated by the <emphasis role="bold">backup diskrestore</emphasis>, <emphasis role="bold">backup volrestore</emphasis>, or <emphasis role="bold">backup
 149                           volsetrestore</emphasis> command.</para>
 150
 151                         </listitem>
 152                       </varlistentry>
 153                       <varlistentry>
 154                         <term>Labeltape (<emphasis>tape_label</emphasis>)</term>
 155                         <listitem>
 156                           <para>Initiated by the <emphasis role="bold">backup labeltape</emphasis>n command. The <emphasis>tape_label</emphasis> is the
 157                           name specified by the <emphasis role="bold">backup labeltape</emphasis> command's <emphasis role="bold">-name</emphasis> or <emphasis role="bold">-pname</emphasis>
 158                           argument.</para>
 159
 160                         </listitem>
 161                       </varlistentry>
 162                       <varlistentry>
 163                         <term>Scantape</term>
 164                         <listitem>
 165                           <para>Initiated by the <emphasis role="bold">backup scantape</emphasis> command.</para>
 166
 167                         </listitem>
 168                       </varlistentry>
 169                       <varlistentry>
 170                         <term>SaveDb</term>
 171                         <listitem>
 172                           <para>Initiated by the <emphasis role="bold">backup savedb</emphasis> command.</para>
 173
 174                         </listitem>
 175                       </varlistentry>
 176                       <varlistentry>
 177                         <term>RestoreDb</term>
 178                         <listitem>
 179                           <para>Initiated by the <emphasis role="bold">backup restoredb</emphasis> command.</para>
 180
 181                         </listitem>
 182                       </varlistentry>
 183                     </variablelist>
 184                   </listitem>
 185                 </varlistentry>
 186                 <varlistentry>
 187                   <term>&lt;status&gt;</term>
 188                   <listitem>
 189                     <para>Indicates the job's current status in one of the following messages. If no
 190                     message appears, the job is either still pending or has finished.</para>
 191
 192                     <variablelist>
 193                       <varlistentry>
 194                         <term><emphasis>number</emphasis> Kbytes, volume <emphasis>volume_name</emphasis></term>
 195                         <listitem>
 196                           <para>For a running dump operation, indicates the number of kilobytes copied to
 197                           tape or a backup data file so far, and the volume currently being dumped.</para>
 198
 199                         </listitem>
 200                       </varlistentry>
 201                       <varlistentry>
 202                         <term><emphasis>number</emphasis> Kbytes, restore.volume</term>
 203                         <listitem>
 204                           <para>For a running restore operation, indicates the number of kilobytes copied
 205                           into AFS from a tape or a backup data file so far.</para>
 206
 207                         </listitem>
 208                       </varlistentry>
 209                       <varlistentry>
 210                         <term>[abort requested]</term>
 211                         <listitem>
 212                           <para>The <emphasis role="bold">backup kill</emphasis> command was issued, but the termination signal has yet
 213                           to reach the Tape Coordinator.</para>
 214
 215                         </listitem>
 216                       </varlistentry>
 217                       <varlistentry>
 218                         <term>[abort sent]</term>
 219                         <listitem>
 220                           <para>The operation is canceled by the <emphasis role="bold">backup kill</emphasis> command.  Once the Backup
 221                           System removes an operation from the queue or stops it from running, it no
 222                           longer appears at all in the output from the command.</para>
 223
 224                         </listitem>
 225                       </varlistentry>
 226                       <varlistentry>
 227                         <term>[butc contact lost]</term>
 228                         <listitem>
 229                           <para>The backup command interpreter cannot reach the Tape Coordinator. The
 230                           message can mean either that the Tape Coordinator handling the operation
 231                           was terminated or failed while the operation was running, or that the
 232                           connection to the Tape Coordinator timed out.</para>
 233
 234                         </listitem>
 235                       </varlistentry>
 236                       <varlistentry>
 237                         <term>[done]</term>
 238                         <listitem>
 239                           <para>The Tape Coordinator has finished the operation.</para>
 240
 241                         </listitem>
 242                       </varlistentry>
 243                       <varlistentry>
 244                         <term>[drive wait]</term>
 245                         <listitem>
 246                           <para>The operation is waiting for the specified tape drive to become free.</para>
 247
 248                         </listitem>
 249                       </varlistentry>
 250                       <varlistentry>
 251                         <term>[operator wait]</term>
 252                         <listitem>
 253                           <para>The Tape Coordinator is waiting for the backup operator to insert a tape
 254                           in the drive.</para>
 255
 256                         </listitem>
 257                       </varlistentry>
 258                     </variablelist>
 259                   </listitem>
 260                 </varlistentry>
 261               </variablelist>
 262             </refsect1>
 263             <refsect1>
 264               <title>Examples</title>
 265               <para>The following example shows that two restore operations and one dump
 266               operation are running (presumably on different Tape Coordinators) and that
 267               the <emphasis role="bold">backup</emphasis> command interpreter's tokens expire on 22 April 1999 at
 268               10:45 am:</para>
 269
 270 <programlisting>
 271    backup&amp;gt; jobs
 272    Job 1: Restore, 1306 Kbytes, restore.volume
 273    Job 2: Dump (user.sunday1), 34 Kbytes, volume user.pat.backup
 274    Job 3: Restore, 2498 Kbytes, restore.volume
 275           04/22/1999 10:45: TOKEN EXPIRATION
 276
 277 </programlisting>
 278               </refsect1>
 279               <refsect1>
 280                 <title>Privilege Required</title>
 281                 <para>None. However, queuing any operation requires privilege, and it is
 282                 possible to issue this command only within the interactive session in
 283                 which the jobs are queued.</para>
 284
 285               </refsect1>
 286               <refsect1>
 287                 <title>See Also</title>
 288                 <para><link linkend="backup8">backup(8)</link>,
 289                 <link linkend="backup_interactive8">backup_interactive(8)</link>,
 290                 <link linkend="backup_kill8">backup_kill(8)</link>,
 291                 <link linkend="backup_quit8">backup_quit(8)</link></para>
 292
 293               </refsect1>
 294               <refsect1>
 295                 <title>Copyright</title>
 296                 <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 297
 298                 <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 299                 converted from HTML to POD by software written by Chas Williams and Russ
 300                 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 301
 302               </refsect1>
 303             </refentry>