3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
8 .TH "AMANDA\.CONF" "5" "03/31/2008" "" ""
9 .\" disable hyphenation
11 .\" disable justification (adjust text to left margin only)
14 amanda.conf - Main configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver
18 is the main configuration file for
19 \fIAmanda\fR\. This manpage lists the relevant sections and parameters of this file for quick reference\.
22 \fB<CONFIG_DIR>/<config>/amanda\.conf\fR
26 There are a number of configuration parameters that control the behavior of the
28 programs\. All have default values, so you need not specify the parameter in
30 if the default is suitable\.
32 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\.
34 Keywords are case insensitive, i\.e\.
38 are treated the same\.
40 Integer arguments may have one of the following (case insensitive) suffixes, some of which have a multiplier effect:
41 .SS "POSSIBLE SUFFIXES"
45 Some number of bytes\.
50 Some number of bytes per second\.
53 \fBk kb kbyte kbytes kilobyte kilobytes\fR
55 Some number of kilobytes (bytes*1024)\.
60 Some number of kilobytes per second (bytes*1024)\.
63 \fBm mb meg mbyte mbytes megabyte megabytes\fR
65 Some number of megabytes (bytes*1024*1024)\.
70 Some number of megabytes per second (bytes*1024*1024)\.
73 \fBg gb gbyte gbytes gigabyte gigabytes\fR
75 Some number of gigabytes (bytes*1024*1024*1024)\.
80 Some number of tapes\.
90 Some number of weeks (days*7)\.
93 .nr an-no-space-flag 1
99 may be used in most places where an integer is expected to mean an infinite amount\.
101 Boolean arguments may have any of the values
108 to indicate a true state, or
115 to indicate a false state\. If no argument is given,
121 \fBorg\fR \fI string\fR
124 \fIdaily\fR\. A descriptive name for the configuration\. This string appears in the Subject line of mail reports\. Each
126 configuration should have a different string to keep mail reports distinct\.
129 \fBmailto\fR \fI string\fR
132 \fIoperators\fR\. A space separated list of recipients for mail reports\.
135 \fBdumpcycle\fR \fI int\fR
138 \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\.
141 .nr an-no-space-flag 1
145 This parameter may also be set in a specific
147 (see below)\. This value sets the default for all
148 \fBdumptype\fRs so must appear in
151 \fBdumptype\fRs are defined\.
154 \fBrunspercycle\fR \fI int\fR
157 \fIsame as dumpcycle\fR\. The number of amdump runs in
159 days\. A value of 0 means the same value as
160 \fBdumpcycle\fR\. A value of \-1 means guess the number of runs from the
162 file, which is the number of tapes used in the last
168 \fBtapecycle\fR \fI int\fR
171 \fI15 tapes\fR\. Typically tapes are used by
173 in an ordered rotation\. The
175 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
179 This is calculated by multiplying the number of
181 runs per dump cycle (\fBrunspercycle\fR
182 parameter) times the number of tapes used per run (\fBruntapes\fR
183 parameter)\. Typically two to four times this calculated number of tapes are in rotation\. While
185 is always willing to use a new tape in its rotation, it refuses to reuse a tape until at least \'\fBtapecycle\fR
186 \-1\' number of other tapes have been used\.
188 It is considered good administrative practice to set the
190 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\.
193 \fBusetimestamps\fR \fI bool\fR
196 \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\.
199 \fBlabel_new_tapes\fR \fI string\fR
201 Default: not set\. When set, this directive will cause
203 to automatically write an
205 tape label to any blank tape she encounters\. This option is DANGEROUS because when set,
207 will ERASE any non\-\fIAmanda\fR
208 tapes you may have, and may also ERASE any near\-failing tapes\. Use with caution\.
210 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:
211 \fBlabel_new_tapes "DailySet1\-%%%"\fR
214 \fBdumpuser\fR \fI string\fR
217 \fIamanda\fR\. The login name
219 uses to run the backups\. The backup client hosts must allow access from the tape server host as this user via
222 \fB\.amandahosts\fR, depending on how the
229 Printer to use when doing tape labels\. See the
238 \fInull:\fR\. The path name of the non\-rewinding tape device\. Non\-rewinding tape device names often have an \'n\' in the name, e\.g\.
239 \fI/dev/rmt/0mn\fR, however this is operating system specific and you should consult that documentation for detailed naming information\.
241 If a tape changer is configured (see the
243 option), this option might not be used\.
247 output driver is selected (see the section OUTPUT DRIVERS in the
249 manpage for more information), programs such as
251 will run normally but all images will be thrown away\. This should only be used for debugging and testing, and probably only with the
257 \fBdevice_property\fR string string
259 These options can set various device properties, including block size, maximum volume usage, authentication information, hardware feature support, and more\.Specifics of how properties are used are device\-dependent, though some common properties are supported across multiple device drivers\.
261 Both strings are 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, do:
265 device_property "BLOCK_SIZE" "131072"
269 The order in which device properties are set is as follows:
272 \h'-04' 1.\h'+02'Tapetype parameters, including length, blocksize, readblocksize, file\-pad, are translated into device properties and set accordingly\.
276 \h'-04' 2.\h'+02'Device properties from any device_property configuration directives are set, in the order they appear in the configuration file\.
280 \fBtpchanger\fR string
283 \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\.
285 If a tape changer is configured, choose one of the changer scripts (e\.g\.
286 \fBchg\-scsi\fR) and enter that here\.
289 \fBchangerdev\fR string
292 \fI/dev/null\fR\. A tape changer configuration parameter\. Usage depends on the particular changer defined with the
297 \fBchangerfile\fR string
300 \fI/usr/adm/amanda/log/changer\-status\fR\. A tape changer configuration parameter\. Usage depends on the particular changer defined with the
308 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\.
310 If a tape changer is configured, this may be set larger than one to let
312 write to more than one tape\.
314 Note that this is an upper bound on the number of tapes, and
318 Also note that as of this release,
320 does not support true tape overflow\. When it reaches the end of one tape, the backup image
322 was processing starts over again on the next tape\.
325 \fBmaxdumpsize\fR int
328 \fIruntapes\fR*\fItape_length\fR\. Maximum number of bytes the planner will schedule for a run\.
331 \fBtaperalgo\fR [first|firstfit|largest|largestfit|smallest|last]
334 \fIfirst\fR\. The algorithm used to choose which dump image to send to the taper\.
338 First in, first out\.
343 The first dump image that will fit on the current tape\.
348 The largest dump image\.
353 The largest dump image that will fit on the current tape\.
358 The smallest dump image\.
367 \fBlabelstr\fR \fI string\fR
370 \fI\.*\fR\. The tape label constraint regular expression\. All tape labels generated (see
371 \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\.
374 \fBtapetype\fR \fI string\fR
377 \fIEXABYTE\fR\. The type of tape drive associated with
380 \fBtpchanger\fR\. This refers to one of the defined
381 \fBtapetype\fRs in the config file (see below), which specify various tape parameters, like the
386 of the tape media and device\.
390 string must be an alphabetic character
396 \fI30 seconds\fR\. Maximum amount of time that
398 will wait for each client host\.
404 \fI1800 seconds\fR\. Amount of idle time per disk on a given client that a
408 will wait before it fails with a data timeout error\.
414 \fI300 seconds\fR\. Amount of time per estimate on a given client that the
418 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,
420 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\.
423 \fBconnect_tries\fR int
426 \fI3\fR\. How many times the server will try a connection\.
432 \fI3\fR\. How many times the server will resend a REQ packet if it doesn\'t get the ACK packet\.
438 \fI8000 Kbps\fR\. The maximum network bandwidth allocated to
439 \fIAmanda\fR, in Kbytes per second\. See also the
447 10\. The maximum number of backups that
449 will attempt to run in parallel\.
451 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\.
454 \fBdisplayunit\fR "k|m|g|t"
457 "k"\. The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera\.
460 \fBdumporder\fR string
463 \fItttTTTTTTT\fR\. The priority order of each dumper:
471 b: smallest bandwidth
480 1\. The maximum number of backups from a single host that
482 will attempt to run in parallel\. See also the
486 Note that this parameter may also be set in a specific
488 (see below)\. This value sets the default for all
489 \fBdumptype\fRs so must appear in
492 \fBdumptype\fRs are defined\.
498 \fI10 Mbytes\fR\. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\. If
500 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
504 The global setting of this parameter can be overwritten inside of a dumptype\-definition\.
513 \fBbumppercent\fR int
516 \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
518 determines that the next higher backup level will be this much smaller than the current level, it will do the next level\.
520 If this parameter is set to 0, the value of the parameter
522 is used to trigger bumping\.
524 The global setting of this parameter can be overwritten inside of a dumptype\-definition\.
533 \fBbumpmult\fR \fI float\fR
536 1\.5\. The bump size multiplier\.
540 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
544 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\.
546 The global setting of this parameter can be overwritten inside of a dumptype\-definition\.
549 \fBbumpdays\fR \fI int\fR
552 \fI2 days\fR\. To insure redundancy in the dumps,
554 keeps filesystems at the same incremental level for at least
556 days, even if the other bump threshold criteria are met\.
558 The global setting of this parameter can be overwritten inside of a dumptype\-definition\.
561 \fBdiskfile\fR \fI string\fR
564 \fIdisklist\fR\. The file name for the
566 file holding client hosts, disks and other client dumping information\.
569 \fBinfofile\fR \fI string\fR
572 \fI/usr/adm/amanda/curinfo\fR\. The file or directory name for the historical information database\. If
574 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\.
577 \fBlogdir\fR \fI string\fR
580 \fI/usr/adm/amanda\fR\. The directory for the
587 \fBindexdir\fR \fI string\fR
590 \fI/usr/adm/amanda/index\fR\. The directory where index files (backup image catalogues) are stored\. Index files are only generated for filesystems whose
597 \fBtapelist\fR \fI string\fR
600 \fItapelist\fR\. The file name for the active
604 maintains this file with information about the active set of tapes\.
607 \fBdevice_output_buffer_size\fR \fI int\fR
610 640k\. Controls the amount of memory used by
612 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\.
615 \fBtapebufs\fR \fI int\fR
618 20\. This option is deprecated; use the
619 \fBdevice_output_buffer_size\fR
622 works the same way, but the number specified is multiplied by the device blocksize prior to use\.
625 \fBreserve\fR \fI number\fR
628 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\.
631 \fBautoflush\fR \fI bool\fR
634 \fIoff\fR\. Whether an amdump run will flush the dumps from holding disk to tape\.
637 \fBamrecover_do_fsf\fR \fI bool\fR
640 \fIon\fR\. Amrecover will call amrestore with the \-f flag for faster positioning of the tape\.
643 \fBamrecover_check_label\fR \fI bool\fR
646 \fIon\fR\. Amrecover will call amrestore with the \-l flag to check the label\.
649 \fBamrecover_changer\fR \fI string\fR
651 Default: \'\'\. Amrecover will use the changer if you use \'settape <string>\' and that string is the same as the amrecover_changer setting\.
654 \fBcolumnspec\fR \fI string\fR
656 Defines the width of columns
660 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:
663 \h'-04' 1.\h'+02'the name of the column, which may be:
667 Compress (compression ratio)
668 Disk (client disk name)
669 DumpRate (dump rate in KBytes/sec)
670 DumpTime (total dump time in hours:minutes)
671 HostName (client host name)
673 OrigKB (original image size in KBytes)
674 OutKB (output image size in KBytes)
675 TapeRate (tape writing rate in KBytes/sec)
676 TapeTime (total tape time in hours:minutes)
683 \h'-04' 2.\h'+02'the amount of space to display before the column (used to get whitespace between columns)\.
688 \h'-04' 3.\h'+02'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\.
695 columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"
699 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\.
702 \fBincludefile\fR \fI string\fR
705 \fInone\fR\. The name of an
707 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\.
713 \fI0\fR\. Debug level of the auth module
716 \fBdebug_event\fR int
719 \fI0\fR\. Debug level of the event module
722 \fBdebug_holding\fR int
725 \fI0\fR\. Debug level of the holdingdisk module
728 \fBdebug_protocol\fR int
731 \fI0\fR\. Debug level of the protocol module
734 \fBdebug_planner\fR int
737 \fI0\fR\. Debug level of the planner process
740 \fBdebug_driver\fR int
743 \fI0\fR\. Debug level of the driver process
746 \fBdebug_dumper\fR int
749 \fI0\fR\. Debug level of the dumper process
752 \fBdebug_chunker\fR int
755 \fI0\fR\. Debug level of the chunker process
758 \fBdebug_taper\fR int
761 \fI0\fR\. Debug level of the taper process
764 \fBflush\-threshold\-dumped\fR int
769 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,
771 will not begin until the inequality
775 is the amount of data on the holding disk,
777 is the capacity of a volume, and
779 is this parameter, expressed as a percentage\.
781 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
783 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\.
785 The value of this parameter may not exceed than that of the
786 \fBflush\-threshold\-scheduled\fR
790 \fBflush\-threshold\-scheduled\fR int
795 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,
797 will not begin until the inequality
801 is the amount of data on the holding disk,
803 is the total amount of data scheduled for this run but not dumped yet,
805 is the capacity of a volume, and
807 is this parameter, expressed as a percentage\.
809 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
811 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\.
813 The value of this parameter may not be less than that of the
814 \fBflush\-threshold\-dumped\fR
823 \fI0\fR\. At the end of a run,
825 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,
827 will begin a new tape if the inequality
831 is the amount of data remaining on the holding disk from this or previous runs,
833 is the capacity of a volume, and
835 is this parameter, expressed as a percentage\.
837 The value of this parameter may not exceed that of the
838 \fBflush\-threshold\-scheduled\fR
841 must be set to \'yes\' if
846 \fBreserved\-udp\-port\fR int,int
848 Default: \-\-with\-udpportrange or
849 \fI512,1023\fR\. Reserved udp port that will be used (bsd, bsdudp)\. Range is inclusive\.
852 \fBreserved\-tcp\-port\fR int,int
854 Default: \-\-with\-low\-tcpportrange or
855 \fI512,1023\fR\. Reserved tcp port that will be used (bsdtcp)\. Range is inclusive\.
858 \fBunreserved\-tcp\-port\fR int,int
860 Default: \-\-with\-tcpportrange or
861 \fI1024,65535\fR\. Unreserved tcp port that will be used (bsd, bsdudp)\. Range is inclusive\.
863 .SH "HOLDINGDISK SECTION"
867 file may define one or more holding disks used as buffers to hold backup images before they are written to tape\. The syntax is:
871 holdingdisk \fIname\fR {
872 \fIholdingdisk\-option\fR \fIholdingdisk\-value\fR
879 is a logical name for this holding disk\.
881 The options and values are:
883 \fBcomment\fR \fI string\fR
886 \fInone\fR\. A comment string describing this holding disk\.
889 \fBdirectory\fR \fI disk\fR
892 \fI/dumps/amanda\fR\. The path to this holding area\.
898 \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,
900 will use all available space minus that value\.
903 \fBchunksize\fR \fI int\fR
906 \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\.
910 will create holding disk chunks as large as ((INT_MAX/1024)\-64) Kbytes\.
912 Each holding disk chunk includes a 32 Kbyte header, so the minimum chunk size is 64 Kbytes (but that would be really silly)\.
914 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
916 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\.
918 .SH "DUMPTYPE SECTION"
922 file may define multiple sets of backup options and refer to them by name from the
924 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\.
926 A set of backup options are entered in a
928 section, which looks like this:
932 define dumptype \fIname\fR {
933 \fIdumptype\-option\fR \fIdumptype\-value\fR
940 is the name of this set of backup options\. It is referenced from the
944 Some of the options in a
946 section are the same as those in the main part of
947 \fIamanda\.conf\fR\. The main option value is used to set the default for all
949 sections\. For instance, setting
951 to 50 in the main part of the config file causes all following
953 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
954 \fBdumptype\fRs are defined\.
956 The dumptype options and values are:
958 \fBauth\fR \fI string\fR
961 \fIbsd\fR\. Type of authorization to perform between tape server and backup client hosts\.
963 \fBbsd\fR, bsd authorization with udp initial connection and one tcp connection by data stream\.
965 \fBbsdtcp\fR, bsd authorization but use only one tcp connection\.
967 \fBbsdudp\fR, like bsd, but will use only one tcp connection for all data stream\.
970 to use Kerberos\-IV authorization\.
973 to use Kerberos\-V authorization\.
975 \fBlocal\fR, if the client is the server, it doesn\'t require authencation setup\.
978 to use rsh authorization\.
981 to use OpenSSH authorization\.
984 \fBamandad_path\fR \fI string\fR
987 \fI$libexec/amandad\fR\. Specify the amandad path of the client, only use with rsh/ssh authentification\.
990 \fBclient_username\fR \fI string\fR
993 \fICLIENT_LOGIN\fR\. Specify the username to connect on the client, only use with rsh/ssh authentification\.
999 \fI10 Mbytes\fR\. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\. If
1001 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
1005 See also the options
1012 \fBbumppercent\fR int
1015 \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
1017 determines that the next higher backup level will be this much smaller than the current level, it will do the next level\.
1019 If this parameter is set to 0, the value of the parameter
1021 is used to trigger bumping\.
1023 See also the options
1030 \fBbumpmult\fR \fI float\fR
1033 1\.5\. The bump size multiplier\.
1037 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
1041 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\.
1044 \fBbumpdays\fR \fI int\fR
1047 \fI2 days\fR\. To insure redundancy in the dumps,
1049 keeps filesystems at the same incremental level for at least
1051 days, even if the other bump threshold criteria are met\.
1054 \fBcomment\fR \fI string\fR
1057 \fInone\fR\. A comment string describing this set of backup options\.
1060 \fBcomprate\fR \fIfloat\fR [, \fIfloat\fR ]
1064 0\.50\. The expected full and incremental compression factor for dumps\. It is only used if
1066 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\.
1069 \fBcompress [client|server]\fR \fI string\fR
1072 \fIclient fast\fR\. If
1074 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\.
1076 For either type of compression,
1078 also allows the selection of three styles of compression\.
1080 is the best compression available, often at the expense of CPU overhead\.
1082 is often not as good a compression as
1083 \fBbest\fR, but usually less CPU overhead\. Or to specify
1085 to use your own compression method\. (See dumptype custom\-compress in example/amanda\.conf for reference)
1089 options line may be one of:
1095 compress client fast
1099 compress client best
1103 compress client custom
1106 \fIclient_custom_compress\fR
1109 PROG must not contain white space and it must accept \-d for uncompress\.
1112 compress server fast
1116 compress server best
1120 compress server custom
1123 \fIserver_custom_compress\fR
1126 PROG must not contain white space and it must accept \-d for uncompress\.
1129 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
1133 (software) compression should be disabled\.
1136 \fBdumpcycle\fR \fI int\fR
1139 \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\.
1142 \fBencrypt [none|client|server]\fR
1145 \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\.
1149 options line may be one of:
1157 Specify client_encrypt "PROG"
1159 PROG must not contain white space\.
1161 Specify client_decrypt_option "decryption\-parameter" Default: "\-d"
1163 decryption\-parameter must not contain white space\.
1165 (See dumptype server\-encrypt\-fast in example/amanda\.conf for reference)
1170 Specify server_encrypt "PROG"
1172 PROG must not contain white space\.
1174 Specify server_decrypt_option "decryption\-parameter" Default: "\-d"
1176 decryption\-parameter must not contain white space\.
1178 (See dumptype client\-encrypt\-nocomp in example/amanda\.conf for reference)
1181 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\.
1183 which is a wrapper of
1185 is provided as a reference symmetric encryption program\.
1188 \fBestimate\fR \fIclient|calcsize|server\fR
1191 \fIclient\fR\. Determine the way
1193 does it\'s estimate\.
1197 Use the same program as the dumping program, this is the most accurate way to do estimates, but it can take a long time\.
1202 Use a faster program to do estimates, but the result is less accurate\.
1207 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\.
1211 \fBexclude\fR [ list|file ][[optional][ append ][ \fIstring\fR ]+]
1214 \fIfile\fR\. There are two exclude lists,
1217 \fBexclude list\.\fR
1224 exclude expression\. With
1228 is a file name on the client containing
1230 exclude expressions\. The path to the specified exclude list file, if present (see description of \'optional\' below), must be readable by the
1234 All exclude expressions are concatenated in one file and passed to
1237 \fB\-\-exclude\-from\fR
1240 Exclude expressions must always be specified as relative to the head directory of the DLE\.
1246 is appended to the current list, without it, the
1248 overwrites the list\.
1253 \fBexclude list\fR, then amcheck will not complain if the file doesn\'t exist or is not readable\.
1256 \fBexclude list\fR, if the file name is relative, the disk name being backed up is prepended\. So if this is entered:
1260 exclude list "\.amanda\.excludes"
1263 the actual file used would be
1264 \fI/var/\.amanda\.excludes\fR
1267 \fI/usr/local/\.amanda\.excludes\fR
1269 \fI/usr/local\fR, and so on\.
1272 \fBholdingdisk\fR [ never|auto|required ]
1275 \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
1277 is backing up, that file system should refer to a dumptype with
1281 to avoid backing up the holding disk into itself\.
1283 \fBnever\fR|no|false|off
1285 Never use a holdingdisk, the dump will always go directly to tape\. There will be no dump if you have a tape error\.
1288 \fBauto\fR|yes|true|on
1290 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)
1295 Always dump to holdingdisk, never directly to tape\. There will be no dump if it doesn\'t fit on holdingdisk
1299 \fBignore\fR \fI boolean\fR
1302 \fIno\fR\. Whether disks associated with this backup type should be backed up or not\. This option is useful when the
1304 file is shared among several configurations, some of which should not back up all the listed file systems\.
1307 \fBinclude\fR [ list|file ][[optional][ append ][ \fIstring\fR ]+]
1311 "\."\. There are two include lists,
1314 \fBinclude list\.\fR
1319 is a glob expression\. With
1323 is a file name on the client containing glob expressions\.
1325 All include expressions are expanded by
1326 \fIAmanda\fR, concatenated in one file and passed to
1329 \fB\-\-files\-from\fR
1330 argument\. They must start with "\./" and contain no other "/"\.
1332 Include expressions must always be specified as relative to the head directory of the DLE\.
1335 .nr an-no-space-flag 1
1339 For globbing to work at all, even the limited single level, the top level directory of the DLE must be readable by the
1347 is appended to the current list, without it, the
1349 overwrites the list\.
1355 then amcheck will not complain if the file doesn\'t exist or is not readable\.
1358 \fBinclude list\fR, If the file name is relative, the disk name being backed up is prepended\.
1361 \fBindex\fR \fI boolean\fR
1364 \fIno\fR\. Whether an index (catalogue) of the backup should be generated and saved in
1365 \fBindexdir\fR\. These catalogues are used by the
1370 \fBkencrypt\fR \fI boolean\fR
1373 \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\.
1376 \fBmaxdumps\fR \fI int\fR
1379 1\. The maximum number of backups from a single host that
1381 will attempt to run in parallel\. See also the main section parameter
1385 \fBmaxpromoteday\fR \fI int\fR
1388 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\.
1391 \fBpriority\fR \fI string\fR
1394 \fImedium\fR\. When there is no tape to write to,
1396 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\.
1399 \fBprogram\fR \fI string\fR
1402 \fIDUMP\fR\. The type of backup to perform\. Valid values are
1404 for the native operating system backup program, and
1408 or to do PC backups using Samba\.
1411 \fBrecord\fR \fI boolean\fR
1414 \fIyes\fR\. Whether to ask the backup program to update its database (e\.g\.
1415 \fI/etc/dumpdates\fR
1417 \fI/usr/local/var/amanda/gnutar\-lists\fR
1418 for GNUTAR) of time stamps\. This is normally enabled for daily backups and turned off for periodic archival runs\.
1421 \fBskip\-full\fR \fI boolean\fR
1428 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
1430 only schedules level 1 incrementals in this configuration; this is probably a bug\.
1433 \fBskip\-incr\fR \fI boolean\fR
1440 has scheduled an incremental backup, these disks will be skipped\.
1443 \fBstarttime\fR \fI int\fR
1446 \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
1450 \fBstrategy\fR \fI string\fR
1453 \fIstandard\fR\. Strategy to use when planning what level of backup to run next\. Values are:
1464 Never do full backups, only level 1 incrementals\.
1469 Never do incremental backups, only full dumps\.
1474 Never do backups (useful when sharing the
1481 Only do incremental dumps\.
1483 should be used to tell
1485 that a full dump has been performed off\-line, so that it resets to level 1\. It is similar to skip\-full, but with incronly full dumps may be scheduled manually\. Unfortunately, it appears that
1487 will perform full backups with this configuration, which is probably a bug\.
1491 \fBtape_splitsize\fR \fI int\fR
1494 \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\.
1497 \fBsplit_diskbuffer\fR \fI string\fR
1500 \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\.
1503 \fBfallback_splitsize\fR \fI int\fR
1506 \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\.
1511 entries are predefined by
1516 define dumptype no\-compress {
1519 define dumptype compress\-fast {
1520 compress client fast
1522 define dumptype compress\-best {
1523 compress client best
1525 define dumptype srvcompress {
1526 compress server fast
1528 define dumptype bsd\-auth {
1531 define dumptype krb4\-auth {
1534 define dumptype no\-record {
1537 define dumptype no\-hold {
1540 define dumptype no\-full {
1546 In addition to options in a
1548 section, one or more other
1550 names may be entered, which make this
1552 inherit options from other previously defined
1553 \fBdumptype\fRs\. For instance, two sections might be the same except for the
1559 define dumptype normal {
1560 comment "Normal backup, no compression, do indexing"
1565 define dumptype testing {
1566 comment "Test backup, no compression, do indexing, no recording"
1581 \fBdumptype\fRs should reference\. This provides an easy place to make changes that will affect every
1583 .SH "TAPETYPE SECTION"
1587 file may define multiple types of tape media and devices\. The information is entered in a
1589 section, which looks like this in the config file:
1593 define tapetype \fIname\fR {
1594 \fItapetype\-option\fR \fItapetype\-value\fR
1601 is the name of this type of tape medium/device\. It is referenced from the
1603 option in the main part of the config file\.
1605 The tapetype options and values are:
1607 \fBcomment\fR \fI string\fR
1610 \fInone\fR\. A comment string describing this set of tape information\.
1613 \fBfilemark\fR \fI int\fR
1616 \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\.
1619 \fBlength\fR \fI int\fR
1622 \fI2000 kbytes\fR\. How much data will fit on a tape\.
1624 Note that this value is only used by
1626 to schedule which backups will be run\. Once the backups start,
1628 will continue to write to a tape until it gets an error, regardless of what value is entered for
1630 (but see the section OUTPUT DRIVERS in the
1632 manpage for exceptions)\.
1635 \fBblocksize\fR \fI int\fR
1638 \fI32 kbytes\fR\. How much data will be written in each tape record expressed in KiloBytes\. The tape record size (= blocksize) can not be reduced below the default 32 KBytes\. The parameter blocksize can only be raised if
1640 was compiled with the configure option \-\-with\-maxtapeblocksize=N set with "N" greater than 32 during
1644 \fBreadblocksize\fR \fI int\fR
1646 Default: (\fIfrom configure \-\-with\-maxtapeblocksize\fR)\. How much data will be read in each tape record expressed in KiloBytes\. Some hardware require a value not too large, and some require it to be equal to the blocksize\. It is useful if you configured amanda with a big \-\-with\-maxtapeblocksize and your hardware don\'t work with a value that big\.
1649 \fBfile\-pad\fR \fI boolean\fR
1652 \fItrue\fR\. If true, every record, including the last one in the file, will have the same length\. This matches the way
1654 wrote tapes prior to the availability of this parameter\. It may also be useful on devices that only support a fixed blocksize\.
1656 Note that the last record on the tape probably includes trailing null byte padding, which will be passed back to
1659 or the restore program\. Most programs just ignore this (although possibly with a warning)\.
1661 If this parameter is false, the last record in a file may be shorter than the block size\. The file will contain the same amount of data the dump program generated, without trailing null byte padding\. When read, the same amount of data that was written will be returned\.
1664 \fBspeed\fR \fI int\fR
1667 \fI200 bps\fR\. How fast the drive will accept data, in bytes per second\. This parameter is NOT currently used by
1671 \fBlbl\-templ\fR \fI string\fR
1673 A PostScript template file used by
1675 to generate labels\. Several sample files are provided with the
1681 man page for more information\.
1684 In addition to options, another
1686 name may be entered, which makes this
1688 inherit options from another
1689 \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:
1693 define tapetype DLT4000\-III {
1694 comment "DLT4000 tape drives with Compact\-III tapes"
1695 length 12500 mbytes # 10 Gig tapes with some compression
1696 filemark 2000 kbytes
1699 define tapetype DLT4000\-IV {
1701 comment "DLT4000 tape drives with Compact\-IV tapes"
1702 length 25000 mbytes # 20 Gig tapes with some compression
1707 .SH "INTERFACE SECTION"
1711 file may define multiple types of network interfaces\. The information is entered in an
1713 section, which looks like this:
1717 define interface \fIname\fR {
1718 \fIinterface\-option\fR \fIinterface\-value\fR
1725 is the name of this type of network interface\. It is referenced from the
1729 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
1732 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,
1734 will use as much of the network as it can leaving throttling up to the operating system and network hardware\.
1736 The interface options and values are:
1738 \fBcomment\fR \fI string\fR
1741 \fInone\fR\. A comment string describing this set of network information\.
1744 \fBuse\fR \fI int\fR
1747 \fI8000 Kbps\fR\. The speed of the interface in Kbytes per second\.
1750 In addition to options, another
1752 name may be entered, which makes this
1754 inherit options from another
1755 \fBinterface\fR\. At the moment, this is of little use\.
1759 <jds@amanda\.org>: Original text
1761 Stefan G\. Weichinger,
1762 <sgw@amanda\.org>, maintainer of the
1763 \fIAmanda\fR\-documentation: XML\-conversion, major update, splitting
1768 \fBamanda-client.conf\fR(5),
1771 \fBhttp://wiki.zmanda.com\fR()
1773 An updated version of this man page may be available at http://wiki\.zmanda\.com/index\.php/Amanda\.conf\.