3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
8 .TH "AMANDA\.CONF" "5" "08/22/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:
263 device_property "BLOCK_SIZE" "131072".fi
265 The order in which device properties are set is as follows:
268 \h'-04' 1.\h'+02'Tapetype parameters, including length, blocksize, readblocksize, file\-pad, are translated into device properties and set accordingly\.
272 \h'-04' 2.\h'+02'Device properties from any device_property configuration directives are set, in the order they appear in the configuration file\.
276 \fBtpchanger\fR string
279 \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\.
281 If a tape changer is configured, choose one of the changer scripts (e\.g\.
282 \fBchg\-scsi\fR) and enter that here\.
285 \fBchangerdev\fR string
288 \fI/dev/null\fR\. A tape changer configuration parameter\. Usage depends on the particular changer defined with the
293 \fBchangerfile\fR string
296 \fI/usr/adm/amanda/log/changer\-status\fR\. A tape changer configuration parameter\. Usage depends on the particular changer defined with the
304 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\.
306 If a tape changer is configured, this may be set larger than one to let
308 write to more than one tape\.
310 Note that this is an upper bound on the number of tapes, and
314 Also note that as of this release,
316 does not support true tape overflow\. When it reaches the end of one tape, the backup image
318 was processing starts over again on the next tape\.
321 \fBmaxdumpsize\fR int
324 \fIruntapes\fR*\fItape_length\fR\. Maximum number of bytes the planner will schedule for a run\.
327 \fBtaperalgo\fR [first|firstfit|largest|largestfit|smallest|last]
330 \fIfirst\fR\. The algorithm used to choose which dump image to send to the taper\.
334 First in, first out\.
339 The first dump image that will fit on the current tape\.
344 The largest dump image\.
349 The largest dump image that will fit on the current tape\.
354 The smallest dump image\.
363 \fBlabelstr\fR \fI string\fR
366 \fI\.*\fR\. The tape label constraint regular expression\. All tape labels generated (see
367 \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\.
370 \fBtapetype\fR \fI string\fR
373 \fIEXABYTE\fR\. The type of tape drive associated with
376 \fBtpchanger\fR\. This refers to one of the defined
377 \fBtapetype\fRs in the config file (see below), which specify various tape parameters, like the
382 of the tape media and device\.
386 string must be an alphabetic character
392 \fI30 seconds\fR\. Maximum amount of time that
394 will wait for each client host\.
400 \fI1800 seconds\fR\. Amount of idle time per disk on a given client that a
404 will wait before it fails with a data timeout error\.
410 \fI300 seconds\fR\. Amount of time per estimate on a given client that the
414 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,
416 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\.
419 \fBconnect_tries\fR int
422 \fI3\fR\. How many times the server will try a connection\.
428 \fI3\fR\. How many times the server will resend a REQ packet if it doesn\'t get the ACK packet\.
434 \fI8000 Kbps\fR\. The maximum network bandwidth allocated to
435 \fIAmanda\fR, in Kbytes per second\. See also the
443 10\. The maximum number of backups that
445 will attempt to run in parallel\.
447 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\.
450 \fBdisplayunit\fR "k|m|g|t"
453 "k"\. The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera\.
456 \fBdumporder\fR string
459 \fItttTTTTTTT\fR\. The priority order of each dumper:
466 b: smallest bandwidth
474 1\. The maximum number of backups from a single host that
476 will attempt to run in parallel\. See also the
480 Note that this parameter may also be set in a specific
482 (see below)\. This value sets the default for all
483 \fBdumptype\fRs so must appear in
486 \fBdumptype\fRs are defined\.
492 \fI10 Mbytes\fR\. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\. If
494 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
498 The global setting of this parameter can be overwritten inside of a dumptype\-definition\.
507 \fBbumppercent\fR int
510 \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
512 determines that the next higher backup level will be this much smaller than the current level, it will do the next level\.
514 If this parameter is set to 0, the value of the parameter
516 is used to trigger bumping\.
518 The global setting of this parameter can be overwritten inside of a dumptype\-definition\.
527 \fBbumpmult\fR \fI float\fR
530 1\.5\. The bump size multiplier\.
534 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
538 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\.
540 The global setting of this parameter can be overwritten inside of a dumptype\-definition\.
543 \fBbumpdays\fR \fI int\fR
546 \fI2 days\fR\. To insure redundancy in the dumps,
548 keeps filesystems at the same incremental level for at least
550 days, even if the other bump threshold criteria are met\.
552 The global setting of this parameter can be overwritten inside of a dumptype\-definition\.
555 \fBdiskfile\fR \fI string\fR
558 \fIdisklist\fR\. The file name for the
560 file holding client hosts, disks and other client dumping information\.
563 \fBinfofile\fR \fI string\fR
566 \fI/usr/adm/amanda/curinfo\fR\. The file or directory name for the historical information database\. If
568 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\.
571 \fBlogdir\fR \fI string\fR
574 \fI/usr/adm/amanda\fR\. The directory for the
581 \fBindexdir\fR \fI string\fR
584 \fI/usr/adm/amanda/index\fR\. The directory where index files (backup image catalogues) are stored\. Index files are only generated for filesystems whose
591 \fBtapelist\fR \fI string\fR
594 \fItapelist\fR\. The file name for the active
598 maintains this file with information about the active set of tapes\.
601 \fBdevice_output_buffer_size\fR \fI int\fR
604 640k\. Controls the amount of memory used by
606 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\.
609 \fBtapebufs\fR \fI int\fR
612 20\. This option is deprecated; use the
613 \fBdevice_output_buffer_size\fR
616 works the same way, but the number specified is multiplied by the device blocksize prior to use\.
619 \fBreserve\fR \fI number\fR
622 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\.
625 \fBautoflush\fR \fI bool\fR
628 \fIoff\fR\. Whether an amdump run will flush the dumps from holding disk to tape\.
631 \fBamrecover_do_fsf\fR \fI bool\fR
634 \fIon\fR\. Amrecover will call amrestore with the \-f flag for faster positioning of the tape\.
637 \fBamrecover_check_label\fR \fI bool\fR
640 \fIon\fR\. Amrecover will call amrestore with the \-l flag to check the label\.
643 \fBamrecover_changer\fR \fI string\fR
645 Default: \'\'\. Amrecover will use the changer if you use \'settape <string>\' and that string is the same as the amrecover_changer setting\.
648 \fBcolumnspec\fR \fI string\fR
650 Defines the width of columns
654 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:
657 \h'-04' 1.\h'+02'the name of the column, which may be:
659 Compress (compression ratio)
660 Disk (client disk name)
661 DumpRate (dump rate in KBytes/sec)
662 DumpTime (total dump time in hours:minutes)
663 HostName (client host name)
665 OrigKB (original image size in KBytes)
666 OutKB (output image size in KBytes)
667 TapeRate (tape writing rate in KBytes/sec)
668 TapeTime (total tape time in hours:minutes)
673 \h'-04' 2.\h'+02'the amount of space to display before the column (used to get whitespace between columns)\.
678 \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\.
684 columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"
687 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\.
690 \fBincludefile\fR \fI string\fR
693 \fInone\fR\. The name of an
695 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\.
701 \fI0\fR\. Debug level of the auth module
704 \fBdebug_event\fR int
707 \fI0\fR\. Debug level of the event module
710 \fBdebug_holding\fR int
713 \fI0\fR\. Debug level of the holdingdisk module
716 \fBdebug_protocol\fR int
719 \fI0\fR\. Debug level of the protocol module
722 \fBdebug_planner\fR int
725 \fI0\fR\. Debug level of the planner process
728 \fBdebug_driver\fR int
731 \fI0\fR\. Debug level of the driver process
734 \fBdebug_dumper\fR int
737 \fI0\fR\. Debug level of the dumper process
740 \fBdebug_chunker\fR int
743 \fI0\fR\. Debug level of the chunker process
746 \fBdebug_taper\fR int
749 \fI0\fR\. Debug level of the taper process
752 \fBflush\-threshold\-dumped\fR int
757 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,
759 will not begin until the inequality
763 is the amount of data on the holding disk,
765 is the capacity of a volume, and
767 is this parameter, expressed as a percentage\.
769 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
771 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\.
773 The value of this parameter may not exceed than that of the
774 \fBflush\-threshold\-scheduled\fR
778 \fBflush\-threshold\-scheduled\fR int
783 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,
785 will not begin until the inequality
789 is the amount of data on the holding disk,
791 is the total amount of data scheduled for this run but not dumped yet,
793 is the capacity of a volume, and
795 is this parameter, expressed as a percentage\.
797 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
799 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\.
801 The value of this parameter may not be less than that of the
802 \fBflush\-threshold\-dumped\fR
811 \fI0\fR\. At the end of a run,
813 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,
815 will begin a new tape if the inequality
819 is the amount of data remaining on the holding disk from this or previous runs,
821 is the capacity of a volume, and
823 is this parameter, expressed as a percentage\.
825 The value of this parameter may not exceed that of the
826 \fBflush\-threshold\-scheduled\fR
829 must be set to \'yes\' if
834 \fBreserved\-udp\-port\fR int,int
836 Default: \-\-with\-udpportrange or
837 \fI512,1023\fR\. Reserved udp port that will be used (bsd, bsdudp)\. Range is inclusive\.
840 \fBreserved\-tcp\-port\fR int,int
842 Default: \-\-with\-low\-tcpportrange or
843 \fI512,1023\fR\. Reserved tcp port that will be used (bsdtcp)\. Range is inclusive\.
846 \fBunreserved\-tcp\-port\fR int,int
848 Default: \-\-with\-tcpportrange or
849 \fI1024,65535\fR\. Unreserved tcp port that will be used (bsd, bsdudp)\. Range is inclusive\.
851 .SH "HOLDINGDISK SECTION"
855 file may define one or more holding disks used as buffers to hold backup images before they are written to tape\. The syntax is:
857 holdingdisk \fIname\fR {
858 \fIholdingdisk\-option\fR \fIholdingdisk\-value\fR
864 is a logical name for this holding disk\.
866 The options and values are:
868 \fBcomment\fR \fI string\fR
871 \fInone\fR\. A comment string describing this holding disk\.
874 \fBdirectory\fR \fI disk\fR
877 \fI/dumps/amanda\fR\. The path to this holding area\.
883 \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,
885 will use all available space minus that value\.
888 \fBchunksize\fR \fI int\fR
891 \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\.
895 will create holding disk chunks as large as ((INT_MAX/1024)\-64) Kbytes\.
897 Each holding disk chunk includes a 32 Kbyte header, so the minimum chunk size is 64 Kbytes (but that would be really silly)\.
899 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
901 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\.
903 .SH "DUMPTYPE SECTION"
907 file may define multiple sets of backup options and refer to them by name from the
909 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\.
911 A set of backup options are entered in a
913 section, which looks like this:
915 define dumptype \fIname\fR {
916 \fIdumptype\-option\fR \fIdumptype\-value\fR
922 is the name of this set of backup options\. It is referenced from the
926 Some of the options in a
928 section are the same as those in the main part of
929 \fIamanda\.conf\fR\. The main option value is used to set the default for all
931 sections\. For instance, setting
933 to 50 in the main part of the config file causes all following
935 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
936 \fBdumptype\fRs are defined\.
938 The dumptype options and values are:
940 \fBauth\fR \fI string\fR
943 \fIbsd\fR\. Type of authorization to perform between tape server and backup client hosts\.
945 \fBbsd\fR, bsd authorization with udp initial connection and one tcp connection by data stream\.
947 \fBbsdtcp\fR, bsd authorization but use only one tcp connection\.
949 \fBbsdudp\fR, like bsd, but will use only one tcp connection for all data stream\.
952 to use Kerberos\-IV authorization\.
955 to use Kerberos\-V authorization\.
957 \fBlocal\fR, if the client is the server, it doesn\'t require authencation setup\.
960 to use rsh authorization\.
963 to use OpenSSH authorization\.
966 \fBamandad_path\fR \fI string\fR
969 \fI$libexec/amandad\fR\. Specify the amandad path of the client, only use with rsh/ssh authentification\.
972 \fBclient_username\fR \fI string\fR
975 \fICLIENT_LOGIN\fR\. Specify the username to connect on the client, only use with rsh/ssh authentification\.
981 \fI10 Mbytes\fR\. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size\. If
983 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
994 \fBbumppercent\fR int
997 \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
999 determines that the next higher backup level will be this much smaller than the current level, it will do the next level\.
1001 If this parameter is set to 0, the value of the parameter
1003 is used to trigger bumping\.
1005 See also the options
1012 \fBbumpmult\fR \fI float\fR
1015 1\.5\. The bump size multiplier\.
1019 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
1023 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\.
1026 \fBbumpdays\fR \fI int\fR
1029 \fI2 days\fR\. To insure redundancy in the dumps,
1031 keeps filesystems at the same incremental level for at least
1033 days, even if the other bump threshold criteria are met\.
1036 \fBcomment\fR \fI string\fR
1039 \fInone\fR\. A comment string describing this set of backup options\.
1042 \fBcomprate\fR \fIfloat\fR [, \fIfloat\fR ]
1046 0\.50\. The expected full and incremental compression factor for dumps\. It is only used if
1048 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\.
1051 \fBcompress [client|server]\fR \fI string\fR
1054 \fIclient fast\fR\. If
1056 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\.
1058 For either type of compression,
1060 also allows the selection of three styles of compression\.
1062 is the best compression available, often at the expense of CPU overhead\.
1064 is often not as good a compression as
1065 \fBbest\fR, but usually less CPU overhead\. Or to specify
1067 to use your own compression method\. (See dumptype custom\-compress in example/amanda\.conf for reference)
1071 options line may be one of:
1077 compress client fast
1081 compress client best
1085 compress client custom
1088 \fIclient_custom_compress\fR
1091 PROG must not contain white space and it must accept \-d for uncompress\.
1094 compress server fast
1098 compress server best
1102 compress server custom
1105 \fIserver_custom_compress\fR
1108 PROG must not contain white space and it must accept \-d for uncompress\.
1111 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
1115 (software) compression should be disabled\.
1118 \fBdumpcycle\fR \fI int\fR
1121 \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\.
1124 \fBencrypt [none|client|server]\fR
1127 \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\.
1131 options line may be one of:
1139 Specify client_encrypt "PROG"
1141 PROG must not contain white space\.
1143 Specify client_decrypt_option "decryption\-parameter" Default: "\-d"
1145 decryption\-parameter must not contain white space\.
1147 (See dumptype server\-encrypt\-fast in example/amanda\.conf for reference)
1152 Specify server_encrypt "PROG"
1154 PROG must not contain white space\.
1156 Specify server_decrypt_option "decryption\-parameter" Default: "\-d"
1158 decryption\-parameter must not contain white space\.
1160 (See dumptype client\-encrypt\-nocomp in example/amanda\.conf for reference)
1163 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\.
1165 which is a wrapper of
1167 is provided as a reference symmetric encryption program\.
1170 \fBestimate\fR \fIclient|calcsize|server\fR
1173 \fIclient\fR\. Determine the way
1175 does it\'s estimate\.
1179 Use the same program as the dumping program, this is the most accurate way to do estimates, but it can take a long time\.
1184 Use a faster program to do estimates, but the result is less accurate\.
1189 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\.
1193 \fBexclude\fR [ list|file ][[optional][ append ][ \fIstring\fR ]+]
1196 \fIfile\fR\. There are two exclude lists,
1199 \fBexclude list\.\fR
1206 exclude expression\. With
1210 is a file name on the client containing
1212 exclude expressions\. The path to the specified exclude list file, if present (see description of \'optional\' below), must be readable by the
1216 All exclude expressions are concatenated in one file and passed to
1219 \fB\-\-exclude\-from\fR
1222 Exclude expressions must always be specified as relative to the head directory of the DLE\.
1228 is appended to the current list, without it, the
1230 overwrites the list\.
1235 \fBexclude list\fR, then amcheck will not complain if the file doesn\'t exist or is not readable\.
1238 \fBexclude list\fR, if the file name is relative, the disk name being backed up is prepended\. So if this is entered:
1240 exclude list "\.amanda\.excludes"
1242 the actual file used would be
1243 \fI/var/\.amanda\.excludes\fR
1246 \fI/usr/local/\.amanda\.excludes\fR
1248 \fI/usr/local\fR, and so on\.
1251 \fBholdingdisk\fR [ never|auto|required ]
1254 \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
1256 is backing up, that file system should refer to a dumptype with
1260 to avoid backing up the holding disk into itself\.
1262 \fBnever\fR|no|false|off
1264 Never use a holdingdisk, the dump will always go directly to tape\. There will be no dump if you have a tape error\.
1267 \fBauto\fR|yes|true|on
1269 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)
1274 Always dump to holdingdisk, never directly to tape\. There will be no dump if it doesn\'t fit on holdingdisk
1278 \fBignore\fR \fI boolean\fR
1281 \fIno\fR\. Whether disks associated with this backup type should be backed up or not\. This option is useful when the
1283 file is shared among several configurations, some of which should not back up all the listed file systems\.
1286 \fBinclude\fR [ list|file ][[optional][ append ][ \fIstring\fR ]+]
1290 "\."\. There are two include lists,
1293 \fBinclude list\.\fR
1298 is a glob expression\. With
1302 is a file name on the client containing glob expressions\.
1304 All include expressions are expanded by
1305 \fIAmanda\fR, concatenated in one file and passed to
1308 \fB\-\-files\-from\fR
1309 argument\. They must start with "\./" and contain no other "/"\.
1311 Include expressions must always be specified as relative to the head directory of the DLE\.
1314 .nr an-no-space-flag 1
1318 For globbing to work at all, even the limited single level, the top level directory of the DLE must be readable by the
1326 is appended to the current list, without it, the
1328 overwrites the list\.
1334 then amcheck will not complain if the file doesn\'t exist or is not readable\.
1337 \fBinclude list\fR, If the file name is relative, the disk name being backed up is prepended\.
1340 \fBindex\fR \fI boolean\fR
1343 \fIno\fR\. Whether an index (catalogue) of the backup should be generated and saved in
1344 \fBindexdir\fR\. These catalogues are used by the
1349 \fBkencrypt\fR \fI boolean\fR
1352 \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\.
1355 \fBmaxdumps\fR \fI int\fR
1358 1\. The maximum number of backups from a single host that
1360 will attempt to run in parallel\. See also the main section parameter
1364 \fBmaxpromoteday\fR \fI int\fR
1367 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\.
1370 \fBpriority\fR \fI string\fR
1373 \fImedium\fR\. When there is no tape to write to,
1375 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\.
1378 \fBprogram\fR \fI string\fR
1381 \fIDUMP\fR\. The type of backup to perform\. Valid values are
1383 for the native operating system backup program, and
1387 or to do PC backups using Samba\.
1390 \fBrecord\fR \fI boolean\fR
1393 \fIyes\fR\. Whether to ask the backup program to update its database (e\.g\.
1394 \fI/etc/dumpdates\fR
1396 \fI/usr/local/var/amanda/gnutar\-lists\fR
1397 for GNUTAR) of time stamps\. This is normally enabled for daily backups and turned off for periodic archival runs\.
1400 \fBskip\-full\fR \fI boolean\fR
1407 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
1409 only schedules level 1 incrementals in this configuration; this is probably a bug\.
1412 \fBskip\-incr\fR \fI boolean\fR
1419 has scheduled an incremental backup, these disks will be skipped\.
1422 \fBstarttime\fR \fI int\fR
1425 \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
1429 \fBstrategy\fR \fI string\fR
1432 \fIstandard\fR\. Strategy to use when planning what level of backup to run next\. Values are:
1443 Never do full backups, only level 1 incrementals\.
1448 Never do incremental backups, only full dumps\.
1453 Never do backups (useful when sharing the
1460 Only do incremental dumps\.
1462 should be used to tell
1464 that a full dump has been performed off\-line, so that it resets to level 1\.
1468 \fBtape_splitsize\fR \fI int\fR
1471 \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\.
1474 \fBsplit_diskbuffer\fR \fI string\fR
1477 \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\.
1480 \fBfallback_splitsize\fR \fI int\fR
1483 \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\.
1488 entries are predefined by
1491 define dumptype no\-compress {
1494 define dumptype compress\-fast {
1495 compress client fast
1497 define dumptype compress\-best {
1498 compress client best
1500 define dumptype srvcompress {
1501 compress server fast
1503 define dumptype bsd\-auth {
1506 define dumptype krb4\-auth {
1509 define dumptype no\-record {
1512 define dumptype no\-hold {
1515 define dumptype no\-full {
1520 In addition to options in a
1522 section, one or more other
1524 names may be entered, which make this
1526 inherit options from other previously defined
1527 \fBdumptype\fRs\. For instance, two sections might be the same except for the
1531 define dumptype normal {
1532 comment "Normal backup, no compression, do indexing"
1537 define dumptype testing {
1538 comment "Test backup, no compression, do indexing, no recording"
1552 \fBdumptype\fRs should reference\. This provides an easy place to make changes that will affect every
1554 .SH "TAPETYPE SECTION"
1558 file may define multiple types of tape media and devices\. The information is entered in a
1560 section, which looks like this in the config file:
1562 define tapetype \fIname\fR {
1563 \fItapetype\-option\fR \fItapetype\-value\fR
1569 is the name of this type of tape medium/device\. It is referenced from the
1571 option in the main part of the config file\.
1573 The tapetype options and values are:
1575 \fBcomment\fR \fI string\fR
1578 \fInone\fR\. A comment string describing this set of tape information\.
1581 \fBfilemark\fR \fI int\fR
1584 \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\.
1587 \fBlength\fR \fI int\fR
1590 \fI2000 kbytes\fR\. How much data will fit on a tape\.
1592 Note that this value is only used by
1594 to schedule which backups will be run\. Once the backups start,
1596 will continue to write to a tape until it gets an error, regardless of what value is entered for
1598 (but see the section OUTPUT DRIVERS in the
1600 manpage for exceptions)\.
1603 \fBblocksize\fR \fI int\fR
1606 \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
1608 was compiled with the configure option \-\-with\-maxtapeblocksize=N set with "N" greater than 32 during
1612 \fBreadblocksize\fR \fI int\fR
1614 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\.
1617 \fBfile\-pad\fR \fI boolean\fR
1620 \fItrue\fR\. If true, every record, including the last one in the file, will have the same length\. This matches the way
1622 wrote tapes prior to the availability of this parameter\. It may also be useful on devices that only support a fixed blocksize\.
1624 Note that the last record on the tape probably includes trailing null byte padding, which will be passed back to
1627 or the restore program\. Most programs just ignore this (although possibly with a warning)\.
1629 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\.
1632 \fBspeed\fR \fI int\fR
1635 \fI200 bps\fR\. How fast the drive will accept data, in bytes per second\. This parameter is NOT currently used by
1639 \fBlbl\-templ\fR \fI string\fR
1641 A PostScript template file used by
1643 to generate labels\. Several sample files are provided with the
1649 man page for more information\.
1652 In addition to options, another
1654 name may be entered, which makes this
1656 inherit options from another
1657 \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:
1659 define tapetype DLT4000\-III {
1660 comment "DLT4000 tape drives with Compact\-III tapes"
1661 length 12500 mbytes # 10 Gig tapes with some compression
1662 filemark 2000 kbytes
1665 define tapetype DLT4000\-IV {
1667 comment "DLT4000 tape drives with Compact\-IV tapes"
1668 length 25000 mbytes # 20 Gig tapes with some compression
1671 .SH "INTERFACE SECTION"
1675 file may define multiple types of network interfaces\. The information is entered in an
1677 section, which looks like this:
1679 define interface \fIname\fR {
1680 \fIinterface\-option\fR \fIinterface\-value\fR
1686 is the name of this type of network interface\. It is referenced from the
1690 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
1693 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,
1695 will use as much of the network as it can leaving throttling up to the operating system and network hardware\.
1697 The interface options and values are:
1699 \fBcomment\fR \fI string\fR
1702 \fInone\fR\. A comment string describing this set of network information\.
1705 \fBuse\fR \fI int\fR
1708 \fI8000 Kbps\fR\. The speed of the interface in Kbytes per second\.
1711 In addition to options, another
1713 name may be entered, which makes this
1715 inherit options from another
1716 \fBinterface\fR\. At the moment, this is of little use\.
1720 <jds@amanda\.org>: Original text
1722 Stefan G\. Weichinger,
1723 <sgw@amanda\.org>, maintainer of the
1724 \fIAmanda\fR\-documentation: XML\-conversion, major update, splitting
1729 \fBamanda-client.conf\fR(5),
1732 : http://wiki.zmanda.com