Imported Upstream version 2.6.1
[debian/amanda] / man / amfetchdump.8
1 .\"     Title: amfetchdump
2 .\"    Author: John Stange <building@nap.edu>
3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4 .\"      Date: 01/22/2009
5 .\"    Manual: System Administration Commands
6 .\"    Source: Amanda 2.6.1
7 .\"  Language: English
8 .\"
9 .TH "AMFETCHDUMP" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
10 .\" -----------------------------------------------------------------
11 .\" * (re)Define some macros
12 .\" -----------------------------------------------------------------
13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14 .\" toupper - uppercase a string (locale-aware)
15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16 .de toupper
17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18 \\$*
19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20 ..
21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 .\" SH-xref - format a cross-reference to an SH section
23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 .de SH-xref
25 .ie n \{\
26 .\}
27 .toupper \\$*
28 .el \{\
29 \\$*
30 .\}
31 ..
32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33 .\" SH - level-one heading that works better for non-TTY output
34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35 .de1 SH
36 .\" put an extra blank line of space above the head in non-TTY output
37 .if t \{\
38 .sp 1
39 .\}
40 .sp \\n[PD]u
41 .nr an-level 1
42 .set-an-margin
43 .nr an-prevailing-indent \\n[IN]
44 .fi
45 .in \\n[an-margin]u
46 .ti 0
47 .HTML-TAG ".NH \\n[an-level]"
48 .it 1 an-trap
49 .nr an-no-space-flag 1
50 .nr an-break-flag 1
51 \." make the size of the head bigger
52 .ps +3
53 .ft B
54 .ne (2v + 1u)
55 .ie n \{\
56 .\" if n (TTY output), use uppercase
57 .toupper \\$*
58 .\}
59 .el \{\
60 .nr an-break-flag 0
61 .\" if not n (not TTY), use normal case (not uppercase)
62 \\$1
63 .in \\n[an-margin]u
64 .ti 0
65 .\" if not n (not TTY), put a border/line under subheading
66 .sp -.6
67 \l'\n(.lu'
68 .\}
69 ..
70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71 .\" SS - level-two heading that works better for non-TTY output
72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73 .de1 SS
74 .sp \\n[PD]u
75 .nr an-level 1
76 .set-an-margin
77 .nr an-prevailing-indent \\n[IN]
78 .fi
79 .in \\n[IN]u
80 .ti \\n[SN]u
81 .it 1 an-trap
82 .nr an-no-space-flag 1
83 .nr an-break-flag 1
84 .ps \\n[PS-SS]u
85 \." make the size of the head bigger
86 .ps +2
87 .ft B
88 .ne (2v + 1u)
89 .if \\n[.$] \&\\$*
90 ..
91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92 .\" BB/BE - put background/screen (filled box) around block of text
93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94 .de BB
95 .if t \{\
96 .sp -.5
97 .br
98 .in +2n
99 .ll -2n
100 .gcolor red
101 .di BX
102 .\}
103 ..
104 .de EB
105 .if t \{\
106 .if "\\$2"adjust-for-leading-newline" \{\
107 .sp -1
108 .\}
109 .br
110 .di
111 .in
112 .ll
113 .gcolor
114 .nr BW \\n(.lu-\\n(.i
115 .nr BH \\n(dn+.5v
116 .ne \\n(BHu+.5v
117 .ie "\\$2"adjust-for-leading-newline" \{\
118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119 .\}
120 .el \{\
121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
122 .\}
123 .in 0
124 .sp -.5v
125 .nf
126 .BX
127 .in
128 .sp .5v
129 .fi
130 .\}
131 ..
132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133 .\" BM/EM - put colored marker in margin next to block of text
134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135 .de BM
136 .if t \{\
137 .br
138 .ll -2n
139 .gcolor red
140 .di BX
141 .\}
142 ..
143 .de EM
144 .if t \{\
145 .br
146 .di
147 .ll
148 .gcolor
149 .nr BH \\n(dn
150 .ne \\n(BHu
151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
152 .in 0
153 .nf
154 .BX
155 .in
156 .fi
157 .\}
158 ..
159 .\" -----------------------------------------------------------------
160 .\" * set default formatting
161 .\" -----------------------------------------------------------------
162 .\" disable hyphenation
163 .nh
164 .\" disable justification (adjust text to left margin only)
165 .ad l
166 .\" -----------------------------------------------------------------
167 .\" * MAIN CONTENT STARTS HERE *
168 .\" -----------------------------------------------------------------
169 .SH "Name"
170 amfetchdump \- extract backup images from multiple \fIAmanda\fR tapes\&.
171 .SH "Synopsis"
172 .fam C
173 .HP \w'\fBamfetchdump\fR\ 'u
174 \fBamfetchdump\fR [\-pcClawns] [\-d\ \fIdevice\fR] [\-O\ \fIdirectory\fR] [\-b\ \fIblocksize\fR] \fIconfig\fR \fIhostname\fR [\fIdisk\fR\ [\ \fIdate\fR\ [\ \fIlevel\fR\ [\ \fIhostname\fR\ [\&.\&.\&.]\ ]\ ]\ ]] [\-o\ \fIconfigoption\fR]...
175 .fam
176 .SH "DESCRIPTION"
177 .PP
178 \fBAmfetchdump\fR
179 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\&.
180 .PP
181 It will automatically use the logs created by
182 \fBamdump\fR(8)
183 to locate available dumps on tape, in the same way that the
184 \fBfind\fR
185 feature of
186 \fBamadmin\fR(8)
187 lists available dumps\&. If these logs are unavailable, it can search tape\-by\-tape to find what it needs, and can generate new logs to serve as an emergency tape inventory\&.
188 .PP
189 The
190 \fIhostname\fR,
191 \fIdiskname\fR,
192 \fIdatestamp\fR, and
193 \fIlevel\fR
194 dump pattern\-matching works as in
195 \fBamrestore\fR(8), with the added requirement that at minimum a
196 \fIhostname\fR
197 must be specified when not in inventory mode\&.
198 .PP
199 Unless
200 \fB\-p\fR
201 is used, backup images are extracted to files in the current directory named:
202 .PP
203 \fIhostname\&.diskname\&.datestamp\&.dumplevel\fR
204 .SH "OPTIONS"
205 .PP
206 \fB\-p\fR
207 .RS 4
208 Pipe exactly one complete dump file to
209 \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)\&.
210 .RE
211 .PP
212 \fB\-d\fR \fIdevice\fR
213 .RS 4
214 Restore from this tape device instead of the default\&.
215 .RE
216 .PP
217 \fB\-O\fR \fIdirectory\fR
218 .RS 4
219 Output restored files to this directory, instead of to the current working directory\&.
220 .RE
221 .PP
222 \fB\-c\fR
223 .RS 4
224 Compress output, fastest method available\&.
225 .RE
226 .PP
227 \fB\-C\fR
228 .RS 4
229 Compress output, smallest file size method available\&.
230 .RE
231 .PP
232 \fB\-l\fR
233 .RS 4
234 Leave dumps in the compressed/uncompressed state in which they were found on tape\&. By default,
235 \fBamfetchdump\fR
236 will automatically uncompress when restoring\&.
237 .RE
238 .PP
239 \fB\-a\fR
240 .RS 4
241 Assume that all tapes are already available, via tape changer or otherwise, instead of prompting the operator to ensure that all tapes are loaded\&.
242 .RE
243 .PP
244 \fB\-w\fR
245 .RS 4
246 Wait to put split dumps together until all chunks have been restored\&. Normally,
247 \fBamfetchdump\fR
248 will attempt to read pieces of a split file from tape in order, so that it can assemble them simply by appending each file to the first\&. This option disables the appending behavior, and instead restores each piece as an individual file and reassembles them only after all have been restored\&.
249 .if n \{\
250 .sp
251 .\}
252 .RS 4
253 .BM yellow
254 .it 1 an-trap
255 .nr an-no-space-flag 1
256 .nr an-break-flag 1
257 .br
258 .ps +1
259 \fBNote\fR
260 .ps -1
261 .br
262 This requires at least double the size of your dump in free disk space, in order to build the final assembled dumpfile\&.
263 .sp .5v
264 .EM yellow
265 .RE
266 This behavior is implicitly invoked in circumstances where knowing the location of all dumps on tape in advance is not possible, such as when you are restoring without log files\&.
267 .RE
268 .PP
269 \fB\-n\fR
270 .RS 4
271 Do not reassemble split dump files at all, just restore each piece as an individual file\&.
272 .RE
273 .PP
274 \fB\-s\fR
275 .RS 4
276 Do not fast\-forward straight to needed files on tape\&. This will slow down most restores substantially\&. Only use this option if your tape drive does not properly support the fast\-forward operation\&.
277 .RE
278 .PP
279 \fB\-b\fR \fIblocksize\fR
280 .RS 4
281 Force a particular block size when reading from tapes\&. This value will usually be autodetected, and should not normally need to be set\&.
282 .RE
283 .PP
284 \fB\-o\fR \fIconfigoption\fR
285 .RS 4
286 See the "\fBCONFIGURATION OVERRIDE\fR" section in
287 \fBamanda\fR(8)\&.
288 .RE
289 .SH "EXAMPLES"
290 .PP
291 All the examples here assume your configuration is called
292 \fISetA\fR\&.
293 .PP
294 Here\'s a simple case, restoring all known dumps of the host vanya to the current working directory\&.
295 .nf
296 $ amfetchdump SetA vanya
297 .fi
298 .PP
299 A more likely scenario involves restoring a particular dump from a particular date\&. We\'ll pipe this one to
300 \fBGNU\-tar\fR
301 as well, to automatically extract the dump\&.
302 .nf
303 $ amfetchdump \-p SetA vanya /home 20051020 | gtar \-xvpf \-
304 .fi
305 .SH "CAVEATS"
306 .PP
307 \fBAmfetchdump\fR
308 is dependent on accessing your server\'s config, tape changer, and (normally) dump logs\&. As such, it\'s 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
309 \fBamrestore\fR(8)
310 or
311 \fBdd\fR(8)
312 instead\&.
313 .SH "SEE ALSO"
314 .PP
315 \fBamanda\fR(8),
316 \fBamadmin\fR(8),
317 \fBamrestore\fR(8),
318 \fBtar\fR(1),
319 \fBrestore\fR(8),
320 : http://wiki.zmanda.com
321 .SH "Authors"
322 .PP
323 \fBJohn Stange\fR <\&building@nap\&.edu\&>
324 .RS 4
325 National Academies Press
326 .RE
327 .PP
328 \fBIan Turner\fR <\&ian@zmanda\&.com\&>
329 .RS 4
330 Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
331 .RE