Imported Upstream version 3.2.1
[debian/amanda] / 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     <arg choice='opt'>-phcClawns</arg>
32     <arg choice='opt'>-d <replaceable>device</replaceable></arg>
33     <arg choice='opt'>-O <replaceable>directory</replaceable></arg>
34     <arg choice='opt'>-b <replaceable>blocksize</replaceable></arg>
35     <arg choice='opt'>--header-fd <replaceable>fd</replaceable></arg>
36     <arg choice='opt'>--header-file <replaceable>filename</replaceable></arg>
37     &configoverride.synopsis;
38     <arg choice='plain'><replaceable>config</replaceable></arg>
39     <arg choice='plain'><replaceable>hostname</replaceable></arg>
40     <arg choice='opt'>
41       <arg choice='plain'><replaceable>disk</replaceable></arg>
42       <arg choice='opt'>
43         <arg choice='plain'><replaceable>date</replaceable></arg>
44         <arg choice='opt'>
45           <arg choice='plain'><replaceable>level</replaceable></arg>
46           <arg choice='opt'>
47             <arg choice='plain'><replaceable>hostname</replaceable></arg>
48             <arg choice='opt'>...</arg>
49           </arg>
50         </arg>
51       </arg>
52     </arg>
53 </cmdsynopsis>
54 </refsynopsisdiv>
55
56
57 <refsect1><title>DESCRIPTION</title>
58 <para><emphasis remap='B'>Amfetchdump</emphasis>
59 pulls one or more matching dumps from tape or from the holding disk,
60 handling the reassembly of multi-tape split dump files as well as any
61 tape autochanger operations.</para>
62
63 <para>It will automatically use the Amanda catalog
64 to locate available dumps on tape, in the same way that the <emphasis
65 remap='B'>find</emphasis> feature of
66 <manref name="amadmin" vol="8"/>
67 lists available dumps.</para>
68
69 <para>The 
70 <emphasis remap='I'>hostname</emphasis>,
71 <emphasis remap='I'>diskname</emphasis>,
72 <emphasis remap='I'>datestamp</emphasis>,
73 and
74 <emphasis remap='I'>level</emphasis> dump specifications are further described in
75 <manref name="amanda-match" vol="7"/>.
76 Note that at minimum a <emphasis remap='I'>hostname</emphasis> must be specified.</para>
77
78 <para>Unless <option>-p</option>
79 is used, backup images are extracted to files in the current directory named:</para>
80
81 <para>If a changer error occurs, or the <option>-d</option> option is given,
82 then amfetchdump prompts for each required volume.</para>
83
84 <!-- .RS -->
85 <para><emphasis remap='I'>hostname.diskname.datestamp.dumplevel</emphasis></para>
86 <!-- .RE -->
87 </refsect1>
88
89 <refsect1><title>OPTIONS</title>
90 <variablelist remap='TP'>
91   <varlistentry>
92     <term><option>-p</option></term>
93 <listitem><para>Pipe exactly one complete dump file to <emphasis
94 remap='I'>stdout</emphasis>, instead of writing the file to disk. This
95 will restore only the first matching dumpfile (where
96 &quot;first&quot; is determined by the dump log search
97 facility).</para></listitem>
98   </varlistentry>
99   <varlistentry>
100     <term><option>-h</option></term>
101 <listitem><para>Output the amanda header as a 32K block to same output as the image.</para></listitem>
102   </varlistentry>
103   <varlistentry>
104     <term><option>--header-fd</option> <replaceable>fd</replaceable></term>
105 <listitem><para>Output the amanda header to the numbered file
106  descriptor.</para></listitem>
107   </varlistentry>
108   <varlistentry>
109     <term><option>--header-file</option> <replaceable>filename</replaceable></term>
110 <listitem><para>Output the amanda header to the filename.</para></listitem>
111   </varlistentry>
112   <varlistentry>
113     <term><option>-d</option> <replaceable>device_or_changer</replaceable></term>
114     <listitem><para> Restore from this device or changer instead of the default,
115 prompting for each volume.</para></listitem>
116   </varlistentry>
117   <varlistentry>
118     <term><option>-O</option>
119     <replaceable>directory</replaceable></term>
120 <listitem><para>Output restored files to this directory, instead of to the
121     current working directory.</para></listitem>
122   </varlistentry>
123   <varlistentry>
124     <term><option>-c</option></term>
125     <listitem><para>Compress output, fastest method
126     available.</para></listitem>
127   </varlistentry>
128   <varlistentry>
129     <term><option>-C</option></term>
130     <listitem><para>Compress output, smallest file size method
131     available.</para></listitem>
132   </varlistentry>
133   <varlistentry>
134     <term><option>-l</option></term>
135 <listitem><para>Leave dumps in the compressed/uncompressed state in which they
136 were found on tape. By default, <emphasis
137 remap='B'>amfetchdump</emphasis> will automatically uncompress when
138 restoring.</para></listitem>
139   </varlistentry>
140   <varlistentry>
141     <term><option>-a</option></term>
142 <listitem><para>Assume that all tapes are already available, via tape changer or
143 otherwise, instead of prompting the operator to ensure that all tapes
144 are loaded.</para></listitem>
145   </varlistentry>
146
147   <varlistentry>
148     <term><option>-n</option></term>
149 <listitem><para>Do not reassemble split dump files at all, just restore each
150 piece as an individual file.</para></listitem>
151   </varlistentry>
152
153   <varlistentry>
154   <term><option>-o</option> <replaceable>configoption</replaceable></term>
155   <listitem>
156 <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>"
157  section in <manref name="amanda" vol="8"/>.</para>
158   </listitem>
159   </varlistentry>
160
161 </variablelist>
162 </refsect1>
163
164 <refsect1><title>EXAMPLES</title>
165 <para>All the examples here assume your configuration is called
166 <replaceable>SetA</replaceable>.</para>
167
168 <para>Here's a simple case, restoring all known dumps of the host
169 vanya to the current working directory.</para>
170 <programlisting>
171 $ amfetchdump SetA vanya
172 </programlisting>
173
174 <para>A more likely scenario involves restoring a particular dump from
175 a particular date. We'll pipe this one to &gnutar; as well, to
176 automatically extract the dump.</para>
177 <programlisting>
178 $ amfetchdump -p SetA vanya /home 20051020 | gtar -xvpf -
179 </programlisting>
180
181 </refsect1>
182
183 <refsect1><title>CAVEATS</title>
184 <para><command>Amfetchdump</command> is dependent on accessing your server's config,
185 tape changer, and (normally) dump logs. As such, it's not necessarily
186 the most useful tool when those have all been wiped out and you
187 desperately need to pull things from your tape. Pains have been taken
188 to make it as capable as possible, but for seriously minimialist
189 restores, look to
190 <manref name="amrestore" vol="8"/>
191 or
192 <manref name="dd" vol="8"/>
193 instead.</para>
194 </refsect1>
195
196 <seealso>
197 <manref name="amanda-match" vol="7"/>,
198 <manref name="amadmin" vol="8"/>,
199 <manref name="amrestore" vol="8"/>,
200 </seealso>
201
202 </refentry>
203