X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Famanda.8;h=1e9137465a6a40ab5b2fea788b1df0c74c5dc795;hb=d74dc4d908fcbc1a4ef474edaf51e61ec90eab6b;hp=186199248d69d296a47170d46e76c0b207b1aa24;hpb=1194fb66aa28d9929c3f2bef3cc6c1c3f40a60a4;p=debian%2Famanda diff --git a/man/amanda.8 b/man/amanda.8 index 1861992..1e91374 100644 --- a/man/amanda.8 +++ b/man/amanda.8 @@ -1,592 +1,930 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "AMANDA" 8 "" "" "" -.SH NAME -amanda \- Advanced Maryland Automatic Network Disk Archiver -.SH "SYNOPSIS" +'\" t +.\" Title: amanda +.\" Author: James da Silva +.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 +.\" Date: 04/10/2009 +.\" Manual: System Administration Commands +.\" Source: Amanda 2.6.1p1 +.\" Language: English +.\" +.TH "AMANDA" "8" "04/10/2009" "Amanda 2\&.6\&.1p1" "System Administration Commands" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 -.HP 8 -\fBamadmin\fR \fIconfig\fR \fIcommand\fR [\fIoptions\fR] -.br - -.ad -.hy -.ad l -.hy 0 -.HP 8 -\fBamcheck\fR [\fIoptions\fR] \fIconfig\fR -.br - -.ad -.hy -.ad l -.hy 0 -.HP 10 -\fBamcheckdb\fR \fIconfig\fR -.br - -.ad -.hy -.ad l -.hy 0 -.HP 10 -\fBamcleanup\fR \fIconfig\fR -.br - -.ad -.hy -.ad l -.hy 0 -.HP 8 -\fBamcrypt\fR -.br - -.ad -.hy -.ad l -.hy 0 -.HP 5 -\fBamdd\fR [\fIoptions\fR] -.ad -.hy -.ad l -.hy 0 -.HP 7 -\fBamdump\fR \fIconfig\fR -.br - -.ad -.hy -.ad l -.hy 0 -.HP 10 -\fBamaespipe\fR -.br - -.ad -.hy -.ad l -.hy 0 -.HP 8 -\fBamflush\fR [\-f] \fIconfig\fR -.br - -.ad -.hy -.ad l -.hy 0 -.HP 10 -\fBamgetconf\fR [\fIconfig\fR] \fIparameter\fR -.br - -.ad -.hy -.ad l -.hy 0 -.HP 8 -\fBamlabel\fR \fIconfig\fR \fIlabel\fR [\fIslot\fR\ \fIslot\fR] -.br - -.ad -.hy -.ad l -.hy 0 -.HP 5 -\fBammt\fR [\fIoptions\fR] -.ad -.hy -.ad l -.hy 0 -.HP 11 -\fBamoverview\fR \fIconfig\fR [\fIoptions\fR] -.br - -.ad -.hy -.ad l -.hy 0 -.HP 7 -\fBamplot\fR [\fIoptions\fR] \fIamdump\-files\fR -.br - -.ad -.hy -.ad l -.hy 0 -.HP 10 -\fBamrecover\fR [\fIconfig\fR] [\fIoptions\fR] -.br - -.ad -.hy -.ad l -.hy 0 -.HP 9 -\fBamreport\fR [\fIconfig\fR] [\fIoptions\fR] -.br - -.ad -.hy -.ad l -.hy 0 -.HP 10 -\fBamrestore\fR [\fIoptions\fR] \fItapedevice\fR [\fIhostname\fR\ [\fIdiskname\fR]] -.br - -.ad -.hy -.ad l -.hy 0 -.HP 12 -\fBamfetchdump\fR [\fIoptions\fR] \fIconfig\fR [\fIhostname\fR\ [\fIdiskname\fR\ [\fIdate\fR\ [level]]]] -.ad -.hy -.ad l -.hy 0 -.HP 9 -\fBamrmtape\fR [\fIoptions\fR] \fIconfig\fR \fIlabel\fR -.br - -.ad -.hy -.ad l -.hy 0 -.HP 9 -\fBamstatus\fR \fIconfig\fR [\fIoptions\fR] -.br - -.ad -.hy -.ad l -.hy 0 -.HP 7 -\fBamtape\fR \fIconfig\fR \fIcommand\fR [\fIoptions\fR] -.br - -.ad -.hy -.ad l -.hy 0 -.HP 11 -\fBamtapetype\fR [\fIoptions\fR] -.ad -.hy -.ad l -.hy 0 -.HP 6 -\fBamtoc\fR [\fIoptions\fR] \fIlogfile\fR -.br - -.ad -.hy -.ad l -.hy 0 -.HP 9 -\fBamverify\fR \fIconfig\fR -.br - -.ad -.hy -.ad l -.hy 0 -.HP 12 -\fBamverifyrun\fR \fIconfig\fR -.ad -.hy - +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +amanda \- The Open Source Backup Platform .SH "DESCRIPTION" - .PP -\fBAmanda\fR is the "Advanced Maryland Automatic Network Disk Archiver"\&. This manual page gives an overview of the \fBAmanda\fR commands and configuration files for quick reference\&. - +This manual page gives an overview of the +\fIAmanda\fR +commands and configuration files for quick reference\&. +.SS "COMMANDS" +.PP +Here are all the +\fIAmanda\fR +commands\&. Each one has its own manual page\&. See them for all the gory details\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamaddclient\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamadmin\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamaespipe\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamcheck\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamcheckdb\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamcheckdump\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamcleanup\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamcrypt-ossl-asym\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamcrypt-ossl\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamcrypt\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamcryptsimple\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamdd\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamdevcheck\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamdump\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamfetchdump\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamflush\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamgetconf\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamgpgcrypt\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamgtar\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamlabel\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBammt\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamoverview\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamplot\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamrecover\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamreport\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamrestore\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamrmtape\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamsamba\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamserverconfig\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamservice\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamstar\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamstatus\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamtape\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamtapetype\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamtoc\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamvault\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamzfs-sendrecv\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamzfs-snapshot\fR(8), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBscript-email\fR(8), +.RE +.SS "CONFIGURATION FILES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamanda.conf\fR(5), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamanda-client.conf\fR(5), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBdisklist\fR(5), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBtapelist\fR(5), +.RE +.SS "DATA FORMATS" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamanda-archive-format\fR(5), +.RE +.SS "CONCEPTS" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamanda-applications\fR(7), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamanda-auth\fR(7), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamanda-changers\fR(7), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamanda-devices\fR(7), +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBamanda-scripts\fR(7), +.RE +.SH "CONFIGURATION" .PP -Here are all the \fBAmanda\fR commands\&. Each one has its own manual page\&. See them for all the gory details\&. - -.TP +There are four user\-editable files that control the behavior of +\fIAmanda\fR\&. +.PP +The first two are +\fBamanda.conf\fR(5) +and +\fBamanda-client.conf\fR(5), the main configuration files for the server and client, respectively\&. They contain parameters to customize +\fIAmanda\fR +for the site\&. +.PP +Next is the +\fBdisklist\fR(5) +file, which lists hosts and disk partitions to back up\&. +.PP +Last is the seldom\-edited +\fBtapelist\fR(5) +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, usually under +/etc/amanda/\&. 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 +/etc/amanda/normal/ +and +/etc/amanda/archive/, respectively\&. Part of the job of an +\fIAmanda\fR +administrator is to create, populate and maintain these directories\&. +.SH "LOG FILES" +.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(5)\&. A typical location would be under +/var/adm/amanda\&. For the above example, the files might go in +/var/adm/amanda/normal/ +and +/var/adm/amanda/archive/\&. +.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 -Take care of automatic \fBAmanda\fR backups\&. This is normally executed by \fBcron\fR on a computer called the \fBtape server host\fR and requests backups of file systems located on \fBbackup\fR \fBclients\fR\&. \fBAmdump\fR backs up all disks in the \fBdisklist\fR file (discussed below) to tape or, if there is a problem, to a special \fBholding\fR \fBdisk\fR\&. After all backups are done, \fBamdump\fR sends mail reporting failures and successes\&. - -.TP -\fBamflush\fR -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\&. - -.TP -\fBamcleanup\fR -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\&. - -.TP -\fBamrecover\fR -Provides an interactive interface to browse the \fBAmanda\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\&. - -.TP -\fBamrestore\fR -Read an \fBAmanda\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\&. - -.TP -\fBamfetchdump\fR -Performs \fBAmanda\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\&. - -.TP -\fBamlabel\fR -Write an \fBAmanda\fR format label onto a tape\&. All \fBAmanda\fR tapes must be labeled with \fBamlabel\fR\&. \fBAmdump\fR and \fBamflush\fR will not write to an unlabeled tape (see TAPE MANAGEMENT below)\&. - -.TP -\fBamcheck\fR -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\&. - -.TP -\fBamadmin\fR -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\&. - -.TP -\fBamtape\fR -Take care of tape changer control operations like loading particular tapes, ejecting tapes and scanning the tape storage slots\&. - -.TP -\fBamverify\fR -Check \fBAmanda\fR backup tapes for errors\&. - -.TP -\fBamrmtape\fR -Delete a tape from the \fBAmanda\fR databases\&. - -.TP -\fBamstatus\fR -Report the status of a running or completed \fBamdump\fR\&. - -.TP -\fBamoverview\fR -Display a chart of hosts and file systems backed up every run\&. - -.TP -\fBamplot\fR -Generate utilization plots of \fBAmanda\fR runs for performance tuning\&. - -.TP +runs are stored in dump logs \-\- 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 -Generate an \fBAmanda\fR summary E\-mail report\&. - -.TP -\fBamtoc\fR -Generate table of content files for \fBAmanda\fR tapes\&. - -.TP -\fBamcheckdb\fR -Verify every tape \fBAmanda\fR knows about is consistent in the database\&. - -.TP -\fBamgetconf\fR -Look up parameters in the \fBAmanda\fR configuration file\&. - -.TP -\fBamtapetype\fR -Generate a tapetype definition\&. - -.TP -\fBamaespipe\fR -Wrapper program from aespipe (data encryption utility) - -.TP -\fBamcrypt\fR -Reference encryption program for Amanda symmetric data encryption - -.SH "CONFIGURATION" - +to generate the mail summary is the trace log\&. This file constitutes the "catalog" describing the data on the tapes written in a run\&. It is named +\fBlog\&.\fR\fIYYYYMMDDHHMMSS\&.NN\fR +where +\fIYYYYMMDDHHMMSS\fR +is the datestamp of the start of the +\fBamdump\fR +or +\fBamflush\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 "USING SAMBA" +.PP +For Samba access, +\fIAmanda\fR +needs a file on the Samba server (which may or may not also be the tape server) named +/etc/amandapass +with share names, (clear text) passwords and (optional) domain names, in that order, one per line, whitespace separated\&. By default, the user used to connect to the PC is the same for all PC\'s and is compiled into +\fIAmanda\fR\&. It may be changed on a host by host basis by listing it first in the password field followed by a percent sign and then the password\&. For instance: +.nf + //some\-pc/home normalpw + //another\-pc/disk otheruser%otherpw +.fi .PP -There are three user\-editable files that control the behavior of \fBAmanda\fR\&. - +With clear text passwords, this file should obviously be tightly protected\&. It only needs to be readable by the +\fIAmanda\fR\-user on the Samba server\&. +.SH "HOST & DISK EXPRESSION" .PP -The first is \fBamanda\&.conf\fR, the main configuration file\&. It contains parameters to customize \fBAmanda\fR for the site\&. Refer to the \fBamanda\&.conf\fR(5), manpage for details on \fBAmanda\fR configuration parameters\&. - +All host and disk arguments to programs are special expressions\&. The command applies to all disks that match your arguments\&. This section describes the matcher\&. .PP -Second is the \fBdisklist\fR file, which lists hosts and disk partitions to back up\&. - +The matcher matches by word, each word is a glob expression, words are separated by the separator \'\&.\' for host and \'/\' for disk\&. You can anchor the expression at left with a \'^\'\&. You can anchor the expression at right with a \'$\'\&. The matcher is case insensitive for host but is case sensitive for disk\&. A match succeeds if all words in your expression match contiguous words in the host or disk\&. .PP -Third is the \fBtapelist\fR file, which lists tapes that are currently active\&. These files are described in more detail in the following sections\&. - +dot (\&.) +.RS 4 +word separator for a host +.RE .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 \fBnormal\fR configuration for everyday backups and an \fBarchive\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 \fBAmanda\fR administrator is to create, populate and maintain these directories\&. - +/ +.RS 4 +word separator for a disk +.RE .PP -All log and database files generated by \fBAmanda\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\&. - +^ +.RS 4 +anchor at left +.RE .PP -As log files are no longer needed (no longer contain relevant information), \fBAmanda\fR cycles them out in various ways, depending on the type of file\&. - +$ +.RS 4 +anchor at right +.RE .PP -Detailed information about \fBamdump\fR runs are stored in files named \fBamdump\&.\fR\fBNN\fR where \fBNN\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\&. - +? +.RS 4 +match exactly one character except the separator +.RE .PP -The file used by \fBamreport\fR to generate the mail summary is named \fBlog\&.\fR\fBYYYYMMDD\&.NN\fR where \fBYYYYMMDD\fR is the datestamp of the start of the \fBamdump\fR run and \fBNN\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 \fBAmanda\fR administrator to remove them from this directory when desired\&. - +* +.RS 4 +match zero or more characters except the separator +.RE .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" - +** +.RS 4 +match zero or more characters including the separator +.RE .PP -The \fBdisklist\fR file determines which disks will be backed up by \fBAmanda\fR\&. The file usually contains one line per disk: -.nf - -\fBhostname diskname\fR [\fBdiskdevice\fR] \fBdumptype\fR [\fBspindle\fR [\fBinterface\fR] ] -.fi - -.PP -All pairs [ \fBhostname diskname\fR ] must be unique\&. - -.PP -Lines starting with # are ignored, as are blank lines\&. The fields have the following meanings: - -.TP -\fBhostname\fR -The name of the host to be backed up\&. If \fBdiskdevice\fR refers to a PC share, this is the host \fBAmanda\fR will run the Samba \fBsmbclient\fR program on to back up the share\&. - -.TP -\fBdiskname\fR -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 \fBAmanda\fR command\&. Look at the example/disklist file for example\&. - -.TP -\fBdiskdevice\fR -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\&. \fBsd0a\fR, or a mount point such as \fI/usr\fR\&. - -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\&. - -.TP -\fBdumptype\fR -Refers to a \fBdumptype\fR defined in the \fBamanda\&.conf\fR file\&. \fBDumptype\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\&. - -.TP -\fBspindle\fR -Default: \fB\-1\fR\&. A number used to balance backup load on a host\&. \fBAmanda\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\&. - -.TP -\fBinterface\fR -Default: \fBlocal\fR\&. The name of a network interface definition in the \fBamanda\&.conf\fR file, used to balance network load\&. - -.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 \fBnormal\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: -.nf - -\fBhostname diskname\fR [ \fBdiskdevice\fR ] { - normal - holdingdisk no -} [ \fBspindle\fR [ \fBinterface\fR ] ] -.fi - -.SH "TAPE MANAGEMENT" - +Some examples: .PP -The \fBtapelist\fR file contains the list of tapes in active use\&. This file is maintained entirely by \fBAmanda\fR and should not be created or edited during normal operation\&. It contains lines of the form: - +hosta +.RS 4 +Will match +hosta, +foo\&.hosta\&.org, and +hoSTA\&.dOMAIna\&.ORG +but not +hostb\&. +.RE .PP - -.nf -YYYYMMDD label flags -.fi - - +host +.RS 4 +Will match +host +but not +hosta\&. +.RE .PP -Where \fBYYYYMMDD\fR is the date the tape was written, \fBlabel\fR is a label for the tape as written by \fBamlabel\fR and \fBflags\fR tell \fBAmanda\fR whether the tape may be reused, etc (see the \fBreuse\fR options of \fBamadmin\fR)\&. - +host? +.RS 4 +Will match +hosta +and +hostb, but not +host\&. +.RE .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" - +ho*na +.RS 4 +Will match +hoina +but not +ho\&.aina\&.org\&. +.RE .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\&. \fBAmanda\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 \fBdriver\fR:\fBdriver\-info\fR where \fBdriver\fR is one of the supported drivers and \fBdriver\-info\fR is optional additional information needed by the driver\&. - +ho**na +.RS 4 +Will match +hoina +and +ho\&.aina\&.org\&. +.RE .PP -The supported drivers are: - -.TP -\fBtape\fR -This is the default driver\&. The \fBdriver\-info\fR is the tape device name\&. Entering -.nf -tapedev /dev/rmt/0mn -.fi - is really a short hand for -.nf -tapedev tape:/dev/rmt/0mn -.fi -\&. - -.TP -\fBnull\fR -This driver throws away anything written to it and returns EOF for any reads except a special case is made for reading a label, in which case a "fake" value is returned that \fBAmanda\fR checks for and allows through regardless of what you have set in \fBlabelstr\fR\&. The \fBdriver\-info\fR field is not used and may be left blank: - - +^hosta +.RS 4 +Will match +hosta +but not +foo\&.hosta\&.org\&. +.RE +.PP +sda* +.RS 4 +Will match +/dev/sda1 +and +/dev/sda12\&. +.RE +.PP +/opt +.RS 4 +Will match the disk +opt +but not the host +opt\&. +.RE +.PP +(note dots:) \&.opt\&. +.RS 4 +Will match the host +opt +but not the disk +opt\&. +.RE +.PP +/ +.RS 4 +Will match the disk +/ +but no other disk\&. +.RE +.PP +/usr +.RS 4 +Will match the disks +/usr +and +/usr/local\&. +.RE +.PP +/usr$ +.RS 4 +Will match the disks +/usr +but not +/usr/local\&. +.RE +.SH "DATESTAMP EXPRESSION" +.PP +A +\fIdatestamp\fR +expression is a range expression where we only match the prefix\&. Leading ^ is removed\&. Trailing $ forces an exact match\&. +.PP +20001212\-14 +.RS 4 +match all dates beginning with 20001212, 20001213 or 20001214 +.RE +.PP +20001212\-4 +.RS 4 +same as previous +.RE +.PP +20001212\-24 +.RS 4 +match all dates between 20001212 and 20001224 +.RE +.PP +2000121 +.RS 4 +match all dates that start with 2000121 (20001210\-20001219) +.RE +.PP +2 +.RS 4 +match all dates that start with 2 (20000101\-29991231) +.RE +.PP +2000\-10 +.RS 4 +match all dates between 20000101\-20101231 +.RE +.PP +200010$ +.RS 4 +match only 200010 +.RE +.SH "DUMP SPECIFICATIONS" +.PP +A dump specification selects one or more dumps\&. It has the form +\fI[host][:disk][@datestamp]\fR, where each component is a pattern as described above\&. If a component is missing, it is treated as a wildcard\&. The characters \':\', \'@\', and \'\e\' may be escaped within any component by preceding them with a \'\e\'\&. +.PP +Some examples: +.PP +client17 +.RS 4 +all dumps of client17 +.RE +.PP +@20080615 +.RS 4 +All dumps on with datestamps matching 20080615 +.RE +.PP +webserver:/var/www +.RS 4 +All dumps of /var/www on host webserver +.RE +.PP +webserver:/var/www@200806150317 +.RS 4 +The dump of webserver with datestamp 200806150317 +.RE +.PP +:/var/www +.RS 4 +All dumps of /var/www on any host +.RE +.SH "CONFIGURATION OVERRIDE" +.PP +Most commands allow the override of specific configuration options on the command line, using the +\-o +option\&. This option has the form +\-o\fIname\fR=\fIvalue\fR\&. An optional space is allowed after the +\-o\&. Each configuration option should be specified in a separate command\-line option\&. +.PP +For global options, +\fIname\fR +is simply the name of the option, e\&.g\&., +.sp .nf -tapedev null: +amdump \-oruntapes=2 .fi - - -The \fBlength\fR value from the associated \fBtapetype\fR is used to limit the amount of data written\&. When the limit is reached, the driver will simulate end of tape\&. - -.RS -.Sh "Note" -This driver should only be used for debugging and testing, -and probably only with the -\fBrecord\fR -option set to -\fBno\fR\&. -.RE - -.TP -\fBrait\fR -\fBR\fRedundant \fBA\fRrray of \fBI\fRnexpensive (?) \fBT\fRapes\&. Reads and writes tapes mounted on multiple drives by spreading the data across N\-1 drives and using the last drive for a checksum\&. See docs/RAIT for more information\&. - -The \fBdriver\-info\fR field describes the devices to use\&. Curly braces indicate multiple replacements in the string\&. For instance: - - +For options in a named section of the configuration, +\fIname\fR +has the form +\fISECTION\fR:\fIsection_name\fR:\fIname\fR, where +\fISECTION\fR +is one of TAPETYPE, DUMPTYPE, HOLDINGDISK, or INTERFACE, and +\fIsection_name\fR +is the name of the tapetype, dumptype, holdingdisk, or interface\&. Examples: +.sp .nf -tapedev rait:/dev/rmt/tps0d{4,5,6}n +amdump \-o TAPETYPE:HP\-DAT:length=2000m +amdump \-o DUMPTYPE:no\-compress:compress="server fast" +amdump \-o HOLDINGDISK:hd1:use="\-100 mb" +amdump \-o INTERFACE:local:use="2000 kbps" .fi - - -would use the following devices: - -\fI/dev/rmt/tps0d4n\fR \fI/dev/rmt/tps0d5n\fR \fI/dev/rmt/tps0d6n\fR - -.TP -\fBfile\fR -This driver emulates a tape device with a set of files in a directory\&. The \fBdriver\-info\fR field must be the name of an existing directory\&. The driver will test for a subdirectory of that named \fBdata\fR and return \fBoffline\fR until it is present\&. When present, the driver uses two files in the \fBdata\fR subdirectory for each tape file\&. One contains the actual data\&. The other contains record length information\&. - -The driver uses a file named \fBstatus\fR in the \fBfile\fR device directory to hold driver status information, such as tape position\&. If not present, the driver will create it as though the device is rewound\&. - -The \fBlength\fR value from the associated \fBtapetype\fR is used to limit the amount of data written\&. When the limit is reached, the driver will simulate end of tape\&. - -One way to use this driver with a real device such as a CD\-writer is to create a directory for the \fBfile\fR device and one or more other directories for the actual data\&. Create a symlink named \fBdata\fR in the \fBfile\fR directory to one of the data directories\&. Set the \fBtapetype\fR length to whatever the medium will hold\&. - -When \fBAmanda\fR fills the \fBfile\fR device, remove the symlink and (optionally) create a new symlink to another data area\&. Use a CD writer software package to burn the image from the first data area\&. - -To read the CD, mount it and create the \fBdata\fR symlink in the \fBfile\fR device directory\&. - -.SH "AUTHORIZATION" - -.PP -\fBAmanda\fR processes on the tape server host run as the \fBdumpuser\fR user listed in \fBamanda\&.conf\fR\&. When they connect to a backup client, they do so with an \fBAmanda\fR\-specific protocol\&. They do not, for instance, use \fBrsh\fR or \fBssh\fR directly\&. - -.PP -On the client side, the \fBamandad\fR daemon validates the connection using one of several methods, depending on how it was compiled and on options it is passed: - -.TP -\&.rhosts -Even though \fBAmanda\fR does not use \fBrsh\fR, it can use \&.rhosts\-style authentication and a \&.rhosts file\&. - -.TP -\&.amandahosts -This is essentially the same as \&.rhosts authentication except a different file, with almost the same format, is used\&. This is the default mechanism built into \fBAmanda\fR\&. - -The format of the \fI\&.amandahosts\fR file is: - -\fBhostname\fR [ \fBusername\fR ] - -If \fBusername\fR is ommitted, it defaults to the user running \fBamandad\fR, i\&.e\&. the user listed in the \fBinetd\fR or \fBxinetd\fR configuration file\&. - -.TP -Kerberos -\fBAmanda\fR may use the Kerberos authentication system\&. Further information is in the \fBdocs/KERBEROS\fR file that comes with an \fBAmanda\fR distribution\&. - -For Samba access, \fBAmanda\fR needs a file on the Samba server (which may or may not also be the tape server) named \fI/etc/amandapass\fR with share names, (clear text) passwords and (optional) domain names, in that order, one per line, whitespace separated\&. By default, the user used to connect to the PC is the same for all PC's and is compiled into \fBAmanda\fR\&. It may be changed on a host by host basis by listing it first in the password field followed by a percent sign and then the password\&. For instance: - -.nf - - //some\-pc/home normalpw - //another\-pc/disk otheruser%otherpw.fi -With clear text passwords, this file should obviously be tightly protected\&. It only needs to be readable by the \fBAmanda\fR\-user on the Samba server\&. - -You can find further information in the \fBdocs/SAMBA\fR file that comes with an \fBAmanda\fR distribution\&. - -.SH "HOST & DISK EXPRESSION" - -.PP -All host and disk arguments to programs are special expressions\&. The command applies to all disks that match your arguments\&. This section describes the matcher\&. - .PP -The matcher matches by word, each word is a glob expression, words are separated by the separator '\&.' for host and '/' for disk\&. You can anchor the expression at left with a '^'\&. You can anchor the expression at right with a '$'\&. The matcher is case insensitive for host but is case sensitive for disk\&. A match succeeds if all words in your expression match contiguous words in the host or disk\&. - +When overriding device properties, one must carefully quote the command line to simulate the syntax of real configuration files\&. The following example should serve as a guide: +.sp .nf - -\&. word separator for a host -/ word separator for a disk -^ anchor at left -$ anchor at right -? match exactly one character except the separator -* match zero or more characters except the separator -** match zero or more characters including the separator - +amdump \-o \'device\-property="PROPERTY_MAX_VOLUME_USAGE" "100000"\' .fi - .PP -Some examples: - +Note that configuration overrides are not effective for tape changers, which supply a tapedev based on their own configuration\&. In order to override +\fItapedev\fR, you must also disable any changer: +.sp .nf - -EXPRESSION WILL MATCH WILL NOT MATCH -hosta hosta hostb - hoSTA\&.dOMAIna\&.ORG - foo\&.hosta\&.org -host host hosta -host? hosta host - hostb -ho*na hoina ho\&.aina\&.org -ho**na hoina - ho\&.aina\&.org -^hosta hosta foo\&.hosta\&.org -sda* /dev/sda1 - /dev/sda12 -/opt/ opt (disk) opt (host) -\&.opt\&. opt (host) opt (disk) -/ / any other disk -/usr /usr - /usr/opt -/usr$ /usr /usr/opt - +amdump \-otapedev=/dev/nst1 \-otpchanger=\'\' .fi - -.SH "DATESTAMP EXPRESSION" - -.PP -A \fBdatestamp\fR expression is a range expression where we only match the prefix\&. Leading ^ is removed\&. Trailing $ forces an exact match\&. -20001212\-14match all dates beginning with 20001212, 20001213 or 2000121420001212\-4same as previous20001212\-24match all dates between 20001212 and 200012242000121match all dates that start with 2000121 (20001210\-20001219)2match all dates that start with 2 (20000101\-29991231)2000\-10match all dates between 20000101\-20101231200010$match only 200010 -.PP - - -.SH "AUTHOR" - -.PP -James da Silva, : Original text - +.SH "AUTHORS" .PP -Stefan G\&. Weichinger, , maintainer of the \fBAmanda\fR\-documentation: XML\-conversion, major update - -.SH "SEE ALSO" - +\fBJames da Silva\fR <\&jds@amanda\&.org\&> .PP - \fBamadmin\fR(8), \fBamanda\&.conf\fR(5), \fBamcheck\fR(8), \fBamcheckdb\fR(8), \fBamcleanup\fR(8), \fBamdd\fR(8), \fBamdump\fR(8), \fBamfetchdump\fR(8) \fBamflush\fR(8), \fBamgetconf\fR(8), \fBamlabel\fR(8), \fBammt\fR(8), \fBamoverview\fR(8), \fBamplot\fR(8), \fBamrecover\fR(8), \fBamreport\fR(8), \fBamrestore\fR(8), \fBamrmtape\fR(8), \fBamstatus\fR(8), \fBamtape\fR(8), \fBamtapetype\fR(8), \fBamtoc\fR(8), \fBamverify\fR(8), \fBamverifyrun\fR(8) - +\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>