3 .\" Author: James da Silva <jds@amanda.org>
4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
6 .\" Manual: File formats and conventions
7 .\" Source: Amanda 3.2.1
10 .TH "AMANDA\&.CONF" "5" "12/14/2010" "Amanda 3\&.2\&.1" "File formats and conventions"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
16 .\" disable justification (adjust text to left margin only)
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
22 amanda.conf \- Main configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver
26 is the main configuration file for Amanda\&. This manpage lists the relevant sections and parameters of this file for quick reference\&.
29 \fB<CONFIG_DIR>/<config>/amanda\&.conf\fR
33 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
35 if the default is suitable\&.
38 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\&.
39 .SS "KEYWORDS AND IDENTIFIERS"
41 Keywords are case insensitive, i\&.e\&.
45 are treated the same\&. Also, the characters \'\fB\-\fR\' and \'\fB_\fR\' are interchangeable in all predefined Amanda keywords:
48 \fBdevice\-property\fR
49 have the same meaning\&. This manpage uses the dashed versions, but the underscored versions will be accepted for backward compatibility
51 Identifiers are names which are defined in the configuration itself, such as dumptypes or interfaces\&. Identifiers are are case\-insensitive, but sensitive to \'\fB\-\fR\' vs\&. \'\fB_\fR\'\&. Identifiers should be quoted in the configuration file, although For historical reasons, the quotes are optional\&.
53 Strings are always quoted with double quotes ("), and any double quotes or backslashes within the string are escaped with a backslash:
56 tapelist "/path/to/tapelist"
57 property "escaped\-string" "escaping: \e\e (backslash) and \e" (double\-quote)"
64 logdir "logs" # required sensitive sensitive
65 send\-amreport\-on strange # prohibited insensitive insensitive
66 tapetype "EXABYTE" # optional insensitive sensitive
68 define dumptype "dt" { # optional insensitive sensitive
69 "dumptype\-common" # optional insensitive sensitive
70 strategy noinc # prohibited insensitive insensitive
75 Integer arguments may have one of the following (case insensitive) suffixes, some of which have a multiplier effect:
79 Some number of bytes\&.
84 Some number of bytes per second\&.
87 \fBk kb kbyte kbytes kilobyte kilobytes\fR
89 Some number of kilobytes (bytes*1024)\&.
94 Some number of kilobytes per second (bytes*1024)\&.
96 It is the default multiplier for all size options\&.
99 \fBm mb meg mbyte mbytes megabyte megabytes\fR
101 Some number of megabytes (bytes*1024*1024)\&.
106 Some number of megabytes per second (bytes*1024*1024)\&.
109 \fBg gb gbyte gbytes gigabyte gigabytes\fR
111 Some number of gigabytes (bytes*1024*1024*1024)\&.
114 \fBt tb tbyte tbytes terabyte terabytes\fR
116 Some number of terabytes (bytes*1024*1024*1024*1024)\&.
121 Some number of tapes\&.
126 Some number of days\&.
131 Some number of weeks (days*7)\&.
137 .nr an-no-space-flag 1
146 may be used in most places where an integer is expected to mean an infinite amount\&.
148 Boolean arguments may have any of the values
156 to indicate a true state, or
164 to indicate a false state\&. If no argument is given,
170 .SS "PARAMETER ORDER"
172 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\&.
175 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
178 ESCAPE SEQUENCE BECOMES
183 \er (carriage return)
187 \e001 \- \e377 (character specified in octal)
189 Illegally quoted strings are handled on a "best\-effort" basis, which may lead to unexpected results\&.
194 finserver "/data/finance/XYZ Corp\'s \e"real\e" finances" finance\-high eth0 \-1
195 property "syspath" "C:\e\eWINDOWS\e\eSYSTEM"
197 .SS "SUBSECTIONS AND INHERITANCE"
199 Amanda configuration files may include various
200 \fIsubsections\fR, each defining a set of configuration directives\&. Each type of subsection is described below\&. Note that all types of subsections can
202 from other subsections of the same type by naming the "parent" section in the "child" subsection\&. For example:
205 define dumptype global {
210 define dumptype nocomp {
211 global # inherit the parameters in dumptype \'global\'
216 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,
219 define tapetype par1 {
225 define tapetype par2 {
230 define tapetype child {
236 In this example, \'child\' will have a filemark of 32k, a speed of 400bps, and a length of 200M\&.
237 .SH "GLOBAL PARAMETERS"
239 \fBorg\fR \fIstring\fR
242 \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\&.
245 \fBmailer\fR \fIstring\fR
247 Default found by configure\&. A mail program that can send mail with \'\fIMAILER \-s "subject" user < message_file\fR\'\&.
250 \fBmailto\fR \fIstring\fR
252 Default: none\&. A space separated list of recipients for mail reports\&. If not specified, amdump will not send any mail\&.
255 \fBsend\-amreport\-on\fR [ \fBall\fR | \fBstrange\fR | \fBerror\fR | \fBnever\fR ]
258 \fBall\fR\&. Specify which types of messages will trigger an email from amreport\&. amreport is used by amdump and amflush\&.
262 Send an email on any message\&.
267 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\&.
272 Send an email only on error messages\&.
277 Never send an email\&.
281 \fBdumpcycle\fR \fIint\fR
284 \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\&.
290 .nr an-no-space-flag 1
297 This parameter may also be set in a specific
299 (see below)\&. This value sets the default for all
300 \fBdumptype\fRs so must appear in
303 \fBdumptype\fRs are defined\&.
308 \fBrunspercycle\fR \fIint\fR
311 \fIsame as dumpcycle\fR\&. The number of amdump runs in
313 days\&. A value of 0 means the same value as
314 \fBdumpcycle\fR\&. A value of \-1 means guess the number of runs from the
316 file, which is the number of tapes used in the last
322 \fBtapecycle\fR \fIint\fR
325 \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 \'\fBtapecycle\fR
326 \-1\' volumes have been written since\&.
328 It is considered good administrative practice to set the
330 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\&.
332 Note: Amanda is commonly misconfigured with
334 equal to the number of tapes per
335 \fBdumpcycle\fR\&. In this misconfiguration, amanda may erase a full dump before a new one is completed\&. Recovery is then impossible\&. The
337 must be at least one tape larger than the number of tapes per dumpcycle\&.
339 The number of tapes per dumpcycle is calculated by multiplying the number of
345 runs per dump cycle) and
347 (the number of tapes used per run)\&. Typically
349 is set to two or four times the tapes per dumpcycle\&.
352 \fBusetimestamps\fR \fIbool\fR
355 \fBYes\fR\&. This option allows Amanda to track multiple runs per calendar day\&. The only reason one might disable it is that Amanda versions before 2\&.5\&.1 can\'t read logfiles written when this option was enabled\&.
358 \fBlabel\-new\-tapes\fR \fIstring\fR
363 \fBvolume\-error empty\fR
364 to get equivalent behavior\&.
366 Default: not set\&. When set, this directive will cause Amanda to automatically write an Amanda tape label to any blank tape she encounters\&.
369 \fBautolabel\fR \fIstring\fR [\fBany\fR] [\fBother\-config\fR] [\fBnon\-amanda\fR] [\fBvolume\-error\fR] [\fBempty\fR]
371 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\&.
373 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:
374 \fBautolabel "DailySet1\-%%%" empty\fR
376 Note that many devices cannot distinguish an empty tape from an error condition, so it may is often necessary to include
378 as an autolabel condition\&.
382 equivalent to \'\fBother\-config non\-amanda volume\-error empty\fR\'
387 Label volumes with a valid Amanda label that do not match our
388 \fBlabelstr\fR\&. Danger: this may erase volumes
389 from other Amanda configurations without warning!
394 Label volumes which do not start with data that resembles an
395 Amanda header\&. Danger: this may erase volumes from other backup applications
401 Label volumes where an error occurs while trying to read the label\&.
402 Danger: this may erase arbitrary volumes due to transient errors\&.
407 Label volumes where a read returns 0 bytes\&.
411 \fBdumpuser\fR \fIstring\fR
414 \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
417 \fB\&.amandahosts\fR, depending on how the Amanda software was built\&.
420 \fBprinter\fR \fIstring\fR
422 Printer to use when doing tape labels\&. See the
428 \fBtapedev\fR \fIstring\fR
431 \fI"null:"\fR\&. This parameter can either specify a device (explicitly or by referencing a device definition \- see
432 \fBamanda-devices\fR(7)) or a tape changer (explicitly or by referencing a device definition \- see
433 \fBamanda-changers\fR(7))\&.
436 \fBdevice\-property\fR \fIstring\fR \fIstring\fR
438 These options can set various device properties\&. See
439 \fBamanda-devices\fR(7)
440 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:
442 device\-property "BLOCK_SIZE" "128k"
446 \fBproperty\fR [\fBappend\fR] \fIstring\fR \fIstring\fR+
448 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\&.
450 keyword append the values to the list of values for that property\&.
453 \fBtpchanger\fR \fIstring\fR
455 Default: not set\&. The tape changer to use\&. In most cases, only one of
459 is specified, although for backward compatibility both may be specified if
461 gives the name of an old changer script\&. See
462 \fBamanda-changers\fR(7)
463 for more information on configuring changers\&.
466 \fBchangerdev\fR \fIstring\fR
469 \fI"dev/null"\fR\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the
474 \fBchangerfile\fR \fIstring\fR
477 \fI"/usr/adm/amanda/log/changer\-status"\fR\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the
482 \fBruntapes\fR \fIint\fR
485 \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\&.
487 If a tape changer is configured, this may be set larger than one to let Amanda write to more than one tape\&.
489 Note that this is an upper bound on the number of tapes, and Amanda may use less\&.
492 \fBmaxdumpsize\fR \fIint\fR
495 \fI\fBruntapes\fR\fR\fI*\fR\fI\fBtape\-length\fR\fR\&. Maximum number of bytes the planner will schedule for a run\&.
497 The default unit is Kbytes if it is not specified\&.
500 \fBtaperalgo\fR [ \fBfirst\fR | \fBfirstfit\fR | \fBlargest\fR | \fBlargestfit\fR | \fBsmallest\fR | \fBlast\fR ]
503 \fBfirst\fR\&. The algorithm used to choose which dump image to send to the taper\&.
507 First in, first out\&.
512 The first dump image that will fit on the current tape\&.
517 The largest dump image\&.
522 The largest dump image that will fit on the current tape\&.
527 The smallest dump image\&.
532 Last in, first out\&.
536 \fBtaper\-parallel\-write\fR \fIint\fR
540 \fI1\fR\&. Amanda can write simultaneously up to that number of volume at any given time\&. The changer must have as many drives\&.
543 \fBlabelstr\fR \fIstring\fR
546 \fI"\&.*"\fR\&. The tape label constraint regular expression\&. All tape labels generated (see
547 \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\&.
550 \fBtapetype\fR \fIstring\fR
553 \fIno default\fR\&. The type of tape drive associated with
556 \fBtpchanger\fR\&. This refers to one of the defined
557 \fBtapetype\fRs in the config file (see below), which specify various tape parameters, like the
562 of the tape media and device\&.
565 \fBctimeout\fR \fIint\fR
568 \fI30 seconds\fR\&. Maximum amount of time that
570 will wait for each client host\&.
573 \fBdtimeout\fR \fIint\fR
576 \fI1800 seconds\fR\&. Amount of idle time per disk on a given client that a
580 will wait before it fails with a data timeout error\&.
583 \fBetimeout\fR \fIint\fR
586 \fI300 seconds\fR\&. Amount of time per estimate on a given client that the
590 will wait to get the dump size estimates (note: Amanda runs up to 3 estimates for each DLE)\&. For instance, with the default of 300 seconds and four DLE\'s, each estimating level 0 and level 1 on client A,
592 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\&.
595 \fBconnect\-tries\fR \fIint\fR
598 \fI3\fR\&. How many times the server will try a connection\&.
601 \fBreq\-tries\fR \fIint\fR
604 \fI3\fR\&. How many times the server will resend a REQ packet if it doesn\'t get the ACK packet\&.
607 \fBnetusage\fR \fIint\fR
610 \fI8000 Kbps\fR\&. The maximum network bandwidth allocated to Amanda, in Kbytes per second\&. See also the
615 \fBinparallel\fR \fIint\fR
618 \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\'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\&.
621 \fBdisplayunit\fR "k|m|g|t"
624 \fI"k"\fR\&. The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera\&.
627 \fBdumporder\fR \fIstring\fR
630 \fI"tttTTTTTTT"\fR\&. The priority order of each dumper:
637 b: smallest bandwidth
642 \fBmaxdumps\fR \fIint\fR
645 \fI1\fR\&. The maximum number of backups from a single host that Amanda will attempt to run in parallel\&. See also the
649 Note that this parameter may also be set in a specific
651 (see below)\&. This value sets the default for all
652 \fBdumptype\fRs so must appear in
655 \fBdumptype\fRs are defined\&.
658 \fBbumpsize\fR \fIint\fR
661 \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
665 The default unit is Kbytes if it is not specified\&.
667 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
676 \fBbumppercent\fR \fIint\fR
679 \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\&.
681 If this parameter is set to 0, the value of the parameter
683 is used to trigger bumping\&.
685 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
694 \fBbumpmult\fR \fIfloat\fR
697 \fI1\&.5\fR\&. The bump size multiplier\&. Amanda multiplies
699 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
703 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\&.
705 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
708 \fBbumpdays\fR \fIint\fR
711 \fI2 days\fR\&. To insure redundancy in the dumps, Amanda keeps filesystems at the same incremental level for at least
713 days, even if the other bump threshold criteria are met\&.
715 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
718 \fBdiskfile\fR \fIstring\fR
721 \fI"disklist"\fR\&. The file name for the
723 file holding client hosts, disks and other client dumping information\&.
726 \fBinfofile\fR \fIstring\fR
729 \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\&.
732 \fBlogdir\fR \fIstring\fR
735 \fI"/usr/adm/amanda"\fR\&. The directory for the
742 \fBindexdir\fR \fIstring\fR
745 \fI"/usr/adm/amanda/index"\fR\&. The directory where index files (backup image catalogues) are stored\&. Index files are only generated for filesystems whose
752 \fBtapelist\fR \fIstring\fR
755 \fI"tapelist"\fR\&. The file name for the active
756 \fBtapelist\fR(5)\&. Amanda maintains this file with information about the active set of tapes\&.
759 \fBdevice\-output\-buffer\-size\fR \fIint\fR
762 \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\&.
764 The default unit is bytes if it is not specified\&.
767 \fBtapebufs\fR \fIint\fR
770 \fI20\fR\&. This option is deprecated; use the
771 \fBdevice\-output\-buffer\-size\fR
774 works the same way, but the number specified is multiplied by the device blocksize prior to use\&.
777 \fBreserve\fR \fIint\fR
780 \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\&.
783 \fBautoflush\fR \fIbool\fR
786 \fBoff\fR\&. Whether an amdump run will flush the dumps from holding disk to tape\&.
789 \fBamrecover\-do\-fsf\fR \fIbool\fR
791 Deprecated; amrecover always uses fsf, and does not invoke amrestore\&.
794 \fBon\fR\&. Amrecover will call amrestore with the \-f flag for faster positioning of the tape\&.
797 \fBamrecover\-check\-label\fR \fIbool\fR
799 Deprecated; amrecover always checks the label, and does not invoke amrestore\&.
802 \fBon\fR\&. Amrecover will call amrestore with the \-l flag to check the label\&.
805 \fBamrecover\-changer\fR \fIstring\fR
807 Default: not set\&. Amrecover will use the changer if you use \'settape <string>\' and that string is the same as the
808 \fBamrecover\-changer\fR
812 \fBcolumnspec\fR \fIstring\fR
814 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"
816 Defines the width of columns
820 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 four parts specify:
830 the name of the column, which may be:
833 Compress (compression ratio)
834 Disk (client disk name)
835 DumpRate (dump rate in KBytes/sec)
836 DumpTime (total dump time in hours:minutes)
837 HostName (client host name)
839 OrigKB (original image size in KBytes)
840 OutKB (output image size in KBytes)
841 TapeRate (tape writing rate in KBytes/sec)
842 TapeTime (total tape time in hours:minutes)
854 the amount of space to display before the column (used to get whitespace between columns)\&.
865 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\&.
876 the precision of the column, number of digit after the decimal point for number\&.
882 columnspec "Disk=1:18,HostName=0:10,OrigKB=::2,OutKB=1:7"
885 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\&.
888 \fBincludefile\fR \fIstring\fR
891 \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\&.
894 \fBdebug\-days\fR \fIint\fR
897 \fI3\fR\&. The number of days the debug files are kept\&.
900 \fBdebug\-auth\fR \fIint\fR
903 \fI0\fR\&. Debug level of the auth module
906 \fBdebug\-event\fR \fIint\fR
909 \fI0\fR\&. Debug level of the event module
912 \fBdebug\-holding\fR \fIint\fR
915 \fI0\fR\&. Debug level of the holdingdisk module
918 \fBdebug\-protocol\fR \fIint\fR
921 \fI0\fR\&. Debug level of the protocol module
924 \fBdebug\-planner\fR \fIint\fR
927 \fI0\fR\&. Debug level of the planner process
930 \fBdebug\-driver\fR \fIint\fR
933 \fI0\fR\&. Debug level of the driver process
936 \fBdebug\-dumper\fR \fIint\fR
939 \fI0\fR\&. Debug level of the dumper process
942 \fBdebug\-chunker\fR \fIint\fR
945 \fI0\fR\&. Debug level of the chunker process
948 \fBdebug\-taper\fR \fIint\fR
951 \fI0\fR\&. Debug level of the taper process
954 \fBdebug\-recovery\fR \fIint\fR
957 \fI1\fR\&. Debug level of all recovery process
960 \fBflush\-threshold\-dumped\fR \fIint\fR
963 \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\&.
965 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\&.
967 The value of this parameter may not exceed than that of the
968 \fBflush\-threshold\-scheduled\fR
972 \fBflush\-threshold\-scheduled\fR \fIint\fR
975 \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
979 is the amount of data on the holding disk,
981 is the total amount of data scheduled for this run but not dumped yet,
983 is the capacity of a volume, and
985 is this parameter, expressed as a percentage\&. This parameter may be larger than 100%\&.
987 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\&.
989 The value of this parameter may not be less than that of the
990 \fBflush\-threshold\-dumped\fR
996 \fBtaperflush\fR \fIint\fR
999 \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
1003 is the amount of data remaining on the holding disk from this or previous runs,
1005 is the capacity of a volume, and
1007 is this parameter, expressed as a percentage\&. This parameter may be greater than 100%\&.
1009 The value of this parameter may not exceed that of the
1010 \fBflush\-threshold\-scheduled\fR
1013 must be set to \'yes\' if
1015 is greater than 0\&.
1018 \fBreserved\-udp\-port\fR \fIint\fR,\fIint\fR
1020 Default: \-\-with\-udpportrange or
1021 \fI512,1023\fR\&. Reserved udp port that will be used (bsd, bsdudp)\&. Range is inclusive\&.
1024 \fBreserved\-tcp\-port\fR \fIint\fR,\fIint\fR
1026 Default: \-\-with\-low\-tcpportrange or
1027 \fI512,1023\fR\&. Reserved tcp port that will be used (bsdtcp)\&. Range is inclusive\&.
1030 \fBunreserved\-tcp\-port\fR \fIint\fR,\fIint\fR
1032 Default: \-\-with\-tcpportrange or
1033 \fI1024,65535\fR\&. Unreserved tcp port that will be used (bsd, bsdudp)\&. Range is inclusive\&.
1036 \fBrecovery\-limit\fR [ \fIstring\fR | \fBsame\-host\fR ]
1038 Default: none (no limitations)\&. This parameter limits the hosts that may do remote recoveries\&. Hosts are identified by their authenticated peer name, as described in
1039 \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
1040 \fBamanda-match\fR(7)) or the special keyword same\-host, which requires an exact match to the hostname of the DLE being recovered\&. Specifying no arguments at all will disable all recoveries from any host\&.
1042 Note that match expressions can be constructed to be forgiving of e\&.g\&., fully\-qualified vs\&. unqualified hostnames, but
1044 requires an exact match\&.
1046 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\&.
1048 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\&.
1050 .SH "HOLDINGDISK SECTION"
1054 file may define one or more holding disks used as buffers to hold backup images before they are written to tape\&. The syntax is:
1056 define holdingdisk \fIname\fR {
1057 \fIholdingdisk\-option\fR \fIholdingdisk\-value\fR
1062 The { must appear at the end of a line, and the } on its own line\&.
1065 is a logical name for this holding disk\&.
1067 The options and values are:
1069 \fBcomment\fR \fIstring\fR
1071 Default: not set\&. A comment string describing this holding disk\&.
1074 \fBdirectory\fR \fIstring\fR
1077 \fI"/dumps/amanda"\fR\&. The path to this holding area\&.
1083 \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\&.
1086 \fBchunksize\fR \fIint\fR
1089 \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\&.
1091 The default unit is Kbytes if it is not specified\&.
1093 If 0 is specified, Amanda will create holding disk chunks as large as ((INT_MAX/1024)\-64) Kbytes\&.
1095 Each holding disk chunk includes a 32 Kbyte header, so the minimum chunk size is 64 Kbytes (but that would be really silly)\&.
1097 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\&.
1099 .SH "DUMPTYPE SECTION"
1102 \fBamanda.conf\fR(5)
1103 file may define multiple sets of backup options and refer to them by name from the
1105 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\&.
1107 A set of backup options are entered in a
1109 section, which looks like this:
1111 define dumptype "\fIname\fR" {
1112 \fIdumptype\-option\fR \fIdumptype\-value\fR
1117 The { must appear at the end of a line, and the } on its own line\&.
1120 is the name of this set of backup options\&. It is referenced from the
1124 Some of the options in a
1126 section are the same as those in the main part of
1127 \fBamanda.conf\fR(5)\&. The main option value is used to set the default for all
1129 sections\&. For instance, setting
1131 to 50 in the main part of the config file causes all following
1133 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
1134 \fBdumptype\fRs are defined\&.
1136 The dumptype options and values are:
1138 \fBauth\fR \fIstring\fR
1141 \fI"bsd"\fR\&. Type of authorization to perform between tape server and backup client hosts\&. See
1142 \fBamanda-auth\fR(7)
1146 \fBamandad\-path\fR \fIstring\fR
1149 \fI"$libexec/amandad"\fR\&. Specify the amandad path of the client, only use with rsh/ssh authentification\&.
1152 \fBclient\-username\fR \fIstring\fR
1155 \fICLIENT_LOGIN\fR\&. Specify the username to connect on the client, only use with rsh/ssh authentification\&.
1158 \fBclient\-port\fR [ \fIint\fR | \fIstring\fR ]
1161 \fI"amanda"\fR\&. Specifies the port to connect to on the client\&. It can be a service name or a numeric port number\&.
1164 \fBbumpsize\fR \fIint\fR
1167 \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
1171 The default unit is Kbytes if it is not specified\&.
1173 See also the options
1180 \fBbumppercent\fR \fIint\fR
1183 \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\&.
1185 If this parameter is set to 0, the value of the parameter
1187 is used to trigger bumping\&.
1189 See also the options
1196 \fBbumpmult\fR \fIfloat\fR
1199 \fI1\&.5\fR\&. The bump size multiplier\&. Amanda multiplies
1201 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
1205 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\&.
1208 \fBbumpdays\fR \fIint\fR
1211 \fI2 days\fR\&. To insure redundancy in the dumps, Amanda keeps filesystems at the same incremental level for at least
1213 days, even if the other bump threshold criteria are met\&.
1216 \fBcomment\fR \fIstring\fR
1218 Default: not set\&. A comment string describing this set of backup options\&.
1221 \fBcomprate\fR \fIfloat\fR [, \fIfloat\fR ]
1224 \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\&.
1227 \fBcompress\fR [ \fBnone\fR | \fBclient\fR | \fBserver\fR ] [ \fBbest\fR | \fBfast\fR | \fBcustom\fR ]
1230 \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\&.
1232 For either type of compression, Amanda also allows the selection of three styles of compression\&.
1234 is the best compression available, often at the expense of CPU overhead\&.
1236 is often not as good a compression as
1237 \fBbest\fR, but usually less CPU overhead\&. Or to specify
1239 to use your own compression method\&. (See dumptype custom\-compress in example/amanda\&.conf for reference)
1243 options line may be one of:
1249 compress client fast
1253 compress client best
1257 compress client custom
1260 \fBclient\-custom\-compress\fR
1263 PROG must not contain white space and it must accept \-d for uncompress\&.
1266 compress server fast
1270 compress server best
1274 compress server custom
1277 \fBserver\-custom\-compress\fR
1280 PROG must not contain white space and it must accept \-d for uncompress\&.
1283 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
1285 option), Amanda (software) compression should be disabled\&.
1288 \fBclient\-custom\-compress\fR \fIstring\fR
1290 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\&.
1293 \fBserver\-custom\-compress\fR \fIstring\fR
1295 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\&.
1298 \fBdumpcycle\fR \fIint\fR
1301 \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\&.
1304 \fBencrypt\fR [ \fBnone\fR | \fBclient\fR | \fBserver\fR ]
1306 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\&.
1310 options line may be one of:
1318 Specify client\-encrypt "PROG"
1320 PROG must not contain white space\&.
1322 Specify client\-decrypt\-option "decryption\-parameter" Default: "\-d"
1324 decryption\-parameter must not contain white space\&.
1326 (See dumptype client\-encrypt\-nocomp in example/amanda\&.conf for reference)
1331 Specify server\-encrypt "PROG"
1333 PROG must not contain white space\&.
1335 Specify server\-decrypt\-option "decryption\-parameter" Default: "\-d"
1337 decryption\-parameter must not contain white space\&.
1339 (See dumptype server\-encrypt\-fast in example/amanda\&.conf for reference)
1342 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\&.
1344 which is a wrapper of
1346 is provided as a reference symmetric encryption program\&.
1349 \fBclient\-encrypt\fR \fIstring\fR
1351 Default: none\&. The program to use to perform encryption/decryption on the client; used with "encrypt client"\&. Must not contain whitespace\&.
1354 \fBclient\-decrypt\-option\fR \fIstring\fR
1356 Default: \-d\&. The option that can be passed to client\-encrypt to make it decrypt instead\&. Must not contain whitespace\&.
1359 \fBserver\-encrypt\fR \fIstring\fR
1361 Default: none\&. The program to use to perform encryption/decryption on the server; used with "encrypt server"\&. Must not contain whitespace\&.
1364 \fBserver\-decrypt\-option\fR \fIstring\fR
1366 Default: \-d\&. The option that can be passed to server\-encrypt to make it decrypt instead\&. Must not contain whitespace\&.
1369 \fBestimate\fR [ \fBclient\fR | \fBcalcsize\fR | \fBserver\fR ]+
1372 \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:
1376 Use the same program as the dumping program\&. This is the most accurate method to do estimates, but it can take a long time\&.
1381 Use a faster program to do estimates, but the result is less accurate\&.
1386 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 \'client\' or \'calcsize\' in this case\&.
1390 \fBexclude\fR [ \fBlist\fR | \fBfile\fR ][[\fBoptional\fR][\fBappend\fR][ \fIstring\fR ]+]
1393 \fBfile\fR\&. Exclude is the opposite of
1395 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\&.
1397 There are two exclude parameters,
1407 is an exclude expression\&. With
1412 is a file name on the client containing
1414 exclude expressions\&. The path to the specified exclude list file, if present (see description of \'optional\' below), must be readable by the Amanda user\&.
1416 All exclude expressions are concatenated in one file and passed to the application as an
1417 \fB\-\-exclude\-from\fR
1421 \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\&.
1427 is appended to the current list, without it, the
1429 overwrites the list\&.
1435 \fBlist\fR, then amcheck will not complain if the file doesn\'t exist or is not readable\&.
1439 \fBlist\fR, if the file name is relative, the disk name being backed up is prepended\&. So if this is entered:
1441 exclude list "\&.amanda\&.excludes"
1443 the actual file used would be
1444 /var/\&.amanda\&.excludes
1447 /usr/local/\&.amanda\&.excludes
1449 /usr/local, and so on\&.
1452 \fBholdingdisk\fR [ \fBnever\fR | \fBauto\fR | \fBrequired\fR ]
1455 \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
1459 to avoid backing up the holding disk into itself\&.
1461 \fBnever\fR|no|false|off
1463 Never use a holdingdisk, the dump will always go directly to tape\&. There will be no dump if you have a tape error\&.
1466 \fBauto\fR|yes|true|on
1468 Use the holding disk, unless there is a problem with the holding disk, the dump won\'t fit there or the medium doesn\'t require spooling (e\&.g\&., VFS device)
1473 Always dump to holdingdisk, never directly to tape\&. There will be no dump if it doesn\'t fit on holdingdisk
1477 \fBignore\fR \fIboolean\fR
1480 \fBno\fR\&. Whether disks associated with this backup type should be backed up or not\&. This option is useful when the
1482 file is shared among several configurations, some of which should not back up all the listed file systems\&.
1485 \fBinclude\fR [ \fBlist\fR | \fBfile\fR ][[\fBoptional\fR][\fBappend\fR][ \fIstring\fR ]+]
1489 "\&."\&. There are two include lists,
1492 \fBinclude list\&.\fR
1497 is a glob expression\&. With
1501 is a file name on the client containing glob expressions\&.
1503 All include expressions are expanded by Amanda, concatenated in one file and passed to
1506 \fB\-\-files\-from\fR
1507 argument\&. They must start with "\&./" and contain no other "/"\&.
1509 Include expressions must always be specified as relative to the head directory of the DLE\&.
1515 .nr an-no-space-flag 1
1522 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\&.
1529 is appended to the current list, without it, the
1531 overwrites the list\&.
1536 \fBinclude list\fR, then amcheck will not complain if the file doesn\'t exist or is not readable\&.
1539 \fBinclude list\fR, If the file name is relative, the disk name being backed up is prepended\&.
1542 \fBindex\fR \fIboolean\fR
1545 \fBno\fR\&. Whether an index (catalogue) of the backup should be generated and saved in
1546 \fBindexdir\fR\&. These catalogues are used by the
1551 \fBkencrypt\fR \fIboolean\fR
1554 \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\&.
1557 \fBmaxdumps\fR \fIint\fR
1560 \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
1564 \fBmaxpromoteday\fR \fIint\fR
1567 \fI10000\fR\&. 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\&.
1570 \fBpriority\fR [ \fBlow\fR | \fBmedium\fR | \fBhigh\fR ]
1573 \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\&.
1576 \fBprogram\fR [ \fB"DUMP"\fR | \fB"GNUTAR"\fR | \fB"APPLICATION"\fR ]
1579 \fI"DUMP"\fR\&. The type of backup to perform\&. Valid values are:
1583 The native operating system backup program\&.
1588 To use GNU\-tar or to do PC backups using Samba\&.
1593 To use an application, see the
1599 \fBapplication\fR \fIstring\fR
1601 No default\&. Must be the name of an application if
1604 \fIAPPLICATION\fR\&. See APPLICATION SECTION below\&.
1607 \fBscript\fR \fIstring\fR
1609 No default\&. Must be the name of a script\&. You can have many script\&. See SCRIPT SECTION below\&.
1612 \fBproperty\fR [\fBappend\fR] \fIstring\fR \fIstring\fR+
1614 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\&.
1616 keyword append the values to the list of values for that property\&.
1619 \fBrecord\fR \fIboolean\fR
1622 \fByes\fR\&. Whether to ask the backup program to update its database (e\&.g\&.
1625 /usr/local/var/amanda/gnutar\-lists
1626 for GNUTAR) of time stamps\&. This is normally enabled for daily backups and turned off for periodic archival runs\&.
1629 \fBskip\-full\fR \fIboolean\fR
1636 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\&.
1639 \fBskip\-incr\fR \fIboolean\fR
1646 has scheduled an incremental backup, these disks will be skipped\&.
1649 \fBssh\-keys\fR \fIstring\fR
1651 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\&.
1654 \fBstarttime\fR \fIint\fR
1656 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
1660 \fBstrategy\fR [ \fBstandard\fR | \fBnofull\fR | \fBnoinc\fR | \fBskip\fR | \fBincronly\fR ]
1663 \fBstandard\fR\&. Strategy to use when planning what level of backup to run next\&. Values are:
1667 The standard Amanda schedule\&.
1672 Never do full backups, only level 1 incrementals\&.
1677 Never do incremental backups, only full dumps\&.
1682 Treat this DLE as if it doesn\'t exist (useful to disable DLEs when sharing the
1684 file between multiple configurations)\&. Skipped DLEs will not be checked or dumped, and will not be matched by disklist expressions\&.
1689 Only do incremental dumps\&.
1691 should be used to tell Amanda that a full dump has been performed off\-line, so that it resets to level 1\&.
1695 \fBallow\-split\fR \fIbool\fR
1697 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\&.
1700 \fBtape\-splitsize\fR \fIint\fR
1702 Deprecated\&. See "Dump Splitting Configuration" below\&.
1704 Default: not set\&. Split dump file on tape into pieces of a specified size\&. The default unit is Kbytes if it is not specified\&.
1707 \fBsplit\-diskbuffer\fR \fIstring\fR
1710 Deprecated\&. See "Dump Splitting Configuration" below\&.
1711 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\&.
1714 \fBfallback\-splitsize\fR \fIint\fR
1716 Deprecated\&. See "Dump Splitting Configuration" below\&.
1719 \fI10M\fR\&. This specifies the part size used when no
1720 \fBsplit\-diskbuffer\fR
1721 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\&.
1724 \fBrecovery\-limit\fR [ \fBsame\-host\fR | \fIstring\fR ]*
1726 Default: global value\&. This parameter overrides the global
1727 \fBrecovery\-limit\fR
1728 parameter for DLEs of this dumptype\&.
1733 entries are predefined by Amanda:
1735 define dumptype "no\-compress" {
1738 define dumptype "compress\-fast" {
1739 compress client fast
1741 define dumptype "compress\-best" {
1742 compress client best
1744 define dumptype "srvcompress" {
1745 compress server fast
1747 define dumptype "bsd\-auth" {
1750 define dumptype "no\-record" {
1753 define dumptype "no\-hold" {
1756 define dumptype "no\-full" {
1761 In addition to options in a
1763 section, one or more other
1765 names may be supplied as identifiers, which make this
1767 inherit options from other previously defined
1768 \fBdumptype\fRs\&. For instance, two sections might be the same except for the
1772 define dumptype "normal" {
1773 comment "Normal backup, no compression, do indexing"
1778 define dumptype "testing" {
1779 comment "Test backup, no compression, do indexing, no recording"
1792 \fBdumptype\fRs should reference\&. This provides an easy place to make changes that will affect every
1793 \fBdumptype\fR, although you must be careful that every dumptype explicitly inherits from the
1795 dumptype \- Amanda does not do so automatically\&.
1796 .SH "TAPETYPE SECTION"
1800 file may define multiple types of tape media and devices\&. The information is entered in a
1802 section, which looks like this in the config file:
1804 define tapetype "\fIname\fR" {
1805 \fItapetype\-option\fR \fItapetype\-value\fR
1810 The { must appear at the end of a line, and the } on its own line\&.
1813 is the name of this type of tape medium/device\&. It is referenced from the
1815 option in the main part of the config file\&.
1817 The tapetype options and values are:
1819 \fBcomment\fR \fIstring\fR
1821 Default: not set\&. A comment string describing this set of tape information\&.
1824 \fBfilemark\fR \fIint\fR
1827 \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\&.
1830 \fBlength\fR \fIint\fR
1833 \fI2000 kbytes\fR\&. How much data will fit on a tape, expressed in kbytes\&.
1835 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
1838 \fBamanda-devices\fR(7)
1842 \fBblocksize\fR \fIint\fR
1845 \fI32 kbytes\fR\&. How much data will be written in each tape record, expressed in kbytes\&. This is similar to the
1847 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\&.
1850 \fBreadblocksize\fR \fIint\fR
1854 How much data will be read in each tape record\&. This can be used to override a device\'s 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\&.
1856 The default unit is Kbytes if it is not specified\&.
1859 \fBpart\-size\fR \fIint\fR
1861 Default: none\&. This is the size (in KB if no units are specified) of each split part written to the volume\&. It is reduced to
1862 \fBpart\-cache\-max\-size\fR
1863 when part caching is required\&. If this is set to zero, then no splitting will take place; in this case, some devices can span dumps from volume to volume, while others will cause the entire dump to fail if they encounter end\-of\-medium before the dump is complete\&. See "Dump Splitting Configuration" below\&.
1866 \fBpart\-cache\-type\fR [ \fBnone\fR | \fBdisk\fR | \fBmemory\fR ]
1868 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
1869 \fBpart\-cache\-dir\fR
1870 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\&.
1873 \fBpart\-cache\-dir\fR \fIstring\fR
1875 Default: none\&. The directory in which part\-cache files can be written when caching on disk\&. See "Dump Splitting Configuration" below\&.
1878 \fBpart\-cache\-max\-size\fR \fIint\fR
1880 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\&.
1883 \fBspeed\fR \fIint\fR
1886 \fI200 bps\fR\&. How fast the drive will accept data, in bytes per second\&. This parameter is NOT currently used by Amanda\&.
1889 \fBlbl\-templ\fR \fIstring\fR
1891 Default: not set\&. A PostScript template file used by
1893 to generate labels\&. Several sample files are provided with the Amanda sources in the
1895 directory\&. See the
1897 man page for more information\&.
1900 In addition to options, another
1902 name may be supplied as an identifier, which makes this
1904 inherit options from another
1905 \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:
1907 define tapetype "DLT4000\-III" {
1908 comment "DLT4000 tape drives with Compact\-III tapes"
1909 length 12500 mbytes # 10 Gig tapes with some compression
1910 filemark 2000 kbytes
1913 define tapetype "DLT4000\-IV" {
1915 comment "DLT4000 tape drives with Compact\-IV tapes"
1916 length 25000 mbytes # 20 Gig tapes with some compression
1919 .SH "INTERFACE SECTION"
1923 file may define multiple types of network interfaces\&. The information is entered in an
1925 section, which looks like this:
1927 define interface "\fIname\fR" {
1928 \fIinterface\-option\fR \fIinterface\-value\fR
1933 The { must appear at the end of a line, and the } on its own line\&.
1936 is the name of this type of network interface\&. It is referenced from the
1940 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\&.
1942 The interface options and values are:
1944 \fBcomment\fR \fIstring\fR
1946 Default: not set\&. A comment string describing this set of network information\&.
1952 \fI8000 Kbps\fR\&. The speed of the interface in Kbytes per second\&.
1955 In addition to options, another
1957 name may be supplied as an identifier, which makes this
1959 inherit options from another
1960 \fBinterface\fR\&. At the moment, this is of little use\&.
1961 .SH "APPLICATION SECTION"
1965 file may define multiple types of application\&. The information is entered in a
1967 section, which looks like this:
1969 define application "\fIname\fR" {
1970 \fIapplication\-option\fR \fIapplication\-value\fR
1975 The { must appear at the end of a line, and the } on its own line\&.
1978 is the name of this type of application\&. It is referenced from the
1981 The application options and values are:
1983 \fBcomment\fR \fIstring\fR
1985 Default: not set\&. A comment string describing this application\&.
1988 \fBplugin\fR \fIstring\fR
1990 No default\&. Must be set to the name of the program\&. This program must be in the
1991 \fI$libexecdir/amanda/application\fR
1992 directory on the client\&.
1995 \fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
1997 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\&.
1999 keyword append the values to the list of values for that property\&.
2001 keyword disallow the setting of that property on the client\&.
2003 .SH "SCRIPT SECTION"
2007 file may define multiple types of script\&. The information is entered in a
2009 section, which looks like this:
2011 define script "\fIname\fR" {
2012 \fIscript\-option\fR \fIscript\-value\fR
2017 The { must appear at the end of a line, and the } on its own line\&.
2020 is the name of this type of script\&. It is referenced from the
2023 The script options and values are:
2025 \fBcomment\fR \fIstring\fR
2027 Default: not set\&. A comment string describing this script\&.
2030 \fBplugin\fR \fIstring\fR
2032 No default\&. Must be set to the name of the program\&. This program must be in the
2033 \fI$libexecdir/amanda/application\fR
2034 directory on the client and/or server\&.
2037 \fBorder\fR \fIint\fR
2040 \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\&.
2043 \fBexecute\-where\fR [ \fBclient\fR | \fBserver\fR ]
2046 \fBclient\fR\&. Where the script must be executed, on the client or server\&.
2049 \fBexecute\-on\fR \fIexecute_on\fR [,\fIexecute_on\fR]*
2051 No default\&. When the script must be executed, you can specify many of them:
2053 \fBpre\-dle\-amcheck\fR
2055 Execute before the amcheck command for the dle\&.
2058 \fBpre\-host\-amcheck\fR
2060 Execute before the amcheck command for all dle for the client\&.
2063 \fBpost\-dle\-amcheck\fR
2065 Execute after the amcheck command for the dle\&.
2068 \fBpost\-host\-amcheck\fR
2070 Execute after the amcheck command for all dle for the client\&.
2073 \fBpre\-dle\-estimate\fR
2075 Execute before the estimate command for the dle\&.
2078 \fBpre\-host\-estimate\fR
2080 Execute before the estimate command for all dle for the client\&.
2083 \fBpost\-dle\-estimate\fR
2085 Execute after the estimate command for the dle\&.
2088 \fBpost\-host\-estimate\fR
2090 Execute after the estimate command for all dle for the client\&.
2093 \fBpre\-dle\-backup\fR
2095 Execute before the backup command for the dle\&.
2098 \fBpre\-host\-backup\fR
2100 Execute before the backup command for all dle for the client\&. It can\'t be run on client, it must be run on server
2103 \fBpost\-dle\-backup\fR
2105 Execute after the backup command for the dle\&.
2108 \fBpost\-host\-backup\fR
2110 Execute after the backup command for all dle for the client\&. It can\'t be run on client, it must be run on server
2115 Execute before any level is recovered\&.
2120 Execute after all levels are recovered\&.
2123 \fBpre\-level\-recover\fR
2125 Execute before each level recovery\&.
2128 \fBpost\-level\-recover\fR
2130 Execute after each level recovery\&.
2133 \fBinter\-level\-recover\fR
2135 Execute between two levels of recovery\&.
2138 If you recover level 0 and 2 of the disk /usr with amrecover, it will execute:
2140 script \-\-pre\-recover
2141 script \-\-pre\-level\-recover \-\-level 0
2143 script \-\-post\-level\-recover \-\-level 0
2144 script \-\-inter\-level\-recover \-\-level 0 \-\-level 2
2145 script \-\-pre\-level\-recover \-\-level 2
2147 script \-\-post\-level\-recover \-\-level 2
2148 script \-\-post\-recover
2152 \fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
2154 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\&.
2156 keyword append the values to the list of values for that property\&.
2158 keyword disallow the setting of that property on the client\&.
2160 .SH "DEVICE SECTION"
2162 Backend storage devices are specified in
2164 in the form of "device" sections, which look like this:
2166 define device \fIname\fR {
2167 commend "\fIcomment (optional)\fR"
2168 tapedev "\fIdevice\-specifier\fR"
2169 device\-property "\fIprop\-name\fR" "\fIprop\-value\fR"
2174 The { must appear at the end of a line, and the } on its own line\&.
2177 is the user\-specified name of this device\&. It is referenced from the global
2180 \fIdevice\-specifier\fR
2181 specifies the device name to use; see
2182 \fBamanda-devices\fR(7)\&. As with most sections, the
2184 parmeter is optional and only for the user\'s convenience\&.
2186 An arbitrary number of
2187 \fIdevice\-property\fR
2188 parameters can be specified\&. Again, see
2189 \fBamanda-devices\fR(7)
2190 for information on device properties\&.
2191 .SH "CHANGER SECTION"
2193 Changers are described in
2195 in the form of "changer" sections, which look like this:
2197 define changer \fIname\fR {
2198 comment "\fIcomment (optional)\fR"
2199 tpchanger "\fIchanger\-spec\fR"
2200 changerdev "\fIdevice\-name\fR"
2201 changerfile "\fIstate\-file\fR"
2206 The { must appear at the end of a line, and the } on its own line\&.
2209 is the user\-specified name of this device\&. The remaining parameters are specific to the changer type selected\&.
2212 \fBamanda-changers\fR(7)
2213 for more information on configuring changers\&.
2214 .SH "DUMP SPLITTING CONFIGURATION"
2216 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\&.
2218 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\&.
2220 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\&.
2222 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\&.
2224 In versions of Amanda through 3\&.1\&.*, splitting was controlled by the dumptype parameters
2225 \fBtape\-splitsize\fR,
2226 \fBsplit\-diskbuffer\fR, and
2227 \fBfallback\-splitsize\fR\&. These keywords had confusing and non\-intuitive interactions, and have since been deprecated\&.
2229 If the deprecated keywords are not present, subsequent versions of Amanda use the dumptype parameter
2231 to control whether a DLE can be split, and the
2235 \fBpart\-cache\-type\fR,
2236 \fBpart\-cache\-dir\fR, and
2237 \fBpart\-cache\-max\-size\fR\&. The
2239 specifies the "normal" part size, while the
2240 \fBpart\-cache\-*\fR
2241 parameters describe how to behave when caching is required (on PORT\-WRITE)\&. Full details on these parameters are given above\&.
2245 \fBamanda-client.conf\fR(5),
2246 \fBamanda-applications\fR(7),
2247 \fBamanda-auth\fR(7),
2248 \fBamanda-changers\fR(7),
2249 \fBamanda-devices\fR(7),
2250 \fBamanda-scripts\fR(7)
2253 : http://wiki.zmanda.com/
2256 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
2258 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>