doc/man-pages/pod8/backup_setexp.pod

   1 =head1 NAME
   2
   3 backup setexp - Sets the expiration date for existing dump levels.
   4
   5 =head1 SYNOPSIS
   6
   7 B<backup setexp> B<-dump> <I<dump level name>>+
   8     [B<-expires> <I<expiration date>>+] [B<-localauth>]
   9     [B<-cell> <I<cell name>>] [B<-help>]
  10
  11 B<backup se> B<-d> <I<dump level name>>+ [B<-e> <I<expiration date>>+]
  12     [B<-l>] [B<-c> <I<cell name>>] [B<-h>]
  13
  14 =head1 DESCRIPTION
  15
  16 The B<backup setexp> command sets or changes the expiration date
  17 associated with each specified dump level, which must already exist in the
  18 dump hierarchy.
  19
  20 Use the B<-expires> argument to associate an expiration date with each
  21 dump level. When the Backup System subsequently creates a dump at the dump
  22 level, it uses the specified value to derive the dump's expiration date,
  23 which it records on the label of the tape (or backup data file). The
  24 Backup System refuses to overwrite a tape until after the latest
  25 expiration date of any dump that the tape contains, unless the B<backup
  26 labeltape> command is used to relabel the tape. If a dump level does not
  27 have an expiration date, the Backup System treats dumps created at the
  28 level as expired as soon as it creates them.
  29
  30 (Note that the Backup System does not automatically remove a dump's record
  31 from the Backup Database when the dump reaches its expiration date, but
  32 only if the tape that contains the dump is recycled or relabeled. To
  33 remove expired and other obsolete dump records, use the B<backup
  34 deletedump> command.)
  35
  36 Define either an absolute or relative expiration date:
  37
  38 =over 4
  39
  40 =item *
  41
  42 An absolute expiration date defines the month/day/year (and, optionally,
  43 hour and minutes) at which a dump expires. If the expiration date predates
  44 the dump creation time, the Backup System immediately treats the dump as
  45 expired.
  46
  47 =item *
  48
  49 A relative date defines the number of years, months, or days (or a
  50 combination of the three) after the dump's creation that it expires. When
  51 the Backup System creates a dump at the dump level, it calculates an
  52 actual expiration date by adding the relative date to the start time of
  53 the dump operation.
  54
  55 =back
  56
  57 If the command is used to change an existing expiration date associated
  58 with a dump level, the new date applies only to dumps created after the
  59 change. Existing dumps retain the expiration date assigned at the time
  60 they were created.
  61
  62 =head1 OPTIONS
  63
  64 =over 4
  65
  66 =item B<-dump> <I<dump level name>>+
  67
  68 Specifies the full pathname of each dump level to assign the expiration
  69 date specified by the B<-expires> argument.
  70
  71 =item B<-expires> <I<expiration date>>+
  72
  73 Defines the absolute or relative expiration date to associate with each
  74 dump level named by the B<-dump> argument. Absolute expiration dates have
  75 the following format:
  76
  77    [at] {NEVER | <mm>/<dd>/<yyyy> [<hh>:<MM>] }
  78
  79 where the optional word at is followed either by the string C<NEVER>,
  80 which indicates that dumps created at the dump level never expire, or by a
  81 date value with a required portion (<mm> for month, <dd> for day, and
  82 <yyyy> for year) and an optional portion (<hh> for hours and <MM> for
  83 minutes).
  84
  85 Omit the <hh>:<MM> portion to use the default of midnight (00:00 hours),
  86 or provide a value in 24-hour format (for example, C<20:30> is 8:30 p.m.).
  87 Valid values for the year range from C<1970> to C<2037>; higher values are
  88 not valid because the latest possible date in the standard UNIX
  89 representation is in February 2038. The command interpreter automatically
  90 reduces later dates to the maximum value.
  91
  92 Relative expiration dates have the following format:
  93
  94    [in] [<years>y] [<months>m] [<days>d]
  95
  96 where the optional word in is followed by at least one of a number of
  97 years (maximum C<9999>) followed by the letter C<y>, a number of months
  98 (maximum C<12>) followed by the letter C<m>, or a number of days (maximum
  99 C<31>) followed by the letter C<d>. If providing more than one of the
 100 three, list them in the indicated order. If the date that results from
 101 adding the relative expiration value to a dump's creation time is later
 102 than the latest possible date in the UNIX time representation, the Backup
 103 System automatically reduces it to that date.
 104
 105 =item B<-localauth>
 106
 107 Constructs a server ticket using a key from the local
 108 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
 109 it to the Backup Server, Volume Server and VL Server during mutual
 110 authentication. Do not combine this flag with the B<-cell> argument. For
 111 more details, see L<backup(8)>.
 112
 113 =item B<-cell> <I<cell name>>
 114
 115 Names the cell in which to run the command. Do not combine this argument
 116 with the B<-localauth> flag. For more details, see L<backup(8)>.
 117
 118 =item B<-help>
 119
 120 Prints the online help for this command. All other valid options are
 121 ignored.
 122
 123 =back
 124
 125 =head1 EXAMPLES
 126
 127 The following example associates an absolute expiration date of 10:00
 128 p.m. on 31 December 1999 with the dump level C</1998/december>:
 129
 130    % backup setexp -dump /1998/december -expires at 12/31/1999 22:00
 131
 132 The following example associates a relative expiration date of 7 days with
 133 the two dump levels C</monthly/week1> and C</monthly/week2>:
 134
 135    % backup setexp -dump /monthly/week1 /monthly/week -expires 7d
 136
 137 =head1 PRIVILEGE REQUIRED
 138
 139 The issuer must be listed in the F</usr/afs/etc/UserList> file on every
 140 machine where the Backup Server is running, or must be logged onto a
 141 server machine as the local superuser C<root> if the B<-localauth> flag is
 142 included.
 143
 144 =head1 SEE ALSO
 145
 146 L<backup(8)>,
 147 L<backup_adddump(8)>,
 148 L<backup_deldump(8)>,
 149 L<backup_listdumps(8)>
 150
 151 =head1 COPYRIGHT
 152
 153 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 154
 155 This documentation is covered by the IBM Public License Version 1.0.  It was
 156 converted from HTML to POD by software written by Chas Williams and Russ
 157 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.