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