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