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.3.0
10 .TH "AMANDA\&.CONF" "5" "06/02/2011" "Amanda 3\&.3\&.0" "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 can contains many variables that are substituted by their values:
377 $o : org configuration
378 $b : barcode of the volume
382 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:
383 \fB"DailySet1\-%%%"\fR,
388 Note that many devices cannot distinguish an empty tape from an error condition, so it may is often necessary to include
390 as an autolabel condition\&.
394 equivalent to \'\fBother\-config non\-amanda volume\-error empty\fR\'
399 Label volumes with a valid Amanda label that do not match our
400 \fBlabelstr\fR\&. Danger: this may erase volumes
401 from other Amanda configurations without warning!
406 Label volumes which do not start with data that resembles an
407 Amanda header\&. Danger: this may erase volumes from other backup applications
413 Label volumes where an error occurs while trying to read the label\&.
414 Danger: this may erase arbitrary volumes due to transient errors\&.
419 Label volumes where a read returns 0 bytes\&.
423 \fBmeta\-autolabel\fR \fIstring\fR
425 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\&.
427 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\&.
429 When using this directive, specify the template for new meta labels\&. The template can contains many variables that are substituted by their values:
433 $o : org configuration
436 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 meta labels\&. Example:
437 \fB"DailySet1\-%%%"\fR,
441 \fBdumpuser\fR \fIstring\fR
444 \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
447 \fB\&.amandahosts\fR, depending on how the Amanda software was built\&.
450 \fBprinter\fR \fIstring\fR
452 Printer to use when doing tape labels\&. See the
458 \fBtapedev\fR \fIstring\fR
461 \fI"null:"\fR\&. This parameter can either specify a device (explicitly or by referencing a device definition \- see
462 \fBamanda-devices\fR(7)) or a tape changer (explicitly or by referencing a device definition \- see
463 \fBamanda-changers\fR(7))\&.
466 \fBdevice\-property\fR \fIstring\fR \fIstring\fR
468 These options can set various device properties\&. See
469 \fBamanda-devices\fR(7)
470 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:
472 device\-property "BLOCK_SIZE" "128k"
476 \fBproperty\fR [\fBappend\fR] \fIstring\fR \fIstring\fR+
478 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\&.
480 keyword append the values to the list of values for that property\&.
483 \fBtpchanger\fR \fIstring\fR
485 Default: not set\&. The tape changer to use\&. In most cases, only one of
489 is specified, although for backward compatibility both may be specified if
491 gives the name of an old changer script\&. See
492 \fBamanda-changers\fR(7)
493 for more information on configuring changers\&.
496 \fBinteractivity\fR \fIstring\fR
498 Default: not set\&. The interactivity module Amanda should use to interact with the user\&. See
499 \fBamanda-interactivity\fR(7)
500 for a list of modules\&.
503 \fBtaperscan\fR \fIstring\fR
505 Default: traditional\&. The taperscan module amanda should use to find a tape to write to\&. See
506 \fBamanda-taperscan\fR(7)
507 for a list of modules\&.
510 \fBchangerdev\fR \fIstring\fR
513 \fI"dev/null"\fR\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the
518 \fBchangerfile\fR \fIstring\fR
521 \fI"/usr/adm/amanda/log/changer\-status"\fR\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the
526 \fBruntapes\fR \fIint\fR
529 \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\&.
531 If a tape changer is configured, this may be set larger than one to let Amanda write to more than one tape\&.
533 Note that this is an upper bound on the number of tapes, and Amanda may use less\&.
536 \fBmaxdumpsize\fR \fIint\fR
539 \fI\fBruntapes\fR\fR\fI*\fR\fI\fBtape\-length\fR\fR\&. Maximum number of bytes the planner will schedule for a run\&.
541 The default unit is Kbytes if it is not specified\&.
544 \fBtaperalgo\fR [ \fBfirst\fR | \fBfirstfit\fR | \fBlargest\fR | \fBlargestfit\fR | \fBsmallest\fR | \fBlast\fR ]
547 \fBfirst\fR\&. The algorithm used to choose which dump image to send to the taper\&.
551 First in, first out\&.
556 The first dump image that will fit on the current tape\&.
561 The largest dump image\&.
566 The largest dump image that will fit on the current tape\&.
571 The smallest dump image\&.
576 Last in, first out\&.
580 \fBtaper\-parallel\-write\fR \fIint\fR
584 \fI1\fR\&. Amanda can write simultaneously up to that number of volume at any given time\&. The changer must have as many drives\&.
587 \fBlabelstr\fR \fIstring\fR
590 \fI"\&.*"\fR\&. The tape label constraint regular expression\&. All tape labels generated (see
591 \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\&.
594 \fBtapetype\fR \fIstring\fR
597 \fIno default\fR\&. The type of tape drive associated with
600 \fBtpchanger\fR\&. This refers to one of the defined
601 \fBtapetype\fRs in the config file (see below), which specify various tape parameters, like the
606 of the tape media and device\&.
609 \fBctimeout\fR \fIint\fR
612 \fI30 seconds\fR\&. Maximum amount of time that
614 will wait for each client host\&.
617 \fBdtimeout\fR \fIint\fR
620 \fI1800 seconds\fR\&. Amount of idle time per disk on a given client that a
624 will wait before it fails with a data timeout error\&.
627 \fBetimeout\fR \fIint\fR
630 \fI300 seconds\fR\&. Amount of time per estimate on a given client that the
634 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,
636 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\&.
639 \fBconnect\-tries\fR \fIint\fR
642 \fI3\fR\&. How many times the server will try a connection\&.
645 \fBreq\-tries\fR \fIint\fR
648 \fI3\fR\&. How many times the server will resend a REQ packet if it doesn\'t get the ACK packet\&.
651 \fBnetusage\fR \fIint\fR
654 \fI8000 Kbps\fR\&. The maximum network bandwidth allocated to Amanda, in Kbytes per second\&. See also the
659 \fBinparallel\fR \fIint\fR
662 \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\&.
665 \fBdisplayunit\fR "k|m|g|t"
668 \fI"k"\fR\&. The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera\&.
671 \fBdumporder\fR \fIstring\fR
674 \fI"tttTTTTTTT"\fR\&. The priority order of each dumper:
681 b: smallest bandwidth
686 \fBmaxdumps\fR \fIint\fR
689 \fI1\fR\&. The maximum number of backups from a single host that Amanda will attempt to run in parallel\&. See also the
693 Note that this parameter may also be set in a specific
695 (see below)\&. This value sets the default for all
696 \fBdumptype\fRs so must appear in
699 \fBdumptype\fRs are defined\&.
702 \fBbumpsize\fR \fIint\fR
705 \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
709 The default unit is Kbytes if it is not specified\&.
711 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
720 \fBbumppercent\fR \fIint\fR
723 \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\&.
725 If this parameter is set to 0, the value of the parameter
727 is used to trigger bumping\&.
729 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
738 \fBbumpmult\fR \fIfloat\fR
741 \fI1\&.5\fR\&. The bump size multiplier\&. Amanda multiplies
743 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
747 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\&.
749 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
752 \fBbumpdays\fR \fIint\fR
755 \fI2 days\fR\&. To insure redundancy in the dumps, Amanda keeps filesystems at the same incremental level for at least
757 days, even if the other bump threshold criteria are met\&.
759 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
762 \fBdiskfile\fR \fIstring\fR
765 \fI"disklist"\fR\&. The file name for the
767 file holding client hosts, disks and other client dumping information\&.
770 \fBinfofile\fR \fIstring\fR
773 \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\&.
776 \fBlogdir\fR \fIstring\fR
779 \fI"/usr/adm/amanda"\fR\&. The directory for the
786 \fBindexdir\fR \fIstring\fR
789 \fI"/usr/adm/amanda/index"\fR\&. The directory where index files (backup image catalogues) are stored\&. Index files are only generated for filesystems whose
796 \fBtapelist\fR \fIstring\fR
799 \fI"tapelist"\fR\&. The file name for the active
800 \fBtapelist\fR(5)\&. Amanda maintains this file with information about the active set of tapes\&.
803 \fBdevice\-output\-buffer\-size\fR \fIint\fR
806 \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\&.
808 The default unit is bytes if it is not specified\&.
811 \fBtapebufs\fR \fIint\fR
814 \fI20\fR\&. This option is deprecated; use the
815 \fBdevice\-output\-buffer\-size\fR
818 works the same way, but the number specified is multiplied by the device blocksize prior to use\&.
821 \fBreserve\fR \fIint\fR
824 \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\&.
827 \fBautoflush\fR \fBno\fR|\fByes\fR|\fBall\fR
830 \fBno\fR\&. Whether an amdump run will flush the dumps from holding disk to tape\&. With
831 \fByes\fR, only dump matching the command line argument are flushed\&. With
832 \fBall\fR, all dump are flushed\&.
835 \fBamrecover\-do\-fsf\fR \fIbool\fR
837 Deprecated; amrecover always uses fsf, and does not invoke amrestore\&.
840 \fBon\fR\&. Amrecover will call amrestore with the \-f flag for faster positioning of the tape\&.
843 \fBamrecover\-check\-label\fR \fIbool\fR
845 Deprecated; amrecover always checks the label, and does not invoke amrestore\&.
848 \fBon\fR\&. Amrecover will call amrestore with the \-l flag to check the label\&.
851 \fBamrecover\-changer\fR \fIstring\fR
853 Default: not set\&. Amrecover will use the changer if you use \'settape <string>\' and that string is the same as the
854 \fBamrecover\-changer\fR
858 \fBcolumnspec\fR \fIstring\fR
860 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"
862 Defines the width of columns
866 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:
876 the name of the column, which may be:
879 Compress (compression ratio)
880 Disk (client disk name)
881 DumpRate (dump rate in KBytes/sec)
882 DumpTime (total dump time in hours:minutes)
883 HostName (client host name)
885 OrigKB (original image size in KBytes)
886 OutKB (output image size in KBytes)
887 TapeRate (tape writing rate in KBytes/sec)
888 TapeTime (total tape time in hours:minutes)
900 the amount of space to display before the column (used to get whitespace between columns)\&.
911 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\&.
922 the precision of the column, number of digit after the decimal point for number\&.
928 columnspec "Disk=1:18,HostName=0:10,OrigKB=::2,OutKB=1:7"
931 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\&.
934 \fBincludefile\fR \fIstring\fR
937 \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\&.
940 \fBdebug\-days\fR \fIint\fR
943 \fI3\fR\&. The number of days the debug files are kept\&.
946 \fBdebug\-auth\fR \fIint\fR
949 \fI0\fR\&. Debug level of the auth module
952 \fBdebug\-event\fR \fIint\fR
955 \fI0\fR\&. Debug level of the event module
958 \fBdebug\-holding\fR \fIint\fR
961 \fI0\fR\&. Debug level of the holdingdisk module
964 \fBdebug\-protocol\fR \fIint\fR
967 \fI0\fR\&. Debug level of the protocol module
970 \fBdebug\-planner\fR \fIint\fR
973 \fI0\fR\&. Debug level of the planner process
976 \fBdebug\-driver\fR \fIint\fR
979 \fI0\fR\&. Debug level of the driver process
982 \fBdebug\-dumper\fR \fIint\fR
985 \fI0\fR\&. Debug level of the dumper process
988 \fBdebug\-chunker\fR \fIint\fR
991 \fI0\fR\&. Debug level of the chunker process
994 \fBdebug\-taper\fR \fIint\fR
997 \fI0\fR\&. Debug level of the taper process
1000 \fBdebug\-recovery\fR \fIint\fR
1003 \fI1\fR\&. Debug level of all recovery process
1006 \fBflush\-threshold\-dumped\fR \fIint\fR
1009 \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\&.
1011 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\&.
1013 The value of this parameter may not exceed than that of the
1014 \fBflush\-threshold\-scheduled\fR
1018 \fBflush\-threshold\-scheduled\fR \fIint\fR
1021 \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
1025 is the amount of data on the holding disk,
1027 is the total amount of data scheduled for this run but not dumped yet,
1029 is the capacity of a volume, and
1031 is this parameter, expressed as a percentage\&. This parameter may be larger than 100%\&.
1033 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\&.
1035 The value of this parameter may not be less than that of the
1036 \fBflush\-threshold\-dumped\fR
1042 \fBtaperflush\fR \fIint\fR
1045 \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
1049 is the amount of data remaining on the holding disk from this or previous runs,
1051 is the capacity of a volume, and
1053 is this parameter, expressed as a percentage\&. This parameter may be greater than 100%\&.
1055 The value of this parameter may not exceed that of the
1056 \fBflush\-threshold\-scheduled\fR
1059 must be set to \'yes\' if
1061 is greater than 0\&.
1064 \fBreserved\-udp\-port\fR \fIint\fR,\fIint\fR
1066 Default: \-\-with\-udpportrange or
1067 \fI512,1023\fR\&. Reserved udp port that will be used (bsd, bsdudp)\&. Range is inclusive\&.
1070 \fBreserved\-tcp\-port\fR \fIint\fR,\fIint\fR
1072 Default: \-\-with\-low\-tcpportrange or
1073 \fI512,1023\fR\&. Reserved tcp port that will be used (bsdtcp)\&. Range is inclusive\&.
1076 \fBunreserved\-tcp\-port\fR \fIint\fR,\fIint\fR
1078 Default: \-\-with\-tcpportrange or
1079 \fI1024,65535\fR\&. Unreserved tcp port that will be used (bsd, bsdudp)\&. Range is inclusive\&.
1082 \fBrecovery\-limit\fR [ \fIstring\fR | \fBsame\-host\fR | \fBserver\fR]
1084 Default: none (no limitations)\&. This parameter limits the hosts that may do recoveries\&. Hosts are identified by their authenticated peer name, as described in
1085 \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
1086 \fBamanda-match\fR(7)) or the special keywords
1091 keyword requires an exact match to the hostname of the DLE being recovered\&. The
1093 keyword require the connection come from the fqdn of the server\&. Specifying no arguments at all will disable all recoveries from any host\&.
1095 Note that match expressions can be constructed to be forgiving of e\&.g\&., fully\-qualified vs\&. unqualified hostnames, but
1097 requires an exact match\&.
1099 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\&.
1101 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\&.
1103 .SH "HOLDINGDISK SECTION"
1107 file may define one or more holding disks used as buffers to hold backup images before they are written to tape\&. The syntax is:
1109 define holdingdisk \fIname\fR {
1110 \fIholdingdisk\-option\fR \fIholdingdisk\-value\fR
1115 The { must appear at the end of a line, and the } on its own line\&.
1118 is a logical name for this holding disk\&.
1120 The options and values are:
1122 \fBcomment\fR \fIstring\fR
1124 Default: not set\&. A comment string describing this holding disk\&.
1127 \fBdirectory\fR \fIstring\fR
1130 \fI"/dumps/amanda"\fR\&. The path to this holding area\&.
1136 \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\&.
1139 \fBchunksize\fR \fIint\fR
1142 \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\&.
1144 The default unit is Kbytes if it is not specified\&.
1146 If 0 is specified, Amanda will create holding disk chunks as large as ((INT_MAX/1024)\-64) Kbytes\&.
1148 Each holding disk chunk includes a 32 Kbyte header, so the minimum chunk size is 64 Kbytes (but that would be really silly)\&.
1150 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\&.
1152 .SH "DUMPTYPE SECTION"
1155 \fBamanda.conf\fR(5)
1156 file may define multiple sets of backup options and refer to them by name from the
1158 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\&.
1160 A set of backup options are entered in a
1162 section, which looks like this:
1164 define dumptype "\fIname\fR" {
1165 \fIdumptype\-option\fR \fIdumptype\-value\fR
1170 The { must appear at the end of a line, and the } on its own line\&.
1173 is the name of this set of backup options\&. It is referenced from the
1177 Some of the options in a
1179 section are the same as those in the main part of
1180 \fBamanda.conf\fR(5)\&. The main option value is used to set the default for all
1182 sections\&. For instance, setting
1184 to 50 in the main part of the config file causes all following
1186 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
1187 \fBdumptype\fRs are defined\&.
1189 The dumptype options and values are:
1191 \fBauth\fR \fIstring\fR
1194 \fI"bsdtcp"\fR\&. Type of authorization to perform between tape server and backup client hosts\&. See
1195 \fBamanda-auth\fR(7)
1199 \fBamandad\-path\fR \fIstring\fR
1202 \fI"$libexec/amandad"\fR\&. Specify the amandad path of the client, only use with rsh/ssh authentification\&.
1205 \fBclient\-username\fR \fIstring\fR
1208 \fICLIENT_LOGIN\fR\&. Specify the username to connect on the client, only use with rsh/ssh authentification\&.
1211 \fBclient\-port\fR [ \fIint\fR | \fIstring\fR ]
1214 \fI"amanda"\fR\&. Specifies the port to connect to on the client\&. It can be a service name or a numeric port number\&.
1217 \fBbumpsize\fR \fIint\fR
1220 \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
1224 The default unit is Kbytes if it is not specified\&.
1226 See also the options
1233 \fBbumppercent\fR \fIint\fR
1236 \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\&.
1238 If this parameter is set to 0, the value of the parameter
1240 is used to trigger bumping\&.
1242 See also the options
1249 \fBbumpmult\fR \fIfloat\fR
1252 \fI1\&.5\fR\&. The bump size multiplier\&. Amanda multiplies
1254 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
1258 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\&.
1261 \fBbumpdays\fR \fIint\fR
1264 \fI2 days\fR\&. To insure redundancy in the dumps, Amanda keeps filesystems at the same incremental level for at least
1266 days, even if the other bump threshold criteria are met\&.
1269 \fBcomment\fR \fIstring\fR
1271 Default: not set\&. A comment string describing this set of backup options\&.
1274 \fBcomprate\fR \fIfloat\fR [, \fIfloat\fR ]
1277 \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\&.
1280 \fBcompress\fR [ \fBnone\fR | \fBclient\fR | \fBserver\fR ] [ \fBbest\fR | \fBfast\fR | \fBcustom\fR ]
1283 \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\&.
1285 For either type of compression, Amanda also allows the selection of three styles of compression\&.
1287 is the best compression available, often at the expense of CPU overhead\&.
1289 is often not as good a compression as
1290 \fBbest\fR, but usually less CPU overhead\&. Or to specify
1292 to use your own compression method\&. (See dumptype custom\-compress in example/amanda\&.conf for reference)
1296 options line may be one of:
1302 compress client fast
1306 compress client best
1310 compress client custom
1313 \fBclient\-custom\-compress\fR
1316 PROG must not contain white space and it must accept \-d for uncompress\&.
1319 compress server fast
1323 compress server best
1327 compress server custom
1330 \fBserver\-custom\-compress\fR
1333 PROG must not contain white space and it must accept \-d for uncompress\&.
1336 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
1338 option), Amanda (software) compression should be disabled\&.
1341 \fBclient\-custom\-compress\fR \fIstring\fR
1343 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\&.
1346 \fBserver\-custom\-compress\fR \fIstring\fR
1348 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\&.
1351 \fBdumpcycle\fR \fIint\fR
1354 \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\&.
1357 \fBencrypt\fR [ \fBnone\fR | \fBclient\fR | \fBserver\fR ]
1359 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\&.
1363 options line may be one of:
1371 Specify client\-encrypt "PROG"
1373 PROG must not contain white space\&.
1375 Specify client\-decrypt\-option "decryption\-parameter" Default: "\-d"
1377 decryption\-parameter must not contain white space\&.
1379 (See dumptype client\-encrypt\-nocomp in example/amanda\&.conf for reference)
1384 Specify server\-encrypt "PROG"
1386 PROG must not contain white space\&.
1388 Specify server\-decrypt\-option "decryption\-parameter" Default: "\-d"
1390 decryption\-parameter must not contain white space\&.
1392 (See dumptype server\-encrypt\-fast in example/amanda\&.conf for reference)
1395 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\&.
1397 which is a wrapper of
1399 is provided as a reference symmetric encryption program\&.
1402 \fBclient\-encrypt\fR \fIstring\fR
1404 Default: none\&. The program to use to perform encryption/decryption on the client; used with "encrypt client"\&. Must not contain whitespace\&.
1407 \fBclient\-decrypt\-option\fR \fIstring\fR
1409 Default: \-d\&. The option that can be passed to client\-encrypt to make it decrypt instead\&. Must not contain whitespace\&.
1412 \fBserver\-encrypt\fR \fIstring\fR
1414 Default: none\&. The program to use to perform encryption/decryption on the server; used with "encrypt server"\&. Must not contain whitespace\&.
1417 \fBserver\-decrypt\-option\fR \fIstring\fR
1419 Default: \-d\&. The option that can be passed to server\-encrypt to make it decrypt instead\&. Must not contain whitespace\&.
1422 \fBestimate\fR [ \fBclient\fR | \fBcalcsize\fR | \fBserver\fR ]+
1425 \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:
1429 Use the same program as the dumping program\&. This is the most accurate method to do estimates, but it can take a long time\&.
1434 Use a faster program to do estimates, but the result is less accurate\&.
1439 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\&.
1443 \fBexclude\fR [ \fBlist\fR | \fBfile\fR ][[\fBoptional\fR][\fBappend\fR][ \fIstring\fR ]+]
1446 \fBfile\fR\&. Exclude is the opposite of
1448 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\&.
1450 There are two exclude parameters,
1460 is an exclude expression\&. With
1465 is a file name on the client containing
1467 exclude expressions\&. The path to the specified exclude list file, if present (see description of \'optional\' below), must be readable by the Amanda user\&.
1469 All exclude expressions are concatenated in one file and passed to the application as an
1470 \fB\-\-exclude\-from\fR
1474 \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\&.
1480 is appended to the current list, without it, the
1482 overwrites the list\&.
1488 \fBlist\fR, then amcheck will not complain if the file doesn\'t exist or is not readable\&.
1492 \fBlist\fR, if the file name is relative, the disk name being backed up is prepended\&. So if this is entered:
1494 exclude list "\&.amanda\&.excludes"
1496 the actual file used would be
1497 /var/\&.amanda\&.excludes
1500 /usr/local/\&.amanda\&.excludes
1502 /usr/local, and so on\&.
1505 \fBholdingdisk\fR [ \fBnever\fR | \fBauto\fR | \fBrequired\fR ]
1508 \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
1512 to avoid backing up the holding disk into itself\&.
1514 \fBnever\fR|no|false|off
1516 Never use a holdingdisk, the dump will always go directly to tape\&. There will be no dump if you have a tape error\&.
1519 \fBauto\fR|yes|true|on
1521 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)
1526 Always dump to holdingdisk, never directly to tape\&. There will be no dump if it doesn\'t fit on holdingdisk
1530 \fBignore\fR \fIboolean\fR
1533 \fBno\fR\&. Whether disks associated with this backup type should be backed up or not\&. This option is useful when the
1535 file is shared among several configurations, some of which should not back up all the listed file systems\&.
1538 \fBinclude\fR [ \fBlist\fR | \fBfile\fR ][[\fBoptional\fR][\fBappend\fR][ \fIstring\fR ]+]
1542 "\&."\&. There are two include lists,
1545 \fBinclude list\&.\fR
1550 is a glob expression\&. With
1554 is a file name on the client containing glob expressions\&.
1556 All include expressions are expanded by Amanda, concatenated in one file and passed to
1559 \fB\-\-files\-from\fR
1560 argument\&. They must start with "\&./" and contain no other "/"\&.
1562 Include expressions must always be specified as relative to the head directory of the DLE\&.
1568 .nr an-no-space-flag 1
1575 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\&.
1582 is appended to the current list, without it, the
1584 overwrites the list\&.
1589 \fBinclude list\fR, then amcheck will not complain if the file doesn\'t exist or is not readable\&.
1592 \fBinclude list\fR, If the file name is relative, the disk name being backed up is prepended\&.
1595 \fBindex\fR \fIboolean\fR
1598 \fBno\fR\&. Whether an index (catalogue) of the backup should be generated and saved in
1599 \fBindexdir\fR\&. These catalogues are used by the
1604 \fBkencrypt\fR \fIboolean\fR
1607 \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\&.
1610 \fBmaxdumps\fR \fIint\fR
1613 \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
1617 \fBmaxpromoteday\fR \fIint\fR
1620 \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\&.
1623 \fBpriority\fR [ \fBlow\fR | \fBmedium\fR | \fBhigh\fR ]
1626 \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\&.
1629 \fBprogram\fR [ \fB"DUMP"\fR | \fB"GNUTAR"\fR | \fB"APPLICATION"\fR ]
1632 \fI"DUMP"\fR\&. The type of backup to perform\&. Valid values are:
1636 The native operating system backup program\&.
1641 To use GNU\-tar or to do PC backups using Samba\&.
1646 To use an application, see the
1652 \fBapplication\fR \fIstring\fR
1654 No default\&. Must be the name of an application if
1657 \fIAPPLICATION\fR\&. See APPLICATION SECTION below\&.
1660 \fBscript\fR \fIstring\fR
1662 No default\&. Must be the name of a script\&. You can have many script\&. See SCRIPT SECTION below\&.
1665 \fBproperty\fR [\fBappend\fR] \fIstring\fR \fIstring\fR+
1667 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\&.
1669 keyword append the values to the list of values for that property\&.
1672 \fBrecord\fR \fIboolean\fR
1675 \fByes\fR\&. Whether to ask the backup program to update its database (e\&.g\&.
1678 /usr/local/var/amanda/gnutar\-lists
1679 for GNUTAR) of time stamps\&. This is normally enabled for daily backups and turned off for periodic archival runs\&.
1682 \fBskip\-full\fR \fIboolean\fR
1689 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\&.
1692 \fBskip\-incr\fR \fIboolean\fR
1699 has scheduled an incremental backup, these disks will be skipped\&.
1702 \fBssh\-keys\fR \fIstring\fR
1704 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\&.
1707 \fBstarttime\fR \fIint\fR
1709 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
1713 \fBstrategy\fR [ \fBstandard\fR | \fBnofull\fR | \fBnoinc\fR | \fBskip\fR | \fBincronly\fR ]
1716 \fBstandard\fR\&. Strategy to use when planning what level of backup to run next\&. Values are:
1720 The standard Amanda schedule\&.
1725 Never do full backups, only level 1 incrementals\&.
1730 Never do incremental backups, only full dumps\&.
1735 Treat this DLE as if it doesn\'t exist (useful to disable DLEs when sharing the
1737 file between multiple configurations)\&. Skipped DLEs will not be checked or dumped, and will not be matched by disklist expressions\&.
1742 Only do incremental dumps\&.
1744 should be used to tell Amanda that a full dump has been performed off\-line, so that it resets to level 1\&.
1748 \fBallow\-split\fR \fIbool\fR
1750 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\&.
1753 \fBtape\-splitsize\fR \fIint\fR
1755 Deprecated\&. See "Dump Splitting Configuration" below\&.
1757 Default: not set\&. Split dump file on tape into pieces of a specified size\&. The default unit is Kbytes if it is not specified\&.
1760 \fBsplit\-diskbuffer\fR \fIstring\fR
1763 Deprecated\&. See "Dump Splitting Configuration" below\&.
1764 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\&.
1767 \fBfallback\-splitsize\fR \fIint\fR
1769 Deprecated\&. See "Dump Splitting Configuration" below\&.
1772 \fI10M\fR\&. This specifies the part size used when no
1773 \fBsplit\-diskbuffer\fR
1774 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\&.
1777 \fBrecovery\-limit\fR [ \fBserver\fR | \fBsame\-host\fR | \fIstring\fR ]*
1779 Default: global value\&. This parameter overrides the global
1780 \fBrecovery\-limit\fR
1781 parameter for DLEs of this dumptype\&.
1784 \fBdump\-limit\fR [ \fBserver\fR | \fBsame\-host\fR ]*
1787 \fBserver\fR\&. Specify which host can initiate a backup of the dle\&. With
1788 \fBserver\fR, the server can initiate a backup with the
1791 \fBsame\-host\fR, the client can initiate a backup with the
1798 entries are predefined by Amanda:
1800 define dumptype "no\-compress" {
1803 define dumptype "compress\-fast" {
1804 compress client fast
1806 define dumptype "compress\-best" {
1807 compress client best
1809 define dumptype "srvcompress" {
1810 compress server fast
1812 define dumptype "bsd\-auth" {
1815 define dumptype "bsdtcp\-auth" {
1818 define dumptype "no\-record" {
1821 define dumptype "no\-hold" {
1824 define dumptype "no\-full" {
1829 In addition to options in a
1831 section, one or more other
1833 names may be supplied as identifiers, which make this
1835 inherit options from other previously defined
1836 \fBdumptype\fRs\&. For instance, two sections might be the same except for the
1840 define dumptype "normal" {
1841 comment "Normal backup, no compression, do indexing"
1846 define dumptype "testing" {
1847 comment "Test backup, no compression, do indexing, no recording"
1860 \fBdumptype\fRs should reference\&. This provides an easy place to make changes that will affect every
1861 \fBdumptype\fR, although you must be careful that every dumptype explicitly inherits from the
1863 dumptype \- Amanda does not do so automatically\&.
1864 .SH "TAPETYPE SECTION"
1868 file may define multiple types of tape media and devices\&. The information is entered in a
1870 section, which looks like this in the config file:
1872 define tapetype "\fIname\fR" {
1873 \fItapetype\-option\fR \fItapetype\-value\fR
1878 The { must appear at the end of a line, and the } on its own line\&.
1881 is the name of this type of tape medium/device\&. It is referenced from the
1883 option in the main part of the config file\&.
1885 The tapetype options and values are:
1887 \fBcomment\fR \fIstring\fR
1889 Default: not set\&. A comment string describing this set of tape information\&.
1892 \fBfilemark\fR \fIint\fR
1895 \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\&.
1898 \fBlength\fR \fIint\fR
1901 \fI2000 kbytes\fR\&. How much data will fit on a tape, expressed in kbytes\&.
1903 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
1906 \fBamanda-devices\fR(7)
1910 \fBblocksize\fR \fIint\fR
1913 \fI32 kbytes\fR\&. How much data will be written in each tape record, expressed in kbytes\&. This is similar to the
1915 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\&.
1918 \fBreadblocksize\fR \fIint\fR
1922 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\&.
1924 The default unit is Kbytes if it is not specified\&.
1927 \fBpart\-size\fR \fIint\fR
1929 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
1930 \fBpart\-cache\-max\-size\fR
1931 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\&.
1934 \fBpart\-cache\-type\fR [ \fBnone\fR | \fBdisk\fR | \fBmemory\fR ]
1936 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
1937 \fBpart\-cache\-dir\fR
1938 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\&.
1941 \fBpart\-cache\-dir\fR \fIstring\fR
1943 Default: none\&. The directory in which part\-cache files can be written when caching on disk\&. See "Dump Splitting Configuration" below\&.
1946 \fBpart\-cache\-max\-size\fR \fIint\fR
1948 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\&.
1951 \fBspeed\fR \fIint\fR
1954 \fI200 bps\fR\&. How fast the drive will accept data, in bytes per second\&. This parameter is NOT currently used by Amanda\&.
1957 \fBlbl\-templ\fR \fIstring\fR
1959 Default: not set\&. A PostScript template file used by
1961 to generate labels\&. Several sample files are provided with the Amanda sources in the
1963 directory\&. See the
1965 man page for more information\&.
1968 In addition to options, another
1970 name may be supplied as an identifier, which makes this
1972 inherit options from another
1973 \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:
1975 define tapetype "DLT4000\-III" {
1976 comment "DLT4000 tape drives with Compact\-III tapes"
1977 length 12500 mbytes # 10 Gig tapes with some compression
1978 filemark 2000 kbytes
1981 define tapetype "DLT4000\-IV" {
1983 comment "DLT4000 tape drives with Compact\-IV tapes"
1984 length 25000 mbytes # 20 Gig tapes with some compression
1987 .SH "INTERFACE SECTION"
1991 file may define multiple types of network interfaces\&. The information is entered in an
1993 section, which looks like this:
1995 define interface "\fIname\fR" {
1996 \fIinterface\-option\fR \fIinterface\-value\fR
2001 The { must appear at the end of a line, and the } on its own line\&.
2004 is the name of this type of network interface\&. It is referenced from the
2008 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\&.
2010 The interface options and values are:
2012 \fBcomment\fR \fIstring\fR
2014 Default: not set\&. A comment string describing this set of network information\&.
2020 \fI8000 Kbps\fR\&. The speed of the interface in Kbytes per second\&.
2023 In addition to options, another
2025 name may be supplied as an identifier, which makes this
2027 inherit options from another
2028 \fBinterface\fR\&. At the moment, this is of little use\&.
2029 .SH "APPLICATION SECTION"
2033 file may define multiple types of application\&. The information is entered in a
2035 section, which looks like this:
2037 define application "\fIname\fR" {
2038 \fIapplication\-option\fR \fIapplication\-value\fR
2043 The { must appear at the end of a line, and the } on its own line\&.
2046 is the name of this type of application\&. It is referenced from the
2049 The application options and values are:
2051 \fBclient\-name\fR \fIstring\fR
2053 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
2055 is set then it is an error if that application is not defined on the client\&.
2059 is not set then the merge is done with the application that have the name equal to the plugin\&. eg\&. if the plugin is \'amgtar\', then the setting from the application \'amgtar\' is used if it is defined\&.
2062 \fBcomment\fR \fIstring\fR
2064 Default: not set\&. A comment string describing this application\&.
2067 \fBplugin\fR \fIstring\fR
2069 No default\&. Must be set to the name of the program\&. This program must be in the
2070 \fI$libexecdir/amanda/application\fR
2071 directory on the client\&.
2074 \fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
2076 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\&.
2078 keyword append the values to the list of values for that property\&.
2080 keyword disallow the setting of that property on the client\&.
2082 .SH "SCRIPT SECTION"
2086 file may define multiple types of script\&. The information is entered in a
2088 section, which looks like this:
2090 define script "\fIname\fR" {
2091 \fIscript\-option\fR \fIscript\-value\fR
2096 The { must appear at the end of a line, and the } on its own line\&.
2099 is the name of this type of script\&. It is referenced from the
2102 The script options and values are:
2104 \fBclient\-name\fR \fIstring\fR
2106 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
2108 is set then it is an error if that script is not defined on the client\&.
2112 is not set then the merge is done with the script that have the name equal to the plugin\&. eg\&. if the plugin is \'amlog\-script\', then the setting from the script \'amlog\-script\' is used\&.
2115 \fBcomment\fR \fIstring\fR
2117 Default: not set\&. A comment string describing this script\&.
2120 \fBplugin\fR \fIstring\fR
2122 No default\&. Must be set to the name of the program\&. This program must be in the
2123 \fI$libexecdir/amanda/application\fR
2124 directory on the client and/or server\&.
2127 \fBorder\fR \fIint\fR
2130 \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\&.
2133 \fBsingle\-execution\fR \fIboolean\fR
2136 \fIno\fR\&. The script is executed for each dle\&. If
2137 \fIyes\fR, the script is executed one time only\&.
2140 \fBexecute\-where\fR [ \fBclient\fR | \fBserver\fR ]
2143 \fBclient\fR\&. Where the script must be executed, on the client or server\&.
2146 \fBexecute\-on\fR \fIexecute_on\fR [,\fIexecute_on\fR]*
2148 No default\&. When the script must be executed, you can specify many of them:
2152 Execute before the amcheck command for all dle\&. Can only be run on server\&.
2155 \fBpre\-dle\-amcheck\fR
2157 Execute before the amcheck command for the dle\&.
2160 \fBpre\-host\-amcheck\fR
2162 Execute before the amcheck command for all dle for the client\&.
2167 Execute after the amcheck command for all dle\&. Can only be run on server\&.
2170 \fBpost\-dle\-amcheck\fR
2172 Execute after the amcheck command for the dle\&.
2175 \fBpost\-host\-amcheck\fR
2177 Execute after the amcheck command for all dle for the client\&.
2182 Execute before the estimate command for all dle\&. Can only be run on server\&.
2185 \fBpre\-dle\-estimate\fR
2187 Execute before the estimate command for the dle\&.
2190 \fBpre\-host\-estimate\fR
2192 Execute before the estimate command for all dle for the client\&.
2195 \fBpost\-estimate\fR
2197 Execute after the estimate command for all dle\&. Can only be run on server\&.
2200 \fBpost\-dle\-estimate\fR
2202 Execute after the estimate command for the dle\&.
2205 \fBpost\-host\-estimate\fR
2207 Execute after the estimate command for all dle for the client\&.
2212 Execute before the backup command for all dle\&. Can only be run on server\&.
2215 \fBpre\-dle\-backup\fR
2217 Execute before the backup command for the dle\&.
2220 \fBpre\-host\-backup\fR
2222 Execute before the backup command for all dle for the client\&. It can\'t be run on client, it must be run on server
2227 Execute after the backup command for all dle\&. Can only be run on server\&.
2230 \fBpost\-dle\-backup\fR
2232 Execute after the backup command for the dle\&.
2235 \fBpost\-host\-backup\fR
2237 Execute after the backup command for all dle for the client\&. It can\'t be run on client, it must be run on server
2242 Execute before any level is recovered\&.
2247 Execute after all levels are recovered\&.
2250 \fBpre\-level\-recover\fR
2252 Execute before each level recovery\&.
2255 \fBpost\-level\-recover\fR
2257 Execute after each level recovery\&.
2260 \fBinter\-level\-recover\fR
2262 Execute between two levels of recovery\&.
2265 If you recover level 0 and 2 of the disk /usr with amrecover, it will execute:
2267 script \-\-pre\-recover
2268 script \-\-pre\-level\-recover \-\-level 0
2270 script \-\-post\-level\-recover \-\-level 0
2271 script \-\-inter\-level\-recover \-\-level 0 \-\-level 2
2272 script \-\-pre\-level\-recover \-\-level 2
2274 script \-\-post\-level\-recover \-\-level 2
2275 script \-\-post\-recover
2279 \fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
2281 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\&.
2283 keyword append the values to the list of values for that property\&.
2285 keyword disallow the setting of that property on the client\&.
2287 .SH "DEVICE SECTION"
2289 Backend storage devices are specified in
2291 in the form of "device" sections, which look like this:
2293 define device \fIname\fR {
2294 commend "\fIcomment (optional)\fR"
2295 tapedev "\fIdevice\-specifier\fR"
2296 device\-property "\fIprop\-name\fR" "\fIprop\-value\fR"
2301 The { must appear at the end of a line, and the } on its own line\&.
2304 is the user\-specified name of this device\&. It is referenced from the global
2307 \fIdevice\-specifier\fR
2308 specifies the device name to use; see
2309 \fBamanda-devices\fR(7)\&. As with most sections, the
2311 parmeter is optional and only for the user\'s convenience\&.
2313 An arbitrary number of
2314 \fIdevice\-property\fR
2315 parameters can be specified\&. Again, see
2316 \fBamanda-devices\fR(7)
2317 for information on device properties\&.
2318 .SH "CHANGER SECTION"
2320 Changers are described in
2322 in the form of "changer" sections, which look like this:
2324 define changer \fIname\fR {
2325 comment "\fIcomment (optional)\fR"
2326 tpchanger "\fIchanger\-spec\fR"
2327 changerdev "\fIdevice\-name\fR"
2328 changerfile "\fIstate\-file\fR"
2333 The { must appear at the end of a line, and the } on its own line\&.
2336 is the user\-specified name of this device\&. The remaining parameters are specific to the changer type selected\&.
2339 \fBamanda-changers\fR(7)
2340 for more information on configuring changers\&.
2341 .SH "INTERACTIVITY SECTION"
2345 file may define multiple interactivyt methods, although only one will be used \- that specified by the
2347 parameter\&. The information is entered in a
2349 section, which looks like this:
2351 define interactivity \fIname\fR {
2352 \fIinteractivity\-option\fR \fIinteractivity\-value\fR
2357 The { must appear at the end of a line, and the } on its own line\&.
2360 is the user\-specified name of this interactivity\&. The remaining parameters are specific to the interactivity type selected\&.
2362 The interactivity options and values are:
2364 \fBcomment\fR \fIstring\fR
2366 Default: not set\&. A comment string describing this interactivity\&.
2369 \fBplugin\fR \fIstring\fR
2371 No default\&. Must be set to the name of the interactivity module, as described in
2372 \fBamanda-interactivity\fR(7)\&.
2375 \fBproperty\fR [\fBappend\fR] \fIstring\fR \fIstring\fR+
2377 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
2379 keyword appends the given values to an existing list of values for that property\&.
2383 \fBamanda-interactivity\fR(7)
2384 for more information on configuring interactivity methods\&.
2385 .SH "TAPERSCAN SECTION"
2389 file may define multiple taperscan methods, although only one will be used \- that specified by the
2391 parameter\&. The information is entered in a
2393 section, which looks like this:
2395 define taperscan \fIname\fR {
2396 \fItaperscan\-option\fR \fItaperscan\-value\fR
2401 The { must appear at the end of a line, and the } on its own line\&.
2404 is the user\-specified name of this taperscan\&. The remaining parameters are specific to the taperscan type selected\&.
2406 The taperscan options and values are:
2408 \fBcomment\fR \fIstring\fR
2410 Default: not set\&. A comment string describing this taperscan\&.
2413 \fBplugin\fR \fIstring\fR
2415 No default\&. Must be set to the name of the taperscan module\&. See
2417 for a list of defined taperscan modules\&.
2420 \fBproperty\fR [\fBappend\fR] \fIstring\fR \fIstring\fR+
2422 No default\&. Operates just like properties for interactivity methods, above\&.
2426 \fBamanda-taperscan\fR(7)
2427 for more information on configuring taperscan\&.
2428 .SH "DUMP SPLITTING CONFIGURATION"
2430 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\&.
2432 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\&.
2434 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\&.
2436 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\&.
2438 In versions of Amanda through 3\&.1\&.*, splitting was controlled by the dumptype parameters
2439 \fBtape\-splitsize\fR,
2440 \fBsplit\-diskbuffer\fR, and
2441 \fBfallback\-splitsize\fR\&. These keywords had confusing and non\-intuitive interactions, and have since been deprecated\&.
2443 If the deprecated keywords are not present, subsequent versions of Amanda use the dumptype parameter
2445 to control whether a DLE can be split, and the
2449 \fBpart\-cache\-type\fR,
2450 \fBpart\-cache\-dir\fR, and
2451 \fBpart\-cache\-max\-size\fR\&. The
2453 specifies the "normal" part size, while the
2454 \fBpart\-cache\-*\fR
2455 parameters describe how to behave when caching is required (on PORT\-WRITE)\&. Full details on these parameters are given above\&.
2459 \fBamanda-client.conf\fR(5),
2460 \fBamanda-applications\fR(7),
2461 \fBamanda-auth\fR(7),
2462 \fBamanda-changers\fR(7),
2463 \fBamanda-devices\fR(7),
2464 \fBamanda-interactivity\fR(7),
2465 \fBamanda-scripts\fR(7),
2466 \fBamanda-taperscan\fR(7)
2469 : http://wiki.zmanda.com/
2472 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
2474 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>
projects / debian / amanda / blob