git.gag.com Git - debian/amanda/blob - man/amflush.8

   1 .\"     Title: amflush
   2 .\"    Author: James da Silva <jds@amanda.org>
   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 "AMFLUSH" "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 amflush \- flush \fIAmanda\fR backup files from holding disk to tape
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBamflush\fR\ 'u
 174 \fBamflush\fR [\-b] [\-f] [\-s] [\-D\ \fIdatestamp\fR] \fIconfig\fR [\fIhost\fR\ [\fIdisk\fR...]...] [\-o\ \fIconfigoption\fR]...
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 \fBAmflush\fR
 179 writes
 180 \fIAmanda\fR
 181 backups from the holding disks to tape, and updates the
 182 \fIAmanda\fR
 183 info database and
 184 \fBtapelist\fR(5)
 185 accordingly\&. Backups may stay in a holding disk when something is wrong with the tape at the time
 186 \fBamdump\fR
 187 is run\&. When this happens, the problem must be corrected and
 188 \fBamflush\fR
 189 run by hand\&.
 190 .SH "OPTIONS"
 191 .PP
 192 \fB\-b\fR
 193 .RS 4
 194 Run
 195 \fBamflush\fR
 196 in batch mode\&. All datestamps are selected unless specified\&. The flush is started without confirmation\&.
 197 .RE
 198 .PP
 199 \fB\-f\fR
 200 .RS 4
 201 Run
 202 \fBamflush\fR
 203 in foreground\&.
 204 \fBAmflush\fR
 205 normally detaches itself from the tty and runs as a background process\&. With the
 206 \fB\-f\fR
 207 option,
 208 \fBamflush\fR
 209 stays in the foreground\&. This is useful if
 210 \fBamflush\fR
 211 is run as part of another script that, for example, advances the tape after the flush is completed\&.
 212 .RE
 213 .PP
 214 \fB\-s\fR
 215 .RS 4
 216 Write log to stdout/stderr instead of the amflush log file\&. Requires the
 217 \fB\-f\fR
 218 option\&.
 219 .RE
 220 .PP
 221 \fB\-D datestamp\fR
 222 .RS 4
 223 specify a datestamp expression you want to flush, see the "DATESTAMP EXPRESSION" section of
 224 \fBamanda\fR(8)
 225 for a description\&.
 226 \fB\-D 20001225\-7\fR
 227 will flush all dumps from 25 december 2000 to 27 december 2000\&.
 228 .RE
 229 .PP
 230 \fIhost\fR [\fIdisk\fR]*
 231 .RS 4
 232 Specify the host and disk on which the command will work\&.
 233 .RE
 234 .PP
 235 \fB\-o\fR \fIconfigoption\fR
 236 .RS 4
 237 See the "\fBCONFIGURATION OVERRIDE\fR" section in
 238 \fBamanda\fR(8)\&.
 239 .RE
 240 .PP
 241 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
 242 \fBamanda\fR(8)
 243 for a description\&.
 244 .PP
 245 \fBAmflush\fR
 246 will look in the holding disks specified by the
 247 \fIamanda\&.conf\fR
 248 file in /usr/local/etc/amanda/\fIconfig\fR
 249 for any non\-empty
 250 \fIAmanda\fR
 251 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
 252 \fBamdump\fR
 253 was run, e\&.g\&.
 254 \FC19910215\F[]\&.
 255 .PP
 256 See the
 257 \fBamanda\fR(8)
 258 man page for more details about
 259 \fIAmanda\fR\&.
 260 .SH "EXAMPLE"
 261 .PP
 262 \fBAmflush\fR
 263 will search for holding areas associated with the
 264 \fIdaily\fR
 265 configuration\&. After you select which holding area to flush,
 266 \fBamflush\fR
 267 writes the data to tape, updates the databases and sends a mail report similar to
 268 \fBamdump\fR(8)\&.
 269 .nf
 270 % amflush MyConfig
 271 Scanning /amanda\-hold\&.\&.\&.
 272   20001113: found \fIAmanda\fR directory\&.
 273   20001114: found \fIAmanda\fR directory\&.
 274
 275 Multiple \fIAmanda\fR directories, please pick one by letter:
 276   A\&. 20001113
 277   B\&. 20001114
 278 Select directories to flush [A\&.\&.B]: [ALL] all
 279
 280 Flushing dumps in 20001113, 20001114,
 281 today: 20001117
 282 to tape drive /dev/rmt/0mn\&.
 283 Expecting tape DMP014 or a new tape\&.  (The last dumps were to tape DMP013)
 284 Are you sure you want to do this? yes
 285 Running in background, you can log off now\&.
 286 You\'ll get mail when amflush is finished\&.
 287 .fi
 288 .PP
 289 The following example causes amflush to flush everything to tape, then ejects tape, using \'at\' to run the task in the background\&.
 290 .nf
 291 % echo \'amflush \-b \-f MyConfig && mt offline\' | at now
 292 .fi
 293 .SH "EXIT CODE"
 294
 295 The exit code of \fBamflush\fR is the ORed value of:
 296 .nf
 297  0  = success
 298  1  = error
 299  4  = a dle failed
 300  8  = Don\'t know the status of a dle (RESULT_MISSING in the report)
 301  16 = tape error or no more tape
 302 .fi
 303 .SH "SEE ALSO"
 304 .PP
 305
 306 \fBamanda\fR(8),
 307 \fBamdump\fR(8),
 308 : http://wiki.zmanda.com
 309 .SH "Authors"
 310 .PP
 311 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
 312 .PP
 313 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>