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