doc/man-pages/pod8/backup_kill.pod

   1 =head1 NAME
   2
   3 backup kill - Terminates a pending or running operation
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<kill> S<<< B<-id> <I<job ID or dump set name>> >>> [B<-help>]
  11
  12 S<<< B<k -i> <I<job ID or dump set name>> >>> [B<-h>]
  13
  14 =for html
  15 </div>
  16
  17 =head1 DESCRIPTION
  18
  19 The B<backup kill> command dequeues a Backup System operation that is
  20 pending, or terminates an operation that is running, in the current
  21 interactive session. It is available only in interactive mode.  If the
  22 issuer of the B<backup interactive> command included the B<-localauth>
  23 flag, the B<-cell> argument, or both, then those settings apply to this
  24 command also.
  25
  26 To terminate a dump operation, specify either the dump name
  27 (I<volume_set_name>.I<dump_level_name>) or its job ID number, which
  28 appears in the output from the B<backup jobs> command. To terminate any
  29 other type of operation, provide the job ID number.
  30
  31 The effect of terminating an operation depends on the type and current
  32 state of the operation:
  33
  34 =over 4
  35
  36 =item *
  37
  38 If an operation is still pending, the Tape Coordinator removes it from the
  39 queue with no other lasting effects.
  40
  41 =item *
  42
  43 If the Tape Coordinator is unable to process the termination signal before
  44 an operation completes, it simply confirms the operation's completion. The
  45 operator must take the action necessary to undo the effects of the
  46 incorrect operation.
  47
  48 =item *
  49
  50 If a tape labeling operation is running, the effect depends on when the
  51 Tape Coordinator receives the termination signal. The labeling operation
  52 is atomic, so it either completes or does not begin at all.  Use the
  53 B<backup readlabel> command to determine if the labeling operation
  54 completed, and reissue the B<backup labeltape> command to overwrite the
  55 incorrect label if necessary.
  56
  57 =item *
  58
  59 If a tape scanning operation is running, it terminates with no other
  60 effects unless the B<-dbadd> flag was included on the B<backup>
  61 command. In that case, the Backup System possibly has already written new
  62 Backup Database records to represent dumps on the scanned tape. If
  63 planning to restart the scanning operation, first locate and remove the
  64 records created during the terminated operation: a repeated B<backup
  65 scantape> operation exits automatically when it finds that a record that
  66 it needs to create already exists.
  67
  68 =item *
  69
  70 If a dump operation is running, all of the volumes written to the tape or
  71 backup data file before the termination signal is received are complete
  72 and usable. If the operation is restarted, the Backup System performs all
  73 the dumps again from scratch, and assigns a new dump ID number. If writing
  74 the new dumps to the same tape or file, the operator must relabel it first
  75 if the interrupted dump is not expired. If writing the new dump to a
  76 different tape or file, the operator can remove the dump record associated
  77 with the interrupted dump to free up space in the database.
  78
  79 =item *
  80
  81 If a restore operation is running, completely restored volumes are online
  82 and usable. However, it is unlikely that many volumes are completely
  83 restored, given that complete restoration usually requires data from
  84 multiple tapes. If the termination signal comes before the Backup System
  85 has accessed all of the necessary tapes, each volume is only partially
  86 written and is never brought online. It is best to restart the restore
  87 operation from scratch to avoid possible inconsistencies. See also
  88 L<CAUTIONS>.
  89
  90 =back
  91
  92 =head1 CAUTIONS
  93
  94 It is best not to issue the B<backup kill> command against restore
  95 operations. If the termination signal interrupts a restore operation as
  96 the Backup System is overwriting an existing volume, it is possible to
  97 lose the volume entirely (that is, to lose both the contents of the volume
  98 as it was before the restore and any data that was restored before the
  99 termination signal arrived). The data being restored still exists on the
 100 tape, but some data can be lost permanently.
 101
 102 =head1 OPTIONS
 103
 104 =over 4
 105
 106 =item B<-id> <I<job ID or dump set name>>
 107
 108 Identifies the backup operation to terminate. Provide one of two types of
 109 values:
 110
 111 =over 4
 112
 113 =item *
 114
 115 The operation's job ID number, as displayed in the output of the B<backup
 116 jobs> command.
 117
 118 =item *
 119
 120 For a dump operation, either the job ID number or a dump name of the form
 121 I<volume_set_name>.I<dump_level_name>, where I<volume_set_name> is the
 122 name of the volume set being dumped and I<dump_level_name> is the last
 123 element in the dump level pathname at which the volume set is being
 124 dumped. The dump name appears in the output of the B<backup jobs> command
 125 along with the job ID number.
 126
 127 =back
 128
 129 =item B<-help>
 130
 131 Prints the online help for this command. All other valid options are
 132 ignored.
 133
 134 =back
 135
 136 =head1 EXAMPLES
 137
 138 The following command terminates the operation with job ID 5:
 139
 140    backup> kill 5
 141
 142 The following command terminates the dump operation called
 143 C<user.sunday1>:
 144
 145    backup> kill user.sunday1
 146
 147 =head1 PRIVILEGE REQUIRED
 148
 149 The issuer must have the privilege required to initiate the operation
 150 being cancelled. Because this command can be issued only within the
 151 interactive session during which the operation was initiated, the required
 152 privilege is essentially guaranteed.
 153
 154 =head1 SEE ALSO
 155
 156 L<backup(8)>,
 157 L<backup_interactive(8)>,
 158 L<backup_jobs(8)>
 159
 160 =head1 COPYRIGHT
 161
 162 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 163
 164 This documentation is covered by the IBM Public License Version 1.0.  It was
 165 converted from HTML to POD by software written by Chas Williams and Russ
 166 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.