doc/html/AdminReference/auarf079.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="auarf078.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="auarf080.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_LABELTAPE" HREF="auarf002.htm#ToC_93">backup labeltape</A></H2>
  19 <A NAME="IDX4345"></A>
  20 <A NAME="IDX4346"></A>
  21 <A NAME="IDX4347"></A>
  22 <A NAME="IDX4348"></A>
  23 <A NAME="IDX4349"></A>
  24 <A NAME="IDX4350"></A>
  25 <A NAME="IDX4351"></A>
  26 <A NAME="IDX4352"></A>
  27 <A NAME="IDX4353"></A>
  28 <A NAME="IDX4354"></A>
  29 <A NAME="IDX4355"></A>
  30 <A NAME="IDX4356"></A>
  31 <P><STRONG>Purpose</STRONG>
  32 <P>Creates the magnetic label on a tape
  33 <P><STRONG>Synopsis</STRONG>
  34 <PRE><B>backup labeltape</B> [<B>-name</B> &lt;<VAR>AFS&nbsp;tape&nbsp;name,&nbsp;defaults&nbsp;to&nbsp;NULL</VAR>>]
  35                  [<B>-size</B> &lt;<VAR>tape&nbsp;size&nbsp;in&nbsp;Kbytes,&nbsp;defaults&nbsp;to&nbsp;size&nbsp;in&nbsp;tapeconfig</VAR>>]
  36                  [<B>-portoffset</B> &lt;<VAR>TC&nbsp;port&nbsp;offset</VAR>>]
  37                  [<B>-pname</B> &lt;<VAR>permanent&nbsp;tape&nbsp;name</VAR>>]
  38                  [<B>-localauth</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-help</B>]
  39
  40 <B>backup la</B> [<B>-n</B> &lt;<VAR>AFS&nbsp;tape&nbsp;name,&nbsp;defaults&nbsp;to&nbsp;NULL</VAR>>]
  41           [<B>-s</B> &lt;<VAR>tape&nbsp;size&nbsp;in&nbsp;Kbytes,&nbsp;defaults&nbsp;to&nbsp;size&nbsp;in&nbsp;tapeconfig</VAR>>]
  42           [<B>-po</B> &lt;<VAR>TC&nbsp;port&nbsp;offset</VAR>>]  [<B>-pn</B> &lt;<VAR>permanent&nbsp;tape&nbsp;name</VAR>>]
  43           [<B>-l</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-h</B>]
  44 </PRE>
  45 <P><STRONG>Description</STRONG>
  46 <P>The <B>backup labeltape</B> command creates a magnetic label, readable
  47 by the Backup System, at the beginning of a tape. The label records the
  48 tape's name (either a <I>permanent name</I>, or an <I>AFS tape
  49 name</I> that reflects the tape's contents in a prescribed format) and
  50 its capacity.
  51 <P>(If the <B>FILE YES</B> instruction appears in the
  52 <B>/usr/afs/backup/CFG_</B><VAR>device_name</VAR> file on the Tape
  53 Coordinator machine associated with the specified port offset, then the
  54 <B>backup</B> command writes label information to the first 16 KB block in
  55 the backup data file listed for that port offset in the Tape
  56 Coordinator's <B>/usr/afs/backup/tapeconfig</B> file, rather than at
  57 the beginning of a tape. For the sake of clarity, the following text
  58 refers to tapes only, but the Backup System handles backup data files in much
  59 the same way.)
  60 <P>Relabeling a tape that already contains AFS backup data effectively makes
  61 the data unusable, because the command removes the Backup Database record of
  62 the complete dump set of which the tape is a part. Use this command to
  63 enable recycling of a tape that contains unexpired dumps that are not actually
  64 still needed.
  65 <P>To write a permanent name on the label, include the <B>-pname</B>
  66 argument to specify a string of up to 32 characters. The permanent name
  67 persists until the <B>-pname</B> argument is again included on the
  68 <B>backup labeltape</B> command, regardless of the tape's contents
  69 and of how often the tape is otherwise relabeled or recycled. Include
  70 this argument or the <B>-name</B> argument, but not both. If this
  71 argument is included, the AFS tape name is set to <TT>&lt;NULL></TT>.
  72 The permanent name is set to <TT>&lt;NULL></TT> if this argument is omitted
  73 and no permanent name already exists.
  74 <P>The issuer must ensure that a permanent name is unique among the tapes used
  75 for AFS backup in the cell, because the <B>backup</B> command interpreter
  76 does not verify that another tape does not already have the same permanent
  77 name. When a tape has a permanent name, the Backup System uses it
  78 instead of the AFS tape name in most prompts and when referring to the tape in
  79 output from <B>backup</B> commands. The permanent name appears in
  80 the <TT>tape</TT> <TT>name</TT> field of the output from the <B>backup
  81 readlabel</B> command.
  82 <P>To write an AFS tape name on the label, provide a value for the
  83 <B>-name</B> argument in the required format described in the
  84 <B>Options</B> section. Include the <B>-name</B> argument or
  85 the <B>-pname</B> argument, but not both. If this argument is
  86 omitted, the AFS tape name is set to <TT>&lt;NULL></TT>, but the Backup
  87 System automatically assigns the appropriate name when the tape is used in a
  88 future <B>backup dump</B> or <B>backup savedb</B> operation.
  89 The AFS tape name appears in the <TT>AFS</TT> <TT>tape</TT>
  90 <TT>name</TT> field of the output from the <B>backup readlabel</B> and
  91 <B>backup scantape</B> commands.
  92 <P>The <B>backup</B> command interpreter does not accept the
  93 <B>-name</B> argument if the tape already has a permanent name. To
  94 erase a tape's permanent name, provide a null value to the
  95 <B>-pname</B> argument by issuing the following command:
  96 <PRE>   % <B>backup labeltape -pname ""</B>
  97
  98 </PRE>
  99 <P>To record the tape's capacity on the label, specify a number of
 100 kilobytes as the <B>-size</B> argument. If the argument is omitted
 101 the first time a tape is labeled, the Backup System records the default tape
 102 capacity recorded for the specified port offset in the
 103 <B>/usr/afs/backup/tapeconfig</B> file on the Tape Coordinator
 104 machine. Subsequently, the value in the size field persists until the
 105 <B>-size</B> argument is again included on the <B>backup labeltape</B>
 106 command.
 107 <P>To determine how much data can be written to a tape during a <B>backup
 108 dump</B> or <B>backup savedb</B> operation, the Tape Coordinator reads
 109 the capacity recorded on the tape's label (or uses the value associated
 110 with its port offset in the <B>/usr/afs/backup/tapeconfig</B> file, if the
 111 tape was never labeled). For further description, see the <B>backup
 112 dump</B> reference page.
 113 <P>The Tape Coordinator's default response to this command is to access
 114 the tape by invoking the <B>MOUNT</B> instruction in the local
 115 <B>/usr/afs/backup/CFG_</B><VAR>device_name</VAR> file, or by prompting the
 116 backup operator to insert the tape if there is no <B>MOUNT</B>
 117 instruction. However, if the <B>AUTOQUERY NO</B> instruction
 118 appears in the <B>CFG_</B><VAR>device_name</VAR> file, or if the issuer of
 119 the <B>butc</B> command included the <B>-noautoquery</B> flag, the
 120 Tape Coordinator instead expects the tape to be in the device already.
 121 If it is not, the Tape Coordinator invokes the <B>MOUNT</B> instruction or
 122 prompts the operator.
 123 <P><STRONG>Options</STRONG>
 124 <DL>
 125 <P><DT><B>-name
 126 </B><DD>Specifies the AFS tape name to record on the label. Include this
 127 argument or the <B>-pname</B> argument, but not both. If this
 128 argument is omitted, the AFS tape name is set to <TT>&lt;NULL></TT>.
 129 If this argument is provided, it must have the following format:
 130 <PRE>   <VAR>volume_set_name</VAR>.<VAR>dump_level_name</VAR>.<VAR>tape_index</VAR>
 131
 132 </PRE>
 133 <P>for the tape to be acceptable for use in a future <B>backup dump</B>
 134 operation. The <VAR>volume_set_name</VAR> must match the volume set name
 135 of the initial dump to be written to the tape, <VAR>dump_level_name</VAR> must
 136 match the last element of the dump level pathname at which the volume set will
 137 be dumped, and <VAR>tape_index</VAR> indicates the order of the tape in the dump
 138 set (indexing begins with <B>1</B>). To disable this type of name
 139 checking, include the <B>NAME_CHECK NO</B> instruction in the
 140 <B>CFG_</B><VAR>device_name</VAR> file.
 141 <P>For the tape to be acceptable for use in a future <B>backup savedb</B>
 142 operation, the value specified for the <B>-name</B> argument must have the
 143 following format:
 144 <PRE>   <B>Ubik_db_dump.</B><VAR>tape_index</VAR>
 145
 146 </PRE>
 147 <P>where <VAR>tape_index</VAR> indicates the order of the tape in the set of
 148 tapes that house the Backup Database dump; indexing begins with 1
 149 (one).
 150 <P><DT><B>-size
 151 </B><DD>Specifies the tape capacity to record on the label. Provide an
 152 integer value followed by a letter that indicates units, with no intervening
 153 space. A unit value of <B>k</B> or <B>K</B> indicates
 154 kilobytes, <B>m</B> or <B>M</B> indicates megabytes, and <B>g</B>
 155 or <B>G</B> indicates gigabytes. If the units letter is omitted,
 156 the default is kilobytes.
 157 <P>If this argument is omitted the first time a tape is labeled, the Backup
 158 System records the capacity that is associated with the specified port offset
 159 in the <B>/usr/afs/backup/tapeconfig</B> file on the Tape Coordinator
 160 machine. The value recorded the first time then persists until the
 161 <B>-size</B> argument is provided on a future issuance of the
 162 command.
 163 <P><DT><B>-portoffset
 164 </B><DD>Specifies the port offset number of the Tape Coordinator handling the tape
 165 for this operation.
 166 <P><DT><B>-pname
 167 </B><DD>Specifies the permanent name to record on the label. It can be up
 168 to 32 characters in length, and include any alphanumeric characters.
 169 Avoid metacharacters that have a special meaning to the shell, to avoid having
 170 to mark them as literal in commands issued at the shell prompt.
 171 <P>Include this argument or the <B>-name</B> argument, but not
 172 both. If this argument is provided, the AFS tape name is set to
 173 <TT>&lt;NULL></TT>. If this argument is omitted, any existing
 174 permanent name is retained.
 175 <P><DT><B>-localauth
 176 </B><DD>Constructs a server ticket using a key from the local
 177 <B>/usr/afs/etc/KeyFile</B> file. The <B>backup</B> command
 178 interpreter presents it to the Backup Server, Volume Server and VL Server
 179 during mutual authentication. Do not combine this flag with the
 180 <B>-cell</B> argument. For more details, see the introductory
 181 <B>backup</B> reference page.
 182 <P><DT><B>-cell
 183 </B><DD>Names the cell in which to run the command. Do not combine this
 184 argument with the <B>-localauth</B> flag. For more details, see the
 185 introductory <B>backup</B> reference page.
 186 <P><DT><B>-help
 187 </B><DD>Prints the online help for this command. All other valid options
 188 are ignored.
 189 </DL>
 190 <P><STRONG>Examples</STRONG>
 191 <P>The following command records the AFS tape name
 192 <B>user.monthly.1</B> on the label of the tape in the device
 193 with port offset 3:
 194 <PRE>   % <B>backup labeltape -name user.monthly.1 -portoffset 3</B>
 195
 196 </PRE>
 197 <P>The following three commands are equivalent in effect: they all
 198 record a capacity of 2 GB on the label of the tape in the device with port
 199 offset 4. They set the AFS tape name to <TT>&lt;NULL></TT> and leave
 200 the permanent name unchanged.
 201 <PRE>   % <B>backup labeltape -size 2g -portoffset 4</B>
 202    % <B>backup labeltape -size 2048M -portoffset 4</B>
 203    % <B>backup labeltape -size 2097152 -portoffset 4</B>
 204
 205 </PRE>
 206 <P><STRONG>Privilege Required</STRONG>
 207 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
 208 every machine where the Backup Server is running, or must be logged onto a
 209 server machine as the local superuser <B>root</B> if the
 210 <B>-localauth</B> flag is included.
 211 <P><STRONG>Related Information</STRONG>
 212 <P><A HREF="auarf018.htm#HDRCFG">CFG_<I>device_name</I></A>
 213 <P><A HREF="auarf060.htm#HDRBK_INTRO">backup</A>
 214 <P><A HREF="auarf084.htm#HDRBK_READLABEL">backup readlabel</A>
 215 <P><A HREF="auarf126.htm#HDRBUTC">butc</A>
 216 <P>
 217 <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="auarf078.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="auarf080.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>
 218 <!-- Begin Footer Records  ========================================== -->
 219 <P><HR><B>
 220 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved
 221 </B>
 222 <!-- End Footer Records  ============================================ -->
 223 <A NAME="Bot_Of_Page"></A>
 224 </BODY></HTML>