autoconf-updates-for-ac-check-lib-quoting-20010629
[openafs.git] / doc / html / AdminReference / auarf050.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="auarf049.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="auarf051.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="HDRTAPECONFIG" HREF="auarf002.htm#ToC_48">tapeconfig</A></H2>
19 <P><STRONG>Purpose</STRONG>
20 <A NAME="IDX4027"></A>
21 <A NAME="IDX4028"></A>
22 <A NAME="IDX4029"></A>
23 <P>Defines configuration parameters for all tape devices and backup data files
24 on a Tape Coordinator machine
25 <P><STRONG>Description</STRONG>
26 <P>The <B>tapeconfig</B> file defines basic configuration parameters for
27 all of the tape devices or backup data files available for backup operations
28 on a Tape Coordinator machine. The file is in ASCII format and must
29 reside in the local <B>/usr/afs/backup</B> directory. The
30 instruction for each tape device or backup data file appears on its own line
31 and each has the following format:
32 <PRE>   [<VAR>capacity</VAR>    <VAR>filemark_size</VAR>]    <VAR>device_name</VAR>    <VAR>port_offset</VAR>
33    
34 </PRE>
35 <P>where
36 <DL>
37 <P><DT><B><VAR>capacity</VAR>
38 </B><DD>Specifies the capacity of the tapes used with a tape device, or the amount
39 of data to write into a backup data file. The Tape Coordinator refers
40 to this value in two circumstances: 
41 <UL>
42 <P><LI>When the capacity field of a tape or backup data file's label is
43 empty (because the tape has never been labeled). The Tape Coordinator
44 records this value on the label and uses it when determining how much data it
45 can write to the tape or file during a <B>backup dump</B> or <B>backup
46 savedb</B> operation. If there is already a capacity value on the
47 label, the Tape Coordinator uses it instead.
48 <P><LI>When the <B>-size</B> argument is omitted the first time the
49 <B>backup labeltape</B> command is used on a given tape or file.
50 The Tape Coordinator copies this value into the label's capacity
51 field.
52 </UL>
53 <P>
54 <P>The Tape Coordinator uses this capacity value or the one on the Backup
55 System tape label to track how much space remains as it writes data to a tape
56 or backup data file. The appropriate value to record for a tape depends
57 on the size of the tapes usually used in the device and whether it has a
58 compression mode; for suggested values, see the <I>IBM AFS
59 Administration Guide</I> chapter on configuring the Backup System. If
60 using a value obtained from the <B>fms</B> command, reduce it by 10% to
61 15% before recording it in the file.
62 <P>For a backup data file, it is best to provide a value that helps the Tape
63 Coordinator avoid reaching the end-of-file (EOF) unexpectedly. Make it
64 at least somewhat smaller than the amount of space available on the partition
65 housing the file when the dump operation begins, and never larger than the
66 maximum file size allowed by the operating system.
67 <P>Specify a (positive) integer or decimal value followed by a letter than
68 indicates units, with no intervening space. In a decimal number, the
69 number of digits after the decimal point must not translate to fractions of
70 bytes. The maximum acceptable value is 2048 GB (2 TB). The
71 acceptable units letters are as follows; if the letter is omitted, the
72 default is kilobytes.
73 <P>
74 <UL>
75 <P><LI><B>k</B>or <B>K</B> for kilobytes (KB)
76 <P><LI><B>m</B> or <B>M</B> for megabytes (MB)
77 <P><LI><B>g</B> or <B>G</B> for gigabytes (GB)
78 <P><LI><B>t</B> or <B>T</B> for terabytes (TB)
79 </UL>
80 <P>If this field is omitted, the Tape Coordinator uses the maximum acceptable
81 value (2048 GB or 2 TB). Either leave both this field and the
82 <VAR>filemark_size</VAR> field empty, or provide a value in both of them.
83 <P><DT><B><VAR>filemark_size</VAR>
84 </B><DD>Specifies the size of a tape device's filemarks (also called
85 end-of-file or EOF marks), which is set by the device's
86 manufacturer. In a dump to tape, the Tape Coordinator inserts filemarks
87 at the boundary between the data from each volume, so the filemark size
88 affects how much space is available for actual data. 
89 <P>The appropriate value to record for a tape depends on the size of the tapes
90 usually used in the device and whether it has a compression mode; for
91 suggested values, see the <I>IBM AFS Administration Guide</I> chapter on
92 configuring the Backup System. If using a value obtained from the
93 <B>fms</B> command, increase it by 10% to 15% before recording it in the
94 file.
95 <P>For backup data files, record a value of <B>0</B> (zero). The
96 Tape Coordinator actually ignores this field for backup data files, because it
97 does not use filemarks when writing to a file.
98 <P>Use the same notation as for the <VAR>capacity</VAR> field, but note that the
99 default units is bytes rather than kilobytes. The maximum acceptable
100 value is 2048 GB.
101 <P>If this field is empty, the Tape Coordinator uses the value <B>0</B>
102 (zero). Either leave both this field and the <VAR>capacity</VAR> field
103 empty, or provide a value in both of them.
104 <P><DT><B><VAR>device_name</VAR>
105 </B><DD>Specifies the complete pathname of the tape device or backup data
106 file. The format of tape device names depends on the operating system,
107 but on UNIX systems device names generally begin with the string
108 <B>/dev/</B>. For a backup data file, this field defines the
109 complete pathname; for a discussion of suggested naming conventions see
110 the description of the <B>FILE</B> instruction in <A HREF="auarf018.htm#HDRCFG">CFG_<I>device_name</I></A>.
111 <P><DT><B><VAR>port_offset</VAR>
112 </B><DD>Specifies the port offset number associated with this combination of Tape
113 Coordinator and tape device or backup data file. 
114 <P>Acceptable values are the integers <B>0</B> through <B>58510</B>
115 (the Backup System can track a maximum of 58,511 port offset numbers).
116 Each value must be unique among the cell's Tape Coordinators, but any
117 number of them can be associated with a single machine. Port offset
118 numbers need not be assigned sequentially, and can appear in any order in the
119 <B>tapeconfig</B> file. Assign port offset <B>0</B> to the Tape
120 Coordinator for the tape device or backup data file used most often for backup
121 operations; doing so will allow the operator to omit the
122 <B>-portoffset</B> argument from the largest possible number of
123 <B>backup</B> commands.
124 </DL>
125 <P><STRONG>Privilege Required</STRONG>
126 <P>Creating the file requires UNIX <B>w</B> (<B>write</B>) and
127 <B>x</B> (<B>execute</B>) permissions on the
128 <B>/usr/afs/backup</B> directory. Editing the file requires UNIX
129 <B>w</B> (<B>write</B>) permission on the file.
130 <P><STRONG>Examples</STRONG>
131 <P>The following example <B>tapeconfig</B> file configures three tape
132 devices and a backup data file. The first device has device name
133 <B>/dev/rmt/0h</B>, and is assigned port offset <B>0</B> because it
134 will be the most frequently used device for all backup operations in the
135 cell. Its default tape capacity is 2 GB and filemark size is 1
136 MB. The <B>/dev/rmt/3h</B> drive has half the capacity but a much
137 smaller filemark size; its port offset is <B>3</B>. The third
138 device listed, <B>/dev/rmt/4h</B>, has the same capacity and filemark size
139 as the first device and is assigned port offset <B>2</B>. Port
140 offset <B>4</B> is assigned to the backup data file <B>/dev/FILE</B>,
141 which is actually a symbolic link to the actual file located elsewhere on the
142 local disk. The Tape Coordinator writes up to 1.5 GB into the
143 file; as recommended, the filemark size is set to zero.
144 <PRE>   2G 1M /dev/rmt/0h 0
145    1g 4k /dev/rmt/3h 3
146    2G 1m /dev/rmt/4h 2
147    1.5G 0 /dev/FILE 4
148    
149 </PRE>
150 <P><STRONG>Related Information</STRONG>
151 <P><A HREF="auarf062.htm#HDRBK_ADDHOST">backup addhost</A>
152 <P><A HREF="auarf073.htm#HDRBK_DUMP">backup dump</A>
153 <P><A HREF="auarf079.htm#HDRBK_LABELTAPE">backup labeltape</A>
154 <P><A HREF="auarf086.htm#HDRBK_SAVEDB">backup savedb</A>
155 <P><A HREF="auarf126.htm#HDRBUTC">butc</A>
156 <P><A HREF="auarf130.htm#HDRFMS">fms</A>
157 <P>
158 <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="auarf049.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="auarf051.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> 
159 <!-- Begin Footer Records  ========================================== -->
160 <P><HR><B> 
161 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
162 </B> 
163 <!-- End Footer Records  ============================================ -->
164 <A NAME="Bot_Of_Page"></A>
165 </BODY></HTML>