afsmonitor-document-usage-20040729
[openafs.git] / doc / html / AdminReference / auarf089.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf088.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf090.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
17 <P>
18 <H2><A NAME="HDRBK_STATUS" HREF="auarf002.htm#ToC_103">backup status</A></H2>
19 <A NAME="IDX4412"></A>
20 <A NAME="IDX4413"></A>
21 <A NAME="IDX4414"></A>
22 <A NAME="IDX4415"></A>
23 <P><STRONG>Purpose</STRONG>
24 <P>Reports a Tape Coordinator's status
25 <P><STRONG>Synopsis</STRONG>
26 <PRE><B>backup status</B> [<B>-portoffset</B> &lt;<VAR>TC&nbsp;port&nbsp;offset</VAR>>]
27               [<B>-localauth</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-help</B>]
28   
29 <B>backup st</B> [<B>-p</B> &lt;<VAR>TC&nbsp;port&nbsp;offset</VAR>>]  [<B>-l</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-h</B>]
30 </PRE>
31 <P><STRONG>Description</STRONG>
32 <P>The <B>backup status</B> command displays which operation, if any, the
33 indicated Tape Coordinator is currently executing.
34 <P><STRONG>Options</STRONG>
35 <DL>
36 <P><DT><B>-portoffset
37 </B><DD>Specifies the port offset number of the Tape Coordinator for which to
38 report the status.
39 <P><DT><B>-localauth
40 </B><DD>Constructs a server ticket using a key from the local
41 <B>/usr/afs/etc/KeyFile</B> file. The <B>backup</B> command
42 interpreter presents it to the Backup Server, Volume Server and VL Server
43 during mutual authentication. Do not combine this flag with the
44 <B>-cell</B> argument. For more details, see the introductory
45 <B>backup</B> reference page.
46 <P><DT><B>-cell
47 </B><DD>Names the cell in which to run the command. Do not combine this
48 argument with the <B>-localauth</B> flag. For more details, see the
49 introductory <B>backup</B> reference page.
50 <P><DT><B>-help
51 </B><DD>Prints the online help for this command. All other valid options
52 are ignored.
53 </DL>
54 <P><STRONG>Output</STRONG>
55 <P>The following message indicates that the Tape Coordinator is not currently
56 performing an operation:
57 <PRE>   Tape coordinator is idle
58 </PRE>
59 <P>Otherwise, the output includes a message of the following format for each
60 running or pending operation:
61 <PRE>   Task <VAR>task_ID</VAR>:  <VAR>operation</VAR>:   <VAR>status</VAR>
62 </PRE>
63 <P>where
64 <DL>
65 <P><DT><B><VAR>task_ID</VAR>
66 </B><DD>Is a task identification number assigned by the Tape Coordinator.
67 It begins with the Tape Coordinator's port offset number.
68 <P><DT><B><VAR>operation</VAR>
69 </B><DD>Identifies the operation the Tape Coordinator is performing, which is
70 initiated by the indicated command:
71 <UL>
72 <P><LI><TT>Dump</TT> (the <B>backup dump</B> command)
73 <P><LI><TT>Restore</TT> (the <B>backup diskrestore</B>, <B>backup
74 volrestore</B>, or <B>backup volsetrestore</B> commands)
75 <P><LI><TT>Labeltape</TT> (the <B>backup labeltape</B> command)
76 <P><LI><TT>Scantape</TT> (the <B>backup scantape</B> command)
77 <P><LI><TT>SaveDb</TT> (the <B>backup savedb</B> command)
78 <P><LI><TT>RestoreDb</TT> (the <B>backup restoredb</B> command)
79 </UL>
80 <P><DT><B><VAR>status</VAR>
81 </B><DD>Indicates the job's current status in one of the following
82 messages. 
83 <DL>
84 <P><DT><B><VAR>number</VAR> <TT>Kbytes transferred, volume</TT> <VAR>volume_name</VAR>
85 </B><DD>For a running dump operation, indicates the number of kilobytes copied to
86 tape or a backup data file so far, and the volume currently being
87 dumped.
88 <P><DT><B><VAR>number</VAR> <TT>Kbytes, restore.volume</TT>
89 </B><DD>For a running restore operation, indicates the number of kilobytes copied
90 into AFS from a tape or a backup data file so far.
91 <P><DT><B><TT>[abort requested]</TT>
92 </B><DD>The <B>(backup) kill</B> command was issued, but the termination
93 signal has yet to reach the Tape Coordinator.
94 <P><DT><B><TT>[abort sent]</TT>
95 </B><DD>The operation is canceled by the <B>(backup) kill</B> command.
96 Once the Backup System removes an operation from the queue or stops it from
97 running, it no longer appears at all in the output from the command.
98 <P><DT><B><TT>[butc contact lost]</TT>
99 </B><DD>The <B>backup</B> command interpreter cannot reach the Tape
100 Coordinator. The message can mean either that the Tape Coordinator
101 handling the operation was terminated or failed while the operation was
102 running, or that the connection to the Tape Coordinator timed out.
103 <P><DT><B><TT>[done]</TT>
104 </B><DD>The Tape Coordinator has finished the operation.
105 <P><DT><B><TT>[drive wait]</TT>
106 </B><DD>The operation is waiting for the specified tape drive to become
107 free.
108 <P><DT><B><TT>[operator wait]</TT>
109 </B><DD>The Tape Coordinator is waiting for the backup operator to insert a tape
110 in the drive.
111 </DL>
112 </DL>
113 <P>If the Tape Coordinator is communicating with an XBSA server (a third-party
114 backup utility that implements the Open Group's Backup Service API
115 [XBSA]), the following message appears last in the output:
116 <PRE>   <VAR>XBSA_program</VAR> Tape coordinator
117 </PRE>
118 <P>where <VAR>XBSA_program</VAR> is the name of the XBSA-compliant
119 program.
120 <P><STRONG>Examples</STRONG>
121 <P>The following example shows that the Tape Coordinator with port offset 4
122 has so far dumped about 1.5 MB of data for the current dump operation,
123 and is currently dumping the volume named
124 <B>user.pat.backup</B>:
125 <PRE>   % <B>backup status -portoffset 4</B>
126    Task 4001:  Dump:   1520 Kbytes transferred,  volume user.pat.backup
127    
128 </PRE>
129 <P><STRONG>Privilege Required</STRONG>
130 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
131 every machine where the Backup Server is running, or must be logged onto a
132 server machine as the local superuser <B>root</B> if the
133 <B>-localauth</B> flag is included.
134 <P><STRONG>Related Information</STRONG>
135 <P><A HREF="auarf060.htm#HDRBK_INTRO">backup</A>
136 <P><A HREF="auarf126.htm#HDRBUTC">butc</A>
137 <P>
138 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf088.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf090.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
139 <!-- Begin Footer Records  ========================================== -->
140 <P><HR><B> 
141 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
142 </B> 
143 <!-- End Footer Records  ============================================ -->
144 <A NAME="Bot_Of_Page"></A>
145 </BODY></HTML>