doc/xml/AdminReference/sect8/backup_deletedump.xml

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