openafs/doc/html/AdminReference/auarf088.htm

161 lines
9.0 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
<HTML><HEAD>
<TITLE>Administration Reference</TITLE>
<!-- Begin Header Records ========================================== -->
<!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID -->
<!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30 -->
<META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
<META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
<META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
</HEAD><BODY>
<!-- (C) IBM Corporation 2000. All Rights Reserved -->
<BODY bgcolor="ffffff">
<!-- End Header Records ============================================ -->
<A NAME="Top_Of_Page"></A>
<H1>Administration Reference</H1>
<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="auarf087.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="auarf089.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>
<P>
<H2><A NAME="HDRBK_SETEXP" HREF="auarf002.htm#ToC_102">backup setexp</A></H2>
<A NAME="IDX4406"></A>
<A NAME="IDX4407"></A>
<A NAME="IDX4408"></A>
<A NAME="IDX4409"></A>
<A NAME="IDX4410"></A>
<A NAME="IDX4411"></A>
<P><STRONG>Purpose</STRONG>
<P>Sets the expiration date for existing dump levels.
<P><STRONG>Synopsis</STRONG>
<PRE><B>backup setexp -dump</B> &lt;<VAR>dump&nbsp;level&nbsp;name</VAR>><SUP>+</SUP> [<B>-expires</B> &lt;<VAR>expiration&nbsp;date</VAR>><SUP>+</SUP>]
[<B>-localauth</B>] [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>] [<B>-help</B>]
<B>backup se -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>] [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>] [<B>-h</B>]
</PRE>
<P><STRONG>Description</STRONG>
<P>The <B>backup setexp</B> command sets or changes the expiration date
associated with each specified dump level, which must already exist in the
dump hierarchy.
<P>Use the <B>-expires</B> argument to associate an expiration date with
each dump level. When the Backup System subsequently creates a dump at
the dump level, it uses the specified value to derive the dump's
expiration date, which it records on the label of the tape (or backup data
file). The Backup System refuses to overwrite a tape until after the
latest expiration date of any dump that the tape contains, unless the
<B>backup labeltape</B> command is used to relabel the tape. If a
dump level does not have an expiration date, the Backup System treats dumps
created at the level as expired as soon as it creates them.
<P>(Note that the Backup System does not automatically remove a dump's
record from the Backup Database when the dump reaches its expiration date, but
only if the tape that contains the dump is recycled or relabeled. To
remove expired and other obsolete dump records, use the <B>backup
deletedump</B> command.)
<P>Define either an absolute or relative expiration date:
<UL>
<P><LI>An absolute expiration date defines the month/day/year (and, optionally,
hour and minutes) at which a dump expires. If the expiration date
predates the dump creation time, the Backup System immediately treats the dump
as expired.
<P><LI>A relative date defines the number of years, months, or days (or a
combination of the three) after the dump's creation that it
expires. When the Backup System creates a dump at the dump level, it
calculates an actual expiration date by adding the relative date to the start
time of the dump operation.
</UL>
<P>If the command is used to change an existing expiration date associated
with a dump level, the new date applies only to dumps created after the
change. Existing dumps retain the expiration date assigned at the time
they were created.
<P><STRONG>Options</STRONG>
<DL>
<P><DT><B>-dump
</B><DD>Specifies the full pathname of each dump level to assign the expiration
date specified by the <B>-expires</B> argument.
<P><DT><B>-expires
</B><DD>Defines the absolute or relative expiration date to associate with each
dump level named by the <B>-dump</B> argument. Absolute expiration
dates have the following format:
<P>
<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>] }
</PRE>
<P>where the optional word <B>at</B> is followed either by the string
<B>NEVER</B>, which indicates that dumps created at the dump level never
expire, or by a date value with a required portion (<VAR>mm</VAR> for month,
<VAR>dd</VAR> for day, and <VAR>yyyy</VAR> for year) and an optional portion
(<VAR>hh</VAR> for hours and <VAR>MM</VAR> for minutes).
<P>Omit the <VAR>hh</VAR>:<VAR>MM</VAR> portion to use the default of
midnight (00:00 hours), or provide a value in 24-hour format (for
example, <B>20:30</B> is 8:30 p.m.).
Valid values for the year range from <B>1970</B> to <B>2037</B>;
higher values are not valid because the latest possible date in the standard
UNIX representation is in February 2038. The command interpreter
automatically reduces later dates to the maximum value.
<P>Relative expiration dates have the following format:
<PRE> [<B>in</B>] [<VAR>years</VAR><B>y</B>] [<VAR>months</VAR><B>m</B>] [<VAR>days</VAR><B>d</B>]
</PRE>
<P>
<P>where the optional word <B>in</B> is followed by at least one of a
number of years (maximum <B>9999</B>) followed by the letter <B>y</B>,
a number of months (maximum <B>12</B>) followed by the letter
<B>m</B>, or a number of days (maximum <B>31</B>) followed by the
letter <B>d</B>. If providing more than one of the three, list them
in the indicated order. If the date that results from adding the
relative expiration value to a dump's creation time is later than the
latest possible date in the UNIX time representation, the Backup System
automatically reduces it to that date.
<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
because it accepts a multiword value which does not need to be enclosed in
double quotes or other delimiters, not because it accepts multiple
dates. Provide only one date (and optionally, time) definition to be
associated with each dump level specified by the <B>-dump</B>
argument.
</TD></TR></TABLE>
<P><DT><B>-localauth
</B><DD>Constructs a server ticket using a key from the local
<B>/usr/afs/etc/KeyFile</B> file. The <B>backup</B> command
interpreter presents it to the Backup Server, Volume Server and VL Server
during mutual authentication. Do not combine this flag with the
<B>-cell</B> argument. For more details, see the introductory
<B>backup</B> reference page.
<P><DT><B>-cell
</B><DD>Names the cell in which to run the command. Do not combine this
argument with the <B>-localauth</B> flag. For more details, see the
introductory <B>backup</B> reference page.
<P><DT><B>-help
</B><DD>Prints the online help for this command. All other valid options
are ignored.
</DL>
<P><STRONG>Examples</STRONG>
<P>The following example associates an absolute expiration date of 10:00
p.m. on 31 December 1999 with the dump level
<B>/1998/december</B>:
<PRE> % <B>backup setexp -dump /1998/december -expires at 12/31/1999 22:00</B>
</PRE>
<P>The following example associates a relative expiration date of 7 days with
the two dump levels <B>/monthly/week1</B> and
<B>/monthly/week2</B>:
<PRE> % <B>backup setexp -dump /monthly/week1 /monthly/week -expires 7d</B>
</PRE>
<P><STRONG>Privilege Required</STRONG>
<P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
every machine where the Backup Server is running, or must be logged onto a
server machine as the local superuser <B>root</B> if the
<B>-localauth</B> flag is included.
<P><STRONG>Related Information</STRONG>
<P><A HREF="auarf060.htm#HDRBK_INTRO">backup</A>
<P><A HREF="auarf061.htm#HDRBK_ADDDUMP">backup adddump</A>
<P><A HREF="auarf067.htm#HDRBK_DELDUMP">backup deldump</A>
<P><A HREF="auarf080.htm#HDRBK_LISTDUMPS">backup listdumps</A>
<P>
<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="auarf087.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="auarf089.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>
<!-- Begin Footer Records ========================================== -->
<P><HR><B>
<br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A> All Rights Reserved
</B>
<!-- End Footer Records ============================================ -->
<A NAME="Bot_Of_Page"></A>
</BODY></HTML>