doc/man-pages/pod8/backup_status.pod

   1 =head1 NAME
   2
   3 backup_status - Reports a Tape Coordinator's status
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<backup status> S<<< [B<-portoffset> <I<TC port offset>>] >>>
  11     [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
  12
  13 B<backup st> S<<< [B<-p> <I<TC port offset>>] >>>
  14     [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
  15
  16 =for html
  17 </div>
  18
  19 =head1 DESCRIPTION
  20
  21 The B<backup status> command displays which operation, if any, the
  22 indicated Tape Coordinator is currently executing.
  23
  24 =head1 OPTIONS
  25
  26 =over 4
  27
  28 =item B<-portoffset> <I<TC port offset>>
  29
  30 Specifies the port offset number of the Tape Coordinator for which to
  31 report the status.
  32
  33 =item B<-localauth>
  34
  35 Constructs a server ticket using a key from the local
  36 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
  37 it to the Backup Server, Volume Server and VL Server during mutual
  38 authentication. Do not combine this flag with the B<-cell> argument. For
  39 more details, see L<backup(8)>.
  40
  41 =item B<-cell> <I<cell name>>
  42
  43 Names the cell in which to run the command. Do not combine this argument
  44 with the B<-localauth> flag. For more details, see L<backup(8)>.
  45
  46 =item B<-help>
  47
  48 Prints the online help for this command. All other valid options are
  49 ignored.
  50
  51 =back
  52
  53 =head1 OUTPUT
  54
  55 The following message indicates that the Tape Coordinator is not currently
  56 performing an operation:
  57
  58    Tape coordinator is idle
  59
  60 Otherwise, the output includes a message of the following format for each
  61 running or pending operation:
  62
  63    Task <task_ID>:  <operation>:   <status>
  64
  65 where
  66
  67 =over 4
  68
  69 =item <task_ID>
  70
  71 Is a task identification number assigned by the Tape Coordinator.  It
  72 begins with the Tape Coordinator's port offset number.
  73
  74 =item <operation>
  75
  76 Identifies the operation the Tape Coordinator is performing, which is
  77 initiated by the indicated command:
  78
  79 =over 4
  80
  81 =item Dump
  82
  83 The B<backup dump> command.
  84
  85 =item Restore
  86
  87 The B<backup diskrestore>, B<backup volrestore>, or B<backup
  88 volsetrestore> commands.
  89
  90 =item Labeltape
  91
  92 The B<backup labeltape> command.
  93
  94 =item Scantape
  95
  96 The B<backup scantape> command.
  97
  98 =item SaveDb
  99
 100 The B<backup savedb> command.
 101
 102 =item RestoreDb
 103
 104 The B<backup restoredb> command.
 105
 106 =back
 107
 108 =item <status>
 109
 110 Indicates the job's current status in one of the following messages.
 111
 112 =over 4
 113
 114 =item I<number> Kbytes transferred, volume I<volume_name>
 115
 116 For a running dump operation, indicates the number of kilobytes copied to
 117 tape or a backup data file so far, and the volume currently being dumped.
 118
 119 =item I<number> Kbytes, restore.volume
 120
 121 For a running restore operation, indicates the number of kilobytes copied
 122 into AFS from a tape or a backup data file so far.
 123
 124 =item [abort requested]
 125
 126 The B<backup kill> command was issued, but the termination signal has yet
 127 to reach the Tape Coordinator.
 128
 129 =item [abort sent]
 130
 131 The operation is canceled by the B<backup kill> command.  Once the Backup
 132 System removes an operation from the queue or stops it from running, it no
 133 longer appears at all in the output from the command.
 134
 135 =item [butc contact lost]
 136
 137 The B<backup> command interpreter cannot reach the Tape Coordinator. The
 138 message can mean either that the Tape Coordinator handling the operation
 139 was terminated or failed while the operation was running, or that the
 140 connection to the Tape Coordinator timed out.
 141
 142 =item [done]
 143
 144 The Tape Coordinator has finished the operation.
 145
 146 =item [drive wait]
 147
 148 The operation is waiting for the specified tape drive to become free.
 149
 150 =item [operator wait]
 151
 152 The Tape Coordinator is waiting for the backup operator to insert a tape
 153 in the drive.
 154
 155 =back
 156
 157 =back
 158
 159 If the Tape Coordinator is communicating with an XBSA server (a
 160 third-party backup utility that implements the Open Group's Backup Service
 161 API [XBSA]), the following message appears last in the output:
 162
 163    <XBSA_program> Tape coordinator
 164
 165 where <XBSA_program> is the name of the XBSA-compliant program.
 166
 167 =head1 EXAMPLES
 168
 169 The following example shows that the Tape Coordinator with port offset 4
 170 has so far dumped about 1.5 MB of data for the current dump operation, and
 171 is currently dumping the volume named C<user.pat.backup>:
 172
 173    % backup status -portoffset 4
 174    Task 4001:  Dump:   1520 Kbytes transferred,  volume user.pat.backup
 175
 176 =head1 PRIVILEGE REQUIRED
 177
 178 The issuer must be listed in the F</usr/afs/etc/UserList> file on every
 179 machine where the Backup Server is running, or must be logged onto a
 180 server machine as the local superuser C<root> if the B<-localauth> flag is
 181 included.
 182
 183 =head1 SEE ALSO
 184
 185 L<backup(8)>,
 186 L<butc(8)>
 187
 188 =head1 COPYRIGHT
 189
 190 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 191
 192 This documentation is covered by the IBM Public License Version 1.0.  It was
 193 converted from HTML to POD by software written by Chas Williams and Russ
 194 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.