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