amanda.conf.5

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

.\"     Title: amanda.conf
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\"      Date: 05/13/2008
.\"    Manual: 
.\"    Source: 
.\"
.TH "AMANDA\.CONF" "5" "05/13/2008" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
amanda.conf - Main configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver
.SH "DESCRIPTION"
.PP
\fIamanda\.conf\fR
is the main configuration file for
\fIAmanda\fR\. This manpage lists the relevant sections and parameters of this file for quick reference\.
.PP
The file
\fB<CONFIG_DIR>/<config>/amanda\.conf\fR
is loaded\.
.SH "PARAMETERS"
.PP
There are a number of configuration parameters that control the behavior of the
\fIAmanda\fR
programs\. All have default values, so you need not specify the parameter in
\fBamanda\.conf\fR
if the default is suitable\.
.PP
Lines starting with # are ignored, as are blank lines\. Comments may be placed on a line with a directive by starting the comment with a #\. The remainder of the line is ignored\.
.PP
Keywords are case insensitive, i\.e\.
\fBmailto\fR
and
\fBMailTo\fR
are treated the same\.
.PP
Integer arguments may have one of the following (case insensitive) suffixes, some of which have a multiplier effect:
.SS "POSSIBLE SUFFIXES"
.PP
\fBb byte bytes\fR
.RS 4
Some number of bytes\.
.RE
.PP
\fBbps\fR
.RS 4
Some number of bytes per second\.
.RE
.PP
\fBk kb kbyte kbytes kilobyte kilobytes\fR
.RS 4
Some number of kilobytes (bytes*1024)\.
.RE
.PP
\fBkps kbps\fR
.RS 4
Some number of kilobytes per second (bytes*1024)\.
.RE
.PP
\fBm mb meg mbyte mbytes megabyte megabytes\fR
.RS 4
Some number of megabytes (bytes*1024*1024)\.
.RE
.PP
\fBmps mbps\fR
.RS 4
Some number of megabytes per second (bytes*1024*1024)\.
.RE
.PP
\fBg gb gbyte gbytes gigabyte gigabytes\fR
.RS 4
Some number of gigabytes (bytes*1024*1024*1024)\.
.RE
.PP
\fBtape tapes\fR
.RS 4
Some number of tapes\.
.RE
.PP
\fBday days\fR
.RS 4
Some number of days\.
.RE
.PP
\fBweek weeks\fR
.RS 4
Some number of weeks (days*7)\.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
The value
\fBinf\fR
may be used in most places where an integer is expected to mean an infinite amount\.
.sp
Boolean arguments may have any of the values
\fBy\fR,
\fByes\fR,
\fBt\fR,
\fBtrue\fR
or
\fBon\fR
to indicate a true state, or
\fBn\fR,
\fBno\fR,
\fBf\fR,
\fBfalse\fR
or
\fBoff\fR
to indicate a false state\. If no argument is given,
\fBtrue\fR
is assumed\.
.RE
.SS "PARAMETERS"
.PP
\fBorg\fR \fI string\fR
.RS 4
Default:
\fIdaily\fR\. A descriptive name for the configuration\. This string appears in the Subject line of mail reports\. Each
\fIAmanda\fR
configuration should have a different string to keep mail reports distinct\.
.RE
.PP
\fBmailto\fR \fI string\fR
.RS 4
Default:
\fIoperators\fR\. A space separated list of recipients for mail reports\.
.RE
.PP
\fBdumpcycle\fR \fI int\fR
.RS 4
Default:
\fI10 days\fR\. The number of days in the backup cycle\. Each disk will get a full backup at least this often\. Setting this to zero tries to do a full backup each run\.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
This parameter may also be set in a specific
\fBdumptype\fR
(see below)\. This value sets the default for all
\fBdumptype\fRs so must appear in
\fBamanda\.conf\fR
before any
\fBdumptype\fRs are defined\.
.RE
.PP
\fBrunspercycle\fR \fI int\fR
.RS 4
Default:
\fIsame as dumpcycle\fR\. The number of amdump runs in
\fBdumpcycle\fR
days\. A value of 0 means the same value as
\fBdumpcycle\fR\. A value of \-1 means guess the number of runs from the
\fItapelist\fR
file, which is the number of tapes used in the last
\fBdumpcycle\fR
days /
\fBruntapes\fR\.
.RE
.PP
\fBtapecycle\fR \fI int\fR
.RS 4
Default:
\fI15 tapes\fR\. Typically tapes are used by
\fIAmanda\fR
in an ordered rotation\. The
\fBtapecycle\fR
parameter defines the size of that rotation\. The number of tapes in rotation must be larger than the number of tapes required for a complete dump cycle (see the
\fBdumpcycle\fR
parameter)\.
.sp
This is calculated by multiplying the number of
\fBamdump\fR
runs per dump cycle (\fBrunspercycle\fR
parameter) times the number of tapes used per run (\fBruntapes\fR
parameter)\. Typically two to four times this calculated number of tapes are in rotation\. While
\fIAmanda\fR
is always willing to use a new tape in its rotation, it refuses to reuse a tape until at least \'\fBtapecycle\fR
\-1\' number of other tapes have been used\.
.sp
It is considered good administrative practice to set the
\fBtapecycle\fR
parameter slightly lower than the actual number of tapes in rotation\. This allows the administrator to more easily cope with damaged or misplaced tapes or schedule adjustments that call for slight adjustments in the rotation order\.
.RE
.PP
\fBusetimestamps\fR \fI bool\fR
.RS 4
Default:
\fBYes\fR\. This option allows Amanda to track multiple runs per calendar day\. The only reason one might disable it is that Amanda versions before 2\.5\.1 can\'t read logfiles written when this option was enabled\.
.RE
.PP
\fBlabel_new_tapes\fR \fI string\fR
.RS 4
Default: not set\. When set, this directive will cause
\fIAmanda\fR
to automatically write an
\fIAmanda\fR
tape label to any blank tape she encounters\. This option is DANGEROUS because when set,
\fIAmanda\fR
will ERASE any non\-\fIAmanda\fR
tapes you may have, and may also ERASE any near\-failing tapes\. Use with caution\.
.sp
When using this directive, specify the template for new tape labels\. The template should contain some number of contiguous \'%\' characters, which will be replaced with a generated number\. Be sure to specify enough \'%\' characters that you do not run out of tape labels\. Example:
\fBlabel_new_tapes "DailySet1\-%%%"\fR
.RE
.PP
\fBdumpuser\fR \fI string\fR
.RS 4
Default:
\fIamanda\fR\. The login name
\fIAmanda\fR
uses to run the backups\. The backup client hosts must allow access from the tape server host as this user via
\fB\.rhosts\fR
or
\fB\.amandahosts\fR, depending on how the
\fIAmanda\fR
software was built\.
.RE
.PP
\fBprinter\fR string
.RS 4
Printer to use when doing tape labels\. See the
\fBlbl\-templ\fR
\fBtapetype\fR
option\.
.RE
.PP
\fBtapedev\fR string
.RS 4
Default:
\fInull:\fR\. The path name of the non\-rewinding tape device\. Non\-rewinding tape device names often have an \'n\' in the name, e\.g\.
\fI/dev/rmt/0mn\fR, however this is operating system specific and you should consult that documentation for detailed naming information\.
.sp
If a tape changer is configured (see the
\fBtpchanger\fR
option), this option might not be used\.
.sp
If the
\fBnull\fR
output driver is selected (see the section OUTPUT DRIVERS in the
\fBamanda\fR(8)
manpage for more information), programs such as
\fBamdump\fR
will run normally but all images will be thrown away\. This should only be used for debugging and testing, and probably only with the
\fBrecord\fR
option set to
\fIno\fR\.
.RE
.PP
\fBdevice_property\fR string string
.RS 4
These options can set various device properties, including block size, maximum volume usage, authentication information, hardware feature support, and more\.Specifics of how properties are used are device\-dependent, though some common properties are supported across multiple device drivers\.
.sp
Both strings are quoted; the first string contains the name of the property to set, and the second contains its value\. For example, to set a fixed block size of 128k, do:
.sp
.RS 4
.nf
device_property "BLOCK_SIZE" "131072"
.fi
.RE
.sp
The order in which device properties are set is as follows:
.sp
.RS 4
\h'-04' 1.\h'+02'Tapetype parameters, including length, blocksize, readblocksize, file\-pad, are translated into device properties and set accordingly\.
.RE
.sp
.RS 4
\h'-04' 2.\h'+02'Device properties from any device_property configuration directives are set, in the order they appear in the configuration file\.
.RE
.RE
.PP
\fBtpchanger\fR string
.RS 4
Default:
\fInone\fR\. The name of the tape changer\. If a tape changer is not configured, this option is not used and should be commented out of the configuration file\.
.sp
If a tape changer is configured, choose one of the changer scripts (e\.g\.
\fBchg\-scsi\fR) and enter that here\.
.RE
.PP
\fBchangerdev\fR string
.RS 4
Default:
\fI/dev/null\fR\. A tape changer configuration parameter\. Usage depends on the particular changer defined with the
\fBtpchanger\fR
option\.
.RE
.PP
\fBchangerfile\fR string
.RS 4
Default:
\fI/usr/adm/amanda/log/changer\-status\fR\. A tape changer configuration parameter\. Usage depends on the particular changer defined with the
\fBtpchanger\fR
option\.
.RE
.PP
\fBruntapes\fR int
.RS 4
Default:
1\. The maximum number of tapes used in a single run\. If a tape changer is not configured, this option is not used and should be commented out of the configuration file\.
.sp
If a tape changer is configured, this may be set larger than one to let
\fIAmanda\fR
write to more than one tape\.
.sp
Note that this is an upper bound on the number of tapes, and
\fIAmanda\fR
may use less\.
.sp
Also note that as of this release,
\fIAmanda\fR
does not support true tape overflow\. When it reaches the end of one tape, the backup image
\fIAmanda\fR
was processing starts over again on the next tape\.
.RE
.PP
\fBmaxdumpsize\fR int
.RS 4
Default:
\fIruntapes\fR*\fItape_length\fR\. Maximum number of bytes the planner will schedule for a run\.
.RE
.PP
\fBtaperalgo\fR [first|firstfit|largest|largestfit|smallest|last]
.RS 4
Default:
\fIfirst\fR\. The algorithm used to choose which dump image to send to the taper\.
.PP
\fBfirst\fR
.RS 4
First in, first out\.
.RE
.PP
\fBfirstfit\fR
.RS 4
The first dump image that will fit on the current tape\.
.RE
.PP
\fBlargest\fR
.RS 4
The largest dump image\.
.RE
.PP
\fBlargestfit\fR
.RS 4
The largest dump image that will fit on the current tape\.
.RE
.PP
\fBsmallest\fR
.RS 4
The smallest dump image\.
.RE
.PP
\fBlast\fR
.RS 4
Last in, first out\.
.RE
.RE
.PP
\fBlabelstr\fR \fI string\fR
.RS 4
Default:
\fI\.*\fR\. The tape label constraint regular expression\. All tape labels generated (see
\fBamlabel\fR(8)) and used by this configuration must match the regular expression\. If multiple configurations are run from the same tape server host, it is helpful to set their labels to different strings (for example, "DAILY[0\-9][0\-9]*" vs\. "ARCHIVE[0\-9][0\-9]*") to avoid overwriting each other\'s tapes\.
.RE
.PP
\fBtapetype\fR \fI string\fR
.RS 4
Default:
\fIEXABYTE\fR\. The type of tape drive associated with
\fBtapedev\fR
or
\fBtpchanger\fR\. This refers to one of the defined
\fBtapetype\fRs in the config file (see below), which specify various tape parameters, like the
\fBlength\fR,
\fBfilemark\fR
size, and
\fBspeed\fR
of the tape media and device\.
.sp
First character of a
\fBtapetype\fR
string must be an alphabetic character
.RE
.PP
\fBctimeout\fR int
.RS 4
Default:
\fI30 seconds\fR\. Maximum amount of time that
\fBamcheck\fR
will wait for each client host\.
.RE
.PP
\fBdtimeout\fR int
.RS 4
Default:
\fI1800 seconds\fR\. Amount of idle time per disk on a given client that a
\fBdumper\fR
running from within
\fBamdump\fR
will wait before it fails with a data timeout error\.
.RE
.PP
\fBetimeout\fR int
.RS 4
Default:
\fI300 seconds\fR\. Amount of time per estimate on a given client that the
\fBplanner\fR
step of
\fBamdump\fR
will wait to get the dump size estimates (note: Amanda runs up to 3 estimates for each DLE)\. For instance, with the default of 300 seconds and four DLE\'s, each estimating level 0 and level 1 on client A,
\fBplanner\fR
will wait up to 40 minutes for that machine\. A negative value will be interpreted as a total amount of time to wait per client instead of per disk\.
.RE
.PP
\fBconnect_tries\fR int
.RS 4
Default:
\fI3\fR\. How many times the server will try a connection\.
.RE
.PP
\fBreq_tries\fR int
.RS 4
Default:
\fI3\fR\. How many times the server will resend a REQ packet if it doesn\'t get the ACK packet\.
.RE
.PP
\fBnetusage\fR int
.RS 4
Default:
\fI8000 Kbps\fR\. The maximum network bandwidth allocated to
\fIAmanda\fR, in Kbytes per second\. See also the
\fBinterface\fR
section\.
.RE
.PP