doc/html/AdminReference/auarf088.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="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>
  17 <P>
  18 <H2><A NAME="HDRBK_SETEXP" HREF="auarf002.htm#ToC_102">backup setexp</A></H2>
  19 <A NAME="IDX4406"></A>
  20 <A NAME="IDX4407"></A>
  21 <A NAME="IDX4408"></A>
  22 <A NAME="IDX4409"></A>
  23 <A NAME="IDX4410"></A>
  24 <A NAME="IDX4411"></A>
  25 <P><STRONG>Purpose</STRONG>
  26 <P>Sets the expiration date for existing dump levels.
  27 <P><STRONG>Synopsis</STRONG>
  28 <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>]
  29               [<B>-localauth</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-help</B>]
  30
  31 <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>]
  32           [<B>-l</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-h</B>]
  33 </PRE>
  34 <P><STRONG>Description</STRONG>
  35 <P>The <B>backup setexp</B> command sets or changes the expiration date
  36 associated with each specified dump level, which must already exist in the
  37 dump hierarchy.
  38 <P>Use the <B>-expires</B> argument to associate an expiration date with
  39 each dump level. When the Backup System subsequently creates a dump at
  40 the dump level, it uses the specified value to derive the dump's
  41 expiration date, which it records on the label of the tape (or backup data
  42 file). The Backup System refuses to overwrite a tape until after the
  43 latest expiration date of any dump that the tape contains, unless the
  44 <B>backup labeltape</B> command is used to relabel the tape. If a
  45 dump level does not have an expiration date, the Backup System treats dumps
  46 created at the level as expired as soon as it creates them.
  47 <P>(Note that the Backup System does not automatically remove a dump's
  48 record from the Backup Database when the dump reaches its expiration date, but
  49 only if the tape that contains the dump is recycled or relabeled. To
  50 remove expired and other obsolete dump records, use the <B>backup
  51 deletedump</B> command.)
  52 <P>Define either an absolute or relative expiration date:
  53 <UL>
  54 <P><LI>An absolute expiration date defines the month/day/year (and, optionally,
  55 hour and minutes) at which a dump expires. If the expiration date
  56 predates the dump creation time, the Backup System immediately treats the dump
  57 as expired.
  58 <P><LI>A relative date defines the number of years, months, or days (or a
  59 combination of the three) after the dump's creation that it
  60 expires. When the Backup System creates a dump at the dump level, it
  61 calculates an actual expiration date by adding the relative date to the start
  62 time of the dump operation.
  63 </UL>
  64 <P>If the command is used to change an existing expiration date associated
  65 with a dump level, the new date applies only to dumps created after the
  66 change. Existing dumps retain the expiration date assigned at the time
  67 they were created.
  68 <P><STRONG>Options</STRONG>
  69 <DL>
  70 <P><DT><B>-dump
  71 </B><DD>Specifies the full pathname of each dump level to assign the expiration
  72 date specified by the <B>-expires</B> argument.
  73 <P><DT><B>-expires
  74 </B><DD>Defines the absolute or relative expiration date to associate with each
  75 dump level named by the <B>-dump</B> argument. Absolute expiration
  76 dates have the following format:
  77 <P>
  78 <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>] }
  79
  80 </PRE>
  81 <P>where the optional word <B>at</B> is followed either by the string
  82 <B>NEVER</B>, which indicates that dumps created at the dump level never
  83 expire, or by a date value with a required portion (<VAR>mm</VAR> for month,
  84 <VAR>dd</VAR> for day, and <VAR>yyyy</VAR> for year) and an optional portion
  85 (<VAR>hh</VAR> for hours and <VAR>MM</VAR> for minutes).
  86 <P>Omit the <VAR>hh</VAR>:<VAR>MM</VAR> portion to use the default of
  87 midnight (00:00 hours), or provide a value in 24-hour format (for
  88 example, <B>20:30</B> is 8:30 p.m.).
  89 Valid values for the year range from <B>1970</B> to <B>2037</B>;
  90 higher values are not valid because the latest possible date in the standard
  91 UNIX representation is in February 2038. The command interpreter
  92 automatically reduces later dates to the maximum value.
  93 <P>Relative expiration dates have the following format:
  94 <PRE>   [<B>in</B>] [<VAR>years</VAR><B>y</B>] [<VAR>months</VAR><B>m</B>] [<VAR>days</VAR><B>d</B>]
  95
  96 </PRE>
  97 <P>
  98 <P>where the optional word <B>in</B> is followed by at least one of a
  99 number of years (maximum <B>9999</B>) followed by the letter <B>y</B>,
 100 a number of months (maximum <B>12</B>) followed by the letter
 101 <B>m</B>, or a number of days (maximum <B>31</B>) followed by the
 102 letter <B>d</B>. If providing more than one of the three, list them
 103 in the indicated order. If the date that results from adding the
 104 relative expiration value to a dump's creation time is later than the
 105 latest possible date in the UNIX time representation, the Backup System
 106 automatically reduces it to that date.
 107 <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
 108 because it accepts a multiword value which does not need to be enclosed in
 109 double quotes or other delimiters, not because it accepts multiple
 110 dates. Provide only one date (and optionally, time) definition to be
 111 associated with each dump level specified by the <B>-dump</B>
 112 argument.
 113 </TD></TR></TABLE>
 114 <P><DT><B>-localauth
 115 </B><DD>Constructs a server ticket using a key from the local
 116 <B>/usr/afs/etc/KeyFile</B> file. The <B>backup</B> command
 117 interpreter presents it to the Backup Server, Volume Server and VL Server
 118 during mutual authentication. Do not combine this flag with the
 119 <B>-cell</B> argument. For more details, see the introductory
 120 <B>backup</B> reference page.
 121 <P><DT><B>-cell
 122 </B><DD>Names the cell in which to run the command. Do not combine this
 123 argument with the <B>-localauth</B> flag. For more details, see the
 124 introductory <B>backup</B> reference page.
 125 <P><DT><B>-help
 126 </B><DD>Prints the online help for this command. All other valid options
 127 are ignored.
 128 </DL>
 129 <P><STRONG>Examples</STRONG>
 130 <P>The following example associates an absolute expiration date of 10:00
 131 p.m. on 31 December 1999 with the dump level
 132 <B>/1998/december</B>:
 133 <PRE>   % <B>backup setexp -dump /1998/december -expires at 12/31/1999 22:00</B>
 134
 135 </PRE>
 136 <P>The following example associates a relative expiration date of 7 days with
 137 the two dump levels <B>/monthly/week1</B> and
 138 <B>/monthly/week2</B>:
 139 <PRE>   % <B>backup setexp -dump /monthly/week1 /monthly/week -expires 7d</B>
 140
 141 </PRE>
 142 <P><STRONG>Privilege Required</STRONG>
 143 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
 144 every machine where the Backup Server is running, or must be logged onto a
 145 server machine as the local superuser <B>root</B> if the
 146 <B>-localauth</B> flag is included.
 147 <P><STRONG>Related Information</STRONG>
 148 <P><A HREF="auarf060.htm#HDRBK_INTRO">backup</A>
 149 <P><A HREF="auarf061.htm#HDRBK_ADDDUMP">backup adddump</A>
 150 <P><A HREF="auarf067.htm#HDRBK_DELDUMP">backup deldump</A>
 151 <P><A HREF="auarf080.htm#HDRBK_LISTDUMPS">backup listdumps</A>
 152 <P>
 153 <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>
 154 <!-- Begin Footer Records  ========================================== -->
 155 <P><HR><B>
 156 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved
 157 </B>
 158 <!-- End Footer Records  ============================================ -->
 159 <A NAME="Bot_Of_Page"></A>
 160 </BODY></HTML>