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.1.0
10 .TH "AMANDA\&.CONF" "5" "06/01/2010" "Amanda 3\&.1\&.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\&.
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 noincr # 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\&. Typically tapes are used by Amanda in an ordered rotation\&. The
327 parameter defines the size of that rotation\&. This parameter must be be larger than the number of tapes used in a dumpcycle\&.
329 The number of tapes per dumpcycle is calculated by multiplying the number of
335 runs per dump cycle) and
337 (the number of tapes used per run)\&. Typically
339 is set to two or four times the tapes per dumpcycle\&.
345 .nr an-no-space-flag 1
352 Amanda is commonly misconfigured with \fBtapecycle\fR
353 equal to the number of tapes per \fBdumpcycle\fR\&. In this
354 misconfiguration, amanda may erase a full dump before a new one is completed,
355 the recovery is then impossible\&. tapecycle must be at least one tape larger
356 than the number of tapes per dumpcycle\&.
359 While Amanda is always willing to use a new tape in its rotation, it refuses to reuse a tape until at least \'\fBtapecycle\fR
360 \-1\' number of other tapes have been used\&.
362 It is considered good administrative practice to set the
364 parameter slightly lower than the actual number of tapes in rotation\&. This allows the administrator to more easily cope with damaged or misplaced tapes or schedule adjustments that call for slight adjustments in the rotation order\&.
367 \fBusetimestamps\fR \fIbool\fR
370 \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\&.
373 \fBlabel_new_tapes\fR \fIstring\fR
379 Default: not set\&. When set, this directive will cause Amanda to automatically write an Amanda tape label to any blank tape she encounters\&. This option is DANGEROUS because when set, Amanda will ERASE any non\-Amanda tapes you may have, and may also ERASE any near\-failing tapes\&. Use with caution\&.
381 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:
382 \fBlabel_new_tapes "DailySet1\-%%%"\fR
385 \fBautolabel\fR \fIstring\fR [\fBany\fR] [\fBother_config\fR] [\fBnon_amanda\fR] [\fBvolume_error\fR] [\fBempty\fR]
387 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\&.
389 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:
390 \fBautolabel "DailySet1\-%%%" empty\fR
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 \fBdumpuser\fR \fIstring\fR
426 \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
429 \fB\&.amandahosts\fR, depending on how the Amanda software was built\&.
432 \fBprinter\fR \fIstring\fR
434 Printer to use when doing tape labels\&. See the
440 \fBtapedev\fR \fIstring\fR
443 \fI"null:"\fR\&. The device name, referencing the name of a "device" section in the configuration file\&. See
444 \fBamanda-devices\fR(7)
445 for more information on device names\&.
447 If a tape changer is configured (see the
449 option), this option might not be used\&.
454 \fBnull:\fR, programs such as
456 will run normally but all images will be thrown away\&. This should only be used for debugging and testing, and probably only with the
462 \fBdevice_property\fR \fIstring\fR \fIstring\fR
464 These options can set various device properties\&. See
465 \fBamanda-devices\fR(7)
466 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:
468 device_property "BLOCK_SIZE" "128k"
472 \fBproperty\fR [\fBappend\fR] \fIstring\fR \fIstring\fR+
474 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\&.
476 keyword append the values to the list of values for that property\&.
479 \fBtpchanger\fR \fIstring\fR
481 Default: not set\&. The name of the tape changer\&. If a tape changer is not configured, this option is not used and should be commented out of the configuration file\&.
483 If a tape changer is configured, choose one of the changer scripts (e\&.g\&.
484 \fBchg\-scsi\fR) and enter that here\&.
487 \fBchangerdev\fR \fIstring\fR
490 \fI"dev/null"\fR\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the
495 \fBchangerfile\fR \fIstring\fR
498 \fI"usr/adm/amanda/log/changer\-status"\fR\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the
503 \fBruntapes\fR \fIint\fR
506 \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\&.
508 If a tape changer is configured, this may be set larger than one to let Amanda write to more than one tape\&.
510 Note that this is an upper bound on the number of tapes, and Amanda may use less\&.
512 Also note that as of this release, Amanda does not support true tape overflow\&. When it reaches the end of one tape, the backup image Amanda was processing starts over again on the next tape\&.
515 \fBmaxdumpsize\fR \fIint\fR
518 \fI\fBruntapes\fR\fR\fI*\fR\fI\fBtape_length\fR\fR\&. Maximum number of bytes the planner will schedule for a run\&.
520 The default unit is Kbytes if it is not specified\&.
523 \fBtaperalgo\fR [ \fBfirst\fR | \fBfirstfit\fR | \fBlargest\fR | \fBlargestfit\fR | \fBsmallest\fR | \fBlast\fR ]
526 \fBfirst\fR\&. The algorithm used to choose which dump image to send to the taper\&.
530 First in, first out\&.
535 The first dump image that will fit on the current tape\&.
540 The largest dump image\&.
545 The largest dump image that will fit on the current tape\&.
550 The smallest dump image\&.
555 Last in, first out\&.
559 \fBlabelstr\fR \fIstring\fR
562 \fI"\&.*"\fR\&. The tape label constraint regular expression\&. All tape labels generated (see
563 \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\&.
566 \fBtapetype\fR \fIstring\fR
569 \fIno default\fR\&. The type of tape drive associated with
572 \fBtpchanger\fR\&. This refers to one of the defined
573 \fBtapetype\fRs in the config file (see below), which specify various tape parameters, like the
578 of the tape media and device\&.
581 \fBctimeout\fR \fIint\fR
584 \fI30 seconds\fR\&. Maximum amount of time that
586 will wait for each client host\&.
589 \fBdtimeout\fR \fIint\fR
592 \fI1800 seconds\fR\&. Amount of idle time per disk on a given client that a
596 will wait before it fails with a data timeout error\&.
599 \fBetimeout\fR \fIint\fR
602 \fI300 seconds\fR\&. Amount of time per estimate on a given client that the
606 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,
608 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\&.
611 \fBconnect_tries\fR \fIint\fR
614 \fI3\fR\&. How many times the server will try a connection\&.
617 \fBreq_tries\fR \fIint\fR
620 \fI3\fR\&. How many times the server will resend a REQ packet if it doesn\'t get the ACK packet\&.
623 \fBnetusage\fR \fIint\fR
626 \fI8000 Kbps\fR\&. The maximum network bandwidth allocated to Amanda, in Kbytes per second\&. See also the
631 \fBinparallel\fR \fIint\fR
634 \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\&.
637 \fBdisplayunit\fR "k|m|g|t"
640 \fI"k"\fR\&. The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera\&.
643 \fBdumporder\fR \fIstring\fR
646 \fI"tttTTTTTTT"\fR\&. The priority order of each dumper:
653 b: smallest bandwidth
658 \fBmaxdumps\fR \fIint\fR
661 \fI1\fR\&. The maximum number of backups from a single host that Amanda will attempt to run in parallel\&. See also the
665 Note that this parameter may also be set in a specific
667 (see below)\&. This value sets the default for all
668 \fBdumptype\fRs so must appear in
671 \fBdumptype\fRs are defined\&.
674 \fBbumpsize\fR \fIint\fR
677 \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
681 The default unit is Kbytes if it is not specified\&.
683 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
692 \fBbumppercent\fR \fIint\fR
695 \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\&.
697 If this parameter is set to 0, the value of the parameter
699 is used to trigger bumping\&.
701 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
710 \fBbumpmult\fR \fIfloat\fR
713 \fI1\&.5\fR\&. The bump size multiplier\&. Amanda multiplies
715 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
719 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\&.
721 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
724 \fBbumpdays\fR \fIint\fR
727 \fI2 days\fR\&. To insure redundancy in the dumps, Amanda keeps filesystems at the same incremental level for at least
729 days, even if the other bump threshold criteria are met\&.
731 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
734 \fBdiskfile\fR \fIstring\fR
737 \fI"disklist"\fR\&. The file name for the
739 file holding client hosts, disks and other client dumping information\&.
742 \fBinfofile\fR \fIstring\fR
745 \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\&.
748 \fBlogdir\fR \fIstring\fR
751 \fI"/usr/adm/amanda"\fR\&. The directory for the
758 \fBindexdir\fR \fIstring\fR
761 \fI"/usr/adm/amanda/index"\fR\&. The directory where index files (backup image catalogues) are stored\&. Index files are only generated for filesystems whose
768 \fBtapelist\fR \fIstring\fR
771 \fI"tapelist"\fR\&. The file name for the active
772 \fBtapelist\fR(5)\&. Amanda maintains this file with information about the active set of tapes\&.
775 \fBdevice_output_buffer_size\fR \fIint\fR
778 \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\&.
780 The default unit is bytes if it is not specified\&.
783 \fBtapebufs\fR \fIint\fR
786 \fI20\fR\&. This option is deprecated; use the
787 \fBdevice_output_buffer_size\fR
790 works the same way, but the number specified is multiplied by the device blocksize prior to use\&.
793 \fBreserve\fR \fIint\fR
796 \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\&.
799 \fBautoflush\fR \fIbool\fR
802 \fBoff\fR\&. Whether an amdump run will flush the dumps from holding disk to tape\&.
805 \fBamrecover_do_fsf\fR \fIbool\fR
808 \fBon\fR\&. Amrecover will call amrestore with the \-f flag for faster positioning of the tape\&.
811 \fBamrecover_check_label\fR \fIbool\fR
814 \fBon\fR\&. Amrecover will call amrestore with the \-l flag to check the label\&.
817 \fBamrecover_changer\fR \fIstring\fR
819 Default: not set\&. Amrecover will use the changer if you use \'settape <string>\' and that string is the same as the amrecover_changer setting\&.
822 \fBcolumnspec\fR \fIstring\fR
824 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"
826 Defines the width of columns
830 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:
840 the name of the column, which may be:
843 Compress (compression ratio)
844 Disk (client disk name)
845 DumpRate (dump rate in KBytes/sec)
846 DumpTime (total dump time in hours:minutes)
847 HostName (client host name)
849 OrigKB (original image size in KBytes)
850 OutKB (output image size in KBytes)
851 TapeRate (tape writing rate in KBytes/sec)
852 TapeTime (total tape time in hours:minutes)
864 the amount of space to display before the column (used to get whitespace between columns)\&.
875 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\&.
886 the precision of the column, number of digit after the decimal point for number\&.
892 columnspec "Disk=1:18,HostName=0:10,OrigKB=::2,OutKB=1:7"
895 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\&.
898 \fBincludefile\fR \fIstring\fR
901 \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\&.
904 \fBdebug_days\fR \fIint\fR
907 \fI3\fR\&. The number of days the debug files are kept\&.
910 \fBdebug_auth\fR \fIint\fR
913 \fI0\fR\&. Debug level of the auth module
916 \fBdebug_event\fR \fIint\fR
919 \fI0\fR\&. Debug level of the event module
922 \fBdebug_holding\fR \fIint\fR
925 \fI0\fR\&. Debug level of the holdingdisk module
928 \fBdebug_protocol\fR \fIint\fR
931 \fI0\fR\&. Debug level of the protocol module
934 \fBdebug_planner\fR \fIint\fR
937 \fI0\fR\&. Debug level of the planner process
940 \fBdebug_driver\fR \fIint\fR
943 \fI0\fR\&. Debug level of the driver process
946 \fBdebug_dumper\fR \fIint\fR
949 \fI0\fR\&. Debug level of the dumper process
952 \fBdebug_chunker\fR \fIint\fR
955 \fI0\fR\&. Debug level of the chunker process
958 \fBdebug_taper\fR \fIint\fR
961 \fI0\fR\&. Debug level of the taper process
964 \fBflush\-threshold\-dumped\fR \fIint\fR
967 \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\&.
969 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\&.
971 The value of this parameter may not exceed than that of the
972 \fBflush\-threshold\-scheduled\fR
976 \fBflush\-threshold\-scheduled\fR \fIint\fR
979 \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
983 is the amount of data on the holding disk,
985 is the total amount of data scheduled for this run but not dumped yet,
987 is the capacity of a volume, and
989 is this parameter, expressed as a percentage\&. This parameter may be larger than 100%\&.
991 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\&.
993 The value of this parameter may not be less than that of the
994 \fBflush\-threshold\-dumped\fR
1000 \fBtaperflush\fR \fIint\fR
1003 \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
1007 is the amount of data remaining on the holding disk from this or previous runs,
1009 is the capacity of a volume, and
1011 is this parameter, expressed as a percentage\&. This parameter may be greater than 100%\&.
1013 The value of this parameter may not exceed that of the
1014 \fBflush\-threshold\-scheduled\fR
1017 must be set to \'yes\' if
1019 is greater than 0\&.
1022 \fBreserved\-udp\-port\fR \fIint\fR,\fIint\fR
1024 Default: \-\-with\-udpportrange or
1025 \fI512,1023\fR\&. Reserved udp port that will be used (bsd, bsdudp)\&. Range is inclusive\&.
1028 \fBreserved\-tcp\-port\fR \fIint\fR,\fIint\fR
1030 Default: \-\-with\-low\-tcpportrange or
1031 \fI512,1023\fR\&. Reserved tcp port that will be used (bsdtcp)\&. Range is inclusive\&.
1034 \fBunreserved\-tcp\-port\fR \fIint\fR,\fIint\fR
1036 Default: \-\-with\-tcpportrange or
1037 \fI1024,65535\fR\&. Unreserved tcp port that will be used (bsd, bsdudp)\&. Range is inclusive\&.
1039 .SH "HOLDINGDISK SECTION"
1043 file may define one or more holding disks used as buffers to hold backup images before they are written to tape\&. The syntax is:
1045 define holdingdisk \fIname\fR {
1046 \fIholdingdisk\-option\fR \fIholdingdisk\-value\fR
1051 The { must appear at the end of a line, and the } on its own line\&.
1054 is a logical name for this holding disk\&.
1056 The options and values are:
1058 \fBcomment\fR \fIstring\fR
1060 Default: not set\&. A comment string describing this holding disk\&.
1063 \fBdirectory\fR \fIstring\fR
1066 \fI"/dumps/amanda"\fR\&. The path to this holding area\&.
1072 \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\&.
1075 \fBchunksize\fR \fIint\fR
1078 \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\&.
1080 The default unit is Kbytes if it is not specified\&.
1082 If 0 is specified, Amanda will create holding disk chunks as large as ((INT_MAX/1024)\-64) Kbytes\&.
1084 Each holding disk chunk includes a 32 Kbyte header, so the minimum chunk size is 64 Kbytes (but that would be really silly)\&.
1086 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\&.
1088 .SH "DUMPTYPE SECTION"
1091 \fBamanda.conf\fR(5)
1092 file may define multiple sets of backup options and refer to them by name from the
1094 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\&.
1096 A set of backup options are entered in a
1098 section, which looks like this:
1100 define dumptype "\fIname\fR" {
1101 \fIdumptype\-option\fR \fIdumptype\-value\fR
1106 The { must appear at the end of a line, and the } on its own line\&.
1109 is the name of this set of backup options\&. It is referenced from the
1113 Some of the options in a
1115 section are the same as those in the main part of
1116 \fBamanda.conf\fR(5)\&. The main option value is used to set the default for all
1118 sections\&. For instance, setting
1120 to 50 in the main part of the config file causes all following
1122 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
1123 \fBdumptype\fRs are defined\&.
1125 The dumptype options and values are:
1127 \fBauth\fR \fIstring\fR
1130 \fI"bsd"\fR\&. Type of authorization to perform between tape server and backup client hosts\&. See
1131 \fBamanda-auth\fR(7)
1135 \fBamandad_path\fR \fIstring\fR
1138 \fI"$libexec/amandad"\fR\&. Specify the amandad path of the client, only use with rsh/ssh authentification\&.
1141 \fBclient_username\fR \fIstring\fR
1144 \fICLIENT_LOGIN\fR\&. Specify the username to connect on the client, only use with rsh/ssh authentification\&.
1147 \fBclient_port\fR [ \fIint\fR | \fIstring\fR ]
1150 \fI"amanda"\fR\&. Specifies the port to connect to on the client\&. It can be a service name or a numeric port number\&.
1153 \fBbumpsize\fR \fIint\fR
1156 \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
1160 The default unit is Kbytes if it is not specified\&.
1162 See also the options
1169 \fBbumppercent\fR \fIint\fR
1172 \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\&.
1174 If this parameter is set to 0, the value of the parameter
1176 is used to trigger bumping\&.
1178 See also the options
1185 \fBbumpmult\fR \fIfloat\fR
1188 \fI1\&.5\fR\&. The bump size multiplier\&. Amanda multiplies
1190 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
1194 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\&.
1197 \fBbumpdays\fR \fIint\fR
1200 \fI2 days\fR\&. To insure redundancy in the dumps, Amanda keeps filesystems at the same incremental level for at least
1202 days, even if the other bump threshold criteria are met\&.
1205 \fBcomment\fR \fIstring\fR
1207 Default: not set\&. A comment string describing this set of backup options\&.
1210 \fBcomprate\fR \fIfloat\fR [, \fIfloat\fR ]
1213 \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\&.
1216 \fBcompress\fR [ \fBnone\fR | \fBclient\fR | \fBserver\fR ] [ \fBbest\fR | \fBfast\fR | \fBcustom\fR ]
1219 \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\&.
1221 For either type of compression, Amanda also allows the selection of three styles of compression\&.
1223 is the best compression available, often at the expense of CPU overhead\&.
1225 is often not as good a compression as
1226 \fBbest\fR, but usually less CPU overhead\&. Or to specify
1228 to use your own compression method\&. (See dumptype custom\-compress in example/amanda\&.conf for reference)
1232 options line may be one of:
1238 compress client fast
1242 compress client best
1246 compress client custom
1249 \fIclient_custom_compress\fR
1252 PROG must not contain white space and it must accept \-d for uncompress\&.
1255 compress server fast
1259 compress server best
1263 compress server custom
1266 \fBserver_custom_compress\fR
1269 PROG must not contain white space and it must accept \-d for uncompress\&.
1272 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
1274 option), Amanda (software) compression should be disabled\&.
1277 \fBclient_custom_compress\fR \fIstring\fR
1279 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\&.
1282 \fBserver_custom_compress\fR \fIstring\fR
1284 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\&.
1287 \fBdumpcycle\fR \fIint\fR
1290 \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\&.
1293 \fBencrypt\fR [ \fBnone\fR | \fBclient\fR | \fBserver\fR ]
1295 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\&.
1299 options line may be one of:
1307 Specify client_encrypt "PROG"
1309 PROG must not contain white space\&.
1311 Specify client_decrypt_option "decryption\-parameter" Default: "\-d"
1313 decryption\-parameter must not contain white space\&.
1315 (See dumptype client\-encrypt\-nocomp in example/amanda\&.conf for reference)
1320 Specify server_encrypt "PROG"
1322 PROG must not contain white space\&.
1324 Specify server_decrypt_option "decryption\-parameter" Default: "\-d"
1326 decryption\-parameter must not contain white space\&.
1328 (See dumptype server\-encrypt\-fast in example/amanda\&.conf for reference)
1331 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\&.
1333 which is a wrapper of
1335 is provided as a reference symmetric encryption program\&.
1338 \fBclient_encrypt\fR \fIstring\fR
1340 Default: none\&. The program to use to perform encryption/decryption on the client; used with "encrypt client"\&. Must not contain whitespace\&.
1343 \fBclient_decrypt_option\fR \fIstring\fR
1345 Default: \-d\&. The option that can be passed to client_encrypt to make it decrypt instead\&. Must not contain whitespace\&.
1348 \fBserver_encrypt\fR \fIstring\fR
1350 Default: none\&. The program to use to perform encryption/decryption on the server; used with "encrypt server"\&. Must not contain whitespace\&.
1353 \fBserver_decrypt_option\fR \fIstring\fR
1355 Default: \-d\&. The option that can be passed to server_encrypt to make it decrypt instead\&. Must not contain whitespace\&.
1358 \fBestimate\fR [ \fBclient\fR | \fBcalcsize\fR | \fBserver\fR ]+
1361 \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:
1365 Use the same program as the dumping program\&. This is the most accurate method to do estimates, but it can take a long time\&.
1370 Use a faster program to do estimates, but the result is less accurate\&.
1375 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\&.
1379 \fBexclude\fR [ \fBlist\fR | \fBfile\fR ][[\fBoptional\fR][\fBappend\fR][ \fIstring\fR ]+]
1382 \fBfile\fR\&. Exclude is the opposite of
1384 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\&.
1386 There are two exclude parameters,
1396 is an exclude expression\&. With
1401 is a file name on the client containing
1403 exclude expressions\&. The path to the specified exclude list file, if present (see description of \'optional\' below), must be readable by the Amanda user\&.
1405 All exclude expressions are concatenated in one file and passed to the application as an
1406 \fB\-\-exclude\-from\fR
1410 \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\&.
1416 is appended to the current list, without it, the
1418 overwrites the list\&.
1424 \fBlist\fR, then amcheck will not complain if the file doesn\'t exist or is not readable\&.
1428 \fBlist\fR, if the file name is relative, the disk name being backed up is prepended\&. So if this is entered:
1430 exclude list "\&.amanda\&.excludes"
1432 the actual file used would be
1433 /var/\&.amanda\&.excludes
1436 /usr/local/\&.amanda\&.excludes
1438 /usr/local, and so on\&.
1441 \fBholdingdisk\fR [ \fBnever\fR | \fBauto\fR | \fBrequired\fR ]
1444 \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
1448 to avoid backing up the holding disk into itself\&.
1450 \fBnever\fR|no|false|off
1452 Never use a holdingdisk, the dump will always go directly to tape\&. There will be no dump if you have a tape error\&.
1455 \fBauto\fR|yes|true|on
1457 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)
1462 Always dump to holdingdisk, never directly to tape\&. There will be no dump if it doesn\'t fit on holdingdisk
1466 \fBignore\fR \fIboolean\fR
1469 \fBno\fR\&. Whether disks associated with this backup type should be backed up or not\&. This option is useful when the
1471 file is shared among several configurations, some of which should not back up all the listed file systems\&.
1474 \fBinclude\fR [ \fBlist\fR | \fBfile\fR ][[\fBoptional\fR][\fBappend\fR][ \fIstring\fR ]+]
1478 "\&."\&. There are two include lists,
1481 \fBinclude list\&.\fR
1486 is a glob expression\&. With
1490 is a file name on the client containing glob expressions\&.
1492 All include expressions are expanded by Amanda, concatenated in one file and passed to
1495 \fB\-\-files\-from\fR
1496 argument\&. They must start with "\&./" and contain no other "/"\&.
1498 Include expressions must always be specified as relative to the head directory of the DLE\&.
1504 .nr an-no-space-flag 1
1511 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\&.
1518 is appended to the current list, without it, the
1520 overwrites the list\&.
1525 \fBinclude list\fR, then amcheck will not complain if the file doesn\'t exist or is not readable\&.
1528 \fBinclude list\fR, If the file name is relative, the disk name being backed up is prepended\&.
1531 \fBindex\fR \fIboolean\fR
1534 \fBno\fR\&. Whether an index (catalogue) of the backup should be generated and saved in
1535 \fBindexdir\fR\&. These catalogues are used by the
1540 \fBkencrypt\fR \fIboolean\fR
1543 \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\&.
1546 \fBmaxdumps\fR \fIint\fR
1549 \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
1553 \fBmaxpromoteday\fR \fIint\fR
1556 \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\&.
1559 \fBpriority\fR [ \fBlow\fR | \fBmedium\fR | \fBhigh\fR ]
1562 \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\&.
1565 \fBprogram\fR [ \fB"DUMP"\fR | \fB"GNUTAR"\fR | \fB"APPLICATION"\fR ]
1568 \fI"DUMP"\fR\&. The type of backup to perform\&. Valid values are:
1572 The native operating system backup program\&.
1577 To use GNU\-tar or to do PC backups using Samba\&.
1582 To use an application, see the
1588 \fBapplication\fR \fIstring\fR
1590 No default\&. Must be the name of an application if
1593 \fIAPPLICATION\fR\&. See APPLICATION SECTION below\&.
1596 \fBscript\fR \fIstring\fR
1598 No default\&. Must be the name of a script\&. You can have many script\&. See SCRIPT SECTION below\&.
1601 \fBproperty\fR [\fBappend\fR] \fIstring\fR \fIstring\fR+
1603 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\&.
1605 keyword append the values to the list of values for that property\&.
1608 \fBrecord\fR \fIboolean\fR
1611 \fIyes\fR\&. Whether to ask the backup program to update its database (e\&.g\&.
1614 /usr/local/var/amanda/gnutar\-lists
1615 for GNUTAR) of time stamps\&. This is normally enabled for daily backups and turned off for periodic archival runs\&.
1618 \fBskip\-full\fR \fIboolean\fR
1625 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\&.
1628 \fBskip\-incr\fR \fIboolean\fR
1635 has scheduled an incremental backup, these disks will be skipped\&.
1638 \fBssh_keys\fR \fIstring\fR
1640 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\&.
1643 \fBstarttime\fR \fIint\fR
1645 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
1649 \fBstrategy\fR [ \fBstandard\fR | \fBnofull\fR | \fBnoinc\fR | \fBskip\fR | \fBincronly\fR ]
1652 \fBstandard\fR\&. Strategy to use when planning what level of backup to run next\&. Values are:
1656 The standard Amanda schedule\&.
1661 Never do full backups, only level 1 incrementals\&.
1666 Never do incremental backups, only full dumps\&.
1671 Treat this DLE as if it doesn\'t exist (useful to disable DLEs when sharing the
1673 file between multiple configurations)\&. Skipped DLEs will not be checked or dumped, and will not be matched by disklist expressions\&.
1678 Only do incremental dumps\&.
1680 should be used to tell Amanda that a full dump has been performed off\-line, so that it resets to level 1\&.
1684 \fBtape_splitsize\fR \fIint\fR
1686 Default: not set\&. Split dump file on tape into pieces of a specified size\&. This allows dumps to be spread across multiple tapes, and can potentially make more efficient use of tape space\&. Note that if this value is too large (more than half the size of the average dump being split), substantial tape space can be wasted\&. If too small, large dumps will be split into innumerable tiny dumpfiles, adding to restoration complexity\&. A good rule of thumb, usually, is 1/10 of the size of your tape\&.
1688 The default unit is Kbytes if it is not specified\&.
1691 \fBsplit_diskbuffer\fR \fIstring\fR
1693 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\&.
1696 \fBfallback_splitsize\fR \fIint\fR
1699 \fI10M\fR\&. When dumping a split dump in PORT\-WRITE mode, if no split_diskbuffer is specified (or if we somehow fail to use our split_diskbuffer), we must buffer split chunks in memory\&. This specifies the maximum size split chunks can be in this scenario, and thus the maximum amount of memory consumed for in\-memory splitting\&. The size of this buffer can be changed from its (very conservative) default to a value reflecting the amount of memory that each taper process on the dump server may reasonably consume\&.
1701 The default unit is Kbytes if it is not specified\&.
1706 entries are predefined by Amanda:
1708 define dumptype "no\-compress" {
1711 define dumptype "compress\-fast" {
1712 compress client fast
1714 define dumptype "compress\-best" {
1715 compress client best
1717 define dumptype "srvcompress" {
1718 compress server fast
1720 define dumptype "bsd\-auth" {
1723 define dumptype "no\-record" {
1726 define dumptype "no\-hold" {
1729 define dumptype "no\-full" {
1734 In addition to options in a
1736 section, one or more other
1738 names may be supplied as identifiers, which make this
1740 inherit options from other previously defined
1741 \fBdumptype\fRs\&. For instance, two sections might be the same except for the
1745 define dumptype "normal" {
1746 comment "Normal backup, no compression, do indexing"
1751 define dumptype "testing" {
1752 comment "Test backup, no compression, do indexing, no recording"
1765 \fBdumptype\fRs should reference\&. This provides an easy place to make changes that will affect every
1766 \fBdumptype\fR, although you must be careful that every dumptype explicitly inherits from the
1768 dumptype \- Amanda does not do so automatically\&.
1769 .SH "TAPETYPE SECTION"
1773 file may define multiple types of tape media and devices\&. The information is entered in a
1775 section, which looks like this in the config file:
1777 define tapetype "\fIname\fR" {
1778 \fItapetype\-option\fR \fItapetype\-value\fR
1783 The { must appear at the end of a line, and the } on its own line\&.
1786 is the name of this type of tape medium/device\&. It is referenced from the
1788 option in the main part of the config file\&.
1790 The tapetype options and values are:
1792 \fBcomment\fR \fIstring\fR
1794 Default: not set\&. A comment string describing this set of tape information\&.
1797 \fBfilemark\fR \fIint\fR
1800 \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\&.
1803 \fBlength\fR \fIint\fR
1806 \fI2000 kbytes\fR\&. How much data will fit on a tape, expressed in kbytes\&.
1808 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
1811 \fBamanda-devices\fR(7)
1815 \fBblocksize\fR \fIint\fR
1818 \fI32 kbytes\fR\&. How much data will be written in each tape record, expressed in kbytes\&. This is similar to the
1820 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\&.
1823 \fBreadblocksize\fR \fIint\fR
1827 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\&.
1829 The default unit is Kbytes if it is not specified\&.
1832 \fBspeed\fR \fIint\fR
1835 \fI200 bps\fR\&. How fast the drive will accept data, in bytes per second\&. This parameter is NOT currently used by Amanda\&.
1838 \fBlbl\-templ\fR \fIstring\fR
1840 Default: not set\&. A PostScript template file used by
1842 to generate labels\&. Several sample files are provided with the Amanda sources in the
1844 directory\&. See the
1846 man page for more information\&.
1849 In addition to options, another
1851 name may be supplie as an identifier, which makes this
1853 inherit options from another
1854 \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:
1856 define tapetype "DLT4000\-III" {
1857 comment "DLT4000 tape drives with Compact\-III tapes"
1858 length 12500 mbytes # 10 Gig tapes with some compression
1859 filemark 2000 kbytes
1862 define tapetype "DLT4000\-IV" {
1864 comment "DLT4000 tape drives with Compact\-IV tapes"
1865 length 25000 mbytes # 20 Gig tapes with some compression
1868 .SH "INTERFACE SECTION"
1872 file may define multiple types of network interfaces\&. The information is entered in an
1874 section, which looks like this:
1876 define interface "\fIname\fR" {
1877 \fIinterface\-option\fR \fIinterface\-value\fR
1882 The { must appear at the end of a line, and the } on its own line\&.
1885 is the name of this type of network interface\&. It is referenced from the
1889 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\&.
1891 The interface options and values are:
1893 \fBcomment\fR \fIstring\fR
1895 Default: not set\&. A comment string describing this set of network information\&.
1901 \fI8000 Kbps\fR\&. The speed of the interface in Kbytes per second\&.
1904 In addition to options, another
1906 name may be supplied as an identifier, which makes this
1908 inherit options from another
1909 \fBinterface\fR\&. At the moment, this is of little use\&.
1910 .SH "APPLICATION SECTION"
1914 file may define multiple types of application\&. The information is entered in a
1916 section, which looks like this:
1918 define application "\fIname\fR" {
1919 \fIapplication\-option\fR \fIapplication\-value\fR
1924 The { must appear at the end of a line, and the } on its own line\&.
1927 is the name of this type of application\&. It is referenced from the
1930 The application options and values are:
1932 \fBcomment\fR \fIstring\fR
1934 Default: not set\&. A comment string describing this application\&.
1937 \fBplugin\fR \fIstring\fR
1939 No default\&. Must be set to the name of the program\&. This program must be in the
1940 \fI$libexecdir/amanda/application\fR
1941 directory on the client\&.
1944 \fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
1946 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\&.
1948 keyword append the values to the list of values for that property\&.
1950 keyword disallow the setting of that property on the client\&.
1952 .SH "SCRIPT SECTION"
1956 file may define multiple types of script\&. The information is entered in a
1958 section, which looks like this:
1960 define script "\fIname\fR" {
1961 \fIscript\-option\fR \fIscript\-value\fR
1966 The { must appear at the end of a line, and the } on its own line\&.
1969 is the name of this type of script\&. It is referenced from the
1972 The script options and values are:
1974 \fBcomment\fR \fIstring\fR
1976 Default: not set\&. A comment string describing this script\&.
1979 \fBplugin\fR \fIstring\fR
1981 No default\&. Must be set to the name of the program\&. This program must be in the
1982 \fI$libexecdir/amanda/application\fR
1983 directory on the client and/or server\&.
1986 \fBorder\fR \fIint\fR
1989 \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\&.
1992 \fBexecute_where\fR [ \fBclient\fR | \fBserver\fR ]
1995 \fBclient\fR\&. Where the script must be executed, on the client or server\&.
1998 \fB>execute_on\fR \fIexecute_on\fR [,\fIexecute_on\fR]*
2000 No default\&. When the script must be executed, you can specify many of them:
2002 \fBpre\-dle\-amcheck\fR
2004 Execute before the amcheck command for the dle\&.
2007 \fBpre\-host\-amcheck\fR
2009 Execute before the amcheck command for all dle for the client\&.
2012 \fBpost\-dle\-amcheck\fR
2014 Execute after the amcheck command for the dle\&.
2017 \fBpost\-host\-amcheck\fR
2019 Execute after the amcheck command for all dle for the client\&.
2022 \fBpre\-dle\-estimate\fR
2024 Execute before the estimate command for the dle\&.
2027 \fBpre\-host\-estimate\fR
2029 Execute before the estimate command for all dle for the client\&.
2032 \fBpost\-dle\-estimate\fR
2034 Execute after the estimate command for the dle\&.
2037 \fBpost\-host\-estimate\fR
2039 Execute after the estimate command for all dle for the client\&.
2042 \fBpre\-dle\-backup\fR
2044 Execute before the backup command for the dle\&.
2047 \fBpre\-host\-backup\fR
2049 Execute before the backup command for all dle for the client\&. It can\'t be run on client, it must be run on server
2052 \fBpost\-dle\-backup\fR
2054 Execute after the backup command for the dle\&.
2057 \fBpost\-host\-backup\fR
2059 Execute after the backup command for all dle for the client\&. It can\'t be run on client, it must be run on server
2064 Execute before any level is recovered\&.
2069 Execute after all levels are recovered\&.
2072 \fBpre\-level\-recover\fR
2074 Execute before each level recovery\&.
2077 \fBpost\-level\-recover\fR
2079 Execute after each level recovery\&.
2082 \fBinter\-level\-recover\fR
2084 Execute between two levels of recovery\&.
2087 If you recover level 0 and 2 of the disk /usr with amrecover, it will execute:
2089 script \-\-pre\-recover
2090 script \-\-pre\-level\-recover \-\-level 0
2092 script \-\-post\-level\-recover \-\-level 0
2093 script \-\-inter\-level\-recover \-\-level 0 \-\-level 2
2094 script \-\-pre\-level\-recover \-\-level 2
2096 script \-\-post\-level\-recover \-\-level 2
2097 script \-\-post\-recover
2101 \fBproperty\fR> [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
2103 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\&.
2105 keyword append the values to the list of values for that property\&.
2107 keyword disallow the setting of that property on the client\&.
2109 .SH "DEVICE SECTION"
2111 Backend storage devices are specified in
2113 in the form of "device" sections, which look like this:
2115 define device \fIname\fR {
2116 commend "\fIcomment (optional)\fR"
2117 tapedev "\fIdevice\-specifier\fR"
2118 device_property "\fIprop\-name\fR" "\fIprop\-value\fR"
2123 The { must appear at the end of a line, and the } on its own line\&.
2126 is the user\-specified name of this device\&. It is referenced from the global
2129 \fIdevice\-specifier\fR
2130 specifies the device name to use; see
2131 \fBamanda-devices\fR(7)\&. As with most sections, the
2133 parmeter is optional and only for the user\'s convenience\&.
2135 An arbitrary number of
2136 \fIdevice_property\fR
2137 parameters can be specified\&. Again, see
2138 \fBamanda-devices\fR(7)
2139 for information on device properties\&.
2140 .SH "CHANGER SECTION"
2142 Changers are described in
2144 in the form of "changer" sections, which look like this:
2146 define changer \fIname\fR {
2147 comment "\fIcomment (optional)\fR"
2148 tpchanger "\fIchanger\-spec\fR"
2149 changerdev "\fIdevice\-name\fR"
2150 changerfile "\fIstate\-file\fR"
2155 The { must appear at the end of a line, and the } on its own line\&.
2158 is the user\-specified name of this device\&. The remaining parameters are specific to the changer type selected\&.
2161 \fBamanda-changers\fR(7)
2162 for more information on configuring changers\&.
2166 \fBamanda-client.conf\fR(5),
2167 \fBamanda-applications\fR(7),
2168 \fBamanda-auth\fR(7),
2169 \fBamanda-changers\fR(7),
2170 \fBamanda-devices\fR(7),
2171 \fBamanda-scripts\fR(7)
2174 : http://wiki.zmanda.com/
2177 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
2179 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>
projects / debian / amanda / blob