Imported Upstream version 3.3.3
[debian/amanda] / man / amfetchdump.8
1 '\" t
2 .\"     Title: amfetchdump
3 .\"    Author: John Stange <building@nap.edu>
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5 .\"      Date: 01/10/2013
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 3.3.3
8 .\"  Language: English
9 .\"
10 .TH "AMFETCHDUMP" "8" "01/10/2013" "Amanda 3\&.3\&.3" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 amfetchdump \- extract backup images from multiple Amanda tapes\&.
32 .SH "SYNOPSIS"
33 .HP \w'\fBamfetchdump\fR\ 'u
34 \fBamfetchdump\fR [\-c | \-C | \-l] [\-p | \-n] [\-a] [\-O\ \fIdirectory\fR] [\-d\ \fIdevice\fR] [\-h | \-\-header\-file\ \fIfilename\fR | \-\-header\-fd\ \fIfd\fR] [\-\-decompress | \-\-no\-decompress | \-\-server\-decompress | \-\-client\-decompress] [\-\-extract\ \-\-directory\fI\ directory\fR\ [\-\-data\-path\fI\ amanda|directtcp\fR]\ [\-\-application\-property\ \fINAME=VALUE\fR]*] [\-\-decrypt | \-\-no\-decrypt | \-\-server\-decrypt | \-\-client\-decrypt] [\-\-exact_match] [\fB\-o\fR\ \fIconfigoption\fR...] \fIconfig\fR \fIhostname\fR [\fIdisk\fR\ [\ \fIdate\fR\ [\ \fIlevel\fR\ [\ \fIhostname\fR\ [\&.\&.\&.]\ ]\ ]\ ]]
35 .SH "DESCRIPTION"
36 .PP
37 \fBAmfetchdump\fR
38 pulls one or more matching dumps from tape or from the holding disk, handling the reassembly of multi\-tape split dump files as well as any tape autochanger operations\&. The dump are by default decompressed and decrypted\&.
39 .PP
40 It will automatically use the Amanda catalog to locate available dumps on tape, in the same way that the
41 \fBfind\fR
42 feature of
43 \fBamadmin\fR(8)
44 lists available dumps\&.
45 .PP
46 The
47 \fIhostname\fR,
48 \fIdiskname\fR,
49 \fIdatestamp\fR, and
50 \fIlevel\fR
51 dump specifications are further described in
52 \fBamanda-match\fR(7)\&. Note that at minimum a
53 \fIhostname\fR
54 must be specified\&.
55 .PP
56 Unless
57 \fB\-p\fR
58 is used, backup images are extracted to files in the current directory named:
59 .PP
60 If a changer error occurs, or the
61 \fB\-d\fR
62 option is given, then amfetchdump prompts for each required volume\&.
63 .PP
64 \fIhostname\&.diskname\&.datestamp\&.dumplevel\fR
65 .SH "OPTIONS"
66 .PP
67 \fB\-p\fR
68 .RS 4
69 Pipe exactly one complete dump file to
70 \fIstdout\fR, instead of writing the file to disk\&. This will restore only the first matching dumpfile (where "first" is determined by the dump log search facility)\&.
71 .RE
72 .PP
73 \fB\-h\fR
74 .RS 4
75 Output the amanda header as a 32K block to same output as the image\&.
76 .RE
77 .PP
78 \fB\-\-header\-fd\fR \fIfd\fR
79 .RS 4
80 Output the amanda header to the numbered file descriptor\&.
81 .RE
82 .PP
83 \fB\-\-header\-file\fR \fIfilename\fR
84 .RS 4
85 Output the amanda header to the filename\&.
86 .RE
87 .PP
88 \fB\-d\fR \fIdevice_or_changer\fR
89 .RS 4
90 Restore from this device or changer instead of the default, prompting for each volume\&.
91 .RE
92 .PP
93 \fB\-O\fR \fIdirectory\fR
94 .RS 4
95 Output restored files to this directory, instead of to the current working directory\&.
96 .RE
97 .PP
98 \fB\-c\fR
99 .RS 4
100 Compress output, fastest method available\&.
101 .RE
102 .PP
103 \fB\-C\fR
104 .RS 4
105 Compress output, smallest file size method available\&.
106 .RE
107 .PP
108 \fB\-\-decompress\fR
109 .RS 4
110 Always do the decompression, this is the default\&.
111 .RE
112 .PP
113 \fB\-\-no\-decompress\fR
114 .RS 4
115 Never do the decompression\&.
116 .RE
117 .PP
118 \fB\-\-server\-decompress\fR
119 .RS 4
120 Do the decompression only if the compression was done on the server\&.
121 .RE
122 .PP
123 \fB\-\-client\-decompress\fR
124 .RS 4
125 Do the decompression only if the compression was done on the client\&.
126 .RE
127 .PP
128 \fB\-\-decrypt\fR
129 .RS 4
130 Always do the decryption, this is the default\&.
131 .RE
132 .PP
133 \fB\-\-no\-decrypt\fR
134 .RS 4
135 Never do the decryption\&.
136 .RE
137 .PP
138 \fB\-\-server\-decrypt\fR
139 .RS 4
140 Do the decryption only if the encryption was done on the server\&.
141 .RE
142 .PP
143 \fB\-\-client\-decrypt\fR
144 .RS 4
145 Do the decryption only if the encryption was done on the client\&.
146 .RE
147 .PP
148 \fB\-\-exact\-match\fR
149 .RS 4
150 The host and disk are parsed as exact values
151 .RE
152 .PP
153 \fB\-\-extract\fR
154 .RS 4
155 Extract the backup on the server in the
156 \fIdirectory\fR
157 directory\&.
158 .RE
159 .PP
160 \fB\-\-directory\fR \fIdirectory\fR
161 .RS 4
162 Where to extract the backup with the
163 \fB\-\-extract\fR
164 option\&.
165 .sp
166 Warning: All files in that directory can be removed\&.
167 .RE
168 .PP
169 \fB\-\-data\-path\fR amanda|directtcp
170 .RS 4
171 The data path to use with
172 \fB\-\-extract\fR, the default is to use the fatest data path\&.
173 .RE
174 .PP
175 \fB\-\-application\-property\fR \fINAME=VALUE\fR
176 .RS 4
177 Application property to send to the application with
178 \fB\-\-extract\&.\fR
179 .RE
180 .PP
181 \fB\-l\fR
182 .RS 4
183 Leave dumps in the compressed/uncompressed and encrypted/unencrypted state in which they were found on tape\&. It is a synonym for
184 \fB\-\-no\-decompression\fR
185 \fB\-\-no\-decryption\fR
186 .RE
187 .PP
188 \fB\-a\fR
189 .RS 4
190 Assume that all tapes are already available, via tape changer or otherwise, instead of prompting the operator to ensure that all tapes are loaded\&.
191 .RE
192 .PP
193 \fB\-n\fR
194 .RS 4
195 Do not reassemble split dump files at all, just restore each piece as an individual file\&.
196 .RE
197 .PP
198 \fB\-o\fR \fIconfigoption\fR
199 .RS 4
200 See the "\fBCONFIGURATION OVERRIDE\fR" section in
201 \fBamanda\fR(8)\&.
202 .RE
203 .SH "EXAMPLES"
204 .PP
205 All the examples here assume your configuration is called
206 \fISetA\fR\&.
207 .PP
208 Here\*(Aqs a simple case, restoring all known dumps of the host vanya to the current working directory\&.
209 .nf
210 $ amfetchdump SetA vanya
211 .fi
212 .PP
213 A more likely scenario involves restoring a particular dump from a particular date\&. We\*(Aqll pipe this one to
214 \fBGNU\-tar\fR
215 as well, to automatically extract the dump\&.
216 .nf
217 $ amfetchdump \-p SetA vanya /home 20051020 | gtar \-xvpf \-
218 .fi
219 .SH "CAVEATS"
220 .PP
221 \fBAmfetchdump\fR
222 is dependent on accessing your server\*(Aqs config, tape changer, and (normally) dump logs\&. As such, it\*(Aqs not necessarily the most useful tool when those have all been wiped out and you desperately need to pull things from your tape\&. Pains have been taken to make it as capable as possible, but for seriously minimialist restores, look to
223 \fBamrestore\fR(8)
224 or
225 \fBdd\fR(8)
226 instead\&.
227 .SH "SEE ALSO"
228 .PP
229 \fBamanda\fR(8),
230 \fBamanda-match\fR(7),
231 \fBamadmin\fR(8),
232 \fBamrestore\fR(8)
233 .PP
234 The Amanda Wiki:
235 : http://wiki.zmanda.com/
236 .SH "AUTHORS"
237 .PP
238 \fBJohn Stange\fR <\&building@nap\&.edu\&>
239 .RS 4
240 National Academies Press
241 .RE
242 .PP
243 \fBIan Turner\fR <\&ian@zmanda\&.com\&>
244 .RS 4
245 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
246 .RE