amanda.8

开源备份软件源码 AMANDA, the Advanced Maryland Automatic Network Disk Archiver, is a backup system that a

.\"     Title: amanda
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\"      Date: 05/13/2008
.\"    Manual: 
.\"    Source: 
.\"
.TH "AMANDA" "8" "05/13/2008" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
amanda - Advanced Maryland Automatic Network Disk Archiver
.SH "SYNOPSIS"
.HP 8
\fBamadmin\fR \fIconfig\fR \fIcommand\fR [\fIoptions\fR]
.br

.HP 8
\fBamcheck\fR [\fIoptions\fR] \fIconfig\fR
.br

.HP 10
\fBamcheckdb\fR \fIconfig\fR
.br

.HP 10
\fBamcleanup\fR \fIconfig\fR
.br

.HP 8
\fBamcrypt\fR
.br

.HP 5
\fBamdd\fR [\fIoptions\fR]
.HP 7
\fBamdump\fR \fIconfig\fR
.br

.HP 10
\fBamaespipe\fR
.br

.HP 8
\fBamflush\fR [\-f] \fIconfig\fR
.br

.HP 10
\fBamgetconf\fR [\fIconfig\fR] \fIparameter\fR
.br

.HP 8
\fBamlabel\fR \fIconfig\fR \fIlabel\fR [\fIslot\fR\ \fIslot\fR]
.br

.HP 5
\fBammt\fR [\fIoptions\fR]
.HP 11
\fBamoverview\fR \fIconfig\fR [\fIoptions\fR]
.br

.HP 7
\fBamplot\fR [\fIoptions\fR] \fIamdump\-files\fR
.br

.HP 10
\fBamrecover\fR [\fIconfig\fR] [\fIoptions\fR]
.br

.HP 9
\fBamreport\fR [\fIconfig\fR] [\fIoptions\fR]
.br

.HP 10
\fBamrestore\fR [\fIoptions\fR] \fItapedevice\fR [\fIhostname\fR\ [\fIdiskname\fR]]
.br

.HP 12
\fBamfetchdump\fR [\fIoptions\fR] \fIconfig\fR [\fIhostname\fR\ [\fIdiskname\fR\ [\fIdate\fR\ [level]]]]
.HP 9
\fBamrmtape\fR [\fIoptions\fR] \fIconfig\fR \fIlabel\fR
.br

.HP 9
\fBamstatus\fR \fIconfig\fR [\fIoptions\fR]
.br

.HP 7
\fBamtape\fR \fIconfig\fR \fIcommand\fR [\fIoptions\fR]
.br

.HP 11
\fBamtapetype\fR [\fIoptions\fR]
.HP 6
\fBamtoc\fR [\fIoptions\fR] \fIlogfile\fR
.br

.HP 12
\fBamcheckdump\fR [\fIoptions\fR] \fIconfig\fR
.br

.HP 15
\fBamserverconfig\fR [\fIoptions\fR] \fIconfig\fR
.br

.HP 12
\fBamaddclient\fR \fIconfig\fR [\fIoptions\fR]
.br

.SH "DESCRIPTION"
.PP
\fIAmanda\fR
is the "Advanced Maryland Automatic Network Disk Archiver"\. This manual page gives an overview of the
\fIAmanda\fR
commands and configuration files for quick reference\.
.PP
Here are all the
\fIAmanda\fR
commands\. Each one has its own manual page\. See them for all the gory details\.
.PP
\fBamdump\fR
.RS 4
Take care of automatic
\fIAmanda\fR
backups\. This is normally executed by
\fBcron\fR
on a computer called the
\fItape server host\fR
and requests backups of file systems located on
\fIbackup\fR
\fIclients\fR\.
\fBAmdump\fR
backs up all disks in the
\fIdisklist\fR
file (discussed below) to tape or, if there is a problem, to a special
\fIholding\fR
\fIdisk\fR\. After all backups are done,
\fBamdump\fR
sends mail reporting failures and successes\.
.RE
.PP
\fBamflush\fR
.RS 4
Flush backups from the holding disk to tape\.
\fBAmflush\fR
is used after
\fBamdump\fR
has reported it could not write backups to tape for some reason\. When this happens, backups stay in the holding disk\. Run
\fBamflush\fR
after the tape problem is corrected to write backups from the holding disk to tape\.
.RE
.PP
\fBamcleanup\fR
.RS 4
Clean up after an interrupted
\fBamdump\fR\. This command is only needed if
\fBamdump\fR
was unable to complete for some reason, usually because the tape server host crashed while
\fBamdump\fR
was running\.
.RE
.PP
\fBamrecover\fR
.RS 4
Provides an interactive interface to browse the
\fIAmanda\fR
index files (backup image catalogues) and select which tapes to recover files from\. It can also run
\fBamrestore\fR
and a restore program (e\.g\.
\fBtar\fR) to actually recover the files\.
.RE
.PP
\fBamrestore\fR
.RS 4
Read an
\fIAmanda\fR
tape, searching for requested backups\.
\fBAmrestore\fR
is suitable for everything from interactive restores of single files to a full restore of all partitions on a failed disk\.
.RE
.PP
\fBamfetchdump\fR
.RS 4
Performs
\fIAmanda\fR
tape restoration, similar to
\fBamrestore\fR\. Additional capabilities include "hands\-off" searching of multiple tapes, automatic retrieval of specific dump files based on dump logs, and assembly of tape\-spanning split dump files\.
.RE
.PP
\fBamlabel\fR
.RS 4
Write an
\fIAmanda\fR
format label onto a tape\. All
\fIAmanda\fR
tapes must be labeled with
\fBamlabel\fR\.
\fBAmdump\fR
and
\fBamflush\fR
will not write to an unlabeled tape (see TAPE MANAGEMENT below)\.
.RE
.PP
\fBamcheck\fR
.RS 4
Verify the correct tape is mounted and all file systems on all backup client systems are ready to be backed up\. Often run by
\fBcron\fR
before
\fBamdump\fR
to generate a mail warning that backups might fail unless corrective action is taken\.
.RE
.PP
\fBamadmin\fR
.RS 4
Take care of administrative tasks like finding out which tapes are needed to restore a filesystem, forcing hosts to do full backups of selected disks and looking at schedule balance information\.
.RE
.PP
\fBamtape\fR
.RS 4
Take care of tape changer control operations like loading particular tapes, ejecting tapes and scanning the tape storage slots\.
.RE
.PP
\fBamcheckdump\fR
.RS 4
Check the results of an
\fIAmanda\fR
dump\.
.RE
.PP
\fBamserverconfig\fR
.RS 4
Program to setup initial
\fIAmanda\fR
configuration\.
.RE
.PP
\fBamaddclient\fR
.RS 4
Program to add client to an existing
\fIAmanda\fR
configuration\.
.RE
.PP
\fBamrmtape\fR
.RS 4
Delete a tape from the
\fIAmanda\fR
databases\.
.RE
.PP
\fBamstatus\fR
.RS 4
Report the status of a running or completed
\fBamdump\fR\.
.RE
.PP
\fBamoverview\fR
.RS 4
Display a chart of hosts and file systems backed up every run\.
.RE
.PP
\fBamplot\fR
.RS 4
Generate utilization plots of
\fIAmanda\fR
runs for performance tuning\.
.RE
.PP
\fBamreport\fR
.RS 4
Generate an
\fIAmanda\fR
summary E\-mail report\.
.RE
.PP
\fBamtoc\fR
.RS 4
Generate table of content files for
\fIAmanda\fR
tapes\.
.RE
.PP
\fBamcheckdb\fR
.RS 4
Verify every tape
\fIAmanda\fR
knows about is consistent in the database\.
.RE
.PP
\fBamgetconf\fR
.RS 4
Look up parameters in the
\fIAmanda\fR
configuration file\.
.RE
.PP
\fBamtapetype\fR
.RS 4
Generate a tapetype definition\.
.RE
.PP
\fBamaespipe\fR
.RS 4
Wrapper program from aespipe (data encryption utility)
.RE
.PP
\fBamcrypt\fR
.RS 4
Reference encryption program for Amanda symmetric data encryption
.RE
.SH "CONFIGURATION"
.PP
There are three user\-editable files that control the behavior of
\fIAmanda\fR\.
.PP
The first is
\fBamanda\.conf\fR, the main configuration file\. It contains parameters to customize
\fIAmanda\fR
for the site\. Refer to the
\fBamanda.conf\fR(5), manpage for details on
\fIAmanda\fR
configuration parameters\.
.PP
Second is the
\fIdisklist\fR
file, which lists hosts and disk partitions to back up\.
.PP
Third is the
\fItapelist\fR
file, which lists tapes that are currently active\. These files are described in more detail in the following sections\.
.PP
All files are stored in individual configuration directories under
\fI/usr/local/etc/amanda/\fR\. A site will often have more than one configuration\. For example, it might have a
\fInormal\fR
configuration for everyday backups and an
\fIarchive\fR
configuration for infrequent full archival backups\. The configuration files would be stored under directories
\fI/usr/local/etc/amanda/normal/\fR
and
\fI/usr/local/etc/amanda/archive/\fR, respectively\. Part of the job of an
\fIAmanda\fR
administrator is to create, populate and maintain these directories\.
.PP
All log and database files generated by
\fIAmanda\fR
go in corresponding directories somewhere\. The exact location is controlled by entries in
\fBamanda\.conf\fR\. A typical location would be under
\fI/var/adm/amanda\fR\. For the above example, the files might go in
\fI/var/adm/amanda/normal/\fR
and
\fI/var/adm/amanda/archive/\fR\.
.PP
As log files are no longer needed (no longer contain relevant information),
\fIAmanda\fR
cycles them out in various ways, depending on the type of file\.
.PP
Detailed information about
\fBamdump\fR
runs are stored in files named
\fBamdump\.\fR\fINN\fR
where
\fINN\fR
is a sequence number, with 1 being the most recent file\.
\fBAmdump\fR
rotates these files each run, keeping roughly the last
\fBtapecycle\fR
(see below) worth of them\.
.PP
The file used by
\fBamreport\fR
to generate the mail summary is named
\fBlog\.\fR\fIYYYYMMDD\.NN\fR
where
\fIYYYYMMDD\fR
is the datestamp of the start of the
\fBamdump\fR
run and
\fINN\fR
is a sequence number started at 0\. At the end of each
\fBamdump\fR
run, log files for runs whose tapes have been reused are renamed into a subdirectory of the main log directory (see the
\fBlogdir\fR
parameter below) named
\fBoldlog\fR\. It is up to the
\fIAmanda\fR
administrator to remove them from this directory when desired\.
.PP
Index (backup image catalogue) files older than the full dump matching the oldest backup image for a given client and disk are removed by
\fBamdump\fR
at the end of each run\.
.SH "DISKLIST FILE"
.PP
The
\fIdisklist\fR
file determines which disks will be backed up by
\fIAmanda\fR\. The file usually contains one line per disk:
.sp
.RS 4
.nf
\fIhostname diskname\fR [\fIdiskdevice\fR] \fIdumptype\fR [\fIspindle\fR [\fIinterface\fR] ]
.fi
.RE
.PP
All pairs [
\fIhostname diskname\fR
] must be unique\.
.PP
Lines starting with # are ignored, as are blank lines\. The fields have the following meanings:
.PP
\fIhostname\fR
.RS 4
The name of the host to be backed up\. If
\fBdiskdevice\fR
refers to a PC share, this is the host
\fIAmanda\fR
will run the Samba
\fBsmbclient\fR
program on to back up the share\.
.RE
.PP
\fIdiskname\fR
.RS 4
The name of the disk (a label)\. In most case, you set your
\fBdiskname\fR
to the
\fBdiskdevice\fR
and you don\'t set the
\fBdiskdevice\.\fR
If you want multiple entries with the same
\fBdiskdevice\fR, you must set a different
\fBdiskname\fR
for each entry\. It\'s the
\fBdiskname\fR
that you use on the commandline for any
\fIAmanda\fR
command\. Look at the example/disklist file for example\.
.RE
.PP
\fIdiskdevice\fR
.RS 4
Default: same as diskname\. The name of the disk device to be backed up\. It may be a full device name, a device name without the
\fI/dev/\fR
prefix, e\.g\.
\fIsd0a\fR, or a mount point such as
\fI/usr\fR\.
.sp
It may also refer to a PC share by starting the name with two (forward) slashes, e\.g\.
\fI//some\-pc/home\fR\. In this case, the
\fBprogram\fR
option in the associated
\fBdumptype\fR
must be entered as
\fBGNUTAR\fR\. It is the combination of the double slash disk name and
\fBprogram GNUTAR\fR
in the
\fBdumptype\fR
that triggers the use of Samba\.
.RE
.PP
\fIdumptype\fR
.RS 4
Refers to a
\fBdumptype\fR
defined in the
\fBamanda\.conf\fR
file\.
\fIDumptype\fRs specify backup related parameters, such as whether to compress the backups, whether to record backup results in
\fI/etc/dumpdates\fR, the disk\'s relative priority, etc\.
.RE
.PP
\fIspindle\fR
.RS 4
Default:
\fB\-1\fR\. A number used to balance backup load on a host\.
\fIAmanda\fR
will not run multiple backups at the same time on the same spindle, unless the spindle number is \-1, which means there is no spindle restriction\.
.RE
.PP
\fIinterface\fR
.RS 4
Default:
\fIlocal\fR\. The name of a network interface definition in the
\fBamanda\.conf\fR
file, used to balance network load\.
.RE
.PP
Instead of naming a
\fBdumptype\fR, it is possible to define one in\-line, enclosing
\fBdumptype\fR
options within curly braces, one per line, just like a
\fBdumptype\fR
definition in
\fBamanda\.conf\fR\. Since pre\-existing
\fBdumptype\fRs are valid option names, this syntax may be used to customize
\fBdumptype\fRs for particular disks\.
.PP
A line break
\fBmust\fR
follow the left curly bracket\.
.PP
For instance, if a
\fBdumptype\fR
named
\fInormal\fR
is used for most disks, but use of the holding disk needs to be disabled for the file system that holds it, this would work instead of defining a new dumptype:
.sp
.RS 4
.nf
\fIhostname diskname\fR [ \fIdiskdevice\fR ] {
  normal
  holdingdisk never
} [ \fIspindle\fR [ \fIinterface\fR ] ]
.fi
.RE
.SH "TAPE MANAGEMENT"
.PP
The
\fItapelist\fR
file contains the list of tapes in active use\. This file is maintained entirely by
\fIAmanda\fR
and should not be created or edited during normal operation\. It contains lines of the form:
.PP
.RS 4
.nf
YYYYMMDD label flags
.fi
.RE
.PP
Where
\fIYYYYMMDD\fR
is the date the tape was written,
\fIlabel\fR
is a label for the tape as written by
\fBamlabel\fR
and
\fIflags\fR
tell
\fIAmanda\fR
whether the tape may be reused, etc (see the
\fBreuse\fR
options of
\fBamadmin\fR)\.
.PP
\fBAmdump\fR
and
\fBamflush\fR
will refuse to write to an unlabeled tape, or to a labeled tape that is considered active\. There must be more tapes in active rotation (see the
\fBtapecycle\fR
option) than there are runs in the backup cycle (see the
\fBdumpcycle\fR
option) to prevent overwriting a backup image that would be needed to do a full recovery\.
.SH "OUTPUT DRIVERS"
.PP
The normal value for the
\fBtapedev\fR
parameter, or for what a tape changer returns, is a full path name to a non\-rewinding tape device, such as
\fI/dev/nst0\fR
or
\fI/dev/rmt/0mn\fR
or
\fI/dev/nst0\.1\fR
or whatever conventions the operating system uses\.
\fIAmanda\fR
provides additional application level drivers that support non\-traditional tape\-simulations or features\. To access a specific output driver, set
\fBtapedev\fR
(or configure your changer to return) a string of the form
\fIdriver\fR:\fIdriver\-info\fR
where
\fIdriver\fR
is one of the supported drivers and
\fIdriver\-info\fR
is optional additional information needed by the driver\.
.PP
The supported drivers are:
.PP
\fItape\fR
.RS 4
This is the default driver\. The
\fIdriver\-info\fR
is the tape device name\. Entering
.sp
.RS 4
.nf
tapedev /dev/rmt/0mn
.fi
.RE
.sp
is really a short hand for
.sp
.RS 4
.nf
tapedev tape:/dev/rmt/0mn
.fi
.RE