doc/xml/AdminReference/sect8/backup_listdumps.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="backup_listdumps8">
   3   <refmeta>
   4     <refentrytitle>backup listdumps</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>backup listdumps</refname>
   9     <refpurpose>Displays the dump hierarchy from the Backup Database</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">backup listdumps</emphasis> [<emphasis role="bold">-localauth</emphasis>] [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-help</emphasis>]</para>
  14
  15     <para><emphasis role="bold">backup listd</emphasis> [<emphasis role="bold">-l</emphasis>] [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-h</emphasis>]</para>
  16
  17   </refsect1>
  18   <refsect1>
  19     <title>Description</title>
  20     <para>The <emphasis role="bold">backup listdumps</emphasis> command displays the dump hierarchy from the
  21     Backup Database.</para>
  22
  23   </refsect1>
  24   <refsect1>
  25     <title>Options</title>
  26     <variablelist>
  27       <varlistentry>
  28         <term><emphasis role="bold">-localauth</emphasis></term>
  29         <listitem>
  30           <para>Constructs a server ticket using a key from the local
  31           <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">backup</emphasis> command interpreter presents
  32           it to the Backup Server, Volume Server and VL Server during mutual
  33           authentication. Do not combine this flag with the <emphasis role="bold">-cell</emphasis> argument. For
  34           more details, see <link linkend="backup8">backup(8)</link>.</para>
  35
  36         </listitem>
  37       </varlistentry>
  38       <varlistentry>
  39         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  40         <listitem>
  41           <para>Names the cell in which to run the command. Do not combine this argument
  42           with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="backup8">backup(8)</link>.</para>
  43
  44         </listitem>
  45       </varlistentry>
  46       <varlistentry>
  47         <term><emphasis role="bold">-help</emphasis></term>
  48         <listitem>
  49           <para>Prints the online help for this command. All other valid options are
  50           ignored.</para>
  51
  52         </listitem>
  53       </varlistentry>
  54     </variablelist>
  55   </refsect1>
  56   <refsect1>
  57     <title>Output</title>
  58     <para>The output displays the complete dump hierarchy and indicates the
  59     relationship between full and incremental dump levels. Full dump levels
  60     appear at the left margin. The hierarchy can include more than one full
  61     dump level; each one defines a subhierarchy of dump levels that can be
  62     used for dumping different volume sets.</para>
  63
  64     <para>Incremental dump levels appear below and indented to the right of their
  65     parent dump levels, which can be either full or incremental. Since
  66     multiple incremental dump levels can share the same parent, an incremental
  67     dump level is not always directly below its parent; the amount of
  68     indentation indicates the parent/child relationship.</para>
  69
  70     <para>If a dump level has an associated expiration date, it appears along with
  71     the level name. Absolute expiration dates appear in the format</para>
  72
  73 <programlisting>
  74    &amp;lt;dump_level&amp;gt; expires at &amp;lt;day month date time year&amp;gt;
  75
  76 </programlisting>
  77       <para>and relative expiration dates in the format</para>
  78
  79 <programlisting>
  80    &amp;lt;dump_level&amp;gt; expires in {&amp;lt;years&amp;gt;y | &amp;lt;months&amp;gt;m | &amp;lt;days&amp;gt;d}
  81
  82 </programlisting>
  83         <para>to indicate the number of years, months, days, or combination of the three
  84         after creation a dump expires when created at this level.</para>
  85
  86       </refsect1>
  87       <refsect1>
  88         <title>Examples</title>
  89         <para>The following example depicts six dump hierarchies. The expiration date
  90         for all incremental dump levels is 13 days so that the corresponding tapes
  91         can be recycled two weeks after their creation. The expiration dates for
  92         all full dump levels is 27 days so that the corresponding tapes can be
  93         recycled four weeks after their creation.</para>
  94
  95 <programlisting>
  96    % backup listdumps
  97    /week1  expires in  27d
  98          /tuesday  expires in  13d
  99                  /thursday  expires in  13d
 100          /sunday  expires in  13d
 101                 /tuesday expires in  13d
 102                         /thursday expires in  13d
 103    /week3  expires in  27d
 104          /tuesday  expires in  13d
 105                  /thursday  expires in  13d
 106          /sunday  expires in  13d
 107                 /tuesday  expires in  13d
 108                         /thursday  expires in  13d
 109    /sunday1  expires in  27d
 110            /monday1  expires in  13d
 111            /tuesday1  expires in  13d
 112            /wednesday1  expires in  13d
 113            /thursday1  expires in  13d
 114            /friday1  expires in  13d
 115    /sunday2  expires in  27d
 116            /monday2  expires in  13d
 117            /tuesday2  expires in  13d
 118            /wednesday2  expires in  13d
 119            /thursday2  expires in  13d
 120            /friday2  expires in  13d
 121    /sunday3  expires in  27d
 122            /monday1  expires in  13d
 123            /tuesday1  expires in  13d
 124            /wednesday1  expires in  13d
 125            /thursday1  expires in  13d
 126            /friday1  expires in  13d
 127    /sunday4  expires in  27d
 128            /monday2  expires in  13d
 129            /tuesday2  expires in  13d
 130            /wednesday2  expires in  13d
 131            /thursday2  expires in  13d
 132            /friday2  expires in  13d
 133
 134 </programlisting>
 135         </refsect1>
 136         <refsect1>
 137           <title>Privilege Required</title>
 138           <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on every
 139           machine where the Backup Server is running, or must be logged onto a
 140           server machine as the local superuser <computeroutput>root</computeroutput> if the <emphasis role="bold">-localauth</emphasis> flag is
 141           included.</para>
 142
 143         </refsect1>
 144         <refsect1>
 145           <title>See Also</title>
 146           <para><link linkend="backup8">backup(8)</link>,
 147           <link linkend="backup_adddump8">backup_adddump(8)</link>,
 148           <link linkend="backup_deldump8">backup_deldump(8)</link></para>
 149
 150         </refsect1>
 151         <refsect1>
 152           <title>Copyright</title>
 153           <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 154
 155           <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 156           converted from HTML to POD by software written by Chas Williams and Russ
 157           Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 158
 159         </refsect1>
 160       </refentry>