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