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