1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
10 .de Sp \" Vertical space (when we can't use .PP)
16 .ie \\n(.$>=3 .ne \\$3
20 .TH "AMANDA.CONF" 5 "" "" ""
22 amanda.conf - Main configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver
26 is the main configuration file for
27 \fBAmanda\fR. This manpage lists the relevant sections and parameters of this file for quick reference.
30 There are a number of configuration parameters that control the behavior of the
32 programs. All have default values, so you need not specify the parameter in
34 if the default is suitable.
36 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.
38 Keywords are case insensitive, i.e.
44 Integer arguments may have one of the following (case insensitive) suffixes, some of which have a multiplier effect:
45 .SS "POSSIBLE SUFFIXES"
51 Some number of bytes per second.
53 \fBk kb kbyte kbytes kilobyte kilobytes\fR
54 Some number of kilobytes (bytes*1024).
57 Some number of kilobytes per second (bytes*1024).
59 \fBm mb meg mbyte mbytes megabyte megabytes\fR
60 Some number of megabytes (bytes*1024*1024).
63 Some number of megabytes per second (bytes*1024*1024).
65 \fBg gb gbyte gbytes gigabyte gigabytes\fR
66 Some number of gigabytes (bytes*1024*1024*1024).
75 Some number of weeks (days*7).
78 .nr an-no-space-flag 1
84 may be used in most places where an integer is expected
85 to mean an infinite amount.
87 Boolean arguments may have any of the values
94 to indicate a true state, or
101 to indicate a false state. If no argument is given,
106 \fBorg\fR \fB string\fR
108 \fBdaily\fR. A descriptive name for the configuration. This string appears in the Subject line of mail reports. Each
110 configuration should have a different string to keep mail reports distinct.
112 \fBmailto\fR \fB string\fR
114 \fBoperators\fR. A space separated list of recipients for mail reports.
116 \fBdumpcycle\fR \fB int\fR
118 \fB10 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.
121 .nr an-no-space-flag 1
125 This parameter may also be set in a specific
128 This value sets the default for all
135 \fBrunspercycle\fR \fB int\fR
137 \fBsame as dumpcycle\fR. The number of amdump runs in
139 days. A value of 0 means the same value as
140 \fBdumpcycle\fR. A value of -1 means guess the number of runs from the
142 file, which is the number of tapes used in the last
147 \fBtapecycle\fR \fB int\fR
149 \fB15 tapes\fR. Typically tapes are used by
151 in an ordered rotation. The
153 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
157 This is calculated by multiplying the number of
159 runs per dump cycle (\fBrunspercycle\fR
160 parameter) times the number of tapes used per run (\fBruntapes\fR
161 parameter). Typically two to four times this calculated number of tapes are in rotation. While
163 is always willing to use a new tape in its rotation, it refuses to reuse a tape until at least '\fBtapecycle\fR
164 -1' number of other tapes have been used.
166 It is considered good administrative practice to set the
168 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.
170 \fBlabel_new_tapes\fR \fB string\fR
171 Default: not set. When set, this directive will cause
173 to automatically write an
175 tape label to any blank tape she encounters. This option is DANGEROUS because when set,
177 will ERASE any non-\fBAmanda\fR
178 tapes you may have, and may also ERASE any near-failing tapes. Use with caution.
180 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:
181 label_new_tapes "DailySet1-%%%"
183 \fBlabel_new_tapes\fR \fB string\fR
186 Default: not set. When set, this directive will cause
188 to automatically write an Amanda tape label to any black tape she encounters. This option is DANGEROUS because when set,
190 will ERASE any non-\fBAmanda\fR
191 tapes you may have, and may also ERASE any near-failing tapes. Use with caution.
193 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:
194 label_new_tapes "DailySet1-%%%"
196 \fBdumpuser\fR \fB string\fR
198 \fBamanda\fR. The login name
200 uses to run the backups. The backup client hosts must allow access from the tape server host as this user via
203 .amandahosts, depending on how the
208 Printer to use when doing tape labels. See the
209 \fBlbl-templ\fR\fBtapetype\fR
214 \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.
215 \fI/dev/rmt/0mn\fR, however this is operating system specific and you should consult that documentation for detailed naming information.
217 If a tape changer is configured (see the
219 option), this option might not be used.
223 output driver is selected (see the section OUTPUT DRIVERS in the
225 manpage for more information), programs such as
227 will run normally but all images will be thrown away. This should only be used for debugging and testing, and probably only with the
232 \fBrawtapedev\fR string
234 \fInull:\fR. The path name of the raw tape device. This is only used if
236 is compiled for Linux machines with floppy tapes and is needed for QIC volume table operations.
238 \fBtpchanger\fR string
240 \fBnone\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.
242 If a tape changer is configured, choose one of the changer scripts (e.g.
243 \fBchg-scsi\fR) and enter that here.
245 \fBchangerdev\fR string
247 \fI/dev/null\fR. A tape changer configuration parameter. Usage depends on the particular changer defined with the
251 \fBchangerfile\fR string
253 \fI/usr/adm/amanda/log/changer-status\fR. A tape changer configuration parameter. Usage depends on the particular changer defined with the
259 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.
261 If a tape changer is configured, this may be set larger than one to let
263 write to more than one tape.
265 Note that this is an upper bound on the number of tapes, and
269 Also note that as of this release,
271 does not support true tape overflow. When it reaches the end of one tape, the backup image
273 was processing starts over again on the next tape.
275 \fBmaxdumpsize\fR int
277 \fBruntapes\fR*\fBtape_length\fR. Maximum number of bytes the planner will schedule for a run.
279 \fBtaperalgo\fR [first|firstfit|largest|largestfit|smallest|last]
281 \fBfirst\fR. The algorithm used to choose which dump image to send to the taper.
288 The first dump image that will fit on the current tape.
291 The largest dump image.
294 The largest dump image that will fit on the current tape.
297 The smallest dump image.
303 \fBlabelstr\fR \fB string\fR
305 \fB.*\fR. The tape label constraint regular expression. All tape labels generated (see
306 \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.
308 \fBtapetype\fR \fB string\fR
310 \fBEXABYTE\fR. The type of tape drive associated with
313 \fBtpchanger\fR. This refers to one of the defined
314 \fBtapetype\fRs in the config file (see below), which specify various tape parameters, like the
319 of the tape media and device.
323 string must be an alphabetic character
327 \fB30 seconds\fR. Maximum amount of time that
329 will wait for each client host.
333 \fB1800 seconds\fR. Amount of idle time per disk on a given client that a
337 will wait before it fails with a data timeout error.
341 \fB300 seconds\fR. Amount of time per disk on a given client that the
345 will wait to get the dump size estimates. For instance, with the default of 300 seconds and four disks on client A,
347 will wait up to 20 minutes for that machine. A negative value will be interpreted as a total amount of time to wait per client instead of per disk.
351 \fB300 Kbps\fR. The maximum network bandwidth allocated to
352 \fBAmanda\fR, in Kbytes per second. See also the
358 10. The maximum number of backups that
360 will attempt to run in parallel.
362 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.
364 \fBdisplayunit\fR "k|m|g|t"
366 "k". The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera.
368 \fBdumporder\fR string
370 \fBtttTTTTTTT\fR. The priority order of each dumper:
386 b: smallest bandwidth
394 1. The maximum number of backups from a single host that
396 will attempt to run in parallel. See also the
400 Note that this parameter may also be set in a specific
402 (see below). This value sets the default for all
403 \fBdumptype\fRs so must appear in
406 \fBdumptype\fRs are defined.
410 \fB10 Mbytes\fR. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size. If
412 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
416 The global setting of this parameter can be overwritten inside of a dumptype-definition.
424 \fBbumppercent\fR int
426 \fB0 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
428 determines that the next higher backup level will be this much smaller than the current level, it will do the next level.
430 If this parameter is set to 0, the value of the parameter
432 is used to trigger bumping.
434 The global setting of this parameter can be overwritten inside of a dumptype-definition.
442 \fBbumpmult\fR \fB float\fR
444 1.5. The bump size multiplier.
448 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
452 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.
454 The global setting of this parameter can be overwritten inside of a dumptype-definition.
456 \fBbumpdays\fR \fB int\fR
458 \fB2 days\fR. To insure redundancy in the dumps,
460 keeps filesystems at the same incremental level for at least
462 days, even if the other bump threshold criteria are met.
464 The global setting of this parameter can be overwritten inside of a dumptype-definition.
466 \fBdiskfile\fR \fB string\fR
468 \fBdisklist\fR. The file name for the
470 file holding client hosts, disks and other client dumping information.
472 \fBinfofile\fR \fB string\fR
474 \fI/usr/adm/amanda/curinfo\fR. The file or directory name for the historical information database. If
476 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.
478 \fBlogdir\fR \fB string\fR
480 \fI/usr/adm/amanda\fR. The directory for the
486 \fBindexdir\fR \fB string\fR
488 \fI/usr/adm/amanda/index\fR. The directory where index files (backup image catalogues) are stored. Index files are only generated for filesystems whose
494 \fBtapelist\fR \fB string\fR
496 \fBtapelist\fR. The file name for the active
500 maintains this file with information about the active set of tapes.
502 \fBtapebufs\fR \fB int\fR
504 20. The number of buffers used by the
510 to hold data as it is read from the network or disk before it is written to tape. Each buffer is a little larger than 32 KBytes and is held in a shared memory region.
512 \fBreserve\fR \fB number\fR
514 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.
516 \fBautoflush\fR \fB bool\fR
518 \fBoff\fR. Whether an amdump run will flush the dumps from holding disk to tape.
520 \fBamrecover_do_fsf\fR \fB bool\fR
522 \fBoff\fR. Amrecover will call amrestore with the -f flag for faster positioning of the tape.
524 \fBamrecover_check_label\fR \fB bool\fR
526 \fBoff\fR. Amrecover will call amrestore with the -l flag to check the label.
528 \fBamrecover_changer\fR \fB string\fR
529 Default: ''. Amrecover will use the changer if you use 'settape <string>' and that string is the same as the amrecover_changer setting.
531 \fBcolumnspec\fR \fB string\fR
532 Defines the width of columns
536 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:
540 the name of the column, which may be:
544 Compress (compression ratio)
547 Disk (client disk name)
550 DumpRate (dump rate in KBytes/sec)
553 DumpTime (total dump time in hours:minutes)
556 HostName (client host name)
562 OrigKB (original image size in KBytes)
565 OutKB (output image size in KBytes)
568 TapeRate (tape writing rate in KBytes/sec)
571 TapeTime (total tape time in hours:minutes)
575 the amount of space to display before the column (used to get whitespace between columns).
578 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.
584 columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"
588 The above will display the disk information in 18 characters
589 and put one space before it. The hostname column will be 10 characters wide with
590 no space to the left. The output KBytes column is seven characters wide
591 with one space before it.
593 \fBincludefile\fR \fB string\fR
595 \fBnone\fR. The name of an
597 configuration file to include within the current file. Useful for sharing dumptypes, tapetypes and interface definitions among several configurations.
598 .SH "HOLDINGDISK SECTION"
602 file may define one or more holding disks used as buffers to hold backup images before they are written to tape. The syntax is:
605 holdingdisk \fBname\fR {
606 \fBholdingdisk-option\fR \fBholdingdisk-value\fR
611 is a logical name for this holding disk.
613 The options and values are:
615 \fBcomment\fR \fB string\fR
617 \fBnone\fR. A comment string describing this holding disk.
619 \fBdirectory\fR \fB disk\fR
621 \fI/dumps/amanda\fR. The path to this holding area.
627 Amount of space that can be used in this holding disk area.
628 If the value is zero, all available space on the file system is used.
629 If the value is negative, \fBAmanda\fR will use all available space minus that value.
631 \fBchunksize\fR \fB int\fR
635 Holding disk chunk size. Dumps larger than the specified size will be stored in multiple
636 holding disk files. The size of each chunk will not exceed the specified value.
637 However, even though dump images are split in the holding disk, they are concatenated as
638 they are written to tape, so each dump image still corresponds to a single continuous
641 If 0 is specified, \fBAmanda\fR will create holding disk chunks as large as
642 ((INT_MAX/1024)-64) Kbytes.
644 Each holding disk chunk includes a 32 Kbyte header, so the minimum
645 chunk size is 64 Kbytes (but that would be really silly).
647 Operating systems that are limited to a maximum file size of 2 Gbytes
648 actually cannot handle files that large.
649 They must be at least one byte less than 2 Gbytes.
650 Since \fBAmanda\fR works with 32 Kbyte blocks, and
651 to handle the final read at the end of the chunk, the chunk size
652 should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum
653 file size, e.g. 2047 Mbytes.
654 .SH "DUMPTYPE SECTION"
658 file may define multiple sets of backup options and refer to them by name from the
660 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.
662 A set of backup options are entered in a
664 section, which looks like this:
667 define dumptype \fBname\fR {
668 \fBdumptype-option\fR \fBdumptype-value\fR
674 is the name of this set of backup options. It is referenced from the
678 Some of the options in a
680 section are the same as those in the main part of
681 \fIamanda.conf\fR. The main option value is used to set the default for all
683 sections. For instance, setting
685 to 50 in the main part of the config file causes all following
687 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
688 \fBdumptype\fRs are defined.
690 The dumptype options and values are:
692 \fBauth\fR \fB string\fR
694 \fBbsd\fR. Type of authorization to perform between tape server and backup client hosts.
697 to use Kerberos-IV authorization.
700 to use Kerberos-V authorization.
703 to use OpenSSH authorization.
707 \fB10 Mbytes\fR. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size. If
709 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
719 \fBbumppercent\fR int
721 \fB0 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
723 determines that the next higher backup level will be this much smaller than the current level, it will do the next level.
725 If this parameter is set to 0, the value of the parameter
727 is used to trigger bumping.
735 \fBbumpmult\fR \fB float\fR
737 1.5. The bump size multiplier.
741 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
745 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.
747 \fBbumpdays\fR \fB int\fR
749 \fB2 days\fR. To insure redundancy in the dumps,
751 keeps filesystems at the same incremental level for at least
753 days, even if the other bump threshold criteria are met.
755 \fBcomment\fR \fB string\fR
757 \fBnone\fR. A comment string describing this set of backup options.
759 \fBcomprate\fR \fBfloat\fR [, \fBfloat\fR ]
762 0.50. The expected full and incremental compression factor for dumps. It is only used if
764 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.
766 \fBcompress [client|server]\fR \fB string\fR
768 \fBclient fast\fR. If
770 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.
772 For either type of compression,
774 also allows the selection of three styles of compression.
776 is the best compression available, often at the expense of CPU overhead.
778 is often not as good a compression as
779 \fBbest\fR, but usually less CPU overhead. Or to specify
781 to use your own compression method. (See dumptype custom-compress in example/amanda.conf for reference)
785 options line may be one of:
792 compress [client] fast
795 compress [client] best
798 compress client custom
800 Specify client_custom_compress "PROG"
802 PROG must not contain white space and it must accept -d for uncompress.
811 compress server custom
813 Specify server_custom_compress "PROG"
815 PROG must not contain white space and it must accept -d for uncompress.
818 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
822 (software) compression should be disabled.
824 \fBdumpcycle\fR \fB int\fR
826 \fB10 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.
828 \fBencrypt [none|client|server]\fR
830 \fBnone\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.
834 options line may be one of:
843 Specify client_encrypt "PROG"
845 PROG must not contain white space.
847 Specify client_decrypt_option "decryption-parameter" Default: "-d"
849 decryption-parameter must not contain white space.
851 (See dumptype encrypt-fast in example/amanda.conf for reference)
856 Specify server_encrypt "PROG"
858 PROG must not contain white space.
860 Specify server_decrypt_option "decryption-parameter" Default: "-d"
862 decryption-parameter must not contain white space.
865 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.
867 which is a wrapper of
869 is provided as a reference encryption program.
871 \fBestimate\fR \fBclient|calcsize|server\fR
873 \fBclient\fR. Determine the way
881 Use the same program as the dumping program, this is the most accurate way to do estimates, but it can take a long time.
886 Use a faster program to do estimates, but the result is less accurate.
891 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.
894 \fBexclude\fR [ \fBlist|file\fR ][[optional][ \fBappend\fR ][ \fB string\fR ]+]
896 \fBfile\fR. There are two exclude lists,
906 exclude expression. With
910 is a file name on the client containing
912 exclude expressions. The path to the specified exclude list file, if present (see description of 'optional' below), must be readable by the
916 All exclude expressions are concatenated in one file and passed to
922 Exclude expressions must always be specified as relative to the head directory of the DLE.
928 is appended to the current list, without it, the
935 \fBexclude list\fR, then amcheck will not complain if the file doesn't exist or is not readable.
938 \fBexclude list\fR, if the file name is relative, the disk name being backed up is prepended. So if this is entered:
941 exclude list ".amanda.excludes"
943 the actual file used would be
944 \fI/var/.amanda.excludes\fR
947 \fI/usr/local/.amanda.excludes\fR
949 \fI/usr/local\fR, and so on.
951 \fBholdingdisk\fR \fB boolean\fR
953 \fByes\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
955 is backing up, that file system should refer to a dumptype with
959 to avoid backing up the holding disk into itself.
961 \fBignore\fR \fB boolean\fR
963 \fBno\fR. Whether disks associated with this backup type should be backed up or not. This option is useful when the
965 file is shared among several configurations, some of which should not back up all the listed file systems.
967 \fBinclude\fR [ \fBlist|file\fR ][[optional][ \fBappend\fR ][ \fB string\fR ]+]
970 ".". There are two include lists,
978 is a glob expression. With
982 is a file name on the client containing glob expressions.
984 All include expressions are expanded by
985 \fBAmanda\fR, concatenated in one file and passed to
989 argument. They must start with "./" and contain no other "/".
991 Include expressions must always be specified as relative to the head directory of the DLE.
994 .nr an-no-space-flag 1
998 For globbing to work at all, even the limited single level,
999 the top level directory of the DLE must be readable by the \fBAmanda\fR user.With the
1003 is appended to the current list, without it, the
1005 overwrites the list.
1011 then amcheck will not complain if the file doesn't exist or is not readable.
1014 \fBinclude list\fR, If the file name is relative, the disk name being backed up is prepended.
1016 \fBindex\fR \fB boolean\fR
1018 \fBno\fR. Whether an index (catalogue) of the backup should be generated and saved in
1019 \fBindexdir\fR. These catalogues are used by the
1023 \fBkencrypt\fR \fB boolean\fR
1025 \fBno\fR. Whether the backup image should be encrypted by Kerberos as it is sent across the network from the backup client host to the tape server host.
1027 \fBmaxdumps\fR \fB int\fR
1029 1. The maximum number of backups from a single host that
1031 will attempt to run in parallel. See also the main section parameter
1034 \fBmaxpromoteday\fR \fB int\fR
1036 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.
1038 \fBpriority\fR \fB string\fR
1040 \fBmedium\fR. When there is no tape to write to,
1042 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.
1044 \fBprogram\fR \fB string\fR
1046 \fBDUMP\fR. The type of backup to perform. Valid values are
1048 for the native operating system backup program, and
1052 or to do PC backups using Samba.
1054 \fBrecord\fR \fB boolean\fR
1056 \fByes\fR. Whether to ask the backup program to update its database (e.g.
1057 \fI/etc/dumpdates\fR
1059 \fI/usr/local/var/amanda/gnutar-lists\fR
1060 for GNUTAR) of time stamps. This is normally enabled for daily backups and turned off for periodic archival runs.
1062 \fBskip-full\fR \fB boolean\fR
1068 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
1070 only schedules level 1 incrementals in this configuration; this is probably a bug.
1072 \fBskip-incr\fR \fB boolean\fR
1078 has scheduled an incremental backup, these disks will be skipped.
1080 \fBstarttime\fR \fB int\fR
1082 \fBnone\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
1085 \fBstrategy\fR \fB string\fR
1087 \fBstandard\fR. Strategy to use when planning what level of backup to run next. Values are:
1096 Never do full backups, only level 1 incrementals.
1099 Never do incremental backups, only full dumps.
1102 Never do backups (useful when sharing the
1107 Only do incremental dumps.
1109 should be used to tell
1111 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
1113 will perform full backups with this configuration, which is probably a bug.
1116 \fBtape_splitsize\fR \fB int\fR
1118 \fBnone\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.
1120 \fBsplit_diskbuffer\fR \fB string\fR
1122 \fBnone\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.
1124 \fBfallback_splitsize\fR \fB int\fR
1126 \fB10M\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.
1130 entries are predefined by
1134 define dumptype no-compress {
1137 define dumptype compress-fast {
1138 compress client fast
1140 define dumptype compress-best {
1141 compress client best
1143 define dumptype srvcompress {
1144 compress server fast
1146 define dumptype bsd-auth {
1149 define dumptype krb4-auth {
1152 define dumptype no-record {
1155 define dumptype no-hold {
1158 define dumptype no-full {
1163 In addition to options in a
1165 section, one or more other
1167 names may be entered, which make this
1169 inherit options from other previously defined
1170 \fBdumptype\fRs. For instance, two sections might be the same except for the
1175 define dumptype normal {
1176 comment "Normal backup, no compression, do indexing"
1181 define dumptype testing {
1182 comment "Test backup, no compression, do indexing, no recording"
1196 \fBdumptype\fRs should reference. This provides an easy place to make changes that will affect every
1198 .SH "TAPETYPE SECTION"
1202 file may define multiple types of tape media and devices. The information is entered in a
1204 section, which looks like this in the config file:
1207 define tapetype \fBname\fR {
1208 \fBtapetype-option\fR \fBtapetype-value\fR
1214 is the name of this type of tape medium/device. It is referenced from the
1216 option in the main part of the config file.
1218 The tapetype options and values are:
1220 \fBcomment\fR \fB string\fR
1222 \fBnone\fR. A comment string describing this set of tape information.
1224 \fBfilemark\fR \fB int\fR
1226 \fB1000 bytes\fR. How large a file mark (tape mark) is, measured in bytes. If the size is only known in some linear measurement (e.g. inches), convert it to bytes using the device density.
1228 \fBlength\fR \fB int\fR
1230 \fB2000 kbytes\fR. How much data will fit on a tape.
1232 Note that this value is only used by
1234 to schedule which backups will be run. Once the backups start,
1236 will continue to write to a tape until it gets an error, regardless of what value is entered for
1238 (but see the section OUTPUT DRIVERS in the
1240 manpage for exceptions).
1242 \fBblocksize\fR \fB int\fR
1244 \fB32\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
1246 was compiled with the configure option --with-maxtapeblocksize=N set with "N" greater than 32 during
1249 \fBfile-pad\fR \fB boolean\fR
1251 \fBtrue\fR. If true, every record, including the last one in the file, will have the same length. This matches the way
1253 wrote tapes prior to the availability of this parameter. It may also be useful on devices that only support a fixed blocksize.
1255 Note that the last record on the tape probably includes trailing null byte padding, which will be passed back to
1258 or the restore program. Most programs just ignore this (although possibly with a warning).
1260 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.
1262 \fBspeed\fR \fB int\fR
1264 \fB200 bps\fR. How fast the drive will accept data, in bytes per second. This parameter is NOT currently used by
1267 \fBlbl-templ\fR \fB string\fR
1268 A PostScript template file used by
1270 to generate labels. Several sample files are provided with the
1276 man page for more information.
1278 In addition to options, another
1280 name may be entered, which makes this
1282 inherit options from another
1283 \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:
1286 define tapetype DLT4000-III {
1287 comment "DLT4000 tape drives with Compact-III tapes"
1288 length 12500 mbytes # 10 Gig tapes with some compression
1289 filemark 2000 kbytes
1292 define tapetype DLT4000-IV {
1294 comment "DLT4000 tape drives with Compact-IV tapes"
1295 length 25000 mbytes # 20 Gig tapes with some compression
1298 .SH "INTERFACE SECTION"
1302 file may define multiple types of network interfaces. The information is entered in an
1304 section, which looks like this:
1307 define interface \fBname\fR {
1308 \fBinterface-option\fR \fBinterface-value\fR
1314 is the name of this type of network interface. It is referenced from the
1318 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
1321 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,
1323 will use as much of the network as it can leaving throttling up to the operating system and network hardware.
1325 The interface options and values are:
1327 \fBcomment\fR \fB string\fR
1329 \fBnone\fR. A comment string describing this set of network information.
1331 \fBuse\fR \fB int\fR
1333 \fB300 Kbps\fR. The speed of the interface in Kbytes per second.
1335 In addition to options, another
1337 name may be entered, which makes this
1339 inherit options from another
1340 \fBinterface\fR. At the moment, this is of little use.
1344 <jds@amanda.org>: Original text
1346 Stefan G. Weichinger,
1347 <sgw@amanda.org>, maintainer of the
1348 \fBAmanda\fR-documentation: XML-conversion, major update, splitting
projects / debian / amanda / blob