727f4ccfcdcc7e6adb666f3e8ecf067df2fe30f4
[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 '../entities/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 &A; 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'>-pcClawns</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='plain'><replaceable>config</replaceable></arg>
36     <arg choice='plain'><replaceable>hostname</replaceable></arg>
37     <arg choice='opt'>
38       <arg choice='plain'><replaceable>disk</replaceable></arg>
39       <arg choice='opt'>
40         <arg choice='plain'><replaceable>date</replaceable></arg>
41         <arg choice='opt'>
42           <arg choice='plain'><replaceable>level</replaceable></arg>
43           <arg choice='opt'>
44             <arg choice='plain'><replaceable>hostname</replaceable></arg>
45             <arg choice='opt'>...</arg>
46           </arg>
47         </arg>
48       </arg>
49     </arg>
50     <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o </arg><replaceable>configoption</replaceable></group></arg>
51 </cmdsynopsis>
52 </refsynopsisdiv>
53
54
55 <refsect1><title>DESCRIPTION</title>
56 <para><emphasis remap='B'>Amfetchdump</emphasis>
57 pulls one or more matching dumps from tape or from the holding disk,
58 handling the reassembly of multi-tape split dump files as well as any
59 tape autochanger operations.</para>
60
61 <para>It will automatically use the logs created by
62 <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>
63 to locate available dumps on tape, in the same way that the <emphasis
64 remap='B'>find</emphasis> feature of
65 <citerefentry><refentrytitle>amadmin</refentrytitle><manvolnum>8</manvolnum></citerefentry>
66 lists available dumps. If these logs are unavailable, it can search
67 tape-by-tape to find what it needs, and can generate new logs to serve
68 as an emergency tape inventory.</para>
69
70 <para>The 
71 <emphasis remap='I'>hostname</emphasis>,
72 <emphasis remap='I'>diskname</emphasis>,
73 <emphasis remap='I'>datestamp</emphasis>,
74 and
75 <emphasis remap='I'>level</emphasis> dump pattern-matching works as in
76 <citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
77 with the added requirement that at minimum a <emphasis
78 remap='I'>hostname</emphasis> must be specified when not in inventory mode.</para>
79
80 <para>Unless
81 <option>-p</option>
82 is used, backup images are extracted to files in the current directory named:</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>-d</option> <replaceable>device</replaceable></term>
101 <listitem><para> Restore from this tape device instead of the default.</para></listitem>
102   </varlistentry>
103   <varlistentry>
104     <term><option>-O</option>
105     <replaceable>directory</replaceable></term>
106 <listitem><para>Output restored files to this directory, instead of to the
107     current working directory.</para></listitem>
108   </varlistentry>
109   <varlistentry>
110     <term><option>-c</option></term>
111     <listitem><para>Compress output, fastest method
112     available.</para></listitem>
113   </varlistentry>
114   <varlistentry>
115     <term><option>-C</option></term>
116     <listitem><para>Compress output, smallest file size method
117     available.</para></listitem>
118   </varlistentry>
119   <varlistentry>
120     <term><option>-l</option></term>
121 <listitem><para>Leave dumps in the compressed/uncompressed state in which they
122 were found on tape. By default, <emphasis
123 remap='B'>amfetchdump</emphasis> will automatically uncompress when
124 restoring.</para></listitem>
125   </varlistentry>
126   <varlistentry>
127     <term><option>-a</option></term>
128 <listitem><para>Assume that all tapes are already available, via tape changer or
129 otherwise, instead of prompting the operator to ensure that all tapes
130 are loaded.</para></listitem>
131   </varlistentry>
132   <varlistentry>
133     <term><option>-w</option></term>
134 <listitem><para>Wait to put split dumps together until all chunks have been
135 restored. Normally, <emphasis remap='B'>amfetchdump</emphasis> will
136 attempt to read pieces of a split file from tape in order, so that it
137 can assemble them simply by appending each file to the first. This
138 option disables the appending behavior, and instead restores each
139 piece as an individual file and reassembles them only after all have
140 been restored.</para>
141
142 <note><para>This requires at least double the size of your dump in free
143 disk space, in order to build the final assembled dumpfile.</para>
144 </note>
145
146 <para>This behavior is implicitly invoked in circumstances where knowing the
147 location of all dumps on tape in advance is not possible, such as when
148 you are restoring without log files.</para></listitem>
149   </varlistentry>
150   <varlistentry>
151     <term><option>-n</option></term>
152 <listitem><para>Do not reassemble split dump files at all, just restore each
153 piece as an individual file.</para></listitem>
154   </varlistentry>
155   <varlistentry>
156     <term><option>-s</option></term>
157 <listitem><para>Do not fast-forward straight to needed files on tape. This will
158 slow down most restores substantially. Only use this option if your
159 tape drive does not properly support the fast-forward
160 operation.</para></listitem>
161   </varlistentry>
162   <varlistentry>
163     <term><option>-b</option>
164     <replaceable>blocksize</replaceable></term>
165 <listitem><para>Force a particular block size when reading from tapes. This
166     value will usually be autodetected, and should not normally need
167     to be set.</para></listitem>
168   </varlistentry>
169
170   <varlistentry>
171   <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
172   <listitem>
173 <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>"
174  section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
175   </listitem>
176   </varlistentry>
177
178 </variablelist>
179 </refsect1>
180
181 <refsect1><title>EXAMPLES</title>
182 <para>All the examples here assume your configuration is called
183 <replaceable>SetA</replaceable>.</para>
184
185 <para>Here's a simple case, restoring all known dumps of the host
186 vanya to the current working directory.</para>
187 <programlisting>
188 $ amfetchdump SetA vanya
189 </programlisting>
190
191 <para>A more likely scenario involves restoring a particular dump from
192 a particular date. We'll pipe this one to &gnutar; as well, to
193 automatically extract the dump.</para>
194 <programlisting>
195 $ amfetchdump -p SetA vanya /home 20051020 | gtar -xvpf -
196 </programlisting>
197
198 </refsect1>
199
200 <refsect1><title>CAVEATS</title>
201 <para><command>Amfetchdump</command> is dependent on accessing your server's config,
202 tape changer, and (normally) dump logs. As such, it's not necessarily
203 the most useful tool when those have all been wiped out and you
204 desperately need to pull things from your tape. Pains have been taken
205 to make it as capable as possible, but for seriously minimialist
206 restores, look to
207 <citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>
208 or
209 <citerefentry><refentrytitle>dd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
210 instead.</para>
211 </refsect1>
212
213 <refsect1><title>SEE ALSO</title>
214 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
215 <citerefentry><refentrytitle>amadmin</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
216 <citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
217 <citerefentry><refentrytitle>tar</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
218 <citerefentry><refentrytitle>restore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
219 <ulink url="http://wiki.zmanda.com"/>
220 </para>
221 </refsect1>
222 </refentry>
223