Imported Upstream version 3.1.0
[debian/amanda] / man / amdump.8
1 '\" t
2 .\"     Title: amdump
3 .\"    Author: James da Silva <jds@amanda.org>
4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
5 .\"      Date: 06/01/2010
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 3.1.0
8 .\"  Language: English
9 .\"
10 .TH "AMDUMP" "8" "06/01/2010" "Amanda 3\&.1\&.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 amdump \- back up all disks in an Amanda configuration
23 .SH "SYNOPSIS"
24 .HP \w'\fBamdump\fR\ 'u
25 \fBamdump\fR \fIconfig\fR [\fIhost\fR\ [\fIdisk\fR...]...] [{\fB\-o\fR\ \fIconfigoption\fR}...]
26 .SH "DESCRIPTION"
27 .PP
28 \fBAmdump\fR
29 switches to the appropriate Amanda configuration directory, e\&.g\&. /usr/local/etc/amanda/\fIconfig\fR, then attempts to back up every disk specified by the
30 \fIamanda\&.conf\fR
31 file\&.
32 \fBAmdump\fR
33 is normally run by
34 \fBcron\fR\&.
35 .PP
36 You can specify many host/disk expressions, only disks that match an expression will be dumped\&. All disks are dumped if no expressions are given\&.
37 .PP
38 If the file /usr/local/etc/amanda/\fIconfig\fR/hold exists,
39 \fBamdump\fR
40 will wait until it is removed before starting the backups\&. This allows scheduled backups to be delayed when circumstances warrant, for example, if the tape device is being used for some other purpose\&. While waiting,
41 \fBamdump\fR
42 checks for the hold file every minute\&.
43 .PP
44 See the
45 \fBamanda\fR(8)
46 man page for more details about Amanda\&.
47 .SH "OPTIONS"
48 .PP
49 \fIhost\fR [\fIdisk\fR]*
50 .RS 4
51 Specify the host and disk on which the command will work\&.
52 .RE
53 .PP
54 \fB\-o \fR\fB\fIconfigoption\fR\fR
55 .RS 4
56 See the "CONFIGURATION OVERRIDE" section in
57 \fBamanda\fR(8)\&.
58 .RE
59 .SH "EXAMPLE"
60 .PP
61 Here is a typical crontab entry\&. It runs
62 \fBamdump\fR
63 every weeknight at 1 a\&.m\&. as user
64 \fBbin\fR:
65 .nf
66 0 1 * * 1\-5 bin /usr/local/sbin/amdump daily
67 .fi
68 .PP
69 Please see the
70 \fBcrontab\fR(5)
71 or
72 \fBcrontab\fR(1)
73 manual page for the correct crontab format for your system\&.
74 .SH "MESSAGES"
75 .PP
76 amdump: waiting for hold file to be removed
77 .RS 4
78 The "hold" file exists and
79 \fBamdump\fR
80 is waiting for it to be removed before starting backups\&.
81 .RE
82 .PP
83 amdump: amdump or amflush is already running, or you must run amcleanup
84 .RS 4
85 Amdump detected another
86 \fBamdump\fR
87 or
88 \fBamflush\fR
89 running, or the remains of a previous incomplete
90 \fBamdump\fR
91 or
92 \fBamflush\fR
93 run\&. This run is terminated\&. If the problem is caused by the remains of a previous run, you must execute
94 \fBamcleanup\fR(8)
95 and then rerun
96 \fBamdump\fR\&.
97 .RE
98 .SH "EXIT CODE"
99
100 The exit code of \fBamdump\fR is the ORed value of:
101 .nf
102  0  = success
103  1  = error
104  2  = a dle give strange message
105  4  = a dle failed
106  8  = Don\'t know the status of a dle (RESULT_MISSING in the report)
107  16 = tape error or no more tape
108 .fi
109 .SH "SEE ALSO"
110 .PP
111 \fBamanda\fR(8),
112 \fBamcheck\fR(8),
113 \fBamcleanup\fR(8),
114 \fBamrestore\fR(8),
115 \fBamflush\fR(8),
116 \fBcron\fR(8)
117 .PP
118 The Amanda Wiki:
119 : http://wiki.zmanda.com/
120 .SH "AUTHORS"
121 .PP
122 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
123 .PP
124 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>