1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
10 .de Sp \" Vertical space (when we can't use .PP)
16 .ie \\n(.$>=3 .ne \\$3
20 .TH "AMANDA.CONF" 5 "" "" ""
22 amanda.conf \- Main configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver
26 \fIamanda\&.conf\fR is the main configuration file for \fBAmanda\fR\&. This manpage lists the relevant sections and parameters of this file for quick reference\&.
31 There are a number of configuration parameters that control the behavior of the \fBAmanda\fR programs\&. All have default values, so you need not specify the parameter in \fBamanda\&.conf\fR if the default is suitable\&.
34 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\&.
37 Keywords are case insensitive, i\&.e\&. \fBmailto\fR and \fBMailTo\fR are treated the same\&.
40 Integer arguments may have one of the following (case insensitive) suffixes, some of which have a multiplier effect:
42 .SS "POSSIBLE SUFFIXES"
46 Some number of bytes\&.
50 Some number of bytes per second\&.
53 \fBk kb kbyte kbytes kilobyte kilobytes\fR
54 Some number of kilobytes (bytes*1024)\&.
58 Some number of kilobytes per second (bytes*1024)\&.
61 \fBm mb meg mbyte mbytes megabyte megabytes\fR
62 Some number of megabytes (bytes*1024*1024)\&.
66 Some number of megabytes per second (bytes*1024*1024)\&.
69 \fBg gb gbyte gbytes gigabyte gigabytes\fR
70 Some number of gigabytes (bytes*1024*1024*1024)\&.
74 Some number of tapes\&.
78 Some number of days\&.
82 Some number of weeks (days*7)\&.
88 may be used in most places where an integer is expected
89 to mean an infinite amount\&.
91 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\&.
98 \fBorg\fR \fB string\fR
99 Default: \fBdaily\fR\&. A descriptive name for the configuration\&. This string appears in the Subject line of mail reports\&. Each \fBAmanda\fR configuration should have a different string to keep mail reports distinct\&.
102 \fBmailto\fR \fB string\fR
103 Default: \fBoperators\fR\&. A space separated list of recipients for mail reports\&.
106 \fBdumpcycle\fR \fB int\fR
107 Default: \fB10 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\&.
111 This parameter may also be set in a specific
114 This value sets the default for all
124 \fBrunspercycle\fR \fB int\fR
125 Default: \fBsame 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 \fBtapelist\fR file, which is the number of tapes used in the last \fBdumpcycle\fR days / \fBruntapes\fR\&.
128 \fBtapecycle\fR \fB int\fR
129 Default: \fB15 tapes\fR\&. Typically tapes are used by \fBAmanda\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)\&.
131 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 \fBAmanda\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\&.
133 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\&.
136 \fBlabel_new_tapes\fR \fB string\fR
137 Default: not set\&. When set, this directive will cause \fBAmanda\fR to automatically write an \fBAmanda\fR tape label to any blank tape she encounters\&. This option is DANGEROUS because when set, \fBAmanda\fR will ERASE any non\-\fBAmanda\fR tapes you may have, and may also ERASE any near\-failing tapes\&. Use with caution\&.
139 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: label_new_tapes "DailySet1\-%%%"
144 \fBlabel_new_tapes\fR \fB string\fR
145 Default: not set\&. When set, this directive will cause \fBAmanda\fR to automatically write an Amanda tape label to any black tape she encounters\&. This option is DANGEROUS because when set, \fBAmanda\fR will ERASE any non\-\fBAmanda\fR tapes you may have, and may also ERASE any near\-failing tapes\&. Use with caution\&.
147 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: label_new_tapes "DailySet1\-%%%"
150 \fBdumpuser\fR \fB string\fR
151 Default: \fBamanda\fR\&. The login name \fBAmanda\fR uses to run the backups\&. The backup client hosts must allow access from the tape server host as this user via \&.rhosts or \&.amandahosts, depending on how the \fBAmanda\fR software was built\&.
155 Printer to use when doing tape labels\&. See the \fBlbl\-templ\fR \fBtapetype\fR option\&.
159 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\&.
161 If a tape changer is configured (see the \fBtpchanger\fR option), this option might not be used\&.
163 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 \fBno\fR\&.
166 \fBrawtapedev\fR string
167 Default: \fInull:\fR\&. The path name of the raw tape device\&. This is only used if \fBAmanda\fR is compiled for Linux machines with floppy tapes and is needed for QIC volume table operations\&.
170 \fBtpchanger\fR string
171 Default: \fBnone\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\&.
173 If a tape changer is configured, choose one of the changer scripts (e\&.g\&. \fBchg\-scsi\fR) and enter that here\&.
176 \fBchangerdev\fR string
177 Default: \fI/dev/null\fR\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the \fBtpchanger\fR option\&.
180 \fBchangerfile\fR string
181 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\&.
185 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\&.
187 If a tape changer is configured, this may be set larger than one to let \fBAmanda\fR write to more than one tape\&.
189 Note that this is an upper bound on the number of tapes, and \fBAmanda\fR may use less\&.
191 Also note that as of this release, \fBAmanda\fR does not support true tape overflow\&. When it reaches the end of one tape, the backup image \fBAmanda\fR was processing starts over again on the next tape\&.
194 \fBmaxdumpsize\fR int
195 Default: \fBruntapes\fR*\fBtape_length\fR\&. Maximum number of bytes the planner will schedule for a run\&.
198 \fBtaperalgo\fR [first|firstfit|largest|largestfit|smallest|last]
199 Default: \fBfirst\fR\&. The algorithm used to choose which dump image to send to the taper\&.
205 First in, first out\&.
209 The first dump image that will fit on the current tape\&.
213 The largest dump image\&.
217 The largest dump image that will fit on the current tape\&.
221 The smallest dump image\&.
225 Last in, first out\&.
231 \fBlabelstr\fR \fB string\fR
232 Default: \fB\&.*\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\&.
235 \fBtapetype\fR \fB string\fR
236 Default: \fBEXABYTE\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\&.
238 First character of a \fBtapetype\fR string must be an alphabetic character
242 Default: \fB30 seconds\fR\&. Maximum amount of time that \fBamcheck\fR will wait for each client host\&.
246 Default: \fB1800 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\&.
250 Default: \fB300 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\&.
254 Default: \fB300 Kbps\fR\&. The maximum network bandwidth allocated to \fBAmanda\fR, in Kbytes per second\&. See also the \fBinterface\fR section\&.
258 Default: 10\&. The maximum number of backups that \fBAmanda\fR will attempt to run in parallel\&. \fBAmanda\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\&.
261 \fBdisplayunit\fR "k|m|g|t"
262 Default: "k"\&. The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera\&.
265 \fBdumporder\fR string
266 Default: \fBtttTTTTTTT\fR\&. The priority order of each dumper:
283 b: smallest bandwidth
293 Default: 1\&. The maximum number of backups from a single host that \fBAmanda\fR will attempt to run in parallel\&. See also the \fBinparallel\fR option\&.
295 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\&.
299 Default: \fB10 Mbytes\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\&. If \fBAmanda\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 \fBbumppercent\fR is set to 0\&.
301 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
303 See also the options \fBbumppercent\fR, \fBbumpmult\fR and \fBbumpdays\fR\&.
306 \fBbumppercent\fR int
307 Default: \fB0 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 \fBAmanda\fR determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&.
309 If this parameter is set to 0, the value of the parameter \fBbumpsize\fR is used to trigger bumping\&.
311 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
313 See also the options \fBbumpsize\fR, \fBbumpmult\fR and \fBbumpdays\fR\&.
316 \fBbumpmult\fR \fB float\fR
317 Default: 1\&.5\&. The bump size multiplier\&. \fBAmanda\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\&.
319 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
322 \fBbumpdays\fR \fB int\fR
323 Default: \fB2 days\fR\&. To insure redundancy in the dumps, \fBAmanda\fR keeps filesystems at the same incremental level for at least \fBbumpdays\fR days, even if the other bump threshold criteria are met\&.
325 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
328 \fBdiskfile\fR \fB string\fR
329 Default: \fBdisklist\fR\&. The file name for the \fBdisklist\fR file holding client hosts, disks and other client dumping information\&.
332 \fBinfofile\fR \fB string\fR
333 Default: \fI/usr/adm/amanda/curinfo\fR\&. The file or directory name for the historical information database\&. If \fBAmanda\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\&.
336 \fBlogdir\fR \fB string\fR
337 Default: \fI/usr/adm/amanda\fR\&. The directory for the \fBamdump\fR and \fBlog\fR files\&.
340 \fBindexdir\fR \fB string\fR
341 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\&.
344 \fBtapelist\fR \fB string\fR
345 Default: \fBtapelist\fR\&. The file name for the active \fBtapelist\fR file\&. \fBAmanda\fR maintains this file with information about the active set of tapes\&.
348 \fBtapebufs\fR \fB int\fR
349 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\&.
352 \fBreserve\fR \fB number\fR
353 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\&.
356 \fBautoflush\fR \fB bool\fR
357 Default: \fBoff\fR\&. Whether an amdump run will flush the dumps from holding disk to tape\&.
360 \fBamrecover_do_fsf\fR \fB bool\fR
361 Default: \fBoff\fR\&. Amrecover will call amrestore with the \-f flag for faster positioning of the tape\&.
364 \fBamrecover_check_label\fR \fB bool\fR
365 Default: \fBoff\fR\&. Amrecover will call amrestore with the \-l flag to check the label\&.
368 \fBamrecover_changer\fR \fB string\fR
369 Default: ''\&. Amrecover will use the changer if you use 'settape <string>' and that string is the same as the amrecover_changer setting\&.
372 \fBcolumnspec\fR \fB string\fR
373 Defines the width of columns \fBamreport\fR should use\&. \fBString\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:
379 the name of the column, which may be:
384 Compress (compression ratio)
387 Disk (client disk name)
390 DumpRate (dump rate in KBytes/sec)
393 DumpTime (total dump time in hours:minutes)
396 HostName (client host name)
402 OrigKB (original image size in KBytes)
405 OutKB (output image size in KBytes)
408 TapeRate (tape writing rate in KBytes/sec)
411 TapeTime (total tape time in hours:minutes)
417 the amount of space to display before the column (used to get whitespace between columns)\&.
420 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\&.
427 columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"
431 The above will display the disk information in 18 characters
432 and put one space before it\&. The hostname column will be 10 characters wide with
433 no space to the left\&. The output KBytes column is seven characters wide
434 with one space before it\&.
437 \fBincludefile\fR \fB string\fR
438 Default: \fBnone\fR\&. The name of an \fBAmanda\fR configuration file to include within the current file\&. Useful for sharing dumptypes, tapetypes and interface definitions among several configurations\&.
440 .SH "HOLDINGDISK SECTION"
443 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:
446 holdingdisk \fBname\fR {
447 \fBholdingdisk\-option\fR \fBholdingdisk\-value\fR
452 \fBName\fR is a logical name for this holding disk\&.
455 The options and values are:
458 \fBcomment\fR \fB string\fR
459 Default: \fBnone\fR\&. A comment string describing this holding disk\&.
462 \fBdirectory\fR \fB disk\fR
463 Default: \fI/dumps/amanda\fR\&. The path to this holding area\&.
470 Amount of space that can be used in this holding disk area\&.
471 If the value is zero, all available space on the file system is used\&.
472 If the value is negative, \fBAmanda\fR will use all available space minus that value\&.
475 \fBchunksize\fR \fB int\fR
479 Holding disk chunk size\&. Dumps larger than the specified size will be stored in multiple
480 holding disk files\&. The size of each chunk will not exceed the specified value\&.
481 However, even though dump images are split in the holding disk, they are concatenated as
482 they are written to tape, so each dump image still corresponds to a single continuous
485 If 0 is specified, \fBAmanda\fR will create holding disk chunks as large as
486 ((INT_MAX/1024)\-64) Kbytes\&.
488 Each holding disk chunk includes a 32 Kbyte header, so the minimum
489 chunk size is 64 Kbytes (but that would be really silly)\&.
491 Operating systems that are limited to a maximum file size of 2 Gbytes
492 actually cannot handle files that large\&.
493 They must be at least one byte less than 2 Gbytes\&.
494 Since \fBAmanda\fR works with 32 Kbyte blocks, and
495 to handle the final read at the end of the chunk, the chunk size
496 should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum
497 file size, e\&.g\&. 2047 Mbytes\&.
499 .SH "DUMPTYPE SECTION"
502 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\&.
505 A set of backup options are entered in a \fBdumptype\fR section, which looks like this:
508 define dumptype \fBname\fR {
509 \fBdumptype\-option\fR \fBdumptype\-value\fR
515 \fBName\fR is the name of this set of backup options\&. It is referenced from the \fIdisklist\fR file\&.
518 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\&.
521 The dumptype options and values are:
524 \fBauth\fR \fB string\fR
525 Default: \fBbsd\fR\&. Type of authorization to perform between tape server and backup client hosts\&.
527 \fBkrb4\fR to use Kerberos\-IV authorization\&.
529 \fBkrb5\fR to use Kerberos\-V authorization\&.
531 \fBssh\fR to use OpenSSH authorization\&.
535 Default: \fB10 Mbytes\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\&. If \fBAmanda\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 \fBbumppercent\fR is set to 0\&.
537 See also the options \fBbumppercent\fR, \fBbumpmult\fR and \fBbumpdays\fR\&.
540 \fBbumppercent\fR int
541 Default: \fB0 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 \fBAmanda\fR determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&.
543 If this parameter is set to 0, the value of the parameter \fBbumpsize\fR is used to trigger bumping\&.
545 See also the options \fBbumpsize\fR, \fBbumpmult\fR and \fBbumpdays\fR\&.
548 \fBbumpmult\fR \fB float\fR
549 Default: 1\&.5\&. The bump size multiplier\&. \fBAmanda\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\&.
552 \fBbumpdays\fR \fB int\fR
553 Default: \fB2 days\fR\&. To insure redundancy in the dumps, \fBAmanda\fR keeps filesystems at the same incremental level for at least \fBbumpdays\fR days, even if the other bump threshold criteria are met\&.
556 \fBcomment\fR \fB string\fR
557 Default: \fBnone\fR\&. A comment string describing this set of backup options\&.
560 \fBcomprate\fR \fBfloat\fR [, \fBfloat\fR ]
561 Default: 0\&.50, 0\&.50\&. The expected full and incremental compression factor for dumps\&. It is only used if \fBAmanda\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\&.
564 \fBcompress [client|server]\fR \fB string\fR
565 Default: \fBclient fast\fR\&. If \fBAmanda\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\&.
567 For either type of compression, \fBAmanda\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)
569 So the \fBcompress\fR options line may be one of:
578 compress [client] fast
581 compress [client] best
584 compress client custom
586 Specify client_custom_compress "PROG"
588 PROG must not contain white space and it must accept \-d for uncompress\&.
597 compress server custom
599 Specify server_custom_compress "PROG"
601 PROG must not contain white space and it must accept \-d for uncompress\&.
605 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), \fBAmanda\fR (software) compression should be disabled\&.
608 \fBdumpcycle\fR \fB int\fR
609 Default: \fB10 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\&.
612 \fBencrypt [none|client|server]\fR
613 Default: \fBnone\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\&.
615 So the \fBencrypt\fR options line may be one of:
625 Specify client_encrypt "PROG"
627 PROG must not contain white space\&.
629 Specify client_decrypt_option "decryption\-parameter" Default: "\-d"
631 decryption\-parameter must not contain white space\&.
633 (See dumptype encrypt\-fast in example/amanda\&.conf for reference)
638 Specify server_encrypt "PROG"
640 PROG must not contain white space\&.
642 Specify server_decrypt_option "decryption\-parameter" Default: "\-d"
644 decryption\-parameter must not contain white space\&.
650 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\&. \fBamcrypt\fR which is a wrapper of \fBaespipe\fR is provided as a reference encryption program\&.
653 \fBestimate\fR \fBclient|calcsize|server\fR
654 Default: \fBclient\fR\&. Determine the way \fBAmanda\fR does it's estimate\&.
661 Use the same program as the dumping program, this is the most accurate way to do estimates, but it can take a long time\&.
666 Use a faster program to do estimates, but the result is less accurate\&.
671 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\&.
677 \fBexclude\fR [ \fBlist|file\fR ][[optional][ \fBappend\fR ][ \fB string\fR ]+]
678 Default: \fBfile\fR\&. There are two exclude lists, \fBexclude file\fR and \fBexclude list\&.\fR With \fBexclude file\fR , the \fBstring\fR is a \fBGNU\-tar\fR exclude expression\&. With \fBexclude list\fR , the \fBstring\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 \fBAmanda\fR user\&.
680 All exclude expressions are concatenated in one file and passed to \fBGNU\-tar\fR as an \fB\-\-exclude\-from\fR argument\&.
682 Exclude expressions must always be specified as relative to the head directory of the DLE\&.
684 With the \fBappend\fR keyword, the \fBstring\fR is appended to the current list, without it, the \fBstring\fR overwrites the list\&.
686 If \fBoptional\fR is specified for \fBexclude list\fR, then amcheck will not complain if the file doesn't exist or is not readable\&.
688 For \fBexclude list\fR, if the file name is relative, the disk name being backed up is prepended\&. So if this is entered:
692 exclude list "\&.amanda\&.excludes"
694 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\&.
697 \fBholdingdisk\fR \fB boolean\fR
698 Default: \fByes\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 \fBAmanda\fR is backing up, that file system should refer to a dumptype with \fBholdingdisk\fR set to \fBno\fR to avoid backing up the holding disk into itself\&.
701 \fBignore\fR \fB boolean\fR
702 Default: \fBno\fR\&. Whether disks associated with this backup type should be backed up or not\&. This option is useful when the \fBdisklist\fR file is shared among several configurations, some of which should not back up all the listed file systems\&.
705 \fBinclude\fR [ \fBlist|file\fR ][[optional][ \fBappend\fR ][ \fB string\fR ]+]
706 Default: \fBfile\fR "\&."\&. There are two include lists, \fBinclude file\fR and \fBinclude list\&.\fR With \fBinclude file\fR , the \fBstring\fR is a glob expression\&. With \fBinclude list\fR , the \fBstring\fR is a file name on the client containing glob expressions\&.
708 All include expressions are expanded by \fBAmanda\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 "/"\&.
710 Include expressions must always be specified as relative to the head directory of the DLE\&.
715 For globbing to work at all, even the limited single level,
716 the top level directory of the DLE must be readable by the \fBAmanda\fR user\&.
718 With the \fBappend\fR keyword, the \fBstring\fR is appended to the current list, without it, the \fBstring\fR overwrites the list\&.
720 If \fBoptional\fR is specified for \fBinclude list,\fR then amcheck will not complain if the file doesn't exist or is not readable\&.
722 For \fBinclude list\fR, If the file name is relative, the disk name being backed up is prepended\&.
725 \fBindex\fR \fB boolean\fR
726 Default: \fBno\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\&.
729 \fBkencrypt\fR \fB boolean\fR
730 Default: \fBno\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\&.
733 \fBmaxdumps\fR \fB int\fR
734 Default: 1\&. The maximum number of backups from a single host that \fBAmanda\fR will attempt to run in parallel\&. See also the main section parameter \fBinparallel\fR\&.
737 \fBmaxpromoteday\fR \fB int\fR
738 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\&.
741 \fBpriority\fR \fB string\fR
742 Default: \fBmedium\fR\&. When there is no tape to write to, \fBAmanda\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\&.
745 \fBprogram\fR \fB string\fR
746 Default: \fBDUMP\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\&.
749 \fBrecord\fR \fB boolean\fR
750 Default: \fByes\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\&.
753 \fBskip\-full\fR \fB boolean\fR
754 Default: \fBno\fR\&. If \fBtrue\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 \fBAmanda\fR only schedules level 1 incrementals in this configuration; this is probably a bug\&.
757 \fBskip\-incr\fR \fB boolean\fR
758 Default: \fBno\fR\&. If \fBtrue\fR and \fBplanner\fR has scheduled an incremental backup, these disks will be skipped\&.
761 \fBstarttime\fR \fB int\fR
762 Default: \fBnone\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\&.
765 \fBstrategy\fR \fB string\fR
766 Default: \fBstandard\fR\&. Strategy to use when planning what level of backup to run next\&. Values are:
772 The standard \fBAmanda\fR schedule\&.
776 Never do full backups, only level 1 incrementals\&.
780 Never do incremental backups, only full dumps\&.
784 Never do backups (useful when sharing the \fBdisklist\fR file)\&.
788 Only do incremental dumps\&. \fBamadmin force\fR should be used to tell \fBAmanda\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 \fBAmanda\fR will perform full backups with this configuration, which is probably a bug\&.
794 \fBtape_splitsize\fR \fB int\fR
795 Default: \fBnone\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\&.
798 \fBsplit_diskbuffer\fR \fB string\fR
799 Default: \fBnone\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\&.
802 \fBfallback_splitsize\fR \fB int\fR
803 Default: \fB10M\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\&.
806 The following \fBdumptype\fR entries are predefined by \fBAmanda\fR:
809 define dumptype no\-compress {
812 define dumptype compress\-fast {
815 define dumptype compress\-best {
818 define dumptype srvcompress {
821 define dumptype bsd\-auth {
824 define dumptype krb4\-auth {
827 define dumptype no\-record {
830 define dumptype no\-hold {
833 define dumptype no\-full {
839 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:
842 define dumptype normal {
843 comment "Normal backup, no compression, do indexing"
848 define dumptype testing {
849 comment "Test backup, no compression, do indexing, no recording"
856 \fBAmanda\fR provides a \fBdumptype\fR named \fBglobal\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\&.
858 .SH "TAPETYPE SECTION"
861 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:
864 define tapetype \fBname\fR {
865 \fBtapetype\-option\fR \fBtapetype\-value\fR
871 \fBName\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\&.
874 The tapetype options and values are:
877 \fBcomment\fR \fB string\fR
878 Default: \fBnone\fR\&. A comment string describing this set of tape information\&.
881 \fBfilemark\fR \fB int\fR
882 Default: \fB1000 bytes\fR\&. How large a file mark (tape mark) is, measured in bytes\&. If the size is only known in some linear measurement (e\&.g\&. inches), convert it to bytes using the device density\&.
885 \fBlength\fR \fB int\fR
886 Default: \fB2000 kbytes\fR\&. How much data will fit on a tape\&.
888 Note that this value is only used by \fBAmanda\fR to schedule which backups will be run\&. Once the backups start, \fBAmanda\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)\&.
891 \fBblocksize\fR \fB int\fR
892 Default: \fB32\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 \fBAmanda\fR was compiled with the configure option \-\-with\-maxtapeblocksize=N set with "N" greater than 32 during \fBconfigure\fR\&.
895 \fBfile\-pad\fR \fB boolean\fR
896 Default: \fBtrue\fR\&. If true, every record, including the last one in the file, will have the same length\&. This matches the way \fBAmanda\fR wrote tapes prior to the availability of this parameter\&. It may also be useful on devices that only support a fixed blocksize\&.
898 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)\&.
900 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\&.
903 \fBspeed\fR \fB int\fR
904 Default: \fB200 bps\fR\&. How fast the drive will accept data, in bytes per second\&. This parameter is NOT currently used by \fBAmanda\fR\&.
907 \fBlbl\-templ\fR \fB string\fR
908 A PostScript template file used by \fBamreport\fR to generate labels\&. Several sample files are provided with the \fBAmanda\fR sources in the \fBexample\fR directory\&. See the \fBamreport\fR(8) man page for more information\&.
911 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:
914 define tapetype DLT4000\-III {
915 comment "DLT4000 tape drives with Compact\-III tapes"
916 length 12500 mbytes # 10 Gig tapes with some compression
920 define tapetype DLT4000\-IV {
922 comment "DLT4000 tape drives with Compact\-IV tapes"
923 length 25000 mbytes # 20 Gig tapes with some compression
927 .SH "INTERFACE SECTION"
930 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:
933 define interface \fBname\fR {
934 \fBinterface\-option\fR \fBinterface\-value\fR
940 \fBname\fR is the name of this type of network interface\&. It is referenced from the \fBdisklist\fR file\&.
943 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 \fBAmanda\fR\&. \fBAmanda\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, \fBAmanda\fR will use as much of the network as it can leaving throttling up to the operating system and network hardware\&.
946 The interface options and values are:
949 \fBcomment\fR \fB string\fR
950 Default: \fBnone\fR\&. A comment string describing this set of network information\&.
954 Default: \fB300 Kbps\fR\&. The speed of the interface in Kbytes per second\&.
957 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\&.
962 James da Silva, <jds@amanda\&.org>: Original text
965 Stefan G\&. Weichinger, <sgw@amanda\&.org>, maintainer of the \fBAmanda\fR\-documentation: XML\-conversion, major update, splitting
970 \fBamanda\fR(8), \fBamcrypt\fR(8), \fBaespipe\fR(1),
projects / debian / amanda / blob