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