3 .\" Author: James da Silva <jds@amanda.org>
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
6 .\" Manual: File formats and conventions
7 .\" Source: Amanda 3.3.3
10 .TH "AMANDA\&.CONF" "5" "01/10/2013" "Amanda 3\&.3\&.3" "File formats and conventions"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 amanda.conf \- Main configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver
35 is the main configuration file for Amanda\&. This manpage lists the relevant sections and parameters of this file for quick reference\&.
38 \fB<CONFIG_DIR>/<config>/amanda\&.conf\fR
42 There are a number of configuration parameters that control the behavior of the Amanda programs\&. All have default values, so you need not specify the parameter in
44 if the default is suitable\&.
47 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\&.
48 .SS "KEYWORDS AND IDENTIFIERS"
50 Keywords are case insensitive, i\&.e\&.
54 are treated the same\&. Also, the characters \*(Aq\fB\-\fR\*(Aq and \*(Aq\fB_\fR\*(Aq are interchangeable in all predefined Amanda keywords:
57 \fBdevice\-property\fR
58 have the same meaning\&. This manpage uses the dashed versions, but the underscored versions will be accepted for backward compatibility
60 Identifiers are names which are defined in the configuration itself, such as dumptypes or interfaces\&. Identifiers are are case\-insensitive, but sensitive to \*(Aq\fB\-\fR\*(Aq vs\&. \*(Aq\fB_\fR\*(Aq\&. Identifiers should be quoted in the configuration file, although For historical reasons, the quotes are optional\&.
62 Strings are always quoted with double quotes ("), and any double quotes or backslashes within the string are escaped with a backslash:
65 tapelist "/path/to/tapelist"
66 property "escaped\-string" "escaping: \e\e (backslash) and \e" (double\-quote)"
73 logdir "logs" # required sensitive sensitive
74 send\-amreport\-on strange # prohibited insensitive insensitive
75 tapetype "EXABYTE" # optional insensitive sensitive
77 define dumptype "dt" { # optional insensitive sensitive
78 "dumptype\-common" # optional insensitive sensitive
79 strategy noinc # prohibited insensitive insensitive
84 Integer arguments may have one of the following (case insensitive) suffixes, some of which have a multiplier effect:
88 Some number of bytes\&.
93 Some number of bytes per second\&.
96 \fBk kb kbyte kbytes kilobyte kilobytes\fR
98 Some number of kilobytes (bytes*1024)\&.
103 Some number of kilobytes per second (bytes*1024)\&.
105 It is the default multiplier for all size options\&.
108 \fBm mb meg mbyte mbytes megabyte megabytes\fR
110 Some number of megabytes (bytes*1024*1024)\&.
115 Some number of megabytes per second (bytes*1024*1024)\&.
118 \fBg gb gbyte gbytes gigabyte gigabytes\fR
120 Some number of gigabytes (bytes*1024*1024*1024)\&.
123 \fBt tb tbyte tbytes terabyte terabytes\fR
125 Some number of terabytes (bytes*1024*1024*1024*1024)\&.
130 Some number of tapes\&.
135 Some number of days\&.
140 Some number of weeks (days*7)\&.
146 .nr an-no-space-flag 1
155 may be used in most places where an integer is expected to mean an infinite amount\&.
157 Boolean arguments may have any of the values
165 to indicate a true state, or
173 to indicate a false state\&. If no argument is given,
179 .SS "PARAMETER ORDER"
181 In general, the order in which parameters occur in the configuration file does not matter, with the exception of subsection inheritance\&. For example, if dumptype "normal\-encrypt" which inherits from dumptype "normal", then "normal" must appear first in the configuration file\&.
184 Quoted strings in Amanda follow a common, C\-like syntax\&. Printable characters and whitespace are kept as\-is, except that the backslash character (\e) is used as an escape character, and a double\-quote ends the string\&. The allowed escape sequences are
187 ESCAPE SEQUENCE BECOMES
192 \er (carriage return)
196 \e001 \- \e377 (character specified in octal)
198 Illegally quoted strings are handled on a "best\-effort" basis, which may lead to unexpected results\&.
203 finserver "/data/finance/XYZ Corp\*(Aqs \e"real\e" finances" finance\-high eth0 \-1
204 property "syspath" "C:\e\eWINDOWS\e\eSYSTEM"
206 .SS "SUBSECTIONS AND INHERITANCE"
208 Amanda configuration files may include various
209 \fIsubsections\fR, each defining a set of configuration directives\&. Each type of subsection is described below\&. Note that all types of subsections can
211 from other subsections of the same type by naming the "parent" section in the "child" subsection\&. For example:
214 define dumptype global {
219 define dumptype nocomp {
220 global # inherit the parameters in dumptype \*(Aqglobal\*(Aq
225 Note that multiple inheritance is also supported by simply naming multiple parent sections in a child\&. Parents are implicitly expanded in place in a child, and the last occurrence of each parameter takes precedence\&. For example,
228 define tapetype par1 {
234 define tapetype par2 {
239 define tapetype child {
245 In this example, \*(Aqchild\*(Aq will have a filemark of 32k, a speed of 400bps, and a length of 200M\&.
246 .SH "GLOBAL PARAMETERS"
248 \fBorg\fR \fIstring\fR
251 \fI"daily"\fR\&. A descriptive name for the configuration\&. This string appears in the Subject line of mail reports\&. Each Amanda configuration should have a different string to keep mail reports distinct\&.
254 \fBmailer\fR \fIstring\fR
256 Default found by configure\&. A mail program that can send mail with \*(Aq\fIMAILER \-s "subject" user < message_file\fR\*(Aq\&.
259 \fBmailto\fR \fIstring\fR
261 Default: none\&. A space separated list of recipients for mail reports\&. If not specified, amdump will not send any mail\&.
264 \fBsend\-amreport\-on\fR [ \fBall\fR | \fBstrange\fR | \fBerror\fR | \fBnever\fR ]
267 \fBall\fR\&. Specify which types of messages will trigger an email from amreport\&. amreport is used by amdump and amflush\&.
271 Send an email on any message\&.
276 Send an email on strange or error message\&. A strange message occurs when the dump succeeded, but returned one or more errors unknown to Amanda\&.
281 Send an email only on error messages\&.
286 Never send an email\&.
290 \fBreport\-use\-media\fR \fIboolean\fR
295 \fBmax\-dle\-by\-volume\fR
298 if it is set\&. If the reporter must print the list of media used in the run\&.
301 \fBreport\-next\-media\fR \fIboolean\fR
306 \fBmax\-dle\-by\-volume\fR
309 if it is set\&. If the reporter must print the list of media expected for the next run\&.
312 \fBmax\-dle\-by\-volume\fR \fIint\fR
315 \fI1000000000\fR\&. The maximum number of dle written to a single volume\&.
318 \fBdumpcycle\fR \fIint\fR
321 \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\&.
327 .nr an-no-space-flag 1
334 This parameter may also be set in a specific
336 (see below)\&. This value sets the default for all
337 \fBdumptype\fRs so must appear in
340 \fBdumptype\fRs are defined\&.
345 \fBrunspercycle\fR \fIint\fR
348 \fIsame as dumpcycle\fR\&. The number of amdump runs in
350 days\&. A value of 0 means the same value as
351 \fBdumpcycle\fR\&. A value of \-1 means guess the number of runs from the
353 file, which is the number of tapes used in the last
359 \fBtapecycle\fR \fIint\fR
362 \fI15 tapes\fR\&. Specifies the number of "active" volumes \- volumes that Amanda will not overwrite\&. While Amanda is always willing to write to a new volume, it refuses to overwrite a volume unless at least \*(Aq\fBtapecycle\fR
363 \-1\*(Aq volumes have been written since\&.
365 It is considered good administrative practice to set the
367 parameter slightly lower than the actual number of tapes in use\&. 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\&.
369 Note: Amanda is commonly misconfigured with
371 equal to the number of tapes per
372 \fBdumpcycle\fR\&. In this misconfiguration, amanda may erase a full dump before a new one is completed\&. Recovery is then impossible\&. The
374 must be at least one tape larger than the number of tapes per dumpcycle\&.
376 The number of tapes per dumpcycle is calculated by multiplying the number of
382 runs per dump cycle) and
384 (the number of tapes used per run)\&. Typically
386 is set to two or four times the tapes per dumpcycle\&.
389 \fBusetimestamps\fR \fIbool\fR
392 \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\*(Aqt read logfiles written when this option was enabled\&.
395 \fBlabel\-new\-tapes\fR \fIstring\fR
400 \fBvolume\-error empty\fR
401 to get equivalent behavior\&.
403 Default: not set\&. When set, this directive will cause Amanda to automatically write an Amanda tape label to any blank tape she encounters\&.
406 \fBautolabel\fR \fIstring\fR [\fBany\fR] [\fBother\-config\fR] [\fBnon\-amanda\fR] [\fBvolume\-error\fR] [\fBempty\fR]
408 Default: not set\&. When set, this directive will cause Amanda to automatically write an Amanda tape label to most volume she encounters\&. This option is DANGEROUS because when set, Amanda may erase near\-failing tapes or tapes accidentally loaded in the wrong slot\&.
410 When using this directive, specify the template for new tape labels\&. The template can contains many variables that are substituted by their values:
414 $o : org configuration
415 $b : barcode of the volume
416 $s : slot number, can specify a minimun number of digit:
417 $3s to get \*(Aq001\*(Aq
421 The template can contain some number of contiguous \*(Aq%\*(Aq characters, which will be replaced with a generated number\&. Be sure to specify enough \*(Aq%\*(Aq characters that you do not run out of tape labels\&. Example:
422 \fB"DailySet1\-%%%"\fR,
427 The generared label can be used only if it match the
429 setting\&. The volume will not be used if the generated label doesn\*(Aqt match the
433 Note that many devices cannot distinguish an empty tape from an error condition, so it may is often necessary to include
435 as an autolabel condition\&.
439 equivalent to \*(Aq\fBother\-config non\-amanda volume\-error empty\fR\*(Aq
444 Label volumes with a valid Amanda label that do not match our
445 \fBlabelstr\fR\&. Danger: this may erase volumes
446 from other Amanda configurations without warning!
451 Label volumes which do not start with data that resembles an
452 Amanda header\&. Danger: this may erase volumes from other backup applications
458 Label volumes where an error occurs while trying to read the label\&.
459 Danger: this may erase arbitrary volumes due to transient errors\&.
464 Label volumes where a read returns 0 bytes\&.
468 \fBmeta\-autolabel\fR \fIstring\fR
470 Default: not set\&. When set and if the changer support meta\-label, this directive will cause Amanda to automatically add a meta\-label to a meta\-volume\&.
472 A meta\-volume is a containers that contains many volumes, eg\&. a removable hard\-disk for use with chg\-disk, each hard disk have many slots (volume)\&. The meta\-label is the label to put on the meta\-volume\&.
474 When using this directive, specify the template for new meta labels\&. The template can contains many variables that are substituted by their values:
478 $o : org configuration
481 The template should contain some number of contiguous \*(Aq%\*(Aq characters, which will be replaced with a generated number\&. Be sure to specify enough \*(Aq%\*(Aq characters that you do not run out of meta labels\&. Example:
482 \fB"DailySet1\-%%%"\fR,
486 \fBdumpuser\fR \fIstring\fR
489 \fI"amanda"\fR\&. The login name Amanda uses to run the backups\&. The backup client hosts must allow access from the tape server host as this user via
492 \fB\&.amandahosts\fR, depending on how the Amanda software was built\&.
495 \fBprinter\fR \fIstring\fR
497 Printer to use when doing tape labels\&. See the
503 \fBtapedev\fR \fIstring\fR
506 \fI"null:"\fR\&. This parameter can either specify a device (explicitly or by referencing a device definition \- see
507 \fBamanda-devices\fR(7)) or a tape changer (explicitly or by referencing a device definition \- see
508 \fBamanda-changers\fR(7))\&.
511 \fBdevice\-property\fR \fIstring\fR \fIstring\fR
513 These options can set various device properties\&. See
514 \fBamanda-devices\fR(7)
515 for more information on device properties and their syntax\&. Both strings are always 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, write:
517 device\-property "BLOCK_SIZE" "128k"
521 \fBproperty\fR [\fBappend\fR] \fIstring\fR \fIstring\fR+
523 These options can set various properties, they can be used by third party software to store information in the configuration file\&. Both strings are quoted; the first string contains the name of the property to set, and the others contains its values\&.
525 keyword append the values to the list of values for that property\&.
528 \fBtpchanger\fR \fIstring\fR
530 Default: not set\&. The tape changer to use\&. In most cases, only one of
534 is specified, although for backward compatibility both may be specified if
536 gives the name of an old changer script\&. See
537 \fBamanda-changers\fR(7)
538 for more information on configuring changers\&.
541 \fBinteractivity\fR \fIstring\fR
543 Default: not set\&. The interactivity module Amanda should use to interact with the user\&. See
544 \fBamanda-interactivity\fR(7)
545 for a list of modules\&.
548 \fBtaperscan\fR \fIstring\fR
550 Default: traditional\&. The taperscan module amanda should use to find a tape to write to\&. See
551 \fBamanda-taperscan\fR(7)
552 for a list of modules\&.
555 \fBchangerdev\fR \fIstring\fR
558 \fI"dev/null"\fR\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the
563 \fBchangerfile\fR \fIstring\fR
566 \fI"/usr/adm/amanda/log/changer\-status"\fR\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the
571 \fBruntapes\fR \fIint\fR
574 \fI1\fR\&. 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\&.
576 If a tape changer is configured, this may be set larger than one to let Amanda write to more than one tape\&.
578 Note that this is an upper bound on the number of tapes, and Amanda may use less\&.
581 \fBmaxdumpsize\fR \fIint\fR
584 \fI\fBruntapes\fR\fR\fI*\fR\fI\fBtape\-length\fR\fR\&. Maximum number of bytes the planner will schedule for a run\&.
586 The default unit is Kbytes if it is not specified\&.
589 \fBtaperalgo\fR [ \fBfirst\fR | \fBfirstfit\fR | \fBlargest\fR | \fBlargestfit\fR | \fBsmallest\fR | \fBlast\fR ]
592 \fBfirst\fR\&. The algorithm used to choose which dump image to send to the taper\&.
596 First in, first out\&.
601 The first dump image that will fit on the current tape\&.
606 The largest dump image\&.
611 The largest dump image that will fit on the current tape\&.
616 The smallest dump image\&.
621 Last in, first out\&.
625 \fBtaper\-parallel\-write\fR \fIint\fR
628 \fI1\fR\&. Amanda can write simultaneously up to that number of volume at any given time\&. The changer must have as many drives\&.
631 \fBeject\-volume\fR \fIint\fR
636 if you want the volume to be ejected after Amanda wrote data to it\&. It works only with some changer and device\&.
639 \fBlabelstr\fR \fIstring\fR
642 \fI"\&.*"\fR\&. The tape label constraint regular expression\&. All tape labels generated (see
643 \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\*(Aqs tapes\&.
646 \fBtapetype\fR \fIstring\fR
649 \fIno default\fR\&. The type of tape drive associated with
652 \fBtpchanger\fR\&. This refers to one of the defined
653 \fBtapetype\fRs in the config file (see below), which specify various tape parameters, like the
658 of the tape media and device\&.
661 \fBctimeout\fR \fIint\fR
664 \fI30 seconds\fR\&. Maximum amount of time that
666 will wait for each client host\&.
669 \fBdtimeout\fR \fIint\fR
672 \fI1800 seconds\fR\&. Amount of idle time per disk on a given client that a
676 will wait before it fails with a data timeout error\&.
679 \fBetimeout\fR \fIint\fR
682 \fI300 seconds\fR\&. Amount of time per estimate on a given client that the
686 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\*(Aqs, each estimating level 0 and level 1 on client A,
688 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\&.
691 \fBconnect\-tries\fR \fIint\fR
694 \fI3\fR\&. How many times the server will try a connection\&.
697 \fBreq\-tries\fR \fIint\fR
700 \fI3\fR\&. How many times the server will resend a REQ packet if it doesn\*(Aqt get the ACK packet\&.
703 \fBnetusage\fR \fIint\fR
706 \fI80000 Kbps\fR\&. The maximum network bandwidth allocated to Amanda, in Kbytes per second\&. See also the
711 \fBinparallel\fR \fIint\fR
714 \fI10\fR\&. The maximum number of backups that Amanda will attempt to run in parallel\&. Amanda will stay within the constraints of network bandwidth and holding disk space available, so it doesn\*(Aqt 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\&.
717 \fBdisplayunit\fR "k|m|g|t"
720 \fI"k"\fR\&. The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera\&.
723 \fBdumporder\fR \fIstring\fR
726 \fI"tttTTTTTTT"\fR\&. The priority order of each dumper:
733 b: smallest bandwidth
738 \fBmaxdumps\fR \fIint\fR
741 \fI1\fR\&. The maximum number of backups from a single host that Amanda will attempt to run in parallel\&. See also the
745 Note that this parameter may also be set in a specific
747 (see below)\&. This value sets the default for all
748 \fBdumptype\fRs so must appear in
751 \fBdumptype\fRs are defined\&.
754 \fBbumpsize\fR \fIint\fR
757 \fI10 Mbytes\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\&. If Amanda 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
761 The default unit is Kbytes if it is not specified\&.
763 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
772 \fBbumppercent\fR \fIint\fR
775 \fI0\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 Amanda determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&.
777 If this parameter is set to 0, the value of the parameter
779 is used to trigger bumping\&.
781 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
790 \fBbumpmult\fR \fIfloat\fR
793 \fI1\&.5\fR\&. The bump size multiplier\&. Amanda multiplies
795 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
799 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\&.
801 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
804 \fBbumpdays\fR \fIint\fR
807 \fI2 days\fR\&. To insure redundancy in the dumps, Amanda keeps filesystems at the same incremental level for at least
809 days, even if the other bump threshold criteria are met\&.
811 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
814 \fBdiskfile\fR \fIstring\fR
817 \fI"disklist"\fR\&. The file name for the
819 file holding client hosts, disks and other client dumping information\&.
822 \fBinfofile\fR \fIstring\fR
825 \fI"/usr/adm/amanda/curinfo"\fR\&. The file or directory name for the historical information database\&. If Amanda 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\&.
828 \fBlogdir\fR \fIstring\fR
831 \fI"/usr/adm/amanda"\fR\&. The directory for the
838 \fBindexdir\fR \fIstring\fR
841 \fI"/usr/adm/amanda/index"\fR\&. The directory where index files (backup image catalogues) are stored\&. Index files are only generated for filesystems whose
848 \fBtapelist\fR \fIstring\fR
851 \fI"tapelist"\fR\&. The file name for the active
852 \fBtapelist\fR(5)\&. Amanda maintains this file with information about the active set of tapes\&.
855 \fBdevice\-output\-buffer\-size\fR \fIint\fR
858 \fI1280k\fR\&. Controls the amount of memory used by Amanda to hold data as it is read from the network or disk before it is written to the output device\&. Higher values may be useful on fast tape drives and optical media\&.
860 The default unit is bytes if it is not specified\&.
863 \fBtapebufs\fR \fIint\fR
866 \fI20\fR\&. This option is deprecated; use the
867 \fBdevice\-output\-buffer\-size\fR
870 works the same way, but the number specified is multiplied by the device blocksize prior to use\&.
873 \fBreserve\fR \fIint\fR
876 \fI100\fR\&. 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\&.
879 \fBautoflush\fR \fBno\fR|\fByes\fR|\fBall\fR
882 \fBno\fR\&. Whether an amdump run will flush the dumps from holding disk to tape\&. With
883 \fByes\fR, only dump matching the command line argument are flushed\&. With
884 \fBall\fR, all dump are flushed\&.
887 \fBamrecover\-do\-fsf\fR \fIbool\fR
889 Deprecated; amrecover always uses fsf, and does not invoke amrestore\&.
892 \fBon\fR\&. Amrecover will call amrestore with the \-f flag for faster positioning of the tape\&.
895 \fBamrecover\-check\-label\fR \fIbool\fR
897 Deprecated; amrecover always checks the label, and does not invoke amrestore\&.
900 \fBon\fR\&. Amrecover will call amrestore with the \-l flag to check the label\&.
903 \fBamrecover\-changer\fR \fIstring\fR
905 Default: not set\&. Amrecover will use the changer if you use \*(Aqsettape <string>\*(Aq and that string is the same as the
906 \fBamrecover\-changer\fR
910 \fBcolumnspec\fR \fIstring\fR
912 default: "HostName=0:\-12:12,Disk=1:\-11:11,Level=1:\-1:1,OrigKB=1:\-7:0,OutKB=1:\-7:0,Compress=1:\-6:1,DumpTime=1:\-7:7,Dumprate=1:\-6:1,TapeTime=1:\-6:6,TapeRate=1:\-6:1"
914 Defines the width of columns
918 is a comma (\*(Aq,\*(Aq) separated list of triples\&. Each triple consists of three parts which are separated by a equal sign (\*(Aq=\*(Aq) and a colon (\*(Aq:\*(Aq) (see the example)\&. These four parts specify:
928 the name of the column, which may be:
931 Compress (compression ratio)
932 Disk (client disk name)
933 DumpRate (dump rate in KBytes/sec)
934 DumpTime (total dump time in hours:minutes)
935 HostName (client host name)
937 OrigKB (original image size in KBytes)
938 OutKB (output image size in KBytes)
939 TapeRate (tape writing rate in KBytes/sec)
940 TapeTime (total tape time in hours:minutes)
952 the amount of space to display before the column (used to get whitespace between columns)\&.
963 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\&.
974 the precision of the column, number of digit after the decimal point for number\&.
980 columnspec "Disk=1:18,HostName=0:10,OrigKB=::2,OutKB=1:7"
983 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 Original KBytes print 2 decimal digit\&. The output KBytes column is seven characters wide with one space before it\&.
986 \fBincludefile\fR \fIstring\fR
989 \fIno default\fR\&. The name of an Amanda configuration file to include within the current file\&. Useful for sharing dumptypes, tapetypes and interface definitions among several configurations\&. Relative pathnames are relative to the configuration directory\&.
992 \fBdebug\-days\fR \fIint\fR
995 \fI3\fR\&. The number of days the debug files are kept\&.
998 \fBdebug\-auth\fR \fIint\fR
1001 \fI0\fR\&. Debug level of the auth module
1004 \fBdebug\-event\fR \fIint\fR
1007 \fI0\fR\&. Debug level of the event module
1010 \fBdebug\-holding\fR \fIint\fR
1013 \fI0\fR\&. Debug level of the holdingdisk module
1016 \fBdebug\-protocol\fR \fIint\fR
1019 \fI0\fR\&. Debug level of the protocol module
1022 \fBdebug\-planner\fR \fIint\fR
1025 \fI0\fR\&. Debug level of the planner process
1028 \fBdebug\-driver\fR \fIint\fR
1031 \fI0\fR\&. Debug level of the driver process
1034 \fBdebug\-dumper\fR \fIint\fR
1037 \fI0\fR\&. Debug level of the dumper process
1040 \fBdebug\-chunker\fR \fIint\fR
1043 \fI0\fR\&. Debug level of the chunker process
1046 \fBdebug\-taper\fR \fIint\fR
1049 \fI0\fR\&. Debug level of the taper process
1052 \fBdebug\-recovery\fR \fIint\fR
1055 \fI1\fR\&. Debug level of all recovery process
1058 \fBflush\-threshold\-dumped\fR \fIint\fR
1061 \fI0\fR\&. Amanda will not begin writing data to a new volume until the amount of data on the holding disk is at least this percentage of the volume size\&. In other words, Amanda will not begin until the amount of data on the holding disk is greater than the tape length times this parameter\&. This parameter may be larger than 100%, for example to keep more recent dumps on the holding disk for faster recovery\&.
1063 Needless to say, your holding disk must be big enough that this criterion could be satisfied\&. If the holding disk cannot be used for a particular dump (because, for example, there is no remaining holding space) then Amanda will disregard the constraint specified by this setting and start a new volume anyway\&. Once writing to a volume has begun, this constraint is not applied unless and until a new volume is needed\&.
1065 The value of this parameter may not exceed than that of the
1066 \fBflush\-threshold\-scheduled\fR
1070 \fBflush\-threshold\-scheduled\fR \fIint\fR
1073 \fI0\fR\&. Amanda will not begin writing data to a new volume until the sum of the amount of data on the holding disk and the estimated amount of data remaining to be dumped during this run is at least this percentage of the volume size\&. In other words, Amanda will not begin until the inequality
1077 is the amount of data on the holding disk,
1079 is the total amount of data scheduled for this run but not dumped yet,
1081 is the capacity of a volume, and
1083 is this parameter, expressed as a percentage\&. This parameter may be larger than 100%\&.
1085 Needless to say, your holding disk must be big enough that this criterion could be satisfied\&. If the holding disk cannot be used for a particular dump (because, for example, there is no remaining holding space) then Amanda will disregard the constraint specified by this setting and start a new volume anyway\&. Once writing to a volume has begun, this constraint is not applied unless and until a new volume is needed\&.
1087 The value of this parameter may not be less than that of the
1088 \fBflush\-threshold\-dumped\fR
1094 \fBtaperflush\fR \fIint\fR
1097 \fI0\fR\&. At the end of a run, Amanda will start a new tape to flush remaining data if there is more data on the holding disk at the end of a run than this setting allows; the amount is specified as a percentage of the capacity of a single volume\&. In other words, at the end of a run, Amanda will begin a new tape if the inequality
1101 is the amount of data remaining on the holding disk from this or previous runs,
1103 is the capacity of a volume, and
1105 is this parameter, expressed as a percentage\&. This parameter may be greater than 100%\&.
1107 The value of this parameter may not exceed that of the
1108 \fBflush\-threshold\-scheduled\fR
1111 must be set to \*(Aqyes\*(Aq if
1113 is greater than 0\&.
1116 \fBreserved\-udp\-port\fR \fIint\fR,\fIint\fR
1118 Default: \-\-with\-udpportrange or
1119 \fI512,1023\fR\&. Reserved udp port that will be used (bsd, bsdudp)\&. Range is inclusive\&.
1122 \fBreserved\-tcp\-port\fR \fIint\fR,\fIint\fR
1124 Default: \-\-with\-low\-tcpportrange or
1125 \fI512,1023\fR\&. Reserved tcp port that will be used (bsdtcp)\&. Range is inclusive\&.
1128 \fBunreserved\-tcp\-port\fR \fIint\fR,\fIint\fR
1130 Default: \-\-with\-tcpportrange or
1131 \fI1024,65535\fR\&. Unreserved tcp port that will be used (bsd, bsdudp)\&. Range is inclusive\&.
1134 \fBrecovery\-limit\fR [ \fIstring\fR | \fBsame\-host\fR | \fBserver\fR]
1136 Default: none (no limitations)\&. This parameter limits the hosts that may do recoveries\&. Hosts are identified by their authenticated peer name, as described in
1137 \fBamanda-auth\fR(7); if this is not available and the recovery\-limit parameter is present, recovery will be denied\&. The arguments to the parameter are strings giving host match expressions (see
1138 \fBamanda-match\fR(7)) or the special keywords
1143 keyword requires an exact match to the hostname of the DLE being recovered\&. The
1145 keyword require the connection come from the fqdn of the server\&. Specifying no arguments at all will disable all recoveries from any host\&.
1147 Note that match expressions can be constructed to be forgiving of e\&.g\&., fully\-qualified vs\&. unqualified hostnames, but
1149 requires an exact match\&.
1151 The error messages that appear in amrecover are intentionally vague to avoid information leakage\&. Consult the amindexd debug log for more details on the reasons a recovery was rejected\&.
1153 Recovery limits can be refined on a per\-DLE basis using the dumptype parameter of the same name\&. Note that the default value will apply to any dumpfiles for disks which no longer appear in the disklist; thus leaving the global parameter at its default value but setting it for all DLEs is not sufficient to maintain secure backups\&.
1156 \fBtmpdir\fR \fIstring\fR
1158 Default: none (system default)\&. Set it to a directory with lots of free space if sort in amindexd fail with \*(AqNo space left on device\*(Aq\&.
1160 .SH "HOLDINGDISK SECTION"
1164 file may define one or more holding disks used as buffers to hold backup images before they are written to tape\&. The syntax is:
1166 define holdingdisk \fIname\fR {
1167 \fIholdingdisk\-option\fR \fIholdingdisk\-value\fR
1172 The { must appear at the end of a line, and the } on its own line\&.
1175 is a logical name for this holding disk\&.
1177 The options and values are:
1179 \fBcomment\fR \fIstring\fR
1181 Default: not set\&. A comment string describing this holding disk\&.
1184 \fBdirectory\fR \fIstring\fR
1187 \fI"/dumps/amanda"\fR\&. The path to this holding area\&.
1193 \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, Amanda will use all available space minus that value\&.
1196 \fBchunksize\fR \fIint\fR
1199 \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\&.
1201 The default unit is Kbytes if it is not specified\&.
1203 If 0 is specified, Amanda will create holding disk chunks as large as ((INT_MAX/1024)\-64) Kbytes\&.
1205 Each holding disk chunk includes a 32 Kbyte header, so the minimum chunk size is 64 Kbytes (but that would be really silly)\&.
1207 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 Amanda 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\&.
1209 .SH "DUMPTYPE SECTION"
1212 \fBamanda.conf\fR(5)
1213 file may define multiple sets of backup options and refer to them by name from the
1215 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\&.
1217 A set of backup options are entered in a
1219 section, which looks like this:
1221 define dumptype "\fIname\fR" {
1222 \fIdumptype\-option\fR \fIdumptype\-value\fR
1227 The { must appear at the end of a line, and the } on its own line\&.
1230 is the name of this set of backup options\&. It is referenced from the
1234 Some of the options in a
1236 section are the same as those in the main part of
1237 \fBamanda.conf\fR(5)\&. The main option value is used to set the default for all
1239 sections\&. For instance, setting
1241 to 50 in the main part of the config file causes all following
1243 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
1244 \fBdumptype\fRs are defined\&.
1246 The dumptype options and values are:
1248 \fBauth\fR \fIstring\fR
1251 \fI"bsdtcp"\fR\&. Type of authorization to perform between tape server and backup client hosts\&. See
1252 \fBamanda-auth\fR(7)
1256 \fBamandad\-path\fR \fIstring\fR
1259 \fI"$libexec/amandad"\fR\&. Specify the amandad path of the client, only use with rsh/ssh authentification\&.
1262 \fBclient\-username\fR \fIstring\fR
1265 \fICLIENT_LOGIN\fR\&. Specify the username to connect on the client, only use with rsh/ssh authentification\&.
1268 \fBclient\-port\fR [ \fIint\fR | \fIstring\fR ]
1271 \fI"amanda"\fR\&. Specifies the port to connect to on the client\&. It can be a service name or a numeric port number\&.
1274 \fBbumpsize\fR \fIint\fR
1277 \fI10 Mbytes\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\&. If Amanda 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
1281 The default unit is Kbytes if it is not specified\&.
1283 See also the options
1290 \fBbumppercent\fR \fIint\fR
1293 \fI0\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 Amanda determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&.
1295 If this parameter is set to 0, the value of the parameter
1297 is used to trigger bumping\&.
1299 See also the options
1306 \fBbumpmult\fR \fIfloat\fR
1309 \fI1\&.5\fR\&. The bump size multiplier\&. Amanda multiplies
1311 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
1315 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\&.
1318 \fBbumpdays\fR \fIint\fR
1321 \fI2 days\fR\&. To insure redundancy in the dumps, Amanda keeps filesystems at the same incremental level for at least
1323 days, even if the other bump threshold criteria are met\&.
1326 \fBcomment\fR \fIstring\fR
1328 Default: not set\&. A comment string describing this set of backup options\&.
1331 \fBcomprate\fR \fIfloat\fR [, \fIfloat\fR ]
1334 \fI0\&.50, 0\&.50\fR\&. The expected full and incremental compression factor for dumps\&. It is only used if Amanda 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\&.
1337 \fBcompress\fR [ \fBnone\fR | \fBclient\fR | \fBserver\fR ] [ \fBbest\fR | \fBfast\fR | \fBcustom\fR ]
1340 \fBclient fast\fR\&. If Amanda 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\&.
1342 For either type of compression, Amanda also allows the selection of three styles of compression\&.
1344 is the best compression available, often at the expense of CPU overhead\&.
1346 is often not as good a compression as
1347 \fBbest\fR, but usually less CPU overhead\&. Or to specify
1349 to use your own compression method\&. (See dumptype custom\-compress in example/amanda\&.conf for reference)
1353 options line may be one of:
1359 compress client fast
1363 compress client best
1367 compress client custom
1370 \fBclient\-custom\-compress\fR
1373 PROG must not contain white space and it must accept \-d for uncompress\&.
1376 compress server fast
1380 compress server best
1384 compress server custom
1387 \fBserver\-custom\-compress\fR
1390 PROG must not contain white space and it must accept \-d for uncompress\&.
1393 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
1395 option), Amanda (software) compression should be disabled\&.
1398 \fBclient\-custom\-compress\fR \fIstring\fR
1400 Default: none\&. The program to use to perform compression/decompression on the client; used with "compress client custom"\&. Must not contain whitespace\&. Must accept \-d to uncompress\&.
1403 \fBserver\-custom\-compress\fR \fIstring\fR
1405 Default: none\&. The program to use to perform compression/decompression on the server; used with "compress server custom"\&. Must not contain whitespace\&. Must accept \-d to uncompress\&.
1408 \fBdumpcycle\fR \fIint\fR
1411 \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\&.
1414 \fBencrypt\fR [ \fBnone\fR | \fBclient\fR | \fBserver\fR ]
1416 Default: not set\&. 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\&.
1420 options line may be one of:
1428 Specify client\-encrypt "PROG"
1430 PROG must not contain white space\&.
1432 Specify client\-decrypt\-option "decryption\-parameter" Default: "\-d"
1434 decryption\-parameter must not contain white space\&.
1436 (See dumptype client\-encrypt\-nocomp in example/amanda\&.conf for reference)
1441 Specify server\-encrypt "PROG"
1443 PROG must not contain white space\&.
1445 Specify server\-decrypt\-option "decryption\-parameter" Default: "\-d"
1447 decryption\-parameter must not contain white space\&.
1449 (See dumptype server\-encrypt\-fast in example/amanda\&.conf for reference)
1452 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\&.
1454 which is a wrapper of
1456 is provided as a reference symmetric encryption program\&.
1459 \fBclient\-encrypt\fR \fIstring\fR
1461 Default: none\&. The program to use to perform encryption/decryption on the client; used with "encrypt client"\&. Must not contain whitespace\&.
1464 \fBclient\-decrypt\-option\fR \fIstring\fR
1466 Default: \-d\&. The option that can be passed to client\-encrypt to make it decrypt instead\&. Must not contain whitespace\&.
1469 \fBserver\-encrypt\fR \fIstring\fR
1471 Default: none\&. The program to use to perform encryption/decryption on the server; used with "encrypt server"\&. Must not contain whitespace\&.
1474 \fBserver\-decrypt\-option\fR \fIstring\fR
1476 Default: \-d\&. The option that can be passed to server\-encrypt to make it decrypt instead\&. Must not contain whitespace\&.
1479 \fBestimate\fR [ \fBclient\fR | \fBcalcsize\fR | \fBserver\fR ]+
1482 \fBclient\fR\&. Determine the way Amanda estimates the size of each DLE before beginning a backup\&. This is a list of acceptable estimate methods, and Amanda applies the first method supported by the application\&. The methods are:
1486 Use the same program as the dumping program\&. This is the most accurate method to do estimates, but it can take a long time\&.
1491 Use a faster program to do estimates, but the result is less accurate\&.
1496 Use only statistics from the previous few runs to give an estimate\&. This very quick, but the result is not accurate if your disk usage changes from day to day\&. If this method is specified, but the server does not have enough data to make an estimate, then the option is internally moved to the end of the list, thereby preferring \*(Aqclient\*(Aq or \*(Aqcalcsize\*(Aq in this case\&.
1500 \fBexclude\fR [ \fBlist\fR | \fBfile\fR ][[\fBoptional\fR][\fBappend\fR][ \fIstring\fR ]+]
1503 \fBfile\fR\&. Exclude is the opposite of
1505 and specifies files that will be excluded from the backup\&. The format of the exclude expressions depends on the application, and some applications do not support excluding files at all\&.
1507 There are two exclude parameters,
1517 is an exclude expression\&. With
1522 is a file name on the client containing
1524 exclude expressions\&. The path to the specified exclude list file, if present (see description of \*(Aqoptional\*(Aq below), must be readable by the Amanda user\&.
1526 All exclude expressions are concatenated in one file and passed to the application as an
1527 \fB\-\-exclude\-from\fR
1531 \fBGNU\-tar\fR, exclude expressions must always be specified as relative to the top\-level directory of the DLE, and must start with "\&./"\&. See the manpages for individual applications for more information on supported exclude expressions\&.
1537 is appended to the current list, without it, the
1539 overwrites the list\&.
1545 \fBlist\fR, then amcheck will not complain if the file doesn\*(Aqt exist or is not readable\&.
1549 \fBlist\fR, if the file name is relative, the disk name being backed up is prepended\&. So if this is entered:
1551 exclude list "\&.amanda\&.excludes"
1553 the actual file used would be
1554 /var/\&.amanda\&.excludes
1557 /usr/local/\&.amanda\&.excludes
1559 /usr/local, and so on\&.
1562 \fBholdingdisk\fR [ \fBnever\fR | \fBauto\fR | \fBrequired\fR ]
1565 \fBauto\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 Amanda is backing up, that file system should refer to a dumptype with
1569 to avoid backing up the holding disk into itself\&.
1571 \fBnever\fR|no|false|off
1573 Never use a holdingdisk, the dump will always go directly to tape\&. There will be no dump if you have a tape error\&.
1576 \fBauto\fR|yes|true|on
1578 Use the holding disk, unless there is a problem with the holding disk, the dump won\*(Aqt fit there or the medium doesn\*(Aqt require spooling (e\&.g\&., VFS device)
1583 Always dump to holdingdisk, never directly to tape\&. There will be no dump if it doesn\*(Aqt fit on holdingdisk
1587 \fBignore\fR \fIboolean\fR
1590 \fBno\fR\&. Whether disks associated with this backup type should be backed up or not\&. This option is useful when the
1592 file is shared among several configurations, some of which should not back up all the listed file systems\&.
1595 \fBinclude\fR [ \fBlist\fR | \fBfile\fR ][[\fBoptional\fR][\fBappend\fR][ \fIstring\fR ]+]
1599 "\&."\&. There are two include lists,
1602 \fBinclude list\&.\fR
1607 is a glob expression\&. With
1611 is a file name on the client containing glob expressions\&.
1613 All include expressions are expanded by Amanda, concatenated in one file and passed to
1616 \fB\-\-files\-from\fR
1617 argument\&. They must start with "\&./" and contain no other "/"\&.
1619 Include expressions must always be specified as relative to the head directory of the DLE\&.
1625 .nr an-no-space-flag 1
1632 For globbing to work at all, even the limited single level, the top level directory of the DLE must be readable by the Amanda user\&.
1639 is appended to the current list, without it, the
1641 overwrites the list\&.
1646 \fBinclude list\fR, then amcheck will not complain if the file doesn\*(Aqt exist or is not readable\&.
1649 \fBinclude list\fR, If the file name is relative, the disk name being backed up is prepended\&.
1652 \fBindex\fR \fIboolean\fR
1655 \fBno\fR\&. Whether an index (catalogue) of the backup should be generated and saved in
1656 \fBindexdir\fR\&. These catalogues are used by the
1661 \fBkencrypt\fR \fIboolean\fR
1664 \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\&.
1667 \fBmaxdumps\fR \fIint\fR
1670 \fI1\fR\&. The maximum number of backups from a single host that Amanda will attempt to run in parallel\&. See also the main section parameter
1674 \fBmaxpromoteday\fR \fIint\fR
1677 \fI10000\fR\&. The maximum number of day for a promotion, set it 0 if you don\*(Aqt want promotion, set it to 1 or 2 if your disks get overpromoted\&.
1680 \fBmax\-warnings\fR \fIint\fR
1683 \fI20\fR\&. The maximum number of error lines in the report for a dle\&. A value of \*(Aq0\*(Aq means unlimited\&. This is useful to reduce the size of the log file and the size of the report\&. All errors are put in separate files if a dle have more errors\&.
1686 \fBpriority\fR [ \fBlow\fR | \fBmedium\fR | \fBhigh\fR ]
1689 \fBmedium\fR\&. When there is no tape to write to, Amanda 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\&.
1692 \fBprogram\fR [ \fB"DUMP"\fR | \fB"GNUTAR"\fR | \fB"APPLICATION"\fR ]
1695 \fI"DUMP"\fR\&. The type of backup to perform\&. Valid values are:
1699 The native operating system backup program\&.
1704 To use GNU\-tar or to do PC backups using Samba\&.
1709 To use an application, see the
1715 \fBapplication\fR \fIstring\fR
1717 No default\&. Must be the name of an application if
1720 \fIAPPLICATION\fR\&. See APPLICATION SECTION below\&.
1723 \fBscript\fR \fIstring\fR
1725 No default\&. Must be the name of a script\&. You can have many script\&. See SCRIPT SECTION below\&.
1728 \fBproperty\fR [\fBappend\fR] \fIstring\fR \fIstring\fR+
1730 These options can set various properties, they can be used by third party software to store information in the configuration file\&. Both strings are quoted; the first string contains the name of the property to set, and the others contains its values\&.
1732 keyword append the values to the list of values for that property\&.
1735 \fBrecord\fR \fIboolean\fR
1738 \fIyes\fR\&. Whether to ask the backup program to update its database (e\&.g\&.
1741 /usr/local/var/amanda/gnutar\-lists
1742 for GNUTAR) of time stamps\&. This is normally enabled for daily backups and turned off for periodic archival runs\&.
1745 \fBskip\-full\fR \fIboolean\fR
1752 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 Amanda only schedules level 1 incrementals in this configuration; this is probably a bug\&.
1755 \fBskip\-incr\fR \fIboolean\fR
1762 has scheduled an incremental backup, these disks will be skipped\&.
1765 \fBssh\-keys\fR \fIstring\fR
1767 Default: not set\&. The key file the ssh auth will use, it must be the private key\&. If this parameter is not specified, then the default ssh key will be used\&.
1770 \fBstarttime\fR \fIint\fR
1772 Default: not set\&. Backup of these disks 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
1776 \fBstrategy\fR [ \fBstandard\fR | \fBnofull\fR | \fBnoinc\fR | \fBskip\fR | \fBincronly\fR ]
1779 \fBstandard\fR\&. Strategy to use when planning what level of backup to run next\&. Values are:
1783 The standard Amanda schedule\&.
1788 Never do full backups, only level 1 incrementals\&.
1793 Never do incremental backups, only full dumps\&.
1798 Treat this DLE as if it doesn\*(Aqt exist (useful to disable DLEs when sharing the
1800 file between multiple configurations)\&. Skipped DLEs will not be checked or dumped, and will not be matched by disklist expressions\&.
1805 Only do incremental dumps\&.
1807 should be used to tell Amanda that a full dump has been performed off\-line, so that it resets to level 1\&.
1811 \fBallow\-split\fR \fIbool\fR
1813 Default: true\&. If true, then dumps with this dumptype can be split on the storage media\&. If false, then the dump will be written in a single file on the media\&. See "Dump Splitting Configuration" below\&.
1816 \fBtape\-splitsize\fR \fIint\fR
1818 Deprecated\&. See "Dump Splitting Configuration" below\&.
1820 Default: not set\&. Split dump file on tape into pieces of a specified size\&. The default unit is Kbytes if it is not specified\&.
1823 \fBsplit\-diskbuffer\fR \fIstring\fR
1826 Deprecated\&. See "Dump Splitting Configuration" below\&.
1827 Default: not set\&. 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\&.
1830 \fBfallback\-splitsize\fR \fIint\fR
1832 Deprecated\&. See "Dump Splitting Configuration" below\&.
1835 \fI10M\fR\&. This specifies the part size used when no
1836 \fBsplit\-diskbuffer\fR
1837 is specified, or when it is too small or does not exist, and thus the maximum amount of memory consumed for in\-memory splitting\&. The default unit is Kbytes if it is not specified\&.
1840 \fBrecovery\-limit\fR [ \fBserver\fR | \fBsame\-host\fR | \fIstring\fR ]*
1842 Default: global value\&. This parameter overrides the global
1843 \fBrecovery\-limit\fR
1844 parameter for DLEs of this dumptype\&.
1847 \fBdump\-limit\fR [ \fBserver\fR | \fBsame\-host\fR ]*
1850 \fBserver\fR\&. Specify which host can initiate a backup of the dle\&. With
1851 \fBserver\fR, the server can initiate a backup with the
1854 \fBsame\-host\fR, the client can initiate a backup with the
1861 entries are predefined by Amanda:
1863 define dumptype "no\-compress" {
1866 define dumptype "compress\-fast" {
1867 compress client fast
1869 define dumptype "compress\-best" {
1870 compress client best
1872 define dumptype "srvcompress" {
1873 compress server fast
1875 define dumptype "bsd\-auth" {
1878 define dumptype "bsdtcp\-auth" {
1881 define dumptype "no\-record" {
1884 define dumptype "no\-hold" {
1887 define dumptype "no\-full" {
1892 In addition to options in a
1894 section, one or more other
1896 names may be supplied as identifiers, which make this
1898 inherit options from other previously defined
1899 \fBdumptype\fRs\&. For instance, two sections might be the same except for the
1903 define dumptype "normal" {
1904 comment "Normal backup, no compression, do indexing"
1909 define dumptype "testing" {
1910 comment "Test backup, no compression, do indexing, no recording"
1923 \fBdumptype\fRs should reference\&. This provides an easy place to make changes that will affect every
1924 \fBdumptype\fR, although you must be careful that every dumptype explicitly inherits from the
1926 dumptype \- Amanda does not do so automatically\&.
1927 .SH "TAPETYPE SECTION"
1931 file may define multiple types of tape media and devices\&. The information is entered in a
1933 section, which looks like this in the config file:
1935 define tapetype "\fIname\fR" {
1936 \fItapetype\-option\fR \fItapetype\-value\fR
1941 The { must appear at the end of a line, and the } on its own line\&.
1944 is the name of this type of tape medium/device\&. It is referenced from the
1946 option in the main part of the config file\&.
1948 The tapetype options and values are:
1950 \fBcomment\fR \fIstring\fR
1952 Default: not set\&. A comment string describing this set of tape information\&.
1955 \fBfilemark\fR \fIint\fR
1958 \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\&.
1961 \fBlength\fR \fIint\fR
1964 \fI2000 kbytes\fR\&. How much data will fit on a tape, expressed in kbytes\&.
1966 Note that this value is only used by Amanda to schedule which backups will be run\&. Once the backups start, Amanda will continue to write to a tape until it gets an error, regardless of what value is entered for
1969 \fBamanda-devices\fR(7)
1973 \fBblocksize\fR \fIint\fR
1976 \fI32 kbytes\fR\&. How much data will be written in each tape record, expressed in kbytes\&. This is similar to the
1978 device property, but if the blocksize is not a multiple of 1024 bytes, then this parameter cannot be used to specify it, and the property must be used instead\&.
1981 \fBreadblocksize\fR \fIint\fR
1985 How much data will be read in each tape record\&. This can be used to override a device\*(Aqs block size for reads only\&. This may be useful, for example, in reading a tape written with a 256k block size when Amanda is configured to use 128k blocks\&. This unusual feature is not supported by all operating systems and tape devices\&.
1987 The default unit is Kbytes if it is not specified\&.
1990 \fBpart\-size\fR \fIint\fR
1992 If this is set to zero (default), then no splitting will take place, and the entire dump will fail, if end\-of\-medium is encountered before the dump is complete, unless the device property LEOM is true, and the device can detect EOM\&. See "Dump Splitting Configuration" below\&.
1995 \fBpart\-cache\-type\fR [ \fBnone\fR | \fBdisk\fR | \fBmemory\fR ]
1997 Default: none\&. When part caching is required, this parameter specifies the type of caching that will be used\&. The options include no caching (\fBnone\fR), in which case a failed part will cause the entire dump to fail; on\-disk caching (\fBdisk\fR), for which
1998 \fBpart\-cache\-dir\fR
1999 must be set properly; and in\-memory caching (\fBmemory\fR), which on most systems severely restrains the size of the part that can be written\&. See "Dump Splitting Configuration" below\&.
2002 \fBpart\-cache\-dir\fR \fIstring\fR
2004 Default: none\&. The directory in which part\-cache files can be written when caching on disk\&. See "Dump Splitting Configuration" below\&.
2007 \fBpart\-cache\-max\-size\fR \fIint\fR
2009 Default: none\&. The maximum part size to use when caching is in effect\&. This is used to limit the part size when disk or memory space for caching is constrained\&. This value must be greater than zero\&.
2012 \fBspeed\fR \fIint\fR
2015 \fI200 bps\fR\&. How fast the drive will accept data, in bytes per second\&. This parameter is NOT currently used by Amanda\&.
2018 \fBlbl\-templ\fR \fIstring\fR
2020 Default: not set\&. A PostScript template file used by
2022 to generate labels\&. Several sample files are provided with the Amanda sources in the
2024 directory\&. See the
2026 man page for more information\&.
2029 In addition to options, another
2031 name may be supplied as an identifier, which makes this
2033 inherit options from another
2034 \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:
2036 define tapetype "DLT4000\-III" {
2037 comment "DLT4000 tape drives with Compact\-III tapes"
2038 length 12500 mbytes # 10 Gig tapes with some compression
2039 filemark 2000 kbytes
2042 define tapetype "DLT4000\-IV" {
2044 comment "DLT4000 tape drives with Compact\-IV tapes"
2045 length 25000 mbytes # 20 Gig tapes with some compression
2048 .SH "INTERFACE SECTION"
2052 file may define multiple types of network interfaces\&. The information is entered in an
2054 section, which looks like this:
2056 define interface "\fIname\fR" {
2057 \fIinterface\-option\fR \fIinterface\-value\fR
2062 The { must appear at the end of a line, and the } on its own line\&.
2065 is the name of this type of network interface\&. It is referenced from the
2069 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 Amanda\&. Amanda 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, Amanda will use as much of the network as it can leaving throttling up to the operating system and network hardware\&.
2071 The interface options and values are:
2073 \fBcomment\fR \fIstring\fR
2075 Default: not set\&. A comment string describing this set of network information\&.
2081 \fI80000 Kbps\fR\&. The speed of the interface in Kbytes per second\&.
2084 In addition to options, another
2086 name may be supplied as an identifier, which makes this
2088 inherit options from another
2089 \fBinterface\fR\&. At the moment, this is of little use\&.
2090 .SH "APPLICATION SECTION"
2094 file may define multiple types of application\&. The information is entered in a
2096 section, which looks like this:
2098 define application "\fIname\fR" {
2099 \fIapplication\-option\fR \fIapplication\-value\fR
2104 The { must appear at the end of a line, and the } on its own line\&.
2107 is the name of this type of application\&. It is referenced from the
2110 The application options and values are:
2112 \fBclient\-name\fR \fIstring\fR
2114 No default, specifies an application name that is in the amanda\-client\&.conf on the client\&. The setting from that application will be merged with the current application\&. If
2116 is set then it is an error if that application is not defined on the client\&.
2120 is not set then the merge is done with the application that have the name equal to the plugin\&. eg\&. if the plugin is \*(Aqamgtar\*(Aq, then the setting from the application \*(Aqamgtar\*(Aq is used if it is defined\&.
2123 \fBcomment\fR \fIstring\fR
2125 Default: not set\&. A comment string describing this application\&.
2128 \fBplugin\fR \fIstring\fR
2130 No default\&. Must be set to the name of the program\&. This program must be in the
2131 \fI$libexecdir/amanda/application\fR
2132 directory on the client\&.
2135 \fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
2137 No default\&. You can set property for the application, each application have a different set of property\&. Both strings are quoted; the first string contains the name of the property to set, and the others contains its values\&.
2139 keyword append the values to the list of values for that property\&.
2141 keyword disallow the setting of that property on the client\&.
2143 .SH "SCRIPT SECTION"
2147 file may define multiple types of script\&. The information is entered in a
2149 section, which looks like this:
2151 define script "\fIname\fR" {
2152 \fIscript\-option\fR \fIscript\-value\fR
2157 The { must appear at the end of a line, and the } on its own line\&.
2160 is the name of this type of script\&. It is referenced from the
2163 The script options and values are:
2165 \fBclient\-name\fR \fIstring\fR
2167 No default, specifies a script name that is in the amanda\-client\&.conf on the client\&. The setting from that script will be merged with the currect script\&. If
2169 is set then it is an error if that script is not defined on the client\&.
2173 is not set then the merge is done with the script that have the name equal to the plugin\&. eg\&. if the plugin is \*(Aqamlog\-script\*(Aq, then the setting from the script \*(Aqamlog\-script\*(Aq is used\&.
2176 \fBcomment\fR \fIstring\fR
2178 Default: not set\&. A comment string describing this script\&.
2181 \fBplugin\fR \fIstring\fR
2183 No default\&. Must be set to the name of the program\&. This program must be in the
2184 \fI$libexecdir/amanda/application\fR
2185 directory on the client and/or server\&.
2188 \fBorder\fR \fIint\fR
2191 \fI5000\fR\&. Scripts are executed in that order, it is useful if you have many scripts and they must be executed in a spefific order\&.
2194 \fBsingle\-execution\fR \fIboolean\fR
2197 \fIno\fR\&. The script is executed for each dle\&. If
2198 \fIyes\fR, the script is executed one time only\&.
2201 \fBexecute\-where\fR [ \fBclient\fR | \fBserver\fR ]
2204 \fBclient\fR\&. Where the script must be executed, on the client or server\&.
2207 \fBexecute\-on\fR \fIexecute_on\fR [,\fIexecute_on\fR]*
2209 No default\&. When the script must be executed, you can specify many of them:
2213 Execute before the amcheck command for all dle\&. Can only be run on server\&.
2216 \fBpre\-dle\-amcheck\fR
2218 Execute before the amcheck command for the dle\&.
2221 \fBpre\-host\-amcheck\fR
2223 Execute before the amcheck command for all dle for the client\&.
2228 Execute after the amcheck command for all dle\&. Can only be run on server\&.
2231 \fBpost\-dle\-amcheck\fR
2233 Execute after the amcheck command for the dle\&.
2236 \fBpost\-host\-amcheck\fR
2238 Execute after the amcheck command for all dle for the client\&.
2243 Execute before the estimate command for all dle\&. Can only be run on server\&.
2246 \fBpre\-dle\-estimate\fR
2248 Execute before the estimate command for the dle\&.
2251 \fBpre\-host\-estimate\fR
2253 Execute before the estimate command for all dle for the client\&.
2256 \fBpost\-estimate\fR
2258 Execute after the estimate command for all dle\&. Can only be run on server\&.
2261 \fBpost\-dle\-estimate\fR
2263 Execute after the estimate command for the dle\&.
2266 \fBpost\-host\-estimate\fR
2268 Execute after the estimate command for all dle for the client\&.
2273 Execute before the backup command for all dle\&. Can only be run on server\&.
2276 \fBpre\-dle\-backup\fR
2278 Execute before the backup command for the dle\&.
2281 \fBpre\-host\-backup\fR
2283 Execute before the backup command for all dle for the client\&. It can\*(Aqt be run on client, it must be run on server
2288 Execute after the backup command for all dle\&. Can only be run on server\&.
2291 \fBpost\-dle\-backup\fR
2293 Execute after the backup command for the dle\&.
2296 \fBpost\-host\-backup\fR
2298 Execute after the backup command for all dle for the client\&. It can\*(Aqt be run on client, it must be run on server
2303 Execute before any level is recovered\&.
2308 Execute after all levels are recovered\&.
2311 \fBpre\-level\-recover\fR
2313 Execute before each level recovery\&.
2316 \fBpost\-level\-recover\fR
2318 Execute after each level recovery\&.
2321 \fBinter\-level\-recover\fR
2323 Execute between two levels of recovery\&.
2326 If you recover level 0 and 2 of the disk /usr with amrecover, it will execute:
2328 script \-\-pre\-recover
2329 script \-\-pre\-level\-recover \-\-level 0
2331 script \-\-post\-level\-recover \-\-level 0
2332 script \-\-inter\-level\-recover \-\-level 0 \-\-level 2
2333 script \-\-pre\-level\-recover \-\-level 2
2335 script \-\-post\-level\-recover \-\-level 2
2336 script \-\-post\-recover
2340 \fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
2342 No default\&. You can set property for the script, each script have a different set of property\&. Both strings are quoted; the first string contains the name of the property to set, and the others contains its values\&.
2344 keyword append the values to the list of values for that property\&.
2346 keyword disallow the setting of that property on the client\&.
2348 .SH "DEVICE SECTION"
2350 Backend storage devices are specified in
2352 in the form of "device" sections, which look like this:
2354 define device \fIname\fR {
2355 commend "\fIcomment (optional)\fR"
2356 tapedev "\fIdevice\-specifier\fR"
2357 device\-property "\fIprop\-name\fR" "\fIprop\-value\fR"
2362 The { must appear at the end of a line, and the } on its own line\&.
2365 is the user\-specified name of this device\&. It is referenced from the global
2368 \fIdevice\-specifier\fR
2369 specifies the device name to use; see
2370 \fBamanda-devices\fR(7)\&. As with most sections, the
2372 parmeter is optional and only for the user\*(Aqs convenience\&.
2374 An arbitrary number of
2375 \fIdevice\-property\fR
2376 parameters can be specified\&. Again, see
2377 \fBamanda-devices\fR(7)
2378 for information on device properties\&.
2379 .SH "CHANGER SECTION"
2381 Changers are described in
2383 in the form of "changer" sections, which look like this:
2385 define changer \fIname\fR {
2386 comment "\fIcomment (optional)\fR"
2387 tpchanger "\fIchanger\-spec\fR"
2388 changerdev "\fIdevice\-name\fR"
2389 changerfile "\fIstate\-file\fR"
2394 The { must appear at the end of a line, and the } on its own line\&.
2397 is the user\-specified name of this device\&. The remaining parameters are specific to the changer type selected\&.
2400 \fBamanda-changers\fR(7)
2401 for more information on configuring changers\&.
2402 .SH "INTERACTIVITY SECTION"
2406 file may define multiple interactivyt methods, although only one will be used \- that specified by the
2408 parameter\&. The information is entered in a
2410 section, which looks like this:
2412 define interactivity \fIname\fR {
2413 \fIinteractivity\-option\fR \fIinteractivity\-value\fR
2418 The { must appear at the end of a line, and the } on its own line\&.
2421 is the user\-specified name of this interactivity\&. The remaining parameters are specific to the interactivity type selected\&.
2423 The interactivity options and values are:
2425 \fBcomment\fR \fIstring\fR
2427 Default: not set\&. A comment string describing this interactivity\&.
2430 \fBplugin\fR \fIstring\fR
2432 No default\&. Must be set to the name of the interactivity module, as described in
2433 \fBamanda-interactivity\fR(7)\&.
2436 \fBproperty\fR [\fBappend\fR] \fIstring\fR \fIstring\fR+
2438 No default\&. You can set arbitrary properties for the interactivity\&. Each interactivity module has a different set of properties\&. The first string contains the name of the property to set, and the others contains its values\&. All strings should be quoted\&. The
2440 keyword appends the given values to an existing list of values for that property\&.
2444 \fBamanda-interactivity\fR(7)
2445 for more information on configuring interactivity methods\&.
2446 .SH "TAPERSCAN SECTION"
2450 file may define multiple taperscan methods, although only one will be used \- that specified by the
2452 parameter\&. The information is entered in a
2454 section, which looks like this:
2456 define taperscan \fIname\fR {
2457 \fItaperscan\-option\fR \fItaperscan\-value\fR
2462 The { must appear at the end of a line, and the } on its own line\&.
2465 is the user\-specified name of this taperscan\&. The remaining parameters are specific to the taperscan type selected\&.
2467 The taperscan options and values are:
2469 \fBcomment\fR \fIstring\fR
2471 Default: not set\&. A comment string describing this taperscan\&.
2474 \fBplugin\fR \fIstring\fR
2476 No default\&. Must be set to the name of the taperscan module\&. See
2477 \fBamanda-taperscan\fR(7)
2478 for a list of defined taperscan modules\&.
2481 \fBproperty\fR [\fBappend\fR] \fIstring\fR \fIstring\fR+
2483 No default\&. Operates just like properties for interactivity methods, above\&.
2487 \fBamanda-taperscan\fR(7)
2488 for more information on configuring taperscan\&.
2489 .SH "DUMP SPLITTING CONFIGURATION"
2491 Amanda can "split" dumps into parts while writing them to storage media\&. This allows Amanda to recover gracefully from a failure while writing a part to a volume, by simply selecting a new volume and re\-writing the dump from the beginning of the failed part\&. Parts also allow Amanda to seek directly to the required data, although this functionality is not yet used\&.
2493 In order to support re\-writing from the beginning of a failed part, Amanda must have access to the contents of the part after it has been partially written\&. If the dump is being read from holding disk, then the part contents are availble there\&. Otherwise, the part must be cached, and this can be done memory or on disk\&. In either of the latter cases, the cache must have enough space to hold an entire part\&.
2495 Because it is common for a single Amanda configuration to use both holding\-disk (FILE\-WRITE) and direct (known as PORT\-WRITE) dumps, Amanda allows the configuration of different split sizes for the two cases\&. This allows, for example, for a part size appropriate to large tapes when performing FILE\-WRITE dumps, with a part size limited by available disk or memory when performing PORT\-WRITE dumps\&.
2497 Selecting a proper split size is a delicate matter\&. If the parts are too large, substantial storage space may be wasted in failed parts\&. If too small, large dumps will be split into innumerable tiny dumpfiles, adding to restoration complexity; furthermore, an excess of filemarks will cause slower tape drive operation and reduce the usable space on tape\&. A good rule of thumb is 1/10 of the size of a volume of storage media\&.
2499 In versions of Amanda through 3\&.1\&.*, splitting was controlled by the dumptype parameters
2500 \fBtape\-splitsize\fR,
2501 \fBsplit\-diskbuffer\fR, and
2502 \fBfallback\-splitsize\fR\&. These keywords had confusing and non\-intuitive interactions, and have since been deprecated\&.
2504 If the deprecated keywords are not present, subsequent versions of Amanda use the dumptype parameter
2506 to control whether a DLE can be split, and the
2510 \fBpart\-cache\-type\fR,
2511 \fBpart\-cache\-dir\fR, and
2512 \fBpart\-cache\-max\-size\fR\&. The
2514 specifies the "normal" part size, while the
2515 \fBpart\-cache\-*\fR
2516 parameters describe how to behave when caching is required (on PORT\-WRITE)\&. Full details on these parameters are given above\&.
2520 \fBamanda-client.conf\fR(5),
2521 \fBamanda-applications\fR(7),
2522 \fBamanda-auth\fR(7),
2523 \fBamanda-changers\fR(7),
2524 \fBamanda-devices\fR(7),
2525 \fBamanda-interactivity\fR(7),
2526 \fBamanda-scripts\fR(7),
2527 \fBamanda-taperscan\fR(7)
2530 : http://wiki.zmanda.com/
2533 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
2535 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>