doc/man-pages/pod8/backup_deletedump.pod

   1 =head1 NAME
   2
   3 backup deletedump - Deletes one or more dump records from the Backup Database
   4
   5 =head1 SYNOPSIS
   6
   7 B<backup deletedump> [B<-dumpid> <I<dump id>>+] [B<-from> <I<date time>>+]
   8     [B<-to> <I<date time>>+] [B<-localauth>] [B<-cell> <I<cell name>>]
   9     [B<-help>]
  10
  11 B<backup dele> [B<-d> <I<dump id>>+] [B<-f> <I<date time>>+]
  12     [-t <I<date time>>+] [B<-l>] [B<-c> <I<cell name>>] [B<-h>]
  13
  14 =head1 DESCRIPTION
  15
  16 The B<backup deletedump> command deletes one or more dump records from the
  17 Backup Database. Either use the B<-dumpid> argument to specify the dump ID
  18 number of one or more dumps, or use the B<-from> and B<-to> arguments to
  19 delete the records for all regular dumps created during the time period
  20 bracketed by the specified values.
  21
  22 Use this command to remove dump records that are incorrect (possibly
  23 because a dump operation was interrupted or failed), or that correspond to
  24 dumps that are expired or otherwise no longer needed.
  25
  26 =head1 CAUTIONS
  27
  28 The only way to remove the dump record for an appended dump is to remove
  29 the record for its initial dump, and doing so removes the records for all
  30 of the initial dump's associated appended dumps.
  31
  32 The only way to remove the record for a Backup Database dump (created with
  33 the B<backup savedb> command) is to specify its dump ID number with the
  34 B<-dumpid> argument. Using the B<-from> and B<-to> arguments never removes
  35 database dump records.
  36
  37 Removing records of a dump makes it impossible to restore data from the
  38 corresponding tapes or from any dump that refers to the deleted dump as
  39 its parent, directly or indirectly. That is, restore operations must begin
  40 with the full dump and continue with each incremental dump in order. If
  41 the records for a specific dump are removed, it is not possible to restore
  42 data from later incremental dumps unless the deleted records are restored
  43 by running the B<backup scantape> command with the B<-dbadd> flag.
  44
  45 If a dump set contains any dumps that were created outside the time range
  46 specified by the B<-from> and B<-to> arguments, the command does not
  47 delete any of the records associated with the dump set, even if some of
  48 them represent dumps created during the time range.
  49
  50 =head1 OPTIONS
  51
  52 =over 4
  53
  54 =item B<-dumpid> <I<dump id>>+
  55
  56 Specifies the dump ID of each dump record to delete. The corresponding
  57 dumps must be initial dumps; it is not possible to delete appended dump
  58 records directly, but only by deleting the record of their associated
  59 initial dump. Using this argument is the only way to delete records of
  60 Backup Database dumps (created with the B<backup savedb> command).
  61
  62 Provide either this argument or the B<-to> (and optionally B<-from>)
  63 argument.
  64
  65 =item B<-from> <I<date time>>+
  66
  67 Specifies the beginning of a range of dates; the record for any dump
  68 created during the indicated period of time is deleted.
  69
  70 Omit this argument to indicate the default of midnight (00:00 hours) on 1
  71 January 1970 (UNIX time zero), or provide a date value in the format
  72 I<mm/dd/yyyy> [I<hh:MM>]. The month (I<mm>), day (I<dd>), and year
  73 (I<yyyy>) are required. The hour and minutes (I<hh:MM>) are optional, but
  74 if provided must be in 24-hour format (for example, the value C<14:36>
  75 represents 2:36 p.m.). If omitted, the time defaults to midnight (00:00
  76 hours).
  77
  78 The B<-to> argument must be provided along with this one.
  79
  80 =item B<-to> <I<date time>>+
  81
  82 Specifies the end of a range of dates; the record of any dump created
  83 during the range is deleted from the Backup Database.
  84
  85 Provide either the value C<NOW> to indicate the current date and time, or
  86 a date value in the same format as for the B<-from> argument. Valid values
  87 for the year (I<yyyy>) 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 any later date to the maximum value.
  91
  92 If the time portion (I<hh:MM>) is omitted, it defaults to 59 seconds after
  93 midnight (00:00:59 hours). Similarly, the B<backup> command interpreter
  94 automatically adds 59 seconds to any time value provided. In both cases,
  95 adding 59 seconds compensates for how the Backup Database and B<backup
  96 dumpinfo> command represent dump creation times in hours and minutes
  97 only. For example, the Database records a creation timestamp of C<20:55>
  98 for any dump operation that begins between 20:55:00 and 20:55:59.
  99 Automatically adding 59 seconds to a time thus includes the records for
 100 all dumps created during that minute.
 101
 102 Provide either this argument, or the B<-dumpid> argument.  This argument
 103 is required if the B<-from> argument is provided.
 104
 105 B<Caution:> Specifying the value C<NOW> for this argument when the
 106 B<-from> argument is omitted deletes all dump records from the Backup
 107 Database (except for Backup Database dump records created with the
 108 B<backup savedb> command).
 109
 110 =item B<-localauth>
 111
 112 Constructs a server ticket using a key from the local
 113 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
 114 it to the Backup Server, Volume Server and VL Server during mutual
 115 authentication. Do not combine this flag with the B<-cell> argument. For
 116 more details, see L<backup(8)>.
 117
 118 =item B<-cell> <I<cell name>>
 119
 120 Names the cell in which to run the command. Do not combine this argument
 121 with the B<-localauth> flag. For more details, see L<backup(8)>.
 122
 123 =item B<-help>
 124
 125 Prints the online help for this command. All other valid options are
 126 ignored.
 127
 128 =back
 129
 130 =head1 OUTPUT
 131
 132 At the conclusion of processing, the output lists the dump IDs of all dump
 133 records deleted in the following format:
 134
 135    The following dumps were deleted:
 136         dump ID 1
 137         dump ID 2
 138         etc.
 139
 140 =head1 EXAMPLES
 141
 142 The following command deletes the dump record with dump ID 653777462, and
 143 for any appended dumps associated with it:
 144
 145    % backup deletedump -dumpid 653777462
 146    The following dumps were deleted:
 147         653777462
 148
 149 The following command deletes the Backup Database record of all dumps
 150 created between midnight on 1 January 1997 and 23:59:59 hours on 31
 151 December 1997:
 152
 153    % backup deletedump -from 01/01/1997 -to 12/31/1997
 154    The following dumps were deleted:
 155         598324045
 156         598346873
 157            ...
 158            ...
 159         653777523
 160         653779648
 161
 162 =head1 PRIVILEGE REQUIRED
 163
 164 The issuer must be listed in the F</usr/afs/etc/UserList> file on every
 165 machine where the Backup Server is running, or must be logged onto a
 166 server machine as the local superuser C<root> if the B<-localauth> flag is
 167 included.
 168
 169 =head1 SEE ALSO
 170
 171 L<backup(8)>,
 172 L<backup_dumpinfo(8)>,
 173 L<backup_scantape(8)>
 174
 175 =head1 COPYRIGHT
 176
 177 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 178
 179 This documentation is covered by the IBM Public License Version 1.0.  It was
 180 converted from HTML to POD by software written by Chas Williams and Russ
 181 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.