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