git.gag.com Git - debian/amanda/blob - man/xml-source/amfetchdump.8.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
   4 [
   5   <!-- entities files to use -->
   6   <!ENTITY % global_entities SYSTEM 'global.entities'>
   7   %global_entities;
   8 ]>
   9
  10 <refentry id='amfetchdump.8'>
  11
  12 <refmeta>
  13 <refentrytitle>amfetchdump</refentrytitle>
  14 <manvolnum>8</manvolnum>
  15 &rmi.source;
  16 &rmi.version;
  17 &rmi.manual.8;
  18 </refmeta>
  19 <refnamediv>
  20 <refname>amfetchdump</refname>
  21 <refpurpose>extract backup images from multiple Amanda tapes.</refpurpose>
  22 </refnamediv>
  23 <refentryinfo>
  24 &author.jstange;
  25 &author.ian;
  26 </refentryinfo>
  27 <!-- body begins here -->
  28 <refsynopsisdiv>
  29 <cmdsynopsis>
  30   <command>amfetchdump</command>
  31     <group choice='opt'>
  32       <arg choice='plain'>-c</arg>
  33       <arg choice='plain'>-C</arg>
  34       <arg choice='plain'>-l</arg>
  35     </group>
  36     <group choice='opt'>
  37       <arg choice='plain'>-p</arg>
  38       <arg choice='plain'>-n</arg>
  39     </group>
  40     <arg choice='opt'>-a</arg>
  41     <arg choice='opt'>-O <replaceable>directory</replaceable></arg>
  42     <arg choice='opt'>-d <replaceable>device</replaceable></arg>
  43     <group choice='opt'>
  44       <arg choice='plain'>-h</arg>
  45       <arg choice='plain'>--header-file <replaceable>filename</replaceable></arg>
  46       <arg choice='plain'>--header-fd <replaceable>fd</replaceable></arg>
  47     </group>
  48     <group choice='opt'>
  49       <arg choice='plain'>--decompress</arg>
  50       <arg choice='plain'>--no-decompress</arg>
  51       <arg choice='plain'>--server-decompress</arg>
  52       <arg choice='plain'>--client-decompress</arg>
  53     </group>
  54     <group choice='opt'>
  55       <arg choice='plain'>--decrypt</arg>
  56       <arg choice='plain'>--no-decrypt</arg>
  57       <arg choice='plain'>--server-decrypt</arg>
  58       <arg choice='plain'>--client-decrypt</arg>
  59     </group>
  60     &configoverride.synopsis;
  61     <arg choice='plain'><replaceable>config</replaceable></arg>
  62     <arg choice='plain'><replaceable>hostname</replaceable></arg>
  63     <arg choice='opt'>
  64       <arg choice='plain'><replaceable>disk</replaceable></arg>
  65       <arg choice='opt'>
  66         <arg choice='plain'><replaceable>date</replaceable></arg>
  67         <arg choice='opt'>
  68           <arg choice='plain'><replaceable>level</replaceable></arg>
  69           <arg choice='opt'>
  70             <arg choice='plain'><replaceable>hostname</replaceable></arg>
  71             <arg choice='opt'>...</arg>
  72           </arg>
  73         </arg>
  74       </arg>
  75     </arg>
  76 </cmdsynopsis>
  77 </refsynopsisdiv>
  78
  79
  80 <refsect1><title>DESCRIPTION</title>
  81 <para><emphasis remap='B'>Amfetchdump</emphasis>
  82 pulls one or more matching dumps from tape or from the holding disk,
  83 handling the reassembly of multi-tape split dump files as well as any
  84 tape autochanger operations. The dump are by default decompressed and decrypted.
  85 </para>
  86
  87 <para>It will automatically use the Amanda catalog
  88 to locate available dumps on tape, in the same way that the <emphasis
  89 remap='B'>find</emphasis> feature of
  90 <manref name="amadmin" vol="8"/>
  91 lists available dumps.</para>
  92
  93 <para>The
  94 <emphasis remap='I'>hostname</emphasis>,
  95 <emphasis remap='I'>diskname</emphasis>,
  96 <emphasis remap='I'>datestamp</emphasis>,
  97 and
  98 <emphasis remap='I'>level</emphasis> dump specifications are further described in
  99 <manref name="amanda-match" vol="7"/>.
 100 Note that at minimum a <emphasis remap='I'>hostname</emphasis> must be specified.</para>
 101
 102 <para>Unless <option>-p</option>
 103 is used, backup images are extracted to files in the current directory named:</para>
 104
 105 <para>If a changer error occurs, or the <option>-d</option> option is given,
 106 then amfetchdump prompts for each required volume.</para>
 107
 108 <!-- .RS -->
 109 <para><emphasis remap='I'>hostname.diskname.datestamp.dumplevel</emphasis></para>
 110 <!-- .RE -->
 111 </refsect1>
 112
 113 <refsect1><title>OPTIONS</title>
 114 <variablelist remap='TP'>
 115   <varlistentry>
 116     <term><option>-p</option></term>
 117 <listitem><para>Pipe exactly one complete dump file to <emphasis
 118 remap='I'>stdout</emphasis>, instead of writing the file to disk. This
 119 will restore only the first matching dumpfile (where
 120 &quot;first&quot; is determined by the dump log search
 121 facility).</para></listitem>
 122   </varlistentry>
 123   <varlistentry>
 124     <term><option>-h</option></term>
 125 <listitem><para>Output the amanda header as a 32K block to same output as the image.</para></listitem>
 126   </varlistentry>
 127   <varlistentry>
 128     <term><option>--header-fd</option> <replaceable>fd</replaceable></term>
 129 <listitem><para>Output the amanda header to the numbered file
 130  descriptor.</para></listitem>
 131   </varlistentry>
 132   <varlistentry>
 133     <term><option>--header-file</option> <replaceable>filename</replaceable></term>
 134 <listitem><para>Output the amanda header to the filename.</para></listitem>
 135   </varlistentry>
 136   <varlistentry>
 137     <term><option>-d</option> <replaceable>device_or_changer</replaceable></term>
 138     <listitem><para> Restore from this device or changer instead of the default,
 139 prompting for each volume.</para></listitem>
 140   </varlistentry>
 141   <varlistentry>
 142     <term><option>-O</option>
 143     <replaceable>directory</replaceable></term>
 144 <listitem><para>Output restored files to this directory, instead of to the
 145     current working directory.</para></listitem>
 146   </varlistentry>
 147   <varlistentry>
 148     <term><option>-c</option></term>
 149     <listitem><para>Compress output, fastest method
 150     available.</para></listitem>
 151   </varlistentry>
 152   <varlistentry>
 153     <term><option>-C</option></term>
 154     <listitem><para>Compress output, smallest file size method
 155     available.</para></listitem>
 156   </varlistentry>
 157   <varlistentry>
 158     <term><option>--decompress</option></term>
 159     <listitem><para>Always do the decompression, this is the default.</para></listitem>
 160   </varlistentry>
 161   <varlistentry>
 162     <term><option>--no-decompress</option></term>
 163     <listitem><para>Never do the decompression.</para></listitem>
 164   </varlistentry>
 165   <varlistentry>
 166     <term><option>--server-decompress</option></term>
 167     <listitem><para>Do the decompression only if the compression was done on
 168 the server.</para></listitem>
 169   </varlistentry>
 170   <varlistentry>
 171     <term><option>--client-decompress</option></term>
 172     <listitem><para>Do the decompression only if the compression was done on
 173 the client.</para></listitem>
 174   </varlistentry>
 175   <varlistentry>
 176     <term><option>--decrypt</option></term>
 177     <listitem><para>Always do the decryption, this is the default.</para></listitem>
 178   </varlistentry>
 179   <varlistentry>
 180     <term><option>--no-decrypt</option></term>
 181     <listitem><para>Never do the decryption.</para></listitem>
 182   </varlistentry>
 183   <varlistentry>
 184     <term><option>--server-decrypt</option></term>
 185     <listitem><para>Do the decryption only if the encryption was done on
 186 the server.</para></listitem>
 187   </varlistentry>
 188   <varlistentry>
 189     <term><option>--client-decrypt</option></term>
 190     <listitem><para>Do the decryption only if the encryption was done on
 191 the client.</para></listitem>
 192   </varlistentry>
 193   <varlistentry>
 194     <term><option>-l</option></term>
 195 <listitem><para>Leave dumps in the compressed/uncompressed and
 196 encrypted/unencrypted state in which they were found on tape.
 197 It is a synonym for <option>--no-decompression</option>
 198 <option>--no-decryption</option></para></listitem>
 199   </varlistentry>
 200   <varlistentry>
 201     <term><option>-a</option></term>
 202 <listitem><para>Assume that all tapes are already available, via tape changer or
 203 otherwise, instead of prompting the operator to ensure that all tapes
 204 are loaded.</para></listitem>
 205   </varlistentry>
 206
 207   <varlistentry>
 208     <term><option>-n</option></term>
 209 <listitem><para>Do not reassemble split dump files at all, just restore each
 210 piece as an individual file.</para></listitem>
 211   </varlistentry>
 212
 213   <varlistentry>
 214   <term><option>-o</option> <replaceable>configoption</replaceable></term>
 215   <listitem>
 216 <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>"
 217  section in <manref name="amanda" vol="8"/>.</para>
 218   </listitem>
 219   </varlistentry>
 220
 221 </variablelist>
 222 </refsect1>
 223
 224 <refsect1><title>EXAMPLES</title>
 225 <para>All the examples here assume your configuration is called
 226 <replaceable>SetA</replaceable>.</para>
 227
 228 <para>Here's a simple case, restoring all known dumps of the host
 229 vanya to the current working directory.</para>
 230 <programlisting>
 231 $ amfetchdump SetA vanya
 232 </programlisting>
 233
 234 <para>A more likely scenario involves restoring a particular dump from
 235 a particular date. We'll pipe this one to &gnutar; as well, to
 236 automatically extract the dump.</para>
 237 <programlisting>
 238 $ amfetchdump -p SetA vanya /home 20051020 | gtar -xvpf -
 239 </programlisting>
 240
 241 </refsect1>
 242
 243 <refsect1><title>CAVEATS</title>
 244 <para><command>Amfetchdump</command> is dependent on accessing your server's config,
 245 tape changer, and (normally) dump logs. As such, it's not necessarily
 246 the most useful tool when those have all been wiped out and you
 247 desperately need to pull things from your tape. Pains have been taken
 248 to make it as capable as possible, but for seriously minimialist
 249 restores, look to
 250 <manref name="amrestore" vol="8"/>
 251 or
 252 <manref name="dd" vol="8"/>
 253 instead.</para>
 254 </refsect1>
 255
 256 <seealso>
 257 <manref name="amanda-match" vol="7"/>,
 258 <manref name="amadmin" vol="8"/>,
 259 <manref name="amrestore" vol="8"/>,
 260 </seealso>
 261
 262 </refentry>
 263