doc/xml/AdminReference/sect8/backup_volinfo.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="backup_volinfo8">
   3   <refmeta>
   4     <refentrytitle>backup volinfo</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>backup volinfo</refname>
   9     <refpurpose>Displays a volume's dump history from the Backup Database</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">backup volinfo</emphasis> <emphasis role="bold">-volume</emphasis> &lt;<emphasis>volume name</emphasis>&gt; [<emphasis role="bold">-localauth</emphasis>]
  14         [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-help</emphasis>]</para>
  15
  16     <para><emphasis role="bold">backup voli</emphasis> <emphasis role="bold">-v</emphasis> &lt;<emphasis>volume name</emphasis>&gt; [<emphasis role="bold">-l</emphasis>] [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-h</emphasis>]</para>
  17
  18   </refsect1>
  19   <refsect1>
  20     <title>Description</title>
  21     <para>The <emphasis role="bold">backup volinfo</emphasis> command displays a dump history of the specified
  22     volume, reporting information such as the date on which the volume was
  23     dumped and the tapes that contain it. Include the <computeroutput>.backup</computeroutput> extension on
  24     the volume name if the backup version of the volume was dumped.</para>
  25
  26   </refsect1>
  27   <refsect1>
  28     <title>Options</title>
  29     <variablelist>
  30       <varlistentry>
  31         <term><emphasis role="bold">-volume</emphasis> &lt;<emphasis>volume name</emphasis>&gt;</term>
  32         <listitem>
  33           <para>Names the volume for which to display the dump history. Include the
  34           <computeroutput>.backup</computeroutput> or <computeroutput>.readonly</computeroutput> extension if the backup or read-only version of
  35           the volume was dumped.</para>
  36
  37         </listitem>
  38       </varlistentry>
  39       <varlistentry>
  40         <term><emphasis role="bold">-localauth</emphasis></term>
  41         <listitem>
  42           <para>Constructs a server ticket using a key from the local
  43           <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">backup</emphasis> command interpreter presents
  44           it to the Backup Server, Volume Server and VL Server during mutual
  45           authentication. Do not combine this flag with the <emphasis role="bold">-cell</emphasis> argument. For
  46           more details, see <link linkend="backup8">backup(8)</link>.</para>
  47
  48         </listitem>
  49       </varlistentry>
  50       <varlistentry>
  51         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  52         <listitem>
  53           <para>Names the cell in which to run the command. Do not combine this argument
  54           with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="backup8">backup(8)</link>.</para>
  55
  56         </listitem>
  57       </varlistentry>
  58       <varlistentry>
  59         <term><emphasis role="bold">-help</emphasis></term>
  60         <listitem>
  61           <para>Prints the online help for this command. All other valid options are
  62           ignored.</para>
  63
  64         </listitem>
  65       </varlistentry>
  66     </variablelist>
  67   </refsect1>
  68   <refsect1>
  69     <title>Output</title>
  70     <para>The output includes a line for each Backup Database dump record that
  71     mentions the specified volume, order from most to least recent. The output
  72     for each record appears in a table with six columns:</para>
  73
  74     <variablelist>
  75       <varlistentry>
  76         <term>dumpID</term>
  77         <listitem>
  78           <para>The dump ID of the dump that includes the volume.</para>
  79
  80         </listitem>
  81       </varlistentry>
  82       <varlistentry>
  83         <term>lvl</term>
  84         <listitem>
  85           <para>The depth in the dump hierarchy of the dump level at which the volume was
  86           dumped. A value of <computeroutput>0</computeroutput> indicates a full dump. A value of <computeroutput>1</computeroutput> or greater
  87           indicates an incremental dump made at the specified depth in the dump
  88           hierarchy.</para>
  89
  90         </listitem>
  91       </varlistentry>
  92       <varlistentry>
  93         <term>parentid</term>
  94         <listitem>
  95           <para>The dump ID of the dump's parent dump. A value of <computeroutput>0</computeroutput> indicates a full
  96           dump, which has no parent; in this case, the value in the <computeroutput>lvl</computeroutput> column is
  97           also <computeroutput>0</computeroutput>.</para>
  98
  99         </listitem>
 100       </varlistentry>
 101       <varlistentry>
 102         <term>creation date</term>
 103         <listitem>
 104           <para>The date and time at which the Backup System started the dump operation
 105           that created the dump.</para>
 106
 107         </listitem>
 108       </varlistentry>
 109       <varlistentry>
 110         <term>clone date</term>
 111         <listitem>
 112           <para>For a backup or read-only volume, the time at which it was cloned from its
 113           read/write source. For a read/write volume, the same as the value in the
 114           <computeroutput>creation date</computeroutput> field.</para>
 115
 116         </listitem>
 117       </varlistentry>
 118       <varlistentry>
 119         <term>tape name</term>
 120         <listitem>
 121           <para>The name of the tape containing the dump: either the permanent tape name,
 122           or an AFS tape name in the format
 123           <emphasis>volume_set_name</emphasis>.<emphasis>dump_level_name</emphasis>.<emphasis>tape_index</emphasis> where
 124           <emphasis>volume_set_name</emphasis> is the name of the volume set associated with the
 125           initial dump in the dump set of which this tape is a part;
 126           <emphasis>dump_level_name</emphasis> is the name of the dump level at which the initial dump
 127           was backed up; <emphasis>tape_index</emphasis> is the ordinal of the tape in the dump
 128           set. Either type of name can be followed by a dump ID in parentheses; if
 129           it appears, it is the dump ID of the initial dump in the dump set to which
 130           this appended dump belongs.</para>
 131
 132         </listitem>
 133       </varlistentry>
 134     </variablelist>
 135   </refsect1>
 136   <refsect1>
 137     <title>Examples</title>
 138     <para>The following example shows part of the dump history of the Backup volume
 139     <computeroutput>user.smith.backup</computeroutput>:</para>
 140
 141 <programlisting>
 142    % backup volinfo -volume user.smith.backup
 143    DumpID    lvl parentID  creation date    clone date       tape name
 144    924600000 1   924427600 04/20/1999 05:20 04/20/1999 05:01 user_incr_2 (924514392)
 145    924514392 1   924427600 04/19/1999 05:33 04/19/1999 05:08 user_incr_2
 146    924427600 0           0 04/18/1999 05:26 04/18/1999 04:58 user_full_6
 147        .     .      .         .       .       .      .         .
 148        .     .      .         .       .       .      .         .
 149
 150 </programlisting>
 151     </refsect1>
 152     <refsect1>
 153       <title>Privilege Required</title>
 154       <para>None</para>
 155
 156     </refsect1>
 157     <refsect1>
 158       <title>See Also</title>
 159       <para><link linkend="backup8">backup(8)</link>,
 160       <link linkend="backup_dumpinfo8">backup_dumpinfo(8)</link>,
 161       <link linkend="backup_volrestore8">backup_volrestore(8)</link></para>
 162
 163     </refsect1>
 164     <refsect1>
 165       <title>Copyright</title>
 166       <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 167
 168       <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 169       converted from HTML to POD by software written by Chas Williams and Russ
 170       Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 171
 172     </refsect1>
 173   </refentry>