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     <arg>
  55         <arg choice='plain'>--extract</arg>
  56         <arg choice='plain'>--directory<replaceable> directory</replaceable></arg>
  57         <arg choice='opt'>--data-path<replaceable> amanda|directtcp</replaceable></arg>
  58         <arg choice='opt'>--application-property <replaceable>NAME=VALUE</replaceable></arg>*
  59     </arg>
  60     <group choice='opt'>
  61       <arg choice='plain'>--decrypt</arg>
  62       <arg choice='plain'>--no-decrypt</arg>
  63       <arg choice='plain'>--server-decrypt</arg>
  64       <arg choice='plain'>--client-decrypt</arg>
  65     </group>
  66     <arg choice='opt'>--exact_match</arg>
  67     &configoverride.synopsis;
  68     <arg choice='plain'><replaceable>config</replaceable></arg>
  69     <arg choice='plain'><replaceable>hostname</replaceable></arg>
  70     <arg choice='opt'>
  71       <arg choice='plain'><replaceable>disk</replaceable></arg>
  72       <arg choice='opt'>
  73         <arg choice='plain'><replaceable>date</replaceable></arg>
  74         <arg choice='opt'>
  75           <arg choice='plain'><replaceable>level</replaceable></arg>
  76           <arg choice='opt'>
  77             <arg choice='plain'><replaceable>hostname</replaceable></arg>
  78             <arg choice='opt'>...</arg>
  79           </arg>
  80         </arg>
  81       </arg>
  82     </arg>
  83 </cmdsynopsis>
  84 </refsynopsisdiv>
  85
  86
  87 <refsect1><title>DESCRIPTION</title>
  88 <para><emphasis remap='B'>Amfetchdump</emphasis>
  89 pulls one or more matching dumps from tape or from the holding disk,
  90 handling the reassembly of multi-tape split dump files as well as any
  91 tape autochanger operations. The dump are by default decompressed and decrypted.
  92 </para>
  93
  94 <para>It will automatically use the Amanda catalog
  95 to locate available dumps on tape, in the same way that the <emphasis
  96 remap='B'>find</emphasis> feature of
  97 <manref name="amadmin" vol="8"/>
  98 lists available dumps.</para>
  99
 100 <para>The
 101 <emphasis remap='I'>hostname</emphasis>,
 102 <emphasis remap='I'>diskname</emphasis>,
 103 <emphasis remap='I'>datestamp</emphasis>,
 104 and
 105 <emphasis remap='I'>level</emphasis> dump specifications are further described in
 106 <manref name="amanda-match" vol="7"/>.
 107 Note that at minimum a <emphasis remap='I'>hostname</emphasis> must be specified.</para>
 108
 109 <para>Unless <option>-p</option>
 110 is used, backup images are extracted to files in the current directory named:</para>
 111
 112 <para>If a changer error occurs, or the <option>-d</option> option is given,
 113 then amfetchdump prompts for each required volume.</para>
 114
 115 <!-- .RS -->
 116 <para><emphasis remap='I'>hostname.diskname.datestamp.dumplevel</emphasis></para>
 117 <!-- .RE -->
 118 </refsect1>
 119
 120 <refsect1><title>OPTIONS</title>
 121 <variablelist remap='TP'>
 122   <varlistentry>
 123     <term><option>-p</option></term>
 124 <listitem><para>Pipe exactly one complete dump file to <emphasis
 125 remap='I'>stdout</emphasis>, instead of writing the file to disk. This
 126 will restore only the first matching dumpfile (where
 127 &quot;first&quot; is determined by the dump log search
 128 facility).</para></listitem>
 129   </varlistentry>
 130   <varlistentry>
 131     <term><option>-h</option></term>
 132 <listitem><para>Output the amanda header as a 32K block to same output as the image.</para></listitem>
 133   </varlistentry>
 134   <varlistentry>
 135     <term><option>--header-fd</option> <replaceable>fd</replaceable></term>
 136 <listitem><para>Output the amanda header to the numbered file
 137  descriptor.</para></listitem>
 138   </varlistentry>
 139   <varlistentry>
 140     <term><option>--header-file</option> <replaceable>filename</replaceable></term>
 141 <listitem><para>Output the amanda header to the filename.</para></listitem>
 142   </varlistentry>
 143   <varlistentry>
 144     <term><option>-d</option> <replaceable>device_or_changer</replaceable></term>
 145     <listitem><para> Restore from this device or changer instead of the default,
 146 prompting for each volume.</para></listitem>
 147   </varlistentry>
 148   <varlistentry>
 149     <term><option>-O</option>
 150     <replaceable>directory</replaceable></term>
 151 <listitem><para>Output restored files to this directory, instead of to the
 152     current working directory.</para></listitem>
 153   </varlistentry>
 154   <varlistentry>
 155     <term><option>-c</option></term>
 156     <listitem><para>Compress output, fastest method
 157     available.</para></listitem>
 158   </varlistentry>
 159   <varlistentry>
 160     <term><option>-C</option></term>
 161     <listitem><para>Compress output, smallest file size method
 162     available.</para></listitem>
 163   </varlistentry>
 164   <varlistentry>
 165     <term><option>--decompress</option></term>
 166     <listitem><para>Always do the decompression, this is the default.</para></listitem>
 167   </varlistentry>
 168   <varlistentry>
 169     <term><option>--no-decompress</option></term>
 170     <listitem><para>Never do the decompression.</para></listitem>
 171   </varlistentry>
 172   <varlistentry>
 173     <term><option>--server-decompress</option></term>
 174     <listitem><para>Do the decompression only if the compression was done on
 175 the server.</para></listitem>
 176   </varlistentry>
 177   <varlistentry>
 178     <term><option>--client-decompress</option></term>
 179     <listitem><para>Do the decompression only if the compression was done on
 180 the client.</para></listitem>
 181   </varlistentry>
 182   <varlistentry>
 183     <term><option>--decrypt</option></term>
 184     <listitem><para>Always do the decryption, this is the default.</para></listitem>
 185   </varlistentry>
 186   <varlistentry>
 187     <term><option>--no-decrypt</option></term>
 188     <listitem><para>Never do the decryption.</para></listitem>
 189   </varlistentry>
 190   <varlistentry>
 191     <term><option>--server-decrypt</option></term>
 192     <listitem><para>Do the decryption only if the encryption was done on
 193 the server.</para></listitem>
 194   </varlistentry>
 195   <varlistentry>
 196     <term><option>--client-decrypt</option></term>
 197     <listitem><para>Do the decryption only if the encryption was done on
 198 the client.</para></listitem>
 199   </varlistentry>
 200
 201   <varlistentry>
 202   <term><option>--exact-match</option></term>
 203   <listitem>
 204 <para>The host and disk are parsed as exact values</para>
 205   </listitem>
 206   </varlistentry>
 207
 208   <varlistentry>
 209   <term><option>--extract</option></term>
 210   <listitem>
 211 <para>Extract the backup on the server in the
 212 <replaceable>directory</replaceable> directory.</para>
 213   </listitem>
 214   </varlistentry>
 215
 216   <varlistentry>
 217   <term><option>--directory</option> <replaceable>directory</replaceable></term>
 218   <listitem>
 219 <para>Where to extract the backup with the <option>--extract</option> option.</para>
 220 <para>Warning: All files in that directory can be removed.</para>
 221   </listitem>
 222   </varlistentry>
 223
 224   <varlistentry>
 225   <term><option>--data-path</option> amanda|directtcp</term>
 226   <listitem>
 227 <para>The data path to use with <option>--extract</option>, the default is
 228  to use the fatest data path.</para>
 229   </listitem>
 230   </varlistentry>
 231
 232   <varlistentry>
 233   <term><option>--application-property</option> <replaceable>NAME=VALUE</replaceable></term>
 234   <listitem>
 235 <para>Application property to send to the application with
 236 <option>--extract.</option></para>
 237   </listitem>
 238   </varlistentry>
 239
 240   <varlistentry>
 241     <term><option>-l</option></term>
 242 <listitem><para>Leave dumps in the compressed/uncompressed and
 243 encrypted/unencrypted state in which they were found on tape.
 244 It is a synonym for <option>--no-decompression</option>
 245 <option>--no-decryption</option></para></listitem>
 246   </varlistentry>
 247   <varlistentry>
 248     <term><option>-a</option></term>
 249 <listitem><para>Assume that all tapes are already available, via tape changer or
 250 otherwise, instead of prompting the operator to ensure that all tapes
 251 are loaded.</para></listitem>
 252   </varlistentry>
 253
 254   <varlistentry>
 255     <term><option>-n</option></term>
 256 <listitem><para>Do not reassemble split dump files at all, just restore each
 257 piece as an individual file.</para></listitem>
 258   </varlistentry>
 259
 260   <varlistentry>
 261   <term><option>-o</option> <replaceable>configoption</replaceable></term>
 262   <listitem>
 263 <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>"
 264  section in <manref name="amanda" vol="8"/>.</para>
 265   </listitem>
 266   </varlistentry>
 267
 268 </variablelist>
 269 </refsect1>
 270
 271 <refsect1><title>EXAMPLES</title>
 272 <para>All the examples here assume your configuration is called
 273 <replaceable>SetA</replaceable>.</para>
 274
 275 <para>Here's a simple case, restoring all known dumps of the host
 276 vanya to the current working directory.</para>
 277 <programlisting>
 278 $ amfetchdump SetA vanya
 279 </programlisting>
 280
 281 <para>A more likely scenario involves restoring a particular dump from
 282 a particular date. We'll pipe this one to &gnutar; as well, to
 283 automatically extract the dump.</para>
 284 <programlisting>
 285 $ amfetchdump -p SetA vanya /home 20051020 | gtar -xvpf -
 286 </programlisting>
 287
 288 </refsect1>
 289
 290 <refsect1><title>CAVEATS</title>
 291 <para><command>Amfetchdump</command> is dependent on accessing your server's config,
 292 tape changer, and (normally) dump logs. As such, it's not necessarily
 293 the most useful tool when those have all been wiped out and you
 294 desperately need to pull things from your tape. Pains have been taken
 295 to make it as capable as possible, but for seriously minimialist
 296 restores, look to
 297 <manref name="amrestore" vol="8"/>
 298 or
 299 <manref name="dd" vol="8"/>
 300 instead.</para>
 301 </refsect1>
 302
 303 <seealso>
 304 <manref name="amanda-match" vol="7"/>,
 305 <manref name="amadmin" vol="8"/>,
 306 <manref name="amrestore" vol="8"/>,
 307 </seealso>
 308
 309 </refentry>
 310