Imported Upstream version 2.5.2p1

[debian/amanda] / man / amanda.conf.5

.\"     Title: amanda.conf
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
.\"      Date: 06/06/2007
.\"    Manual: 
.\"    Source: 
.\"
.TH "AMANDA.CONF" "5" "06/06/2007" "" ""
.\" 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
\fBNote\fR
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
\fBNote\fR
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:
\fBNo\fR. By default, Amanda can only track at most one run per calendar day. When this option is enabled, however, Amanda can track as many runs as you care to make.
.sp

\fBWARNING\fR: This option is not backward\-compatible. Do not enable it if you intend to downgrade your server installation to Amanda community edition 2.5.0
.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
\fBrawtapedev\fR string
.RS 4
Default:
\fInull:\fR. The path name of the raw tape device. This is only used if
\fIAmanda\fR
is compiled for Linux machines with floppy tapes and is needed for QIC volume table operations.
.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.
.RS 4
.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
.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 disk on a given client that the
\fBplanner\fR
step of
\fBamdump\fR
will wait to get the dump size estimates. For instance, with the default of 300 seconds and four disks on client A,
\fBplanner\fR
will wait up to 20 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:
\fI300 Kbps\fR. The maximum network bandwidth allocated to
\fIAmanda\fR, in Kbytes per second. See also the
\fBinterface\fR
section.
.RE
.PP
\fBinparallel\fR int
.RS 4
Default:
10. The maximum number of backups that
\fIAmanda\fR
will attempt to run in parallel.
\fIAmanda\fR
will stay within the constraints of network bandwidth and holding disk space available, so it doesn't hurt to set this number a bit high. Some contention can occur with larger numbers of backups, but this effect is relatively small on most systems.
.RE
.PP
\fBdisplayunit\fR "k|m|g|t"
.RS 4
Default:
"k". The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera.
.RE
.PP
\fBdumporder\fR string
.RS 4
Default:
\fItttTTTTTTT\fR. The priority order of each dumper:
.sp
.RS 4
.nf
s: smallest size
S: largest size
t: smallest time
T: largest time
b: smallest bandwidth
B: largest bandwidth
.fi
.RE
.RE
.PP
\fBmaxdumps\fR int
.RS 4
Default:
1. The maximum number of backups from a single host that
\fIAmanda\fR
will attempt to run in parallel. See also the
\fBinparallel\fR
option.
.sp
Note that 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
\fBbumpsize\fR int
.RS 4
Default:
\fI10 Mbytes\fR. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size. If
\fIAmanda\fR
determines that the next higher backup level will be this much smaller than the current level, it will do the next level. The value of this parameter is used only if the parameter
\fIbumppercent\fR
is set to 0.
.sp
The global setting of this parameter can be overwritten inside of a dumptype\-definition.
.sp
See also the options
\fBbumppercent\fR,
\fBbumpmult\fR
and
\fBbumpdays\fR.
.RE
.PP
\fBbumppercent\fR int
.RS 4
Default:
\fI0 percent\fR. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as percentage of the current size of the DLE (size of current level 0). If
\fIAmanda\fR
determines that the next higher backup level will be this much smaller than the current level, it will do the next level.
.sp
If this parameter is set to 0, the value of the parameter
\fIbumpsize\fR
is used to trigger bumping.
.sp
The global setting of this parameter can be overwritten inside of a dumptype\-definition.
.sp
See also the options
\fBbumpsize\fR,
\fBbumpmult\fR
and
\fBbumpdays\fR.
.RE
.PP
\fBbumpmult\fR \fI float\fR
.RS 4
Default:
1.5. The bump size multiplier.
\fIAmanda\fR
multiplies
\fBbumpsize\fR
by this factor for each level. This prevents active filesystems from bumping too much by making it harder to bump to the next level. For example, with the default
\fBbumpsize\fR
and
\fBbumpmult\fR
set to 2.0, the bump threshold will be 10 Mbytes for level one, 20 Mbytes for level two, 40 Mbytes for level three, and so on.
.sp
The global setting of this parameter can be overwritten inside of a dumptype\-definition.
.RE
.PP
\fBbumpdays\fR \fI int\fR
.RS 4
Default:
\fI2 days\fR. To insure redundancy in the dumps,
\fIAmanda\fR
keeps filesystems at the same incremental level for at least
\fBbumpdays\fR
days, even if the other bump threshold criteria are met.
.sp
The global setting of this parameter can be overwritten inside of a dumptype\-definition.
.RE
.PP
\fBdiskfile\fR \fI string\fR
.RS 4
Default:
\fIdisklist\fR. The file name for the
\fIdisklist\fR
file holding client hosts, disks and other client dumping information.
.RE
.PP
\fBinfofile\fR \fI string\fR
.RS 4
Default:
\fI/usr/adm/amanda/curinfo\fR. The file or directory name for the historical information database. If
\fIAmanda\fR
was configured to use DBM databases, this is the base file name for them. If it was configured to use text formated databases (the default), this is the base directory and within here will be a directory per client, then a directory per disk, then a text file of data.
.RE
.PP
\fBlogdir\fR \fI string\fR
.RS 4
Default:
\fI/usr/adm/amanda\fR. The directory for the
\fBamdump\fR
and
\fBlog\fR
files.
.RE
.PP
\fBindexdir\fR \fI string\fR
.RS 4
Default
\fI/usr/adm/amanda/index\fR. The directory where index files (backup image catalogues) are stored. Index files are only generated for filesystems whose
\fBdumptype\fR
has the
\fBindex\fR
option enabled.
.RE
.PP
\fBtapelist\fR \fI string\fR
.RS 4
Default:
\fItapelist\fR. The file name for the active
\fItapelist\fR
file.
\fIAmanda\fR
maintains this file with information about the active set of tapes.
.RE
.PP
\fBtapebufs\fR \fI int\fR
.RS 4
Default:
20. The number of buffers used by the
\fBtaper\fR
process run by
\fBamdump\fR
and
\fBamflush\fR
to hold data as it is read from the network or disk before it is written to tape. Each buffer is a little larger than 32 KBytes and is held in a shared memory region.
.RE
.PP
\fBreserve\fR \fI number\fR
.RS 4
Default:
100. The part of holding\-disk space that should be reserved for incremental backups if no tape is available, expressed as a percentage of the available holding\-disk space (0\-100). By default, when there is no tape to write to, degraded mode (incremental) backups will be performed to the holding disk. If full backups should also be allowed in this case, the amount of holding disk space reserved for incrementals should be lowered.
.RE
.PP
\fBautoflush\fR \fI bool\fR
.RS 4
Default:
\fIoff\fR. Whether an amdump run will flush the dumps from holding disk to tape.
.RE
.PP
\fBamrecover_do_fsf\fR \fI bool\fR
.RS 4
Default:
\fIon\fR. Amrecover will call amrestore with the \-f flag for faster positioning of the tape.
.RE
.PP
\fBamrecover_check_label\fR \fI bool\fR
.RS 4
Default:
\fIon\fR. Amrecover will call amrestore with the \-l flag to check the label.
.RE
.PP
\fBamrecover_changer\fR \fI string\fR
.RS 4
Default: ''. Amrecover will use the changer if you use 'settape <string>' and that string is the same as the amrecover_changer setting.
.RE
.PP
\fBcolumnspec\fR \fI string\fR
.RS 4
Defines the width of columns
\fBamreport\fR
should use.
\fIString\fR
is a comma (',') separated list of triples. Each triple consists of three parts which are separated by a equal sign ('=') and a colon (':') (see the example). These three parts specify:
.RS 4
\h'-04' 1.\h'+02'the name of the column, which may be:
.sp
.RS 4
.nf
        Compress (compression ratio)
        Disk (client disk name)
        DumpRate (dump rate in KBytes/sec)
        DumpTime (total dump time in hours:minutes)
        HostName (client host name)
        Level (dump level)
        OrigKB (original image size in KBytes)
        OutKB (output image size in KBytes)
        TapeRate (tape writing rate in KBytes/sec)
        TapeTime (total tape time in hours:minutes)
        
.fi
.RE
.RE
.RS 4
\h'-04' 2.\h'+02'the amount of space to display before the column (used to get whitespace between columns).
.sp
.RE
.RS 4
\h'-04' 3.\h'+02'the width of the column itself. If set to a negative value, the width will be calculated on demand to fit the largest entry in this column.
.RE
.IP "" 4
Here is an example:
.sp
.RS 4
.nf
columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"
.fi
.RE
.sp
The above will display the disk information in 18 characters and put one space before it. The hostname column will be 10 characters wide with no space to the left. The output KBytes column is seven characters wide with one space before it.
.RE
.PP
\fBincludefile\fR \fI string\fR
.RS 4
Default:
\fInone\fR. The name of an
\fIAmanda\fR
configuration file to include within the current file. Useful for sharing dumptypes, tapetypes and interface definitions among several configurations.
.RE
.PP
\fBdebug_auth\fR int
.RS 4
Default:
\fI0\fR. Debug level of the auth module
.RE
.PP
\fBdebug_event\fR int
.RS 4
Default:
\fI0\fR. Debug level of the event module
.RE
.PP
\fBdebug_holding\fR int
.RS 4
Default:
\fI0\fR. Debug level of the holdingdisk module
.RE
.PP
\fBdebug_protocol\fR int
.RS 4
Default:
\fI0\fR. Debug level of the protocol module
.RE
.PP
\fBdebug_planner\fR int
.RS 4
Default:
\fI0\fR. Debug level of the planner process
.RE
.PP
\fBdebug_driver\fR int
.RS 4
Default:
\fI0\fR. Debug level of the driver process
.RE
.PP
\fBdebug_dumper\fR int
.RS 4
Default:
\fI0\fR. Debug level of the dumper process
.RE
.PP
\fBdebug_chunker\fR int
.RS 4
Default:
\fI0\fR. Debug level of the chunker process
.RE
.PP
\fBdebug_taper\fR int
.RS 4
Default:
\fI0\fR. Debug level of the taper process
.RE
.PP
\fBreserved\-udp\-port\fR int,int
.RS 4
Default: \-\-with\-udpportrange or
\fI512,1023\fR. Reserved udp port that will be used (bsd, bsdudp)
.RE
.PP
\fBreserved\-tcp\-port\fR int,int
.RS 4
Default: \-\-with\-low\-tcpportrange or
\fI512,1023\fR. Reserved tcp port that will be used (bsdtcp)
.RE
.PP
\fBunreserved\-tcp\-port\fR int,int
.RS 4
Default: \-\-with\-tcpportrange or
\fI1025,65536\fR. Unreserved tcp port that will be used (bsd, bsdudp)
.RE
.SH "HOLDINGDISK SECTION"
.PP
The
\fBamanda.conf\fR
file may define one or more holding disks used as buffers to hold backup images before they are written to tape. The syntax is:
.sp
.RS 4
.nf
holdingdisk \fIname\fR {
    \fIholdingdisk\-option\fR \fIholdingdisk\-value\fR
    ...
}
.fi
.RE
.PP
\fIName\fR
is a logical name for this holding disk.
.PP
The options and values are:
.PP
\fBcomment\fR \fI string\fR
.RS 4
Default:
\fInone\fR. A comment string describing this holding disk.
.RE
.PP
\fBdirectory\fR \fI disk\fR
.RS 4
Default:
\fI/dumps/amanda\fR. The path to this holding area.
.RE
.PP
\fBuse\fR \fI int\fR
.RS 4
Default:
\fI0 Gb\fR. Amount of space that can be used in this holding disk area. If the value is zero, all available space on the file system is used. If the value is negative,
\fIAmanda\fR
will use all available space minus that value.
.RE
.PP
\fBchunksize\fR \fI int\fR
.RS 4
Default:
\fI1 Gb\fR. Holding disk chunk size. Dumps larger than the specified size will be stored in multiple holding disk files. The size of each chunk will not exceed the specified value. However, even though dump images are split in the holding disk, they are concatenated as they are written to tape, so each dump image still corresponds to a single continuous tape section.
.sp
If 0 is specified,
\fIAmanda\fR
will create holding disk chunks as large as ((INT_MAX/1024)\-64) Kbytes.
.sp
Each holding disk chunk includes a 32 Kbyte header, so the minimum chunk size is 64 Kbytes (but that would be really silly).
.sp
Operating systems that are limited to a maximum file size of 2 Gbytes actually cannot handle files that large. They must be at least one byte less than 2 Gbytes. Since
\fIAmanda\fR
works with 32 Kbyte blocks, and to handle the final read at the end of the chunk, the chunk size should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum file size, e.g. 2047 Mbytes.
.RE
.SH "DUMPTYPE SECTION"
.PP
The
\fIamanda.conf\fR
file may define multiple sets of backup options and refer to them by name from the
\fIdisklist\fR
file. For instance, one set of options might be defined for file systems that can benefit from high compression, another set that does not compress well, another set for file systems that should always get a full backup and so on.
.PP
A set of backup options are entered in a
\fBdumptype\fR
section, which looks like this:
.sp
.RS 4
.nf
define dumptype \fIname\fR {
    \fIdumptype\-option\fR \fIdumptype\-value\fR
    ...
}
.fi
.RE
.PP
\fIName\fR
is the name of this set of backup options. It is referenced from the
\fIdisklist\fR
file.
.PP
Some of the options in a
\fBdumptype\fR
section are the same as those in the main part of
\fIamanda.conf\fR. The main option value is used to set the default for all
\fBdumptype\fR
sections. For instance, setting
\fBdumpcycle\fR
to 50 in the main part of the config file causes all following
\fBdumptype\fR
sections to start with that value, but the value may be changed on a section by section basis. Changes to variables in the main part of the config file must be done before (earlier in the file) any
\fBdumptype\fRs are defined.
.PP
The dumptype options and values are:
.PP
\fBauth\fR \fI string\fR
.RS 4
Default:
\fIbsd\fR. Type of authorization to perform between tape server and backup client hosts.
.sp
\fBbsd\fR, bsd authorization with udp initial connection and one tcp connection by data stream.
.sp
\fBbsdtcp\fR, bsd authorization but use only one tcp connection.
.sp
\fBbsdudp\fR, like bsd, but will use only one tcp connection for all data stream.
.sp
\fBkrb4\fR
to use Kerberos\-IV authorization.
.sp
\fBkrb5\fR
to use Kerberos\-V authorization.
.sp
\fBrsh\fR
to use rsh authorization.
.sp
\fBssh\fR
to use OpenSSH authorization.
.RE
.PP
\fBamandad_path\fR \fI string\fR
.RS 4
Default:
\fI$libexec/amandad\fR. Specify the amandad path of the client, only use with rsh/ssh authentification.
.RE
.PP
\fBclient_username\fR \fI string\fR
.RS 4
Default:
\fICLIENT_LOGIN\fR. Specify the username to connect on the client, only use with rsh/ssh authentification.
.RE
.PP
\fBbumpsize\fR int
.RS 4
Default:
\fI10 Mbytes\fR. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size. If
\fIAmanda\fR
determines that the next higher backup level will be this much smaller than the current level, it will do the next level. The value of this parameter is used only if the parameter
\fIbumppercent\fR
is set to 0.
.sp
See also the options
\fBbumppercent\fR,
\fBbumpmult\fR
and
\fBbumpdays\fR.
.RE
.PP
\fBbumppercent\fR int
.RS 4
Default:
\fI0 percent\fR. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as percentage of the current size of the DLE (size of current level 0). If
\fIAmanda\fR
determines that the next higher backup level will be this much smaller than the current level, it will do the next level.
.sp
If this parameter is set to 0, the value of the parameter
\fIbumpsize\fR
is used to trigger bumping.
.sp
See also the options
\fBbumpsize\fR,
\fBbumpmult\fR
and
\fBbumpdays\fR.
.RE
.PP
\fBbumpmult\fR \fI float\fR
.RS 4
Default:
1.5. The bump size multiplier.
\fIAmanda\fR
multiplies
\fBbumpsize\fR
by this factor for each level. This prevents active filesystems from bumping too much by making it harder to bump to the next level. For example, with the default
\fBbumpsize\fR
and
\fBbumpmult\fR
set to 2.0, the bump threshold will be 10 Mbytes for level one, 20 Mbytes for level two, 40 Mbytes for level three, and so on.
.RE
.PP
\fBbumpdays\fR \fI int\fR
.RS 4
Default:
\fI2 days\fR. To insure redundancy in the dumps,
\fIAmanda\fR
keeps filesystems at the same incremental level for at least
\fBbumpdays\fR
days, even if the other bump threshold criteria are met.
.RE
.PP
\fBcomment\fR \fI string\fR
.RS 4
Default:
\fInone\fR. A comment string describing this set of backup options.
.RE
.PP
\fBcomprate\fR \fIfloat\fR [, \fIfloat\fR ]
.RS 4
Default:
0.50,
0.50. The expected full and incremental compression factor for dumps. It is only used if
\fIAmanda\fR
does not have any history information on compression rates for a filesystem, so should not usually need to be set. However, it may be useful for the first time a very large filesystem that compresses very little is backed up.
.RE
.PP
\fBcompress [client|server]\fR \fI string\fR
.RS 4
Default:
\fIclient fast\fR. If
\fIAmanda\fR
does compression of the backup images, it can do so either on the backup client host before it crosses the network or on the tape server host as it goes from the network into the holding disk or to tape. Which place to do compression (if at all) depends on how well the dump image usually compresses, the speed and load on the client or server, network capacity, holding disk capacity, availability of tape hardware compression, etc.
.sp
For either type of compression,
\fIAmanda\fR
also allows the selection of three styles of compression.
\fBBest\fR
is the best compression available, often at the expense of CPU overhead.
\fBFast\fR
is often not as good a compression as
\fBbest\fR, but usually less CPU overhead. Or to specify
\fBCustom\fR
to use your own compression method. (See dumptype custom\-compress in example/amanda.conf for reference)
.sp
So the
\fBcompress\fR
options line may be one of:
.RS 4
.PP
compress none
.RS 4
.RE
.PP
compress client fast
.RS 4
.RE
.PP
compress client best
.RS 4
.RE
.PP
compress client custom
.RS 4
Specify
\fIclient_custom_compress\fR
"PROG"
.sp
PROG must not contain white space and it must accept \-d for uncompress.
.RE
.PP
compress server fast
.RS 4
.RE
.PP
compress server best
.RS 4
.RE
.PP
compress server custom
.RS 4
Specify
\fIserver_custom_compress\fR
"PROG"
.sp
PROG must not contain white space and it must accept \-d for uncompress.
.RE
.RE
.IP "" 4
Note that some tape devices do compression and this option has nothing to do with whether that is used. If hardware compression is used (usually via a particular tape device name or
\fBmt\fR
option),
\fIAmanda\fR
(software) compression should be disabled.
.RE
.PP
\fBdumpcycle\fR \fI int\fR
.RS 4
Default:
\fI10 days\fR. The number of days in the backup cycle. Each disk using this set of options will get a full backup at least this of ten. Setting this to zero tries to do a full backup each run.
.RE
.PP
\fBencrypt [none|client|server]\fR
.RS 4
Default:
\fInone\fR. To encrypt backup images, it can do so either on the backup client host before it crosses the network or on the tape server host as it goes from the network into the holding disk or to tape.
.sp
So the
\fBencrypt\fR
options line may be one of:
.RS 4
.PP
encrypt none
.RS 4
.RE
.PP
encrypt client
.RS 4
Specify client_encrypt "PROG"
.sp
PROG must not contain white space.
.sp
Specify client_decrypt_option "decryption\-parameter" Default: "\-d"
.sp
decryption\-parameter must not contain white space.
.sp
(See dumptype server\-encrypt\-fast in example/amanda.conf for reference)
.RE
.PP
encrypt server
.RS 4
Specify server_encrypt "PROG"
.sp
PROG must not contain white space.
.sp
Specify server_decrypt_option "decryption\-parameter" Default: "\-d"
.sp
decryption\-parameter must not contain white space.
.sp
(See dumptype client\-encrypt\-nocomp in example/amanda.conf for reference)
.RE
.RE
.IP "" 4
Note that current logic assumes compression then encryption during backup(thus decrypt then uncompress during restore). So specifying client\-encryption AND server\-compression is not supported.
\fIamcrypt\fR
which is a wrapper of
\fIaespipe\fR
is provided as a reference symmetric encryption program.
.RE
.PP
\fBestimate\fR \fIclient|calcsize|server\fR
.RS 4
Default:
\fIclient\fR. Determine the way
\fIAmanda\fR
does it's estimate.
.RS 4
.PP
client
.RS 4
Use the same program as the dumping program, this is the most accurate way to do estimates, but it can take a long time.
.RE
.PP
calcsize
.RS 4
Use a faster program to do estimates, but the result is less accurate.
.RE
.PP
server
.RS 4
Use only statistics from the previous run to give an estimate, it takes only a few seconds but the result is not accurate if your disk usage changes from day to day.
.RE
.RE
.RE
.PP
\fBexclude\fR [ list|file ][[optional][ append ][ \fIstring\fR ]+]
.RS 4
Default:
\fIfile\fR. There are two exclude lists,
\fBexclude file\fR
and
\fBexclude list.\fR
With
\fBexclude file\fR
, the
\fIstring\fR
is a
\fBGNU\-tar\fR
exclude expression. With
\fBexclude list\fR
, the
\fIstring\fR
is a file name on the client containing
\fBGNU\-tar\fR
exclude expressions. The path to the specified exclude list file, if present (see description of 'optional' below), must be readable by the
\fIAmanda\fR
user.
.sp
All exclude expressions are concatenated in one file and passed to
\fBGNU\-tar\fR
as an
\fB\-\-exclude\-from\fR
argument.
.sp
Exclude expressions must always be specified as relative to the head directory of the DLE.
.sp
With the
\fBappend\fR
keyword, the
\fIstring\fR
is appended to the current list, without it, the
\fIstring\fR
overwrites the list.
.sp
If
\fBoptional\fR
is specified for
\fBexclude list\fR, then amcheck will not complain if the file doesn't exist or is not readable.
.sp
For
\fBexclude list\fR, if the file name is relative, the disk name being backed up is prepended. So if this is entered:
.sp
.RS 4
.nf
    exclude list ".amanda.excludes"
.fi
.RE
the actual file used would be
\fI/var/.amanda.excludes\fR
for a backup of
\fI/var\fR,
\fI/usr/local/.amanda.excludes\fR
for a backup of
\fI/usr/local\fR, and so on.
.RE
.PP
\fBholdingdisk\fR [ never|auto|required ]
.RS 4
Default:
\fIauto\fR. Whether a holding disk should be used for these backups or whether they should go directly to tape. If the holding disk is a portion of another file system that
\fIAmanda\fR
is backing up, that file system should refer to a dumptype with
\fBholdingdisk\fR
set to
\fInever\fR
to avoid backing up the holding disk into itself.
.RS 4
.PP
\fBnever\fR|no|false|off
.RS 4
Never use a holdingdisk, the dump will always go directly to tape. There will be no dump if you have a tape error.
.RE
.PP
\fBauto\fR|yes|true|on
.RS 4
Use the holding disk, unless there is a problem with the holding disk, the dump won't fit there or the medium doesn't require spooling (e.g., VFS device)
.RE
.PP
\fBrequired\fR
.RS 4
Always dump to holdingdisk, never directly to tape. There will be no dump if it doesn't fit on holdingdisk
.RE
.RE
.RE
.PP
\fBignore\fR \fI boolean\fR
.RS 4
Default:
\fIno\fR. Whether disks associated with this backup type should be backed up or not. This option is useful when the
\fIdisklist\fR
file is shared among several configurations, some of which should not back up all the listed file systems.
.RE
.PP
\fBinclude\fR [ list|file ][[optional][ append ][ \fIstring\fR ]+]
.RS 4
Default:
\fIfile\fR
".". There are two include lists,
\fBinclude file\fR
and
\fBinclude list.\fR
With
\fBinclude file\fR
, the
\fIstring\fR
is a glob expression. With
\fBinclude list\fR
, the
\fIstring\fR
is a file name on the client containing glob expressions.
.sp
All include expressions are expanded by
\fIAmanda\fR, concatenated in one file and passed to
\fBGNU\-tar\fR
as a
\fB\-\-files\-from\fR
argument. They must start with "./" and contain no other "/".
.sp
Include expressions must always be specified as relative to the head directory of the DLE.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
\fBNote\fR
For globbing to work at all, even the limited single level, the top level directory of the DLE must be readable by the
\fIAmanda\fR
user.

With the
\fBappend\fR
keyword, the
\fIstring\fR
is appended to the current list, without it, the
\fIstring\fR
overwrites the list.
.sp
If
\fBoptional\fR
is specified for
\fBinclude list,\fR
then amcheck will not complain if the file doesn't exist or is not readable.
.sp
For
\fBinclude list\fR, If the file name is relative, the disk name being backed up is prepended.
.RE
.PP
\fBindex\fR \fI boolean\fR
.RS 4
Default:
\fIno\fR. Whether an index (catalogue) of the backup should be generated and saved in
\fBindexdir\fR. These catalogues are used by the
\fBamrecover\fR
utility.
.RE
.PP
\fBkencrypt\fR \fI boolean\fR
.RS 4
Default:
\fIno\fR. Whether the backup image should be encrypted by Kerberos as it is sent across the network from the backup client host to the tape server host.
.RE
.PP
\fBmaxdumps\fR \fI int\fR
.RS 4
Default:
1. The maximum number of backups from a single host that
\fIAmanda\fR
will attempt to run in parallel. See also the main section parameter
\fBinparallel\fR.
.RE
.PP
\fBmaxpromoteday\fR \fI int\fR
.RS 4
Default:
10000. The maximum number of day for a promotion, set it 0 if you don't want promotion, set it to 1 or 2 if your disks get overpromoted.
.RE
.PP
\fBpriority\fR \fI string\fR
.RS 4
Default:
\fImedium\fR. When there is no tape to write to,
\fIAmanda\fR
will do incremental backups in priority order to the holding disk. The priority may be high (2), medium (1), low (0) or a number of your choice.
.RE
.PP
\fBprogram\fR \fI string\fR
.RS 4
Default:
\fIDUMP\fR. The type of backup to perform. Valid values are
\fBDUMP\fR
for the native operating system backup program, and
\fBGNUTAR\fR
to use
\fBGNU\-tar\fR
or to do PC backups using Samba.
.RE
.PP
\fBrecord\fR \fI boolean\fR
.RS 4
Default:
\fIyes\fR. Whether to ask the backup program to update its database (e.g.
\fI/etc/dumpdates\fR
for DUMP or
\fI/usr/local/var/amanda/gnutar\-lists\fR
for GNUTAR) of time stamps. This is normally enabled for daily backups and turned off for periodic archival runs.
.RE
.PP
\fBskip\-full\fR \fI boolean\fR
.RS 4
Default:
\fIno\fR. If
\fItrue\fR
and
\fBplanner\fR
has scheduled a full backup, these disks will be skipped, and full backups should be run off\-line on these days. It was reported that
\fIAmanda\fR
only schedules level 1 incrementals in this configuration; this is probably a bug.
.RE
.PP
\fBskip\-incr\fR \fI boolean\fR
.RS 4
Default:
\fIno\fR. If
\fItrue\fR
and
\fBplanner\fR
has scheduled an incremental backup, these disks will be skipped.
.RE
.PP
\fBstarttime\fR \fI int\fR
.RS 4
Default:
\fInone\fR. Backups will not start until after this time of day. The value should be hh*100+mm, e.g. 6:30PM (18:30) would be entered as
1830.
.RE
.PP
\fBstrategy\fR \fI string\fR
.RS 4
Default:
\fIstandard\fR. Strategy to use when planning what level of backup to run next. Values are:
.RS 4
.PP
\fBstandard\fR
.RS 4
The standard
\fIAmanda\fR
schedule.
.RE
.PP
\fBnofull\fR
.RS 4
Never do full backups, only level 1 incrementals.
.RE
.PP
\fBnoinc\fR
.RS 4
Never do incremental backups, only full dumps.
.RE
.PP
\fBskip\fR
.RS 4
Never do backups (useful when sharing the
\fIdisklist\fR
file).
.RE
.PP
\fBincronly\fR
.RS 4
Only do incremental dumps.
\fBamadmin force\fR
should be used to tell
\fIAmanda\fR
that a full dump has been performed off\-line, so that it resets to level 1. It is similar to skip\-full, but with incronly full dumps may be scheduled manually. Unfortunately, it appears that
\fIAmanda\fR
will perform full backups with this configuration, which is probably a bug.
.RE
.RE
.RE
.PP
\fBtape_splitsize\fR \fI int\fR
.RS 4
Default:
\fInone\fR. Split dump file on tape into pieces of a specified size. This allows dumps to be spread across multiple tapes, and can potentially make more efficient use of tape space. Note that if this value is too large (more than half the size of the average dump being split), substantial tape space can be wasted. If too small, large dumps will be split into innumerable tiny dumpfiles, adding to restoration complexity. A good rule of thumb, usually, is 1/10 of the size of your tape.
.RE
.PP
\fBsplit_diskbuffer\fR \fI string\fR
.RS 4
Default:
\fInone\fR. When dumping a split dump in PORT\-WRITE mode (usually meaning "no holding disk"), buffer the split chunks to a file in the directory specified by this option.
.RE
.PP
\fBfallback_splitsize\fR \fI int\fR
.RS 4
Default:
\fI10M\fR. When dumping a split dump in PORT\-WRITE mode, if no split_diskbuffer is specified (or if we somehow fail to use our split_diskbuffer), we must buffer split chunks in memory. This specifies the maximum size split chunks can be in this scenario, and thus the maximum amount of memory consumed for in\-memory splitting. The size of this buffer can be changed from its (very conservative) default to a value reflecting the amount of memory that each taper process on the dump server may reasonably consume.
.RE
.PP
The following
\fBdumptype\fR
entries are predefined by
\fIAmanda\fR:
.sp
.RS 4
.nf
define dumptype no\-compress {
    compress none
}
define dumptype compress\-fast {
    compress client fast
}
define dumptype compress\-best {
    compress client best
}
define dumptype srvcompress {
    compress server fast
}
define dumptype bsd\-auth {
    auth bsd
}
define dumptype krb4\-auth {
    auth krb4
}
define dumptype no\-record {
    record no
}
define dumptype no\-hold {
    holdingdisk no
}
define dumptype no\-full {
    skip\-full yes
} 
.fi
.RE
.PP
In addition to options in a
\fBdumptype\fR
section, one or more other
\fBdumptype\fR
names may be entered, which make this
\fBdumptype\fR
inherit options from other previously defined
\fBdumptype\fRs. For instance, two sections might be the same except for the
\fBrecord\fR
option:
.sp
.RS 4
.nf
define dumptype normal {
    comment "Normal backup, no compression, do indexing"
    no\-compress
    index yes
    maxdumps 2
}
define dumptype testing {
    comment "Test backup, no compression, do indexing, no recording"
    normal
    record no
}
.fi
.RE
.PP
\fIAmanda\fR
provides a
\fBdumptype\fR
named
\fIglobal\fR
in the sample
\fBamanda.conf\fR
file that all
\fBdumptype\fRs should reference. This provides an easy place to make changes that will affect every
\fBdumptype\fR.
.SH "TAPETYPE SECTION"
.PP
The
\fBamanda.conf\fR
file may define multiple types of tape media and devices. The information is entered in a
\fBtapetype\fR
section, which looks like this in the config file:
.sp
.RS 4
.nf
define tapetype \fIname\fR {
    \fItapetype\-option\fR \fItapetype\-value\fR
    ...
}
.fi
.RE
.PP
\fIName\fR
is the name of this type of tape medium/device. It is referenced from the
\fBtapetype\fR
option in the main part of the config file.
.PP
The tapetype options and values are:
.PP
\fBcomment\fR \fI string\fR
.RS 4
Default:
\fInone\fR. A comment string describing this set of tape information.
.RE
.PP
\fBfilemark\fR \fI int\fR
.RS 4
Default:
\fI1 kbytes\fR. How large a file mark (tape mark) is, measured in kbytes. If the size is only known in some linear measurement (e.g. inches), convert it to kbytes using the device density.
.RE
.PP
\fBlength\fR \fI int\fR
.RS 4
Default:
\fI2000 kbytes\fR. How much data will fit on a tape.
.sp
Note that this value is only used by
\fIAmanda\fR
to schedule which backups will be run. Once the backups start,
\fIAmanda\fR
will continue to write to a tape until it gets an error, regardless of what value is entered for
\fBlength\fR
(but see the section OUTPUT DRIVERS in the
\fBamanda\fR(8)
manpage for exceptions).
.RE
.PP
\fBblocksize\fR \fI int\fR
.RS 4
Default:
\fI32 kbytes\fR. How much data will be written in each tape record expressed in KiloBytes. The tape record size (= blocksize) can not be reduced below the default 32 KBytes. The parameter blocksize can only be raised if
\fIAmanda\fR
was compiled with the configure option \-\-with\-maxtapeblocksize=N set with "N" greater than 32 during
\fBconfigure\fR.
.RE
.PP
\fBreadblocksize\fR \fI int\fR
.RS 4
Default: (\fIfrom configure \-\-with\-maxtapeblocksize\fR). How much data will be read in each tape record expressed in KiloBytes. Some hardware require a value not too large, and some require it to be equal to the blocksize. It is useful if you configured amanda with a big \-\-with\-maxtapeblocksize and your hardware don't work with a value that big.
.RE
.PP
\fBfile\-pad\fR \fI boolean\fR
.RS 4
Default:
\fItrue\fR. If true, every record, including the last one in the file, will have the same length. This matches the way
\fIAmanda\fR
wrote tapes prior to the availability of this parameter. It may also be useful on devices that only support a fixed blocksize.
.sp
Note that the last record on the tape probably includes trailing null byte padding, which will be passed back to
\fBgzip\fR,
\fBcompress\fR
or the restore program. Most programs just ignore this (although possibly with a warning).
.sp
If this parameter is false, the last record in a file may be shorter than the block size. The file will contain the same amount of data the dump program generated, without trailing null byte padding. When read, the same amount of data that was written will be returned.
.RE
.PP
\fBspeed\fR \fI int\fR
.RS 4
Default:
\fI200 bps\fR. How fast the drive will accept data, in bytes per second. This parameter is NOT currently used by
\fIAmanda\fR.
.RE
.PP
\fBlbl\-templ\fR \fI string\fR
.RS 4
A PostScript template file used by
\fBamreport\fR
to generate labels. Several sample files are provided with the
\fIAmanda\fR
sources in the
\fIexample\fR
directory. See the
\fBamreport\fR(8)
man page for more information.
.RE
.PP
In addition to options, another
\fBtapetype\fR
name may be entered, which makes this
\fBtapetype\fR
inherit options from another
\fBtapetype\fR. For instance, the only difference between a DLT4000 tape drive using Compact\-III tapes and one using Compact\-IV tapes is the length of the tape. So they could be entered as:
.sp
.RS 4
.nf
define tapetype DLT4000\-III {
    comment "DLT4000 tape drives with Compact\-III tapes"
    length 12500 mbytes         # 10 Gig tapes with some compression
    filemark 2000 kbytes
    speed 1536 kps
}
define tapetype DLT4000\-IV {
    DLT4000\-III
    comment "DLT4000 tape drives with Compact\-IV tapes"
    length 25000 mbytes         # 20 Gig tapes with some compression
}
.fi
.RE
.sp
.SH "INTERFACE SECTION"
.PP
The
\fBamanda.conf\fR
file may define multiple types of network interfaces. The information is entered in an
\fBinterface\fR
section, which looks like this:
.sp
.RS 4
.nf
define interface \fIname\fR {
    \fIinterface\-option\fR \fIinterface\-value\fR
    ...
}
.fi
.RE
.PP
\fIname\fR
is the name of this type of network interface. It is referenced from the
\fIdisklist\fR
file.
.PP
Note that these sections define network interface characteristics, not the actual interface that will be used. Nor do they impose limits on the bandwidth that will actually be taken up by
\fIAmanda\fR.
\fIAmanda\fR
computes the estimated bandwidth each file system backup will take based on the estimated size and time, then compares that plus any other running backups with the limit as another of the criteria when deciding whether to start the backup. Once a backup starts,
\fIAmanda\fR
will use as much of the network as it can leaving throttling up to the operating system and network hardware.
.PP
The interface options and values are:
.PP
\fBcomment\fR \fI string\fR
.RS 4
Default:
\fInone\fR. A comment string describing this set of network information.
.RE
.PP
\fBuse\fR \fI int\fR
.RS 4
Default:
\fI300 Kbps\fR. The speed of the interface in Kbytes per second.
.RE
.PP
In addition to options, another
\fBinterface\fR
name may be entered, which makes this
\fBinterface\fR
inherit options from another
\fBinterface\fR. At the moment, this is of little use.
.SH "AUTHOR"
.PP
James da Silva,
<jds@amanda.org>: Original text
.PP
Stefan G. Weichinger,
<sgw@amanda.org>, maintainer of the
\fIAmanda\fR\-documentation: XML\-conversion, major update, splitting
.SH "SEE ALSO"
.PP

\fBamanda\fR(8),
\fBamanda\-client.conf\fR(5),
\fBamcrypt\fR(8),
\fBaespipe\fR(1),