DEVEL15-windows-smb-dead-vc-gc-20080627
[openafs.git] / doc / html / AdminReference / auarf061.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="auarf060.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="auarf062.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_ADDDUMP" HREF="auarf002.htm#ToC_75">backup adddump</A></H2>
19 <A NAME="IDX4218"></A>
20 <A NAME="IDX4219"></A>
21 <A NAME="IDX4220"></A>
22 <A NAME="IDX4221"></A>
23 <A NAME="IDX4222"></A>
24 <A NAME="IDX4223"></A>
25 <A NAME="IDX4224"></A>
26 <A NAME="IDX4225"></A>
27 <A NAME="IDX4226"></A>
28 <A NAME="IDX4227"></A>
29 <A NAME="IDX4228"></A>
30 <P><STRONG>Purpose</STRONG>
31 <P>Defines a dump level in the dump hierarchy
32 <P><STRONG>Synopsis</STRONG>
33 <PRE><B>backup adddump -dump</B> &lt;<VAR>dump&nbsp;level&nbsp;name</VAR>><SUP>+</SUP> [<B>-expires</B> &lt;<VAR>expiration&nbsp;date</VAR>><SUP>+</SUP>]
34                [<B>-localauth</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-help</B>]
35    
36 <B>backup addd -d</B>  &lt;<VAR>dump&nbsp;level&nbsp;name</VAR>><SUP>+</SUP> [<B>-e</B> &lt;<VAR>expiration&nbsp;date</VAR>><SUP>+</SUP>]  [<B>-l</B>]  
37             [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-h</B>]
38 </PRE>
39 <P><STRONG>Description</STRONG>
40 <P>The <B>backup adddump</B> command creates one or more dump levels in
41 the dump hierarchy stored in the Backup Database, and optionally assigns an
42 expiration date to each one. All of the dump levels in the Backup
43 Database collectively constitute the dump hierarchy.
44 <P>Use the <B>-expires</B> argument to associate an expiration date with
45 each dump level. When the Backup System subsequently creates a dump at
46 the dump level, it uses the specified value to derive the dump's
47 expiration date, which it records on the label of the tape (or backup data
48 file). The Backup System refuses to overwrite a tape until after the
49 latest expiration date of any dump that the tape contains, unless the
50 <B>backup labeltape</B> command is used to relabel the tape. If a
51 dump level does not have an expiration date, the Backup System treats dumps
52 created at the level as expired as soon as it creates them.
53 <P>(Note that the Backup System does not automatically remove a dump's
54 record from the Backup Database when the dump reaches its expiration date, but
55 only if the tape that contains the dump is recycled or relabeled. To
56 remove expired and other obsolete dump records, use the <B>backup
57 deletedump</B> command.)
58 <P>Define either an absolute or relative expiration date:
59 <UL>
60 <P><LI>An absolute expiration date defines the month/day/year (and, optionally,
61 hour and minutes) at which a dump expires. If the expiration date
62 predates the dump creation time, the Backup System immediately treats the dump
63 as expired.
64 <P><LI>A relative date defines the number of years, months, or days (or a
65 combination of the three) after the dump's creation that it
66 expires. When the Backup System creates a dump at the dump level, it
67 calculates an actual expiration date by adding the relative date to the start
68 time of the dump operation.
69 </UL>
70 <P><STRONG>Options</STRONG>
71 <DL>
72 <P><DT><B>-dump
73 </B><DD>Names each dump level to add to the dump hierarchy. Precede full
74 dump level names with a slash (for example, <B>/full</B>). Indicate
75 an incremental dump level by preceding it with an ordered list of the dump
76 levels directly above it in the hierarchy (its parent dump levels); use
77 the slash as a separator. The parent dump levels must already
78 exist. For example, the dump levels <B>/full</B> and
79 <B>/full/incremental1</B> must exist when the incremental dump level
80 <B>/full/incremental1/incremental2</B> is created.
81 <P>Dump level names can have any number of levels, but cannot exceed 256
82 characters in length, including the slashes. The maximum length for any
83 single level (the text between slashes) is 28 characters, not including the
84 preceding slash.
85 <P>All alphanumeric characters are allowed in dump level names. Do not
86 use the period (<B>.</B>), however, because it is the separator
87 between the volume set name and dump level name in the dump name assigned
88 automatically by the <B>backup dump</B> command. It is best not to
89 include other metacharacters either; if using them, enclose them in
90 double quotes (<B>" "</B>) when issuing the <B>backup adddump</B>
91 command outside interactive mode.
92 <P><DT><B>-expires
93 </B><DD>Defines the absolute or relative expiration date to associate with each
94 dump level named by the <B>-dump</B> argument. Absolute expiration
95 dates have the following format:
96 <P>
97 <PRE>   [<B>at</B>] {<B>NEVER</B> | <VAR>mm</VAR><B>/</B><VAR>dd</VAR><B>/</B><VAR>yyyy</VAR> [<VAR>hh</VAR><B>:</B><VAR>MM</VAR>] }
98    
99 </PRE>
100 <P>where the optional word <B>at</B> is followed either by the string
101 <B>NEVER</B>, which indicates that dumps created at the dump level never
102 expire, or by a date value with a required portion (<VAR>mm</VAR> for month,
103 <VAR>dd</VAR> for day, and <VAR>yyyy</VAR> for year) and an optional portion
104 (<VAR>hh</VAR> for hours and <VAR>MM</VAR> for minutes). 
105 <P>Omit the <VAR>hh</VAR>:<VAR>MM</VAR> portion to use the default of
106 midnight (00:00 hours), or provide a value in 24-hour format (for
107 example, <B>20:30</B> is 8:30 p.m.).
108 Valid values for the year range from <B>1970</B> to <B>2037</B>;
109 higher values are not valid because the latest possible date in the standard
110 UNIX representation is in February 2038. The command interpreter
111 automatically reduces later dates to the maximum value.
112 <P>Relative expiration dates have the following format: 
113 <PRE>   [<B>in</B>] [<VAR>years</VAR><B>y</B>] [<VAR>months</VAR><B>m</B>] [<VAR>days</VAR><B>d</B>]
114    
115 </PRE>
116 <P>
117 <P>where the optional word <B>in</B> is followed by at least one of a
118 number of years (maximum <B>9999</B>) followed by the letter <B>y</B>,
119 a number of months (maximum <B>12</B>) followed by the letter
120 <B>m</B>, or a number of days (maximum <B>31</B>) followed by the
121 letter <B>d</B>. If providing more than one of the three, list them
122 in the indicated order. If the date that results from adding the
123 relative expiration value to a dump's creation time is later than the
124 latest possible date in the UNIX time representation, the Backup System
125 automatically reduces it to that date. 
126 <TABLE><TR><TD ALIGN="LEFT" VALIGN="TOP"><B>Note:</B></TD><TD ALIGN="LEFT" VALIGN="TOP">A plus sign follows this argument in the command's syntax statement
127 because it accepts a multiword value which does not need to be enclosed in
128 double quotes or other delimiters, not because it accepts multiple
129 dates. Provide only one date (and optionally, time) definition to be
130 associated with each dump level specified by the <B>-dump</B>
131 argument.
132 </TD></TR></TABLE>
133 <P><DT><B>-localauth
134 </B><DD>Constructs a server ticket using a key from the local
135 <B>/usr/afs/etc/KeyFile</B> file. The <B>backup</B> command
136 interpreter presents it to the Backup Server, Volume Server and VL Server
137 during mutual authentication. Do not combine this flag with the
138 <B>-cell</B> argument. For more details, see the introductory
139 <B>backup</B> reference page.
140 <P><DT><B>-cell
141 </B><DD>Names the cell in which to run the command. Do not combine this
142 argument with the <B>-localauth</B> flag. For more details, see the
143 introductory <B>backup</B> reference page.
144 <P><DT><B>-help
145 </B><DD>Prints the online help for this command. All other valid options
146 are ignored.
147 </DL>
148 <P><STRONG>Examples</STRONG>
149 <P>The following command defines a full dump called <B>/1999</B> with a
150 relative expiration date of one year:
151 <PRE>   % <B>backup adddump -dump /1999 -expires in 1y</B>
152    
153 </PRE>
154 <P>The following command defines an incremental dump called
155 <B>/sunday1/monday</B>1 with a relative expiration date of 13 days:
156 <PRE>   % <B>backup adddump -dump /sunday1/monday1 -expires in 13d</B>
157    
158 </PRE>
159 <P>The following command defines two dump incremental dump levels,
160 <B>/Monthly/Week1</B> and <B>/Monthly/Week2</B>. Their parent,
161 the full dump level <B>/Monthly</B>, must already exist. The
162 expiration date for both levels is 12:00 a.m. on 1 January
163 2000.
164 <PRE>   % <B>backup adddump -dump /Monthly/Week1 /Monthly/Week2 -expires at 01/01/2000</B>
165    
166 </PRE>
167 <P><STRONG>Privilege Required</STRONG>
168 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
169 every machine where the Backup Server is running, or must be logged onto a
170 server machine as the local superuser <B>root</B> if the
171 <B>-localauth</B> flag is included.
172 <P><STRONG>Related Information</STRONG>
173 <P><A HREF="auarf060.htm#HDRBK_INTRO">backup</A>
174 <P><A HREF="auarf067.htm#HDRBK_DELDUMP">backup deldump</A>
175 <P><A HREF="auarf068.htm#HDRBK_DELETEDUMP">backup deletedump</A>
176 <P><A HREF="auarf080.htm#HDRBK_LISTDUMPS">backup listdumps</A>
177 <P><A HREF="auarf088.htm#HDRBK_SETEXP">backup setexp</A>
178 <P>
179 <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="auarf060.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="auarf062.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> 
180 <!-- Begin Footer Records  ========================================== -->
181 <P><HR><B> 
182 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
183 </B> 
184 <!-- End Footer Records  ============================================ -->
185 <A NAME="Bot_Of_Page"></A>
186 </BODY></HTML>