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