Imported Upstream version 3.2.0
[debian/amanda] / man / amflush.8
1 '\" t
2 .\"     Title: amflush
3 .\"    Author: James da Silva <jds@amanda.org>
4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
5 .\"      Date: 10/18/2010
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 3.2.0
8 .\"  Language: English
9 .\"
10 .TH "AMFLUSH" "8" "10/18/2010" "Amanda 3\&.2\&.0" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
15 .nh
16 .\" disable justification (adjust text to left margin only)
17 .ad l
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
21 .SH "NAME"
22 amflush \- flush Amanda backup files from holding disk to tape
23 .SH "SYNOPSIS"
24 .HP \w'\fBamflush\fR\ 'u
25 \fBamflush\fR [\-b] [\-f] [\-s] [\-D\ \fIdatestamp\fR] \fIconfig\fR [\fIhost\fR\ [\fIdisk\fR...]...] [\fB\-o\fR\ \fIconfigoption\fR...]
26 .SH "DESCRIPTION"
27 .PP
28 \fBAmflush\fR
29 writes Amanda backups from the holding disks to tape, and updates the Amanda info database and
30 \fBtapelist\fR(5)
31 accordingly\&. It is similar to amdump, but does not perform any backup operations on Amanda clients\&. Backups may stay in a holding disk when something is wrong with the tape at the time
32 \fBamdump\fR
33 is run\&. When this happens, the problem must be corrected and
34 \fBamflush\fR
35 run by hand\&.
36 .PP
37 The command optionally takes a set of DLE specifications (see
38 \fBamanda-match\fR(7)) to narrow the DLEs for which dumps will be flushed\&. All dumps in holding are flushed if no expressions are given\&.
39 .SH "OPTIONS"
40 .PP
41 \fB\-b\fR
42 .RS 4
43 Run
44 \fBamflush\fR
45 in batch mode\&. All datestamps are selected unless specified\&. The flush is started without confirmation\&.
46 .RE
47 .PP
48 \fB\-f\fR
49 .RS 4
50 Run
51 \fBamflush\fR
52 in foreground\&.
53 \fBAmflush\fR
54 normally detaches itself from the tty and runs as a background process\&. With the
55 \fB\-f\fR
56 option,
57 \fBamflush\fR
58 stays in the foreground\&. This is useful if
59 \fBamflush\fR
60 is run as part of another script that, for example, advances the tape after the flush is completed\&.
61 .RE
62 .PP
63 \fB\-s\fR
64 .RS 4
65 Write log to stdout/stderr instead of the amflush log file\&. Requires the
66 \fB\-f\fR
67 option\&.
68 .RE
69 .PP
70 \fB\-D datestamp\fR
71 .RS 4
72 specify a datestamp expression you want to flush; see
73 \fBamanda-match\fR(7)
74 for details on the format of this expression\&.
75 \fB\-D 20001225\-7\fR
76 will flush all dumps from 25 december 2000 to 27 december 2000\&.
77 .RE
78 .PP
79 \fIhost\fR [\fIdisk\fR]*
80 .RS 4
81 Specify the host and disk on which the command will work \-\- see the description of DLE specifications in
82 \fBamanda-match\fR(7)\&.
83 .RE
84 .PP
85 \fB\-o \fR\fB\fIconfigoption\fR\fR
86 .RS 4
87 See the "CONFIGURATION OVERRIDE" section in
88 \fBamanda\fR(8)\&.
89 .RE
90 .PP
91 You can specify many host/disk expressions, only disks that match an expression will be flushed\&. All disks are flushed if no expressions are given\&. see the "HOST & DISK EXPRESSION" section of
92 \fBamanda\fR(8)
93 for a description\&.
94 .PP
95 \fBAmflush\fR
96 will look in the holding disks specified by the
97 \fIamanda\&.conf\fR
98 file in /usr/local/etc/amanda/\fIconfig\fR
99 for any non\-empty Amanda work directories\&. It then prompts you to select a directory or to process all of the directories\&. The work directories in the holding disks are named by the date at the time
100 \fBamdump\fR
101 was run, e\&.g\&.
102 19910215\&.
103 .PP
104 See the
105 \fBamanda\fR(8)
106 man page for more details about Amanda\&.
107 .SH "EXAMPLE"
108 .PP
109 \fBAmflush\fR
110 will search for holding areas associated with the
111 \fIdaily\fR
112 configuration\&. After you select which holding area to flush,
113 \fBamflush\fR
114 writes the data to tape, updates the databases and sends a mail report similar to
115 \fBamdump\fR(8)\&.
116 .nf
117 % amflush MyConfig
118 Scanning /amanda\-hold\&.\&.\&.
119   20001113: found Amanda directory\&.
120   20001114: found Amanda directory\&.
121
122 Multiple Amanda directories, please pick one by letter:
123   A\&. 20001113
124   B\&. 20001114
125 Select directories to flush [A\&.\&.B]: [ALL] all
126
127 Flushing dumps in 20001113, 20001114,
128 today: 20001117
129 to tape drive /dev/rmt/0mn\&.
130 Expecting tape DMP014 or a new tape\&.  (The last dumps were to tape DMP013)
131 Are you sure you want to do this? yes
132 Running in background, you can log off now\&.
133 You\'ll get mail when amflush is finished\&.
134 .fi
135 .PP
136 The following example causes amflush to flush everything to tape, then ejects tape, using \'at\' to run the task in the background\&.
137 .nf
138 % echo \'amflush \-b \-f MyConfig && mt offline\' | at now
139 .fi
140 .SH "EXIT CODE"
141
142 The exit code of \fBamflush\fR is the ORed value of:
143 .nf
144  0  = success
145  1  = error
146  4  = a dle failed
147  8  = Don\'t know the status of a dle (RESULT_MISSING in the report)
148  16 = tape error or no more tape
149 .fi
150 .SH "SEE ALSO"
151 .PP
152 \fBamanda\fR(8),
153 \fBamdump\fR(8),
154 \fBamanda-match\fR(7)
155 .PP
156 The Amanda Wiki:
157 : http://wiki.zmanda.com/
158 .SH "AUTHORS"
159 .PP
160 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
161 .PP
162 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>