1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="backup_status8">
4 <refentrytitle>backup status</refentrytitle>
5 <manvolnum>8</manvolnum>
8 <refname>backup status</refname>
9 <refpurpose>Reports a Tape Coordinator's status</refpurpose>
12 <title>Synopsis</title>
13 <para><emphasis role="bold">backup status</emphasis> [<emphasis role="bold">-portoffset</emphasis> <<emphasis>TC port offset</emphasis>>] [<emphasis role="bold">-localauth</emphasis>]
14 [<emphasis role="bold">-cell</emphasis> <<emphasis>cell name</emphasis>>] [<emphasis role="bold">-help</emphasis>]</para>
16 <para><emphasis role="bold">backup st</emphasis> [<emphasis role="bold">-p</emphasis> <<emphasis>TC port offset</emphasis>>] [<emphasis role="bold">-l</emphasis>] [<emphasis role="bold">-c</emphasis> <<emphasis>cell name</emphasis>>]
17 [<emphasis role="bold">-h</emphasis>]</para>
21 <title>Description</title>
22 <para>The <emphasis role="bold">backup status</emphasis> command displays which operation, if any, the
23 indicated Tape Coordinator is currently executing.</para>
27 <title>Options</title>
30 <term><emphasis role="bold">-portoffset</emphasis> <<emphasis>TC port offset</emphasis>></term>
32 <para>Specifies the port offset number of the Tape Coordinator for which to
33 report the status.</para>
38 <term><emphasis role="bold">-localauth</emphasis></term>
40 <para>Constructs a server ticket using a key from the local
41 <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">backup</emphasis> command interpreter presents
42 it to the Backup Server, Volume Server and VL Server during mutual
43 authentication. Do not combine this flag with the <emphasis role="bold">-cell</emphasis> argument. For
44 more details, see <link linkend="backup8">backup(8)</link>.</para>
49 <term><emphasis role="bold">-cell</emphasis> <<emphasis>cell name</emphasis>></term>
51 <para>Names the cell in which to run the command. Do not combine this argument
52 with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="backup8">backup(8)</link>.</para>
57 <term><emphasis role="bold">-help</emphasis></term>
59 <para>Prints the online help for this command. All other valid options are
68 <para>The following message indicates that the Tape Coordinator is not currently
69 performing an operation:</para>
72 Tape coordinator is idle
75 <para>Otherwise, the output includes a message of the following format for each
76 running or pending operation:</para>
79 Task &lt;task_ID&gt;: &lt;operation&gt;: &lt;status&gt;
86 <term><task_ID></term>
88 <para>Is a task identification number assigned by the Tape Coordinator. It
89 begins with the Tape Coordinator's port offset number.</para>
94 <term><operation></term>
96 <para>Identifies the operation the Tape Coordinator is performing, which is
97 initiated by the indicated command:</para>
103 <para>The <emphasis role="bold">backup dump</emphasis> command.</para>
110 <para>The <emphasis role="bold">backup diskrestore</emphasis>, <emphasis role="bold">backup volrestore</emphasis>, or <emphasis role="bold">backup
111 volsetrestore</emphasis> commands.</para>
116 <term>Labeltape</term>
118 <para>The <emphasis role="bold">backup labeltape</emphasis> command.</para>
123 <term>Scantape</term>
125 <para>The <emphasis role="bold">backup scantape</emphasis> command.</para>
132 <para>The <emphasis role="bold">backup savedb</emphasis> command.</para>
137 <term>RestoreDb</term>
139 <para>The <emphasis role="bold">backup restoredb</emphasis> command.</para>
147 <term><status></term>
149 <para>Indicates the job's current status in one of the following messages.</para>
153 <term><emphasis>number</emphasis> Kbytes transferred, volume <emphasis>volume_name</emphasis></term>
155 <para>For a running dump operation, indicates the number of kilobytes copied to
156 tape or a backup data file so far, and the volume currently being dumped.</para>
161 <term><emphasis>number</emphasis> Kbytes, restore.volume</term>
163 <para>For a running restore operation, indicates the number of kilobytes copied
164 into AFS from a tape or a backup data file so far.</para>
169 <term>[abort requested]</term>
171 <para>The <emphasis role="bold">backup kill</emphasis> command was issued, but the termination signal has yet
172 to reach the Tape Coordinator.</para>
177 <term>[abort sent]</term>
179 <para>The operation is canceled by the <emphasis role="bold">backup kill</emphasis> command. Once the Backup
180 System removes an operation from the queue or stops it from running, it no
181 longer appears at all in the output from the command.</para>
186 <term>[butc contact lost]</term>
188 <para>The <emphasis role="bold">backup</emphasis> command interpreter cannot reach the Tape Coordinator. The
189 message can mean either that the Tape Coordinator handling the operation
190 was terminated or failed while the operation was running, or that the
191 connection to the Tape Coordinator timed out.</para>
198 <para>The Tape Coordinator has finished the operation.</para>
203 <term>[drive wait]</term>
205 <para>The operation is waiting for the specified tape drive to become free.</para>
210 <term>[operator wait]</term>
212 <para>The Tape Coordinator is waiting for the backup operator to insert a tape
221 <para>If the Tape Coordinator is communicating with an XBSA server (a
222 third-party backup utility that implements the Open Group's Backup Service
223 API [XBSA]), the following message appears last in the output:</para>
226 &lt;XBSA_program&gt; Tape coordinator
229 <para>where <XBSA_program> is the name of the XBSA-compliant program.</para>
233 <title>Examples</title>
234 <para>The following example shows that the Tape Coordinator with port offset 4
235 has so far dumped about 1.5 MB of data for the current dump operation, and
236 is currently dumping the volume named <computeroutput>user.pat.backup</computeroutput>:</para>
239 % backup status -portoffset 4
240 Task 4001: Dump: 1520 Kbytes transferred, volume user.pat.backup
245 <title>Privilege Required</title>
246 <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on every
247 machine where the Backup Server is running, or must be logged onto a
248 server machine as the local superuser <computeroutput>root</computeroutput> if the <emphasis role="bold">-localauth</emphasis> flag is
253 <title>See Also</title>
254 <para><link linkend="backup8">backup(8)</link>,
255 <link linkend="butc8">butc(8)</link></para>
259 <title>Copyright</title>
260 <para>IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.</para>
262 <para>This documentation is covered by the IBM Public License Version 1.0. It was
263 converted from HTML to POD by software written by Chas Williams and Russ
264 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>