5eb7e5545f9807593bceab0fa8baec5a0ed4f293
[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: 11/05/2009
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 2.6.1p2
8 .\"  Language: English
9 .\"
10 .TH "AMFLUSH" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "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 \fIAmanda\fR 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...]...] [\-o\ \fIconfigoption\fR]...
26 .SH "DESCRIPTION"
27 .PP
28 \fBAmflush\fR
29 writes
30 \fIAmanda\fR
31 backups from the holding disks to tape, and updates the
32 \fIAmanda\fR
33 info database and
34 \fBtapelist\fR(5)
35 accordingly\&. Backups may stay in a holding disk when something is wrong with the tape at the time
36 \fBamdump\fR
37 is run\&. When this happens, the problem must be corrected and
38 \fBamflush\fR
39 run by hand\&.
40 .SH "OPTIONS"
41 .PP
42 \fB\-b\fR
43 .RS 4
44 Run
45 \fBamflush\fR
46 in batch mode\&. All datestamps are selected unless specified\&. The flush is started without confirmation\&.
47 .RE
48 .PP
49 \fB\-f\fR
50 .RS 4
51 Run
52 \fBamflush\fR
53 in foreground\&.
54 \fBAmflush\fR
55 normally detaches itself from the tty and runs as a background process\&. With the
56 \fB\-f\fR
57 option,
58 \fBamflush\fR
59 stays in the foreground\&. This is useful if
60 \fBamflush\fR
61 is run as part of another script that, for example, advances the tape after the flush is completed\&.
62 .RE
63 .PP
64 \fB\-s\fR
65 .RS 4
66 Write log to stdout/stderr instead of the amflush log file\&. Requires the
67 \fB\-f\fR
68 option\&.
69 .RE
70 .PP
71 \fB\-D datestamp\fR
72 .RS 4
73 specify a datestamp expression you want to flush, see the "DATESTAMP EXPRESSION" section of
74 \fBamanda\fR(8)
75 for a description\&.
76 \fB\-D 20001225\-7\fR
77 will flush all dumps from 25 december 2000 to 27 december 2000\&.
78 .RE
79 .PP
80 \fIhost\fR [\fIdisk\fR]*
81 .RS 4
82 Specify the host and disk on which the command will work\&.
83 .RE
84 .PP
85 \fB\-o\fR \fIconfigoption\fR
86 .RS 4
87 See the "\fBCONFIGURATION OVERRIDE\fR" 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
100 \fIAmanda\fR
101 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
102 \fBamdump\fR
103 was run, e\&.g\&.
104 19910215\&.
105 .PP
106 See the
107 \fBamanda\fR(8)
108 man page for more details about
109 \fIAmanda\fR\&.
110 .SH "EXAMPLE"
111 .PP
112 \fBAmflush\fR
113 will search for holding areas associated with the
114 \fIdaily\fR
115 configuration\&. After you select which holding area to flush,
116 \fBamflush\fR
117 writes the data to tape, updates the databases and sends a mail report similar to
118 \fBamdump\fR(8)\&.
119 .nf
120 % amflush MyConfig
121 Scanning /amanda\-hold\&.\&.\&.
122   20001113: found \fIAmanda\fR directory\&.
123   20001114: found \fIAmanda\fR directory\&.
124
125 Multiple \fIAmanda\fR directories, please pick one by letter:
126   A\&. 20001113
127   B\&. 20001114
128 Select directories to flush [A\&.\&.B]: [ALL] all
129
130 Flushing dumps in 20001113, 20001114,
131 today: 20001117
132 to tape drive /dev/rmt/0mn\&.
133 Expecting tape DMP014 or a new tape\&.  (The last dumps were to tape DMP013)
134 Are you sure you want to do this? yes
135 Running in background, you can log off now\&.
136 You\'ll get mail when amflush is finished\&.
137 .fi
138 .PP
139 The following example causes amflush to flush everything to tape, then ejects tape, using \'at\' to run the task in the background\&.
140 .nf
141 % echo \'amflush \-b \-f MyConfig && mt offline\' | at now
142 .fi
143 .SH "EXIT CODE"
144
145 The exit code of \fBamflush\fR is the ORed value of:
146 .nf
147  0  = success
148  1  = error
149  4  = a dle failed
150  8  = Don\'t know the status of a dle (RESULT_MISSING in the report)
151  16 = tape error or no more tape
152 .fi
153 .SH "SEE ALSO"
154 .PP
155
156 \fBamanda\fR(8),
157 \fBamdump\fR(8),
158 : http://wiki.zmanda.com
159 .SH "AUTHORS"
160 .PP
161 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
162 .PP
163 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>