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