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 2.6.1p2
10 .TH "AMANDA\&.CONF" "5" "11/05/2009" "Amanda 2\&.6\&.1p2" "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 \fIAmanda\fR, the Advanced Maryland Automatic Network Disk Archiver
26 is the main configuration file for
27 \fIAmanda\fR\&. This manpage lists the relevant sections and parameters of this file for quick reference\&.
30 \fB<CONFIG_DIR>/<config>/amanda\&.conf\fR
34 There are a number of configuration parameters that control the behavior of the
36 programs\&. All have default values, so you need not specify the parameter in
38 if the default is suitable\&.
41 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\&.
42 .SS "KEYWORDS AND IDENTIFIERS"
44 Keywords are case insensitive, i\&.e\&.
48 are treated the same\&. Also, the characters
52 are interchangeable in all predefined
57 \fBdevice\-property\fR
58 have the same meaning\&.
60 Identifiers are names which are defined in the configuration itself, such as dumptypes or interfaces\&. Identifiers are are case\-insensitive, but sensitive to
63 \fB\'_\'\fR\&. Identifiers should be quoted in the configuration file, although For historical reasons, the quotes are optional\&.
65 Strings are always quoted with double quotes ("), and any double quotes or backslashes within the string are escaped with a backslash:
68 tapelist "/path/to/tapelist"
69 property "escaped\-string" "escaping: \e\e (backslash) and \e" (double\-quote)"
76 logdir "logs" # required sensitive sensitive
77 send\-amreport\-on strange # prohibited insensitive insensitive
78 tapetype "EXABYTE" # optional insensitive sensitive
80 define dumptype "dt" { # optional insensitive sensitive
81 "dumptype\-common" # optional insensitive sensitive
82 strategy noincr # prohibited insensitive insensitive
87 Integer arguments may have one of the following (case insensitive) suffixes, some of which have a multiplier effect:
91 Some number of bytes\&.
96 Some number of bytes per second\&.
99 \fBk kb kbyte kbytes kilobyte kilobytes\fR
101 Some number of kilobytes (bytes*1024)\&.
106 Some number of kilobytes per second (bytes*1024)\&.
108 It is the default multiplier for all size options\&.
111 \fBm mb meg mbyte mbytes megabyte megabytes\fR
113 Some number of megabytes (bytes*1024*1024)\&.
118 Some number of megabytes per second (bytes*1024*1024)\&.
121 \fBg gb gbyte gbytes gigabyte gigabytes\fR
123 Some number of gigabytes (bytes*1024*1024*1024)\&.
128 Some number of tapes\&.
133 Some number of days\&.
138 Some number of weeks (days*7)\&.
144 .nr an-no-space-flag 1
153 may be used in most places where an integer is expected to mean an infinite amount\&.
155 Boolean arguments may have any of the values
162 to indicate a true state, or
169 to indicate a false state\&. If no argument is given,
175 .SS "PARAMETER ORDER"
177 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\&.
180 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
183 ESCAPE SEQUENCE BECOMES
188 \er (carriage return)
192 \e001 \- \e377 (character specified in octal)
194 Illegally quoted strings are handled on a "best\-effort" basis, which may lead to unexpected results\&.
199 finserver "/data/finance/XYZ Corp\'s \e"real\e" finances" finance\-high eth0 \-1
200 property "syspath" "C:\e\eWINDOWS\e\eSYSTEM"
202 .SH "GLOBAL PARAMETERS"
204 \fBorg\fR \fI string\fR
207 \fIdaily\fR\&. A descriptive name for the configuration\&. This string appears in the Subject line of mail reports\&. Each
209 configuration should have a different string to keep mail reports distinct\&.
212 \fBmailer\fR \fI string\fR
214 Default found by configure\&. A mail program that can send mail with \'\fIMAILER \-s "subject" user < message_file\fR\'\&.
217 \fBmailto\fR \fI string\fR
220 \fIoperators\fR\&. A space separated list of recipients for mail reports\&.
223 \fBsend\-amreport\-on\fR [all|strange|error|never]
226 \fBall\fR\&. Specify which types of messages will trigger an email from amreport\&. amreport is used by amdump and amflush\&.
230 Send an email on any message\&.
235 Send an email on strange or error message\&. A strange message occurs when the dump succeeded, but returned one or more errors unknown to
241 Send an email only on error messages\&.
246 Never send an email\&.
250 \fBdumpcycle\fR \fI int\fR
253 \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\&.
259 .nr an-no-space-flag 1
266 This parameter may also be set in a specific
268 (see below)\&. This value sets the default for all
269 \fBdumptype\fRs so must appear in
272 \fBdumptype\fRs are defined\&.
277 \fBrunspercycle\fR \fI int\fR
280 \fIsame as dumpcycle\fR\&. The number of amdump runs in
282 days\&. A value of 0 means the same value as
283 \fBdumpcycle\fR\&. A value of \-1 means guess the number of runs from the
285 file, which is the number of tapes used in the last
291 \fBtapecycle\fR \fI int\fR
294 \fI15 tapes\fR\&. Typically tapes are used by
296 in an ordered rotation\&. The
298 parameter defines the size of that rotation\&. The number of tapes in rotation must be larger than the number of tapes required for a complete dump cycle (see the
302 This is calculated by multiplying the number of
304 runs per dump cycle (\fBrunspercycle\fR
305 parameter) times the number of tapes used per run (\fBruntapes\fR
306 parameter)\&. Typically two to four times this calculated number of tapes are in rotation\&. While
308 is always willing to use a new tape in its rotation, it refuses to reuse a tape until at least \'\fBtapecycle\fR
309 \-1\' number of other tapes have been used\&.
311 It is considered good administrative practice to set the
313 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\&.
316 \fBusetimestamps\fR \fI bool\fR
319 \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\&.
322 \fBlabel_new_tapes\fR \fI string\fR
324 Default: not set\&. When set, this directive will cause
326 to automatically write an
328 tape label to any blank tape she encounters\&. This option is DANGEROUS because when set,
330 will ERASE any non\-\fIAmanda\fR
331 tapes you may have, and may also ERASE any near\-failing tapes\&. Use with caution\&.
333 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:
334 \fBlabel_new_tapes "DailySet1\-%%%"\fR
337 \fBdumpuser\fR \fI string\fR
340 \fIamanda\fR\&. The login name
342 uses to run the backups\&. The backup client hosts must allow access from the tape server host as this user via
345 \fB\&.amandahosts\fR, depending on how the
347 software was built\&.
352 Printer to use when doing tape labels\&. See the
361 null:\&. The device name, referencing the name of a "device" section in the configuration file\&. See
362 \fBamanda-devices\fR(7)
363 for more information on device names\&.
365 If a tape changer is configured (see the
367 option), this option might not be used\&.
372 \fBnull:\fR, programs such as
374 will run normally but all images will be thrown away\&. This should only be used for debugging and testing, and probably only with the
380 \fBdevice_property\fR string string
382 These options can set various device properties\&. See
383 \fBamanda-devices\fR(7)
384 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:
386 device_property "BLOCK_SIZE" "128k"
390 \fBproperty\fR [append] string string+
392 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\&.
394 keyword append the values to the list of values for that property\&.
397 \fBtpchanger\fR string
400 \fInone\fR\&. The name of the tape changer\&. If a tape changer is not configured, this option is not used and should be commented out of the configuration file\&.
402 If a tape changer is configured, choose one of the changer scripts (e\&.g\&.
403 \fBchg\-scsi\fR) and enter that here\&.
406 \fBchangerdev\fR string
409 /dev/null\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the
414 \fBchangerfile\fR string
417 /usr/adm/amanda/log/changer\-status\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the
425 1\&. The maximum number of tapes used in a single run\&. If a tape changer is not configured, this option is not used and should be commented out of the configuration file\&.
427 If a tape changer is configured, this may be set larger than one to let
429 write to more than one tape\&.
431 Note that this is an upper bound on the number of tapes, and
435 Also note that as of this release,
437 does not support true tape overflow\&. When it reaches the end of one tape, the backup image
439 was processing starts over again on the next tape\&.
442 \fBmaxdumpsize\fR int
445 \fIruntapes\fR*\fItape_length\fR\&. Maximum number of bytes the planner will schedule for a run\&.
447 The default unit is Kbytes if it is not specified\&.
450 \fBtaperalgo\fR [first|firstfit|largest|largestfit|smallest|last]
453 \fIfirst\fR\&. The algorithm used to choose which dump image to send to the taper\&.
457 First in, first out\&.
462 The first dump image that will fit on the current tape\&.
467 The largest dump image\&.
472 The largest dump image that will fit on the current tape\&.
477 The smallest dump image\&.
482 Last in, first out\&.
486 \fBlabelstr\fR \fI string\fR
489 \fI\&.*\fR\&. The tape label constraint regular expression\&. All tape labels generated (see
490 \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\&.
493 \fBtapetype\fR \fI identifier\fR
496 \fI"EXABYTE"\fR\&. The type of tape drive associated with
499 \fBtpchanger\fR\&. This refers to one of the defined
500 \fBtapetype\fRs in the config file (see below), which specify various tape parameters, like the
505 of the tape media and device\&.
511 \fI30 seconds\fR\&. Maximum amount of time that
513 will wait for each client host\&.
519 \fI1800 seconds\fR\&. Amount of idle time per disk on a given client that a
523 will wait before it fails with a data timeout error\&.
529 \fI300 seconds\fR\&. Amount of time per estimate on a given client that the
533 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,
535 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\&.
538 \fBconnect_tries\fR int
541 \fI3\fR\&. How many times the server will try a connection\&.
547 \fI3\fR\&. How many times the server will resend a REQ packet if it doesn\'t get the ACK packet\&.
553 \fI8000 Kbps\fR\&. The maximum network bandwidth allocated to
554 \fIAmanda\fR, in Kbytes per second\&. See also the
562 10\&. The maximum number of backups that
564 will attempt to run in parallel\&.
566 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\&.
569 \fBdisplayunit\fR "k|m|g|t"
572 "k"\&. The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera\&.
575 \fBdumporder\fR string
578 \fItttTTTTTTT\fR\&. The priority order of each dumper:
585 b: smallest bandwidth
593 1\&. The maximum number of backups from a single host that
595 will attempt to run in parallel\&. See also the
599 Note that this parameter may also be set in a specific
601 (see below)\&. This value sets the default for all
602 \fBdumptype\fRs so must appear in
605 \fBdumptype\fRs are defined\&.
611 \fI10 Mbytes\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\&. If
613 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
617 The default unit is Kbytes if it is not specified\&.
619 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
628 \fBbumppercent\fR int
631 \fI0 percent\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as percentage of the current size of the DLE (size of current level 0)\&. If
633 determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&.
635 If this parameter is set to 0, the value of the parameter
637 is used to trigger bumping\&.
639 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
648 \fBbumpmult\fR \fI float\fR
651 1\&.5\&. The bump size multiplier\&.
655 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
659 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\&.
661 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
664 \fBbumpdays\fR \fI int\fR
667 \fI2 days\fR\&. To insure redundancy in the dumps,
669 keeps filesystems at the same incremental level for at least
671 days, even if the other bump threshold criteria are met\&.
673 The global setting of this parameter can be overwritten inside of a dumptype\-definition\&.
676 \fBdiskfile\fR \fI string\fR
679 \fIdisklist\fR\&. The file name for the
681 file holding client hosts, disks and other client dumping information\&.
684 \fBinfofile\fR \fI string\fR
687 /usr/adm/amanda/curinfo\&. The file or directory name for the historical information database\&. If
689 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\&.
692 \fBlogdir\fR \fI string\fR
695 /usr/adm/amanda\&. The directory for the
702 \fBindexdir\fR \fI string\fR
705 /usr/adm/amanda/index\&. The directory where index files (backup image catalogues) are stored\&. Index files are only generated for filesystems whose
712 \fBtapelist\fR \fI string\fR
715 \fItapelist\fR\&. The file name for the active
718 maintains this file with information about the active set of tapes\&.
721 \fBdevice_output_buffer_size\fR \fI int\fR
724 1280k\&. Controls the amount of memory used by
726 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\&.
728 The default unit is bytes if it is not specified\&.
731 \fBtapebufs\fR \fI int\fR
734 20\&. This option is deprecated; use the
735 \fBdevice_output_buffer_size\fR
738 works the same way, but the number specified is multiplied by the device blocksize prior to use\&.
741 \fBreserve\fR \fI number\fR
744 100\&. The part of holding\-disk space that should be reserved for incremental backups if no tape is available, expressed as a percentage of the available holding\-disk space (0\-100)\&. By default, when there is no tape to write to, degraded mode (incremental) backups will be performed to the holding disk\&. If full backups should also be allowed in this case, the amount of holding disk space reserved for incrementals should be lowered\&.
747 \fBautoflush\fR \fI bool\fR
750 \fIoff\fR\&. Whether an amdump run will flush the dumps from holding disk to tape\&.
753 \fBamrecover_do_fsf\fR \fI bool\fR
756 \fIon\fR\&. Amrecover will call amrestore with the \-f flag for faster positioning of the tape\&.
759 \fBamrecover_check_label\fR \fI bool\fR
762 \fIon\fR\&. Amrecover will call amrestore with the \-l flag to check the label\&.
765 \fBamrecover_changer\fR \fI string\fR
767 Default: \'\'\&. Amrecover will use the changer if you use \'settape <string>\' and that string is the same as the amrecover_changer setting\&.
770 \fBcolumnspec\fR \fI string\fR
772 Defines the width of columns
776 is a comma (\',\') separated list of triples\&. Each triple consists of three parts which are separated by a equal sign (\'=\') and a colon (\':\') (see the example)\&. These three parts specify:
786 the name of the column, which may be:
788 Compress (compression ratio)
789 Disk (client disk name)
790 DumpRate (dump rate in KBytes/sec)
791 DumpTime (total dump time in hours:minutes)
792 HostName (client host name)
794 OrigKB (original image size in KBytes)
795 OutKB (output image size in KBytes)
796 TapeRate (tape writing rate in KBytes/sec)
797 TapeTime (total tape time in hours:minutes)
809 the amount of space to display before the column (used to get whitespace between columns)\&.
821 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\&.
826 columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"
829 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 output KBytes column is seven characters wide with one space before it\&.
832 \fBincludefile\fR \fI string\fR
835 \fInone\fR\&. The name of an
837 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\&.
843 \fI0\fR\&. Debug level of the auth module
846 \fBdebug_event\fR int
849 \fI0\fR\&. Debug level of the event module
852 \fBdebug_holding\fR int
855 \fI0\fR\&. Debug level of the holdingdisk module
858 \fBdebug_protocol\fR int
861 \fI0\fR\&. Debug level of the protocol module
864 \fBdebug_planner\fR int
867 \fI0\fR\&. Debug level of the planner process
870 \fBdebug_driver\fR int
873 \fI0\fR\&. Debug level of the driver process
876 \fBdebug_dumper\fR int
879 \fI0\fR\&. Debug level of the dumper process
882 \fBdebug_chunker\fR int
885 \fI0\fR\&. Debug level of the chunker process
888 \fBdebug_taper\fR int
891 \fI0\fR\&. Debug level of the taper process
894 \fBflush\-threshold\-dumped\fR int
899 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,
901 will not begin until the inequality
905 is the amount of data on the holding disk,
907 is the capacity of a volume, and
909 is this parameter, expressed as a percentage\&. This parameter may be larger than 100%, for example to keep more recent dumps on the holding disk for faster recovery\&.
911 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
913 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\&.
915 The value of this parameter may not exceed than that of the
916 \fBflush\-threshold\-scheduled\fR
920 \fBflush\-threshold\-scheduled\fR int
925 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,
927 will not begin until the inequality
931 is the amount of data on the holding disk,
933 is the total amount of data scheduled for this run but not dumped yet,
935 is the capacity of a volume, and
937 is this parameter, expressed as a percentage\&. This parameter may be larger than 100%\&.
939 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
941 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\&.
943 The value of this parameter may not be less than that of the
944 \fBflush\-threshold\-dumped\fR
953 \fI0\fR\&. At the end of a run,
955 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,
957 will begin a new tape if the inequality
961 is the amount of data remaining on the holding disk from this or previous runs,
963 is the capacity of a volume, and
965 is this parameter, expressed as a percentage\&. This parameter may be greater than 100%\&.
967 The value of this parameter may not exceed that of the
968 \fBflush\-threshold\-scheduled\fR
971 must be set to \'yes\' if
976 \fBreserved\-udp\-port\fR int,int
978 Default: \-\-with\-udpportrange or
979 \fI512,1023\fR\&. Reserved udp port that will be used (bsd, bsdudp)\&. Range is inclusive\&.
982 \fBreserved\-tcp\-port\fR int,int
984 Default: \-\-with\-low\-tcpportrange or
985 \fI512,1023\fR\&. Reserved tcp port that will be used (bsdtcp)\&. Range is inclusive\&.
988 \fBunreserved\-tcp\-port\fR int,int
990 Default: \-\-with\-tcpportrange or
991 \fI1024,65535\fR\&. Unreserved tcp port that will be used (bsd, bsdudp)\&. Range is inclusive\&.
993 .SH "HOLDINGDISK SECTION"
997 file may define one or more holding disks used as buffers to hold backup images before they are written to tape\&. The syntax is:
999 holdingdisk \fIname\fR {
1000 \fIholdingdisk\-option\fR \fIholdingdisk\-value\fR
1006 is a logical name for this holding disk\&.
1008 The options and values are:
1010 \fBcomment\fR \fI string\fR
1013 \fInone\fR\&. A comment string describing this holding disk\&.
1016 \fBdirectory\fR \fI disk\fR
1019 /dumps/amanda\&. The path to this holding area\&.
1022 \fBuse\fR \fI int\fR
1025 \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,
1027 will use all available space minus that value\&.
1030 \fBchunksize\fR \fI int\fR
1033 \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\&.
1035 The default unit is Kbytes if it is not specified\&.
1039 will create holding disk chunks as large as ((INT_MAX/1024)\-64) Kbytes\&.
1041 Each holding disk chunk includes a 32 Kbyte header, so the minimum chunk size is 64 Kbytes (but that would be really silly)\&.
1043 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
1045 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\&.
1047 .SH "DUMPTYPE SECTION"
1050 \fBamanda.conf\fR(5)
1051 file may define multiple sets of backup options and refer to them by name from the
1053 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\&.
1055 A set of backup options are entered in a
1057 section, which looks like this:
1059 define dumptype "\fIname\fR" {
1060 \fIdumptype\-option\fR \fIdumptype\-value\fR
1066 is the name of this set of backup options\&. It is referenced from the
1070 Some of the options in a
1072 section are the same as those in the main part of
1073 \fBamanda.conf\fR(5)\&. The main option value is used to set the default for all
1075 sections\&. For instance, setting
1077 to 50 in the main part of the config file causes all following
1079 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
1080 \fBdumptype\fRs are defined\&.
1082 The dumptype options and values are:
1084 \fBauth\fR \fI string\fR
1087 \fIbsd\fR\&. Type of authorization to perform between tape server and backup client hosts\&. See
1088 \fBamanda-auth\fR(7)
1092 \fBamandad_path\fR \fI string\fR
1095 \fI$libexec/amandad\fR\&. Specify the amandad path of the client, only use with rsh/ssh authentification\&.
1098 \fBclient_username\fR \fI string\fR
1101 \fICLIENT_LOGIN\fR\&. Specify the username to connect on the client, only use with rsh/ssh authentification\&.
1107 \fI10 Mbytes\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\&. If
1109 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
1113 The default unit is Kbytes if it is not specified\&.
1115 See also the options
1122 \fBbumppercent\fR int
1125 \fI0 percent\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as percentage of the current size of the DLE (size of current level 0)\&. If
1127 determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&.
1129 If this parameter is set to 0, the value of the parameter
1131 is used to trigger bumping\&.
1133 See also the options
1140 \fBbumpmult\fR \fI float\fR
1143 1\&.5\&. The bump size multiplier\&.
1147 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
1151 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\&.
1154 \fBbumpdays\fR \fI int\fR
1157 \fI2 days\fR\&. To insure redundancy in the dumps,
1159 keeps filesystems at the same incremental level for at least
1161 days, even if the other bump threshold criteria are met\&.
1164 \fBcomment\fR \fI string\fR
1167 \fInone\fR\&. A comment string describing this set of backup options\&.
1170 \fBcomprate\fR \fIfloat\fR [, \fIfloat\fR ]
1174 0\&.50\&. The expected full and incremental compression factor for dumps\&. It is only used if
1176 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\&.
1179 \fBcompress [client|server]\fR \fI string\fR
1182 \fIclient fast\fR\&. If
1184 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\&.
1186 For either type of compression,
1188 also allows the selection of three styles of compression\&.
1190 is the best compression available, often at the expense of CPU overhead\&.
1192 is often not as good a compression as
1193 \fBbest\fR, but usually less CPU overhead\&. Or to specify
1195 to use your own compression method\&. (See dumptype custom\-compress in example/amanda\&.conf for reference)
1199 options line may be one of:
1205 compress client fast
1209 compress client best
1213 compress client custom
1216 \fIclient_custom_compress\fR
1219 PROG must not contain white space and it must accept \-d for uncompress\&.
1222 compress server fast
1226 compress server best
1230 compress server custom
1233 \fIserver_custom_compress\fR
1236 PROG must not contain white space and it must accept \-d for uncompress\&.
1239 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
1243 (software) compression should be disabled\&.
1246 \fBdumpcycle\fR \fI int\fR
1249 \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\&.
1252 \fBencrypt [none|client|server]\fR
1255 \fInone\fR\&. To encrypt backup images, it can do so either on the backup client host before it crosses the network or on the tape server host as it goes from the network into the holding disk or to tape\&.
1259 options line may be one of:
1267 Specify client_encrypt "PROG"
1269 PROG must not contain white space\&.
1271 Specify client_decrypt_option "decryption\-parameter" Default: "\-d"
1273 decryption\-parameter must not contain white space\&.
1275 (See dumptype client\-encrypt\-nocomp in example/amanda\&.conf for reference)
1280 Specify server_encrypt "PROG"
1282 PROG must not contain white space\&.
1284 Specify server_decrypt_option "decryption\-parameter" Default: "\-d"
1286 decryption\-parameter must not contain white space\&.
1288 (See dumptype server\-encrypt\-fast in example/amanda\&.conf for reference)
1291 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\&.
1293 which is a wrapper of
1295 is provided as a reference symmetric encryption program\&.
1298 \fBestimate\fR \fIclient|calcsize|server\fR
1301 \fIclient\fR\&. Determine the way
1303 does it\'s estimate\&.
1307 Use the same program as the dumping program, this is the most accurate way to do estimates, but it can take a long time\&.
1312 Use a faster program to do estimates, but the result is less accurate\&.
1317 Use only statistics from the previous run to give an estimate, it takes only a few seconds but the result is not accurate if your disk usage changes from day to day\&.
1321 \fBexclude\fR [ list|file ][[optional][ append ][ \fIstring\fR ]+]
1324 \fIfile\fR\&. There are two exclude lists,
1327 \fBexclude list\&.\fR
1334 exclude expression\&. With
1338 is a file name on the client containing
1340 exclude expressions\&. The path to the specified exclude list file, if present (see description of \'optional\' below), must be readable by the
1344 All exclude expressions are concatenated in one file and passed to
1347 \fB\-\-exclude\-from\fR
1350 Exclude expressions must always be specified as relative to the head directory of the DLE\&.
1356 is appended to the current list, without it, the
1358 overwrites the list\&.
1363 \fBexclude list\fR, then amcheck will not complain if the file doesn\'t exist or is not readable\&.
1366 \fBexclude list\fR, if the file name is relative, the disk name being backed up is prepended\&. So if this is entered:
1368 exclude list "\&.amanda\&.excludes"
1370 the actual file used would be
1371 /var/\&.amanda\&.excludes
1374 /usr/local/\&.amanda\&.excludes
1376 /usr/local, and so on\&.
1379 \fBholdingdisk\fR [ never|auto|required ]
1382 \fIauto\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
1384 is backing up, that file system should refer to a dumptype with
1388 to avoid backing up the holding disk into itself\&.
1390 \fBnever\fR|no|false|off
1392 Never use a holdingdisk, the dump will always go directly to tape\&. There will be no dump if you have a tape error\&.
1395 \fBauto\fR|yes|true|on
1397 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)
1402 Always dump to holdingdisk, never directly to tape\&. There will be no dump if it doesn\'t fit on holdingdisk
1406 \fBignore\fR \fI boolean\fR
1409 \fIno\fR\&. Whether disks associated with this backup type should be backed up or not\&. This option is useful when the
1411 file is shared among several configurations, some of which should not back up all the listed file systems\&.
1414 \fBinclude\fR [ list|file ][[optional][ append ][ \fIstring\fR ]+]
1418 "\&."\&. There are two include lists,
1421 \fBinclude list\&.\fR
1426 is a glob expression\&. With
1430 is a file name on the client containing glob expressions\&.
1432 All include expressions are expanded by
1433 \fIAmanda\fR, concatenated in one file and passed to
1436 \fB\-\-files\-from\fR
1437 argument\&. They must start with "\&./" and contain no other "/"\&.
1439 Include expressions must always be specified as relative to the head directory of the DLE\&.
1445 .nr an-no-space-flag 1
1452 For globbing to work at all, even the limited single level, the top level directory of the DLE must be readable by the
1461 is appended to the current list, without it, the
1463 overwrites the list\&.
1469 then amcheck will not complain if the file doesn\'t exist or is not readable\&.
1472 \fBinclude list\fR, If the file name is relative, the disk name being backed up is prepended\&.
1475 \fBindex\fR \fI boolean\fR
1478 \fIno\fR\&. Whether an index (catalogue) of the backup should be generated and saved in
1479 \fBindexdir\fR\&. These catalogues are used by the
1484 \fBkencrypt\fR \fI boolean\fR
1487 \fIno\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\&.
1490 \fBmaxdumps\fR \fI int\fR
1493 1\&. The maximum number of backups from a single host that
1495 will attempt to run in parallel\&. See also the main section parameter
1499 \fBmaxpromoteday\fR \fI int\fR
1502 10000\&. The maximum number of day for a promotion, set it 0 if you don\'t want promotion, set it to 1 or 2 if your disks get overpromoted\&.
1505 \fBpriority\fR \fI string\fR
1508 \fImedium\fR\&. When there is no tape to write to,
1510 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\&.
1513 \fBprogram\fR [DUMP|GNUTAR|APPLICATION]
1516 \fIDUMP\fR\&. The type of backup to perform\&. Valid values are:
1520 The native operating system backup program\&.
1525 To use GNU\-tar or to do PC backups using Samba\&.
1530 To use an application\-tool, see the
1536 \fBapplication\fR \fI string\fR
1538 No default\&. Must be the name of an application\-tool if
1541 \fIAPPLICATION\fR\&. See APPLICATION SECTION below\&.
1544 \fBscript\fR \fI string\fR
1546 No default\&. Must be the name of a script\-tool\&. You can have many script\&. See SCRIPT SECTION below\&.
1549 \fBproperty\fR [append] \fIstring\fR \fIstring\fR+
1551 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\&.
1553 keyword append the values to the list of values for that property\&.
1556 \fBrecord\fR \fI boolean\fR
1559 \fIyes\fR\&. Whether to ask the backup program to update its database (e\&.g\&.
1562 /usr/local/var/amanda/gnutar\-lists
1563 for GNUTAR) of time stamps\&. This is normally enabled for daily backups and turned off for periodic archival runs\&.
1566 \fBskip\-full\fR \fI boolean\fR
1573 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
1575 only schedules level 1 incrementals in this configuration; this is probably a bug\&.
1578 \fBskip\-incr\fR \fI boolean\fR
1585 has scheduled an incremental backup, these disks will be skipped\&.
1588 \fBssh_keys\fR \fI string\fR
1591 \fINo default\fR\&. 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\&.
1594 \fBstarttime\fR \fI int\fR
1597 \fInone\fR\&. Backups will not start until after this time of day\&. The value should be hh*100+mm, e\&.g\&. 6:30PM (18:30) would be entered as
1601 \fBstrategy\fR \fI string\fR
1604 \fIstandard\fR\&. Strategy to use when planning what level of backup to run next\&. Values are:
1615 Never do full backups, only level 1 incrementals\&.
1620 Never do incremental backups, only full dumps\&.
1625 Never do backups (useful when sharing the
1632 Only do incremental dumps\&.
1634 should be used to tell
1636 that a full dump has been performed off\-line, so that it resets to level 1\&.
1640 \fBtape_splitsize\fR \fI int\fR
1643 \fInone\fR\&. Split dump file on tape into pieces of a specified size\&. This allows dumps to be spread across multiple tapes, and can potentially make more efficient use of tape space\&. Note that if this value is too large (more than half the size of the average dump being split), substantial tape space can be wasted\&. If too small, large dumps will be split into innumerable tiny dumpfiles, adding to restoration complexity\&. A good rule of thumb, usually, is 1/10 of the size of your tape\&.
1645 The default unit is Kbytes if it is not specified\&.
1648 \fBsplit_diskbuffer\fR \fI string\fR
1651 \fInone\fR\&. When dumping a split dump in PORT\-WRITE mode (usually meaning "no holding disk"), buffer the split chunks to a file in the directory specified by this option\&.
1654 \fBfallback_splitsize\fR \fI int\fR
1657 \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\&.
1659 The default unit is Kbytes if it is not specified\&.
1664 entries are predefined by
1667 define dumptype "no\-compress" {
1670 define dumptype "compress\-fast" {
1671 compress client fast
1673 define dumptype "compress\-best" {
1674 compress client best
1676 define dumptype "srvcompress" {
1677 compress server fast
1679 define dumptype "bsd\-auth" {
1682 define dumptype "krb4\-auth" {
1685 define dumptype "no\-record" {
1688 define dumptype "no\-hold" {
1691 define dumptype "no\-full" {
1696 In addition to options in a
1698 section, one or more other
1700 names may be supplied as identifiers, which make this
1702 inherit options from other previously defined
1703 \fBdumptype\fRs\&. For instance, two sections might be the same except for the
1707 define dumptype "normal" {
1708 comment "Normal backup, no compression, do indexing"
1713 define dumptype "testing" {
1714 comment "Test backup, no compression, do indexing, no recording"
1728 \fBdumptype\fRs should reference\&. This provides an easy place to make changes that will affect every
1730 .SH "TAPETYPE SECTION"
1734 file may define multiple types of tape media and devices\&. The information is entered in a
1736 section, which looks like this in the config file:
1738 define tapetype "\fIname\fR" {
1739 \fItapetype\-option\fR \fItapetype\-value\fR
1745 is the name of this type of tape medium/device\&. It is referenced from the
1747 option in the main part of the config file\&.
1749 The tapetype options and values are:
1751 \fBcomment\fR \fI string\fR
1754 \fInone\fR\&. A comment string describing this set of tape information\&.
1757 \fBfilemark\fR \fI int\fR
1760 \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\&.
1763 \fBlength\fR \fI int\fR
1766 \fI2000 kbytes\fR\&. How much data will fit on a tape, expressed in kbytes\&.
1768 Note that this value is only used by
1770 to schedule which backups will be run\&. Once the backups start,
1772 will continue to write to a tape until it gets an error, regardless of what value is entered for
1775 \fBamanda-devices\fR(7)
1779 \fBblocksize\fR \fI int\fR
1782 \fI32 kbytes\fR\&. How much data will be written in each tape record, expressed in kbytes\&. This is similar to the
1784 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\&.
1787 \fBreadblocksize\fR \fI int\fR
1791 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\&.
1793 The default unit is Kbytes if it is not specified\&.
1796 \fBspeed\fR \fI int\fR
1799 \fI200 bps\fR\&. How fast the drive will accept data, in bytes per second\&. This parameter is NOT currently used by
1803 \fBlbl\-templ\fR \fI string\fR
1805 A PostScript template file used by
1807 to generate labels\&. Several sample files are provided with the
1811 directory\&. See the
1813 man page for more information\&.
1816 In addition to options, another
1818 name may be supplie as an identifier, which makes this
1820 inherit options from another
1821 \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:
1823 define tapetype "DLT4000\-III" {
1824 comment "DLT4000 tape drives with Compact\-III tapes"
1825 length 12500 mbytes # 10 Gig tapes with some compression
1826 filemark 2000 kbytes
1829 define tapetype "DLT4000\-IV" {
1831 comment "DLT4000 tape drives with Compact\-IV tapes"
1832 length 25000 mbytes # 20 Gig tapes with some compression
1835 .SH "INTERFACE SECTION"
1839 file may define multiple types of network interfaces\&. The information is entered in an
1841 section, which looks like this:
1843 define interface "\fIname\fR" {
1844 \fIinterface\-option\fR \fIinterface\-value\fR
1850 is the name of this type of network interface\&. It is referenced from the
1854 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
1857 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,
1859 will use as much of the network as it can leaving throttling up to the operating system and network hardware\&.
1861 The interface options and values are:
1863 \fBcomment\fR \fI string\fR
1866 \fInone\fR\&. A comment string describing this set of network information\&.
1869 \fBuse\fR \fI int\fR
1872 \fI8000 Kbps\fR\&. The speed of the interface in Kbytes per second\&.
1875 In addition to options, another
1877 name may be supplied as an identifier, which makes this
1879 inherit options from another
1880 \fBinterface\fR\&. At the moment, this is of little use\&.
1881 .SH "APPLICATION SECTION"
1885 file may define multiple types of application\&. The information is entered in a
1886 \fBapplication\-tool\fR
1887 section, which looks like this:
1889 define application\-tool "\fIname\fR" {
1890 \fIapplication\-option\fR \fIapplication\-value\fR
1896 is the name of this type of application\&. It is referenced from the
1899 The application\-tool options and values are:
1901 \fBcomment\fR \fIstring\fR
1904 \fInone\fR\&. A comment string describing this application\&.
1907 \fBplugin\fR \fIstring\fR
1909 No default\&. Must be set to the name of the program\&. This program must be in the
1910 \fI$libexecdir/amanda/application\fR
1911 directory on the client\&.
1914 \fBproperty\fR [append] [priority] \fIstring\fR \fIstring\fR+
1916 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\&.
1918 keyword append the values to the list of values for that property\&.
1920 keyword disallow the setting of that property on the client\&.
1922 .SH "SCRIPT SECTION"
1926 file may define multiple types of script\&. The information is entered in a
1928 section, which looks like this:
1930 define script\-tool "\fIname\fR" {
1931 \fIscript\-option\fR \fIscript\-value\fR
1937 is the name of this type of script\&. It is referenced from the
1940 The script\-tool options and values are:
1942 \fBcomment\fR \fIstring\fR
1945 \fInone\fR\&. A comment string describing this script\&.
1948 \fBplugin\fR \fIstring\fR
1950 No default\&. Must be set to the name of the program\&. This program must be in the
1951 \fI$libexecdir/amanda/application\fR
1952 directory on the client and/or server\&.
1955 \fBexecute_where\fR [client|server]
1958 \fIclient\fR\&. Where the script must be executed, on the client or server\&.
1961 \fBexecute_on\fR \fIexecute_on\fR[,\fIexecute_on\fR]*
1963 No default\&. When the script must be executed, you can specify many of them:
1965 \fBpre\-dle\-amcheck\fR
1967 Execute before the amcheck command for the dle\&.
1970 \fBpre\-host\-amcheck\fR
1972 Execute before the amcheck command for all dle for the client\&.
1975 \fBpost\-dle\-amcheck\fR
1977 Execute after the amcheck command for the dle\&.
1980 \fBpost\-host\-amcheck\fR
1982 Execute after the amcheck command for all dle for the client\&.
1985 \fBpre\-dle\-estimate\fR
1987 Execute before the estimate command for the dle\&.
1990 \fBpre\-host\-estimate\fR
1992 Execute before the estimate command for all dle for the client\&.
1995 \fBpost\-dle\-estimate\fR
1997 Execute after the estimate command for the dle\&.
2000 \fBpost\-host\-estimate\fR
2002 Execute after the estimate command for all dle for the client\&.
2005 \fBpre\-dle\-backup\fR
2007 Execute before the backup command for the dle\&.
2010 \fBpre\-host\-backup\fR
2012 Execute before the backup command for all dle for the client\&.
2015 \fBpost\-dle\-backup\fR
2017 Execute after the backup command for the dle\&.
2020 \fBpost\-host\-backup\fR
2022 Execute after the backup command for all dle for the client\&.
2027 Execute before any level is recovered\&.
2032 Execute after all levels are recovered\&.
2035 \fBpre\-level\-recover\fR
2037 Execute before each level recovery\&.
2040 \fBpost\-level\-recover\fR
2042 Execute after each level recovery\&.
2045 \fBinter\-level\-recover\fR
2047 Execute between two levels of recovery\&.
2050 If you recover level 0 and 2 of the disk /usr with amrecover, it will execute:
2052 script \-\-pre\-recover
2053 script \-\-pre\-level\-recover \-\-level 0
2055 script \-\-post\-level\-recover \-\-level 0
2056 script \-\-inter\-level\-recover \-\-level 0 \-\-level 2
2057 script \-\-pre\-level\-recover \-\-level 2
2059 script \-\-post\-level\-recover \-\-level 2
2060 script \-\-post\-recover
2064 \fBproperty\fR [append] [priority] \fIstring\fR \fIstring\fR+
2066 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\&.
2068 keyword append the values to the list of values for that property\&.
2070 keyword disallow the setting of that property on the client\&.
2072 .SH "DEVICE SECTION"
2074 Backend storage devices are specified in
2076 in the form of "device" sections, which look like this:
2078 define device \fIname\fR {
2079 commend "\fIcomment (optional)\fR"
2080 tapedev "\fIdevice\-specifier\fR"
2081 device_property "\fIprop\-name\fR" "\fIprop\-value\fR"
2087 is the user\-specified name of this device\&. It is referenced from the global
2090 \fIdevice\-specifier\fR
2091 specifies the device name to use; see
2092 \fBamanda-devices\fR(7)\&. As with most sections, the
2094 parmeter is optional and only for the user\'s convenience\&.
2096 An arbitrary number of
2097 \fIdevice_property\fR
2098 parameters can be specified\&. Again, see
2099 \fBamanda-devices\fR(7)
2100 for information on device properties\&.
2101 .SH "CHANGER SECTION"
2103 Changers are described in
2105 in the form of "changer" sections, which look like this:
2107 define changer \fIname\fR {
2108 comment "\fIcomment (optional)\fR"
2109 tapedev "\fItape\-device\fR"
2110 tpchanger "\fIchanger\-type\fR"
2111 changerdev "\fIdevice\-name\fR"
2112 changerfile "\fIstate\-file\fR"
2118 is the user\-specified name of this device\&. The remaining parameters are specific to the changer type selected\&.
2123 \fBamanda-client.conf\fR(5),
2126 : http://wiki.zmanda.com
2129 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
2131 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>