Imported Upstream version 3.2.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: 10/18/2010
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 3.2.0
8 .\"  Language: English
9 .\"
10 .TH "AMDUMP" "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 amdump \- back up all disks in an Amanda configuration
23 .SH "SYNOPSIS"
24 .HP \w'\fBamdump\fR\ 'u
25 \fBamdump\fR \fIconfig\fR [\fB\-\-no\-taper\fR] [\fIhost\fR\ [\fIdisk\fR...]...] [\fB\-o\fR\ \fIconfigoption\fR...]
26 .SH "DESCRIPTION"
27 .PP
28 \fBAmdump\fR
29 is the main interface to the Amanda backup process\&. It loads the specified configuration and attempts to back up every disk specified by the
30 \fBdisklist\fR(5)\&.
31 \fBAmdump\fR
32 is normally run by
33 \fBcron\fR\&.
34 .PP
35 The command optionally takes a set of DLE specifications (see
36 \fBamanda-match\fR(7)) to narrow the DLEs that will be dumped\&. All disks are dumped if no expressions are given\&.
37 .PP
38 If a file named
39 hold
40 exists in the configuration directory,
41 \fBamdump\fR
42 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,
43 \fBamdump\fR
44 checks for the hold file every minute\&.
45 .PP
46 In some cases it is desirable to dump all Amanda clients to holding disk without writing anything to storage media\&. The
47 \fB\-\-no\-taper\fR
48 option instructs Amanda to not start the taper, and thus enter degraded mode immediately\&.
49 .PP
50 See the
51 \fBamanda\fR(8)
52 man page for more details about Amanda\&.
53 .SH "OPTIONS"
54 .PP
55 \fIhost\fR [\fIdisk\fR]*
56 .RS 4
57 Specify the host and disk on which the command will work \-\- see the description of DLE specifications in
58 \fBamanda-match\fR(7)\&.
59 .RE
60 .PP
61 \fB\-o \fR\fB\fIconfigoption\fR\fR
62 .RS 4
63 See the "CONFIGURATION OVERRIDE" section in
64 \fBamanda\fR(8)\&.
65 .RE
66 .SH "EXAMPLE"
67 .PP
68 Here is a typical crontab entry\&. It runs
69 \fBamdump\fR
70 every weeknight at 1 a\&.m\&. as user
71 \fBbin\fR:
72 .nf
73 0 1 * * 1\-5 bin /usr/local/sbin/amdump daily
74 .fi
75 .PP
76 Please see the
77 \fBcrontab\fR(5)
78 or
79 \fBcrontab\fR(1)
80 manual page for the correct crontab format for your system\&.
81 .SH "MESSAGES"
82 .PP
83 amdump: waiting for hold file to be removed
84 .RS 4
85 The "hold" file exists and
86 \fBamdump\fR
87 is waiting for it to be removed before starting backups\&.
88 .RE
89 .PP
90 amdump: amdump or amflush is already running, or you must run amcleanup
91 .RS 4
92 Amdump detected another
93 \fBamdump\fR
94 or
95 \fBamflush\fR
96 running, or the remains of a previous incomplete
97 \fBamdump\fR
98 or
99 \fBamflush\fR
100 run\&. This run is terminated\&. If the problem is caused by the remains of a previous run, you must execute
101 \fBamcleanup\fR(8)
102 and then rerun
103 \fBamdump\fR\&.
104 .RE
105 .SH "EXIT CODE"
106
107 The exit code of \fBamdump\fR is the ORed value of:
108 .nf
109  0  = success
110  1  = error
111  2  = a dle give strange message
112  4  = a dle failed
113  8  = Don\'t know the status of a dle (RESULT_MISSING in the report)
114  16 = tape error or no more tape
115 .fi
116 .SH "SEE ALSO"
117 .PP
118 \fBamanda\fR(8),
119 \fBamcheck\fR(8),
120 \fBamcleanup\fR(8),
121 \fBamrestore\fR(8),
122 \fBamflush\fR(8),
123 \fBcron\fR(8),
124 \fBamanda-match\fR(7)
125 .PP
126 The Amanda Wiki:
127 : http://wiki.zmanda.com/
128 .SH "AUTHORS"
129 .PP
130 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
131 .PP
132 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>