doc/man-pages/pod8/backup_jobs.pod

   1 =head1 NAME
   2
   3 backup_jobs - Lists pending and running operations in interactive mode
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<jobs> [B<-help>]
  11
  12 B<j> [B<-h>]
  13
  14 =for html
  15 </div>
  16
  17 =head1 DESCRIPTION
  18
  19 The B<backup jobs> command lists the job ID number and status of each
  20 B<backup> operation running or pending in the current interactive session.
  21
  22 This command can be issued in interactive mode only. If the issuer of the
  23 B<backup interactive> command included the B<-localauth> flag, the
  24 B<-cell> argument, or both, those settings apply to this command also.
  25
  26 To terminate operations that appear in the output, issue the B<backup
  27 kill> command and identify the operation to cancel with the job ID number
  28 from this command's output.
  29
  30 To check the status of a Tape Coordinator, rather than of a certain
  31 operation, use the B<backup status> command.
  32
  33 =head1 OPTIONS
  34
  35 =over 4
  36
  37 =item B<-help>
  38
  39 Prints the online help for this command. All other valid options are
  40 ignored.
  41
  42 =back
  43
  44 =head1 OUTPUT
  45
  46 The output always includes the expiration date and time of the tokens that
  47 the B<backup> command interpreter is using during the current interactive
  48 session, in the following format:
  49
  50    <date>   <time>: TOKEN EXPIRATION
  51
  52 If the execution date and time specified for a scheduled dump operation is
  53 later than <date time>, then its individual line (as described in the
  54 following paragraphs) appears below this line to indicate that the current
  55 tokens will not be available to it.
  56
  57 If the issuer of the backup command included the B<-localauth> flag when
  58 entering interactive mode, the line instead reads as follows:
  59
  60    :  TOKEN NEVER EXPIRES
  61
  62 The entry for a scheduled dump operation has the following format:
  63
  64    Job <job_ID>:  <timestamp>:  dump  <volume_set>  <dump_level>
  65
  66 where
  67
  68 =over 4
  69
  70 =item <job_ID>
  71
  72 Is a job identification number assigned by the Backup System.
  73
  74 =item <timestamp>
  75
  76 Indicates the date and time the dump operation is to begin, in the format
  77 I<month>/I<date>/I<year> I<hours>:I<minutes> (in 24-hour format)
  78
  79 =item <volume_set>
  80
  81 Indicates the volume set to dump.
  82
  83 =item <dump_level>
  84
  85 Indicates the dump level at which to perform the dump operation.
  86
  87 =back
  88
  89 The line for a pending or running operation of any other type has the
  90 following format:
  91
  92    Job <job_ID>:  <operation>  <status>
  93
  94 where
  95
  96 =over 4
  97
  98 =item <job_ID>
  99
 100 Is a job identification number assigned by the Backup System.
 101
 102 =item <operation>
 103
 104 Identifies the operation the Tape Coordinator is performing, which is
 105 initiated by the indicated command:
 106
 107 =over 4
 108
 109 =item Dump (I<dump name>)
 110
 111 Initiated by the backup dump command. The I<dump name> has the following
 112 format:
 113
 114     <volume_set_name>.<dump_level_name>
 115
 116 =item Restore
 117
 118 Initiated by the B<backup diskrestore>, B<backup volrestore>, or B<backup
 119 volsetrestore> command.
 120
 121 =item Labeltape (I<tape_label>)
 122
 123 Initiated by the B<backup labeltape>n command. The I<tape_label> is the
 124 name specified by the B<backup labeltape> command's B<-name> or B<-pname>
 125 argument.
 126
 127 =item Scantape
 128
 129 Initiated by the B<backup scantape> command.
 130
 131 =item SaveDb
 132
 133 Initiated by the B<backup savedb> command.
 134
 135 =item RestoreDb
 136
 137 Initiated by the B<backup restoredb> command.
 138
 139 =back
 140
 141 =item <status>
 142
 143 Indicates the job's current status in one of the following messages. If no
 144 message appears, the job is either still pending or has finished.
 145
 146 =over 4
 147
 148 =item I<number> Kbytes, volume I<volume_name>
 149
 150 For a running dump operation, indicates the number of kilobytes copied to
 151 tape or a backup data file so far, and the volume currently being dumped.
 152
 153 =item I<number> Kbytes, restore.volume
 154
 155 For a running restore operation, indicates the number of kilobytes copied
 156 into AFS from a tape or a backup data file so far.
 157
 158 =item [abort requested]
 159
 160 The B<backup kill> command was issued, but the termination signal has yet
 161 to reach the Tape Coordinator.
 162
 163 =item [abort sent]
 164
 165 The operation is canceled by the B<backup kill> command.  Once the Backup
 166 System removes an operation from the queue or stops it from running, it no
 167 longer appears at all in the output from the command.
 168
 169 =item [butc contact lost]
 170
 171 The backup command interpreter cannot reach the Tape Coordinator. The
 172 message can mean either that the Tape Coordinator handling the operation
 173 was terminated or failed while the operation was running, or that the
 174 connection to the Tape Coordinator timed out.
 175
 176 =item [done]
 177
 178 The Tape Coordinator has finished the operation.
 179
 180 =item [drive wait]
 181
 182 The operation is waiting for the specified tape drive to become free.
 183
 184 =item [operator wait]
 185
 186 The Tape Coordinator is waiting for the backup operator to insert a tape
 187 in the drive.
 188
 189 =back
 190
 191 =back
 192
 193 =head1 EXAMPLES
 194
 195 The following example shows that two restore operations and one dump
 196 operation are running (presumably on different Tape Coordinators) and that
 197 the B<backup> command interpreter's tokens expire on 22 April 1999 at
 198 10:45 am:
 199
 200    backup> jobs
 201    Job 1: Restore, 1306 Kbytes, restore.volume
 202    Job 2: Dump (user.sunday1), 34 Kbytes, volume user.pat.backup
 203    Job 3: Restore, 2498 Kbytes, restore.volume
 204           04/22/1999 10:45: TOKEN EXPIRATION
 205
 206 =head1 PRIVILEGE REQUIRED
 207
 208 None. However, queuing any operation requires privilege, and it is
 209 possible to issue this command only within the interactive session in
 210 which the jobs are queued.
 211
 212 =head1 SEE ALSO
 213
 214 L<backup(8)>,
 215 L<backup_interactive(8)>,
 216 L<backup_kill(8)>,
 217 L<backup_quit(8)>
 218
 219 =head1 COPYRIGHT
 220
 221 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 222
 223 This documentation is covered by the IBM Public License Version 1.0.  It was
 224 converted from HTML to POD by software written by Chas Williams and Russ
 225 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.