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

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