1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
5 <!-- entities files to use -->
6 <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
10 <refentry id='amanda.conf.5'>
13 <refentrytitle>amanda.conf</refentrytitle>
14 <manvolnum>5</manvolnum>
17 <refname>amanda.conf</refname>
18 <refpurpose>Main configuration file for &A;, the Advanced Maryland Automatic Network Disk Archiver</refpurpose>
20 <!-- body begins here -->
22 <refsect1><title>DESCRIPTION</title>
23 <para>&amconf; is the main configuration file for &A;. This manpage lists the
24 relevant sections and parameters of this file for quick reference.</para>
25 <para> The file <emphasis remap='B'><CONFIG_DIR>/<config>/amanda.conf</emphasis> is loaded.</para>
28 <refsect1><title>PARAMETERS</title>
30 <para>There are a number of configuration parameters that control the
31 behavior of the &A; programs.
32 All have default values,
33 so you need not specify the parameter in
34 <emphasis remap='B'>amanda.conf</emphasis>
35 if the default is suitable.</para>
37 <para>Lines starting with # are ignored, as are blank lines.
38 Comments may be placed on a line with a directive by starting
40 The remainder of the line is ignored.</para>
42 <para>Keywords are case insensitive, i.e.
43 <emphasis remap='B'>mailto</emphasis>
45 <emphasis remap='B'>MailTo</emphasis>
46 are treated the same.</para>
48 <para>Integer arguments may have one of the following (case insensitive) suffixes,
49 some of which have a multiplier effect:</para>
51 <refsect2><title>POSSIBLE SUFFIXES</title>
53 <variablelist remap='TP'>
55 <term><emphasis remap='B'>b byte bytes</emphasis></term>
57 <para>Some number of bytes.</para>
61 <term><emphasis remap='B'>bps</emphasis></term>
63 <para>Some number of bytes per second.</para>
67 <term><emphasis remap='B'>k kb kbyte kbytes kilobyte kilobytes</emphasis></term>
69 <para>Some number of kilobytes (bytes*1024).</para>
73 <term><emphasis remap='B'>kps kbps</emphasis></term>
75 <para>Some number of kilobytes per second (bytes*1024).</para>
79 <term><emphasis remap='B'>m mb meg mbyte mbytes megabyte megabytes</emphasis></term>
81 <para>Some number of megabytes (bytes*1024*1024).</para>
85 <term><emphasis remap='B'>mps mbps</emphasis></term>
87 <para>Some number of megabytes per second (bytes*1024*1024).</para>
91 <term><emphasis remap='B'>g gb gbyte gbytes gigabyte gigabytes</emphasis></term>
93 <para>Some number of gigabytes (bytes*1024*1024*1024).</para>
97 <term><emphasis remap='B'>tape tapes</emphasis></term>
99 <para>Some number of tapes.</para>
103 <term><emphasis remap='B'>day days</emphasis></term>
105 <para>Some number of days.</para>
109 <term><emphasis remap='B'>week weeks</emphasis></term>
111 <para>Some number of weeks (days*7).</para>
113 <note><para>The value
114 <emphasis remap='B'>inf</emphasis>
115 may be used in most places where an integer is expected
116 to mean an infinite amount.</para>
118 <para>Boolean arguments may have any of the values
119 <emphasis remap='B'>y</emphasis>,
120 <emphasis remap='B'>yes</emphasis>,
121 <emphasis remap='B'>t</emphasis>,
122 <emphasis remap='B'>true</emphasis>
124 <emphasis remap='B'>on</emphasis>
125 to indicate a true state, or
126 <emphasis remap='B'>n</emphasis>,
127 <emphasis remap='B'>no</emphasis>,
128 <emphasis remap='B'>f</emphasis>,
129 <emphasis remap='B'>false</emphasis>
131 <emphasis remap='B'>off</emphasis>
132 to indicate a false state.
133 If no argument is given,
134 <emphasis remap='B'>true</emphasis>
144 <title>PARAMETERS</title>
146 <variablelist remap='TP'>
148 <term><emphasis remap='B'>org</emphasis> <emphasis remap='I'> string</emphasis></term>
151 <emphasis remap='I'>daily</emphasis>.
152 A descriptive name for the configuration.
153 This string appears in the Subject line of mail reports.
154 Each &A; configuration should have a different string to keep
155 mail reports distinct.</para>
159 <term><emphasis remap='B'>mailto</emphasis> <emphasis remap='I'> string</emphasis></term>
162 <emphasis remap='I'>operators</emphasis>.
163 A space separated list of recipients for mail reports.</para>
167 <term><emphasis remap='B'>dumpcycle</emphasis> <emphasis remap='I'> int</emphasis></term>
170 <emphasis remap='I'>10 days</emphasis>.
171 The number of days in the backup cycle.
172 Each disk will get a full backup at least this often.
173 Setting this to zero tries to do a full backup each run.</para>
174 <note><para>This parameter may also be set in a specific
175 <emphasis remap='B'>dumptype</emphasis>
177 This value sets the default for all
178 <emphasis remap='B'>dumptype</emphasis>s
180 <emphasis remap='B'>amanda.conf</emphasis>
182 <emphasis remap='B'>dumptype</emphasis>s
189 <term><emphasis remap='B'>runspercycle</emphasis> <emphasis remap='I'> int</emphasis></term>
192 <emphasis remap='I'>same as dumpcycle</emphasis>.
193 The number of amdump runs in
194 <emphasis remap='B'>dumpcycle</emphasis>
196 A value of 0 means the same value as
197 <emphasis remap='B'>dumpcycle</emphasis>.
198 A value of -1 means guess the number of runs from the
199 <emphasis remap='I'>tapelist</emphasis>
201 which is the number of tapes used in the last
202 <emphasis remap='B'>dumpcycle</emphasis>
204 <emphasis remap='B'>runtapes</emphasis>.</para>
208 <term><emphasis remap='B'>tapecycle</emphasis> <emphasis remap='I'> int</emphasis></term>
211 <emphasis remap='I'>15 tapes</emphasis>.
212 Typically tapes are used by &A; in an ordered rotation. The <emphasis remap='B'>tapecycle</emphasis> parameter
213 defines the size of that rotation. The number of tapes in rotation must be larger than the number of tapes
214 required for a complete dump cycle (see the <emphasis remap='B'>dumpcycle</emphasis> parameter).
217 This is calculated by multiplying the number of &amdump; runs per dump cycle
218 (<emphasis remap='B'>runspercycle</emphasis> parameter) times the number of tapes used per run
219 (<emphasis remap='B'>runtapes</emphasis> parameter). Typically two to four times this calculated number of tapes are in rotation.
220 While &A; is always willing to use a new tape in its rotation, it refuses to reuse a tape until at
221 least '<emphasis remap='B'>tapecycle</emphasis> -1' number of other tapes have been used.
224 It is considered good administrative practice to set the <emphasis remap='B'>tapecycle</emphasis> parameter
225 slightly lower than the actual number of tapes in rotation. This allows the administrator to more easily cope
226 with damaged or misplaced tapes or schedule adjustments that call for slight adjustments in the rotation order.
232 <term><emphasis remap='B'>usetimestamps</emphasis>
233 <emphasis remap='I'> bool</emphasis></term>
235 <para>Default: <emphasis remap='B'>No</emphasis>.
236 By default, Amanda can only track at most one run per calendar day. When
237 this option is enabled, however, Amanda can track as many runs as you care
241 <emphasis remap='B'>WARNING</emphasis>: This option is not backward-compatible.
242 Do not enable it if you intend to downgrade your server installation to
243 Amanda community edition 2.5.0
249 <term><emphasis remap='B'>label_new_tapes</emphasis>
250 <emphasis remap='I'> string</emphasis></term>
252 <para>Default: not set.
253 When set, this directive will cause &A; to automatically write an &A;
254 tape label to any blank tape she encounters. This option is DANGEROUS
255 because when set, &A; will ERASE any non-&A; tapes you may have, and may
256 also ERASE any near-failing tapes. Use with caution.</para>
257 <para>When using this directive, specify the template for new tape
258 labels. The template should contain some number of contiguous '%'
259 characters, which will be replaced with a generated number. Be sure to
260 specify enough '%' characters that you do not run out of tape labels.
262 <markup>label_new_tapes "DailySet1-%%%"</markup>
268 <term><emphasis remap='B'>dumpuser</emphasis> <emphasis remap='I'> string</emphasis></term>
271 <emphasis remap='I'>amanda</emphasis>.
272 The login name &A; uses to run the backups.
273 The backup client hosts must allow access
274 from the tape server host as this user via
275 <markup>.rhosts</markup>
277 <markup>.amandahosts</markup>,
278 depending on how the &A; software was built.</para>
282 <term><emphasis remap='B'>printer</emphasis> string</term>
284 <para>Printer to use when doing tape labels.
286 <emphasis remap='B'>lbl-templ</emphasis>
287 <emphasis remap='B'>tapetype</emphasis>
292 <term><emphasis remap='B'>tapedev</emphasis> string</term>
295 <filename>null:</filename>.
296 The path name of the non-rewinding tape device.
297 Non-rewinding tape device names often have an 'n' in the name,
299 <filename>/dev/rmt/0mn</filename>,
300 however this is operating system specific and you should consult
301 that documentation for detailed naming information.</para>
303 <para>If a tape changer is configured
305 <emphasis remap='B'>tpchanger</emphasis>
306 option), this option might not be used.</para>
309 <emphasis remap='B'>null</emphasis>
310 output driver is selected
311 (see the section OUTPUT DRIVERS in the
312 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
313 manpage for more information),
316 will run normally but all images will be thrown away.
317 This should only be used for debugging and testing,
318 and probably only with the
319 <emphasis remap='B'>record</emphasis>
321 <emphasis remap='I'>no</emphasis>.</para>
326 <term><emphasis remap='B'>rawtapedev</emphasis> string</term>
329 <filename>null:</filename>.
330 The path name of the raw tape device.
331 This is only used if &A; is compiled for Linux machines with floppy tapes
332 and is needed for QIC volume table operations.</para>
336 <term><emphasis remap='B'>tpchanger</emphasis> string</term>
339 <emphasis remap='I'>none</emphasis>.
340 The name of the tape changer.
341 If a tape changer is not configured, this option is not used
342 and should be commented out of the configuration file.</para>
343 <para>If a tape changer is configured, choose one of the changer scripts
344 (e.g. <emphasis remap='B'>chg-scsi</emphasis>)
345 and enter that here.</para>
350 <term><emphasis remap='B'>changerdev</emphasis> string</term>
353 <filename>/dev/null</filename>.
354 A tape changer configuration parameter.
355 Usage depends on the particular changer defined with the
356 <emphasis remap='B'>tpchanger</emphasis>
361 <term><emphasis remap='B'>changerfile</emphasis> string</term>
364 <filename>/usr/adm/amanda/log/changer-status</filename>.
365 A tape changer configuration parameter.
366 Usage depends on the particular changer defined with the
367 <emphasis remap='B'>tpchanger</emphasis>
372 <term><emphasis remap='B'>runtapes</emphasis> int</term>
375 <literal>1</literal>.
376 The maximum number of tapes used in a single run.
377 If a tape changer is not configured, this option is not used
378 and should be commented out of the configuration file.</para>
379 <para>If a tape changer is configured, this may be set larger than one to
380 let &A; write to more than one tape.</para>
381 <para>Note that this is an upper bound on the number of tapes,
382 and &A; may use less.</para>
383 <para>Also note that as of this release, &A; does not support true tape overflow.
384 When it reaches the end of one tape,
385 the backup image &A; was processing starts over again on the next tape.</para>
390 <term><emphasis remap='B'>maxdumpsize</emphasis> int</term>
393 <emphasis remap='I'>runtapes</emphasis>*<emphasis remap='I'>tape_length</emphasis>.
394 Maximum number of bytes the planner will schedule for a run.</para>
398 <term><emphasis remap='B'>taperalgo</emphasis> [first|firstfit|largest|largestfit|smallest|last]</term>
401 <emphasis remap='I'>first</emphasis>.
402 The algorithm used to choose which dump image to send to the taper.</para>
404 <variablelist remap='TP'>
406 <term><emphasis remap='B'>first</emphasis></term>
408 <para>First in, first out.</para>
412 <term><emphasis remap='B'>firstfit</emphasis></term>
414 <para>The first dump image that will fit on the current tape.</para>
418 <term><emphasis remap='B'>largest</emphasis></term>
420 <para>The largest dump image.</para>
424 <term><emphasis remap='B'>largestfit</emphasis></term>
426 <para>The largest dump image that will fit on the current tape.</para>
430 <term><emphasis remap='B'>smallest</emphasis></term>
432 <para>The smallest dump image.</para>
436 <term><emphasis remap='B'>last</emphasis></term>
438 <para>Last in, first out.</para>
446 <term><emphasis remap='B'>labelstr</emphasis> <emphasis remap='I'> string</emphasis></term>
449 <emphasis remap='I'>.*</emphasis>.
450 The tape label constraint regular expression.
451 All tape labels generated (see
452 <citerefentry><refentrytitle>amlabel</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
453 and used by this configuration must match the regular expression.
454 If multiple configurations are run from the same tape server host,
455 it is helpful to set their labels to different strings
456 (for example, "DAILY[0-9][0-9]*" vs.
457 "ARCHIVE[0-9][0-9]*")
458 to avoid overwriting each other's tapes.</para>
462 <term><emphasis remap='B'>tapetype</emphasis> <emphasis remap='I'> string</emphasis></term>
465 <emphasis remap='I'>EXABYTE</emphasis>.
466 The type of tape drive associated with
467 <emphasis remap='B'>tapedev</emphasis>
469 <emphasis remap='B'>tpchanger</emphasis>.
470 This refers to one of the defined <emphasis remap='B'>tapetype</emphasis>s
471 in the config file (see below), which specify various tape parameters,
473 <emphasis remap='B'>length</emphasis>,
474 <emphasis remap='B'>filemark</emphasis>
476 <emphasis remap='B'>speed</emphasis>
477 of the tape media and device.</para>
478 <para>First character of a <emphasis remap='B'>tapetype</emphasis> string must
479 be an alphabetic character</para>
483 <term><emphasis remap='B'>ctimeout</emphasis> int</term>
486 <emphasis remap='I'>30 seconds</emphasis>.
487 Maximum amount of time that
488 <emphasis remap='B'>amcheck</emphasis>
489 will wait for each client host.</para>
493 <term><emphasis remap='B'>dtimeout</emphasis> int</term>
496 <emphasis remap='I'>1800 seconds</emphasis>.
497 Amount of idle time per disk on a given client that a
498 <emphasis remap='B'>dumper</emphasis>
500 <command>amdump</command>
501 will wait before it fails with a data timeout error.</para>
506 <term><emphasis remap='B'>etimeout</emphasis> int</term>
509 <emphasis remap='I'>300 seconds</emphasis>.
510 Amount of time per disk on a given client that the
511 <emphasis remap='B'>planner</emphasis>
513 <command>amdump</command>
514 will wait to get the dump size estimates.
515 For instance, with the default of 300 seconds and four disks on client A,
516 <emphasis remap='B'>planner</emphasis>
517 will wait up to 20 minutes for that machine.
518 A negative value will be interpreted as a total amount of time to wait
519 per client instead of per disk.</para>
524 <term><emphasis remap='B'>connect_tries</emphasis> int</term>
527 <emphasis remap='I'>3</emphasis>.
528 How many times the server will try a connection.</para>
533 <term><emphasis remap='B'>req_tries</emphasis> int</term>
536 <emphasis remap='I'>3</emphasis>.
537 How many times the server will resend a REQ packet if it doesn't get the ACK packet.</para>
542 <term><emphasis remap='B'>netusage</emphasis> int</term>
545 <emphasis remap='I'>300 Kbps</emphasis>.
546 The maximum network bandwidth allocated to &A;, in Kbytes per second.
548 <emphasis remap='B'>interface</emphasis>
553 <term><emphasis remap='B'>inparallel</emphasis> int</term>
556 <literal>10</literal>.
557 The maximum number of backups that &A; will attempt to run in parallel.
558 &A; will stay within the constraints of network bandwidth and
559 holding disk space available, so it doesn't hurt to set
560 this number a bit high. Some contention can occur with larger numbers
561 of backups, but this effect is relatively small on most systems.</para>
566 <term><emphasis remap='B'>displayunit</emphasis> "k|m|g|t"</term>
569 <literal>"k"</literal>.
570 The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera.
576 <term><emphasis remap='B'>dumporder</emphasis> string</term>
579 <emphasis remap='I'>tttTTTTTTT</emphasis>.
580 The priority order of each dumper:
587 b: smallest bandwidth
589 </programlisting></para>
595 <term><emphasis remap='B'>maxdumps</emphasis> int</term>
598 <literal>1</literal>.
599 The maximum number of backups from a single host that &A; will
600 attempt to run in parallel. See also the
601 <emphasis remap='B'>inparallel</emphasis>
604 <para>Note that this parameter may also be set in a specific
605 <emphasis remap='B'>dumptype</emphasis>
607 This value sets the default for all
608 <emphasis remap='B'>dumptype</emphasis>s
610 <emphasis remap='B'>amanda.conf</emphasis>
612 <emphasis remap='B'>dumptype</emphasis>s
618 <term><emphasis remap='B'>bumpsize</emphasis> int</term>
621 <emphasis remap='I'>10 Mbytes</emphasis>.
622 The minimum savings required to trigger an automatic
623 bump from one incremental level to the next, expressed as size.
624 If &A; determines that the next higher backup level
625 will be this much smaller than the current level,
626 it will do the next level.
627 The value of this parameter is used only if the parameter
628 <emphasis>bumppercent</emphasis> is set to 0.
631 The global setting of this parameter can be overwritten inside of a
636 <emphasis remap='B'>bumppercent</emphasis>,
637 <emphasis remap='B'>bumpmult</emphasis> and
638 <emphasis remap='B'>bumpdays</emphasis>.</para>
643 <term><emphasis remap='B'>bumppercent</emphasis> int</term>
646 <emphasis remap='I'>0 percent</emphasis>.
647 The minimum savings required to trigger an automatic
648 bump from one incremental level to the next, expressed as percentage of the
649 current size of the DLE (size of current level 0).
650 If &A; determines that the next higher backup level
651 will be this much smaller than the current level,
652 it will do the next level.
655 If this parameter is set to 0, the value of the
656 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
659 The global setting of this parameter can be overwritten inside of a
664 <emphasis remap='B'>bumpsize</emphasis>,
665 <emphasis remap='B'>bumpmult</emphasis> and
666 <emphasis remap='B'>bumpdays</emphasis>.</para>
671 <term><emphasis remap='B'>bumpmult</emphasis> <emphasis remap='I'> float</emphasis></term>
674 <literal>1.5</literal>.
675 The bump size multiplier.
677 <emphasis remap='B'>bumpsize</emphasis>
678 by this factor for each level.
679 This prevents active filesystems from
680 bumping too much by making it harder to bump to the next level.
681 For example, with the default
682 <emphasis remap='B'>bumpsize</emphasis>
684 <emphasis remap='B'>bumpmult</emphasis>
685 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
686 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
688 The global setting of this parameter can be overwritten inside of a
694 <term><emphasis remap='B'>bumpdays</emphasis> <emphasis remap='I'> int</emphasis></term>
697 <emphasis remap='I'>2 days</emphasis>.
698 To insure redundancy in the dumps, &A; keeps filesystems at the
699 same incremental level for at least
700 <emphasis remap='B'>bumpdays</emphasis>
701 days, even if the other bump threshold criteria are met.</para>
703 The global setting of this parameter can be overwritten inside of a
710 <term><emphasis remap='B'>diskfile</emphasis> <emphasis remap='I'> string</emphasis></term>
713 <emphasis remap='I'>disklist</emphasis>.
714 The file name for the
715 <emphasis remap='I'>disklist</emphasis>
716 file holding client hosts, disks and other client dumping information.</para>
720 <term><emphasis remap='B'>infofile</emphasis> <emphasis remap='I'> string</emphasis></term>
723 <filename>/usr/adm/amanda/curinfo</filename>.
724 The file or directory name for the historical information database.
725 If &A; was configured to use DBM databases, this is the base file
727 If it was configured to use text formated databases (the default),
728 this is the base directory and within here will be a directory per
729 client, then a directory per disk, then a text file of data.</para>
733 <term><emphasis remap='B'>logdir</emphasis> <emphasis remap='I'> string</emphasis></term>
736 <filename>/usr/adm/amanda</filename>.
737 The directory for the
738 <command>amdump</command>
740 <emphasis remap='B'>log</emphasis>
745 <term><emphasis remap='B'>indexdir</emphasis> <emphasis remap='I'> string</emphasis></term>
748 <filename>/usr/adm/amanda/index</filename>.
749 The directory where index files (backup image catalogues) are stored.
751 only generated for filesystems whose
752 <emphasis remap='B'>dumptype</emphasis>
754 <emphasis remap='B'>index</emphasis>
755 option enabled.</para>
759 <term><emphasis remap='B'>tapelist</emphasis> <emphasis remap='I'> string</emphasis></term>
762 <emphasis remap='I'>tapelist</emphasis>.
763 The file name for the active
764 <emphasis remap='I'>tapelist</emphasis>
766 &A; maintains this file with information about the active set of tapes.</para>
770 <term><emphasis remap='B'>tapebufs</emphasis> <emphasis remap='I'> int</emphasis></term>
773 <literal>20</literal>.
774 The number of buffers used by the
775 <emphasis remap='B'>taper</emphasis>
777 <command>amdump</command>
779 <emphasis remap='B'>amflush</emphasis>
780 to hold data as it is read from the network or disk before it is written to tape.
781 Each buffer is a little larger than 32 KBytes and is held in a shared memory region.</para>
785 <term><emphasis remap='B'>reserve</emphasis> <emphasis remap='I'> number</emphasis></term>
788 <literal>100</literal>.
789 The part of holding-disk space that should be reserved for incremental
790 backups if no tape is available, expressed as a percentage of the
791 available holding-disk space (0-100).
792 By default, when there is no tape to write to, degraded mode (incremental) backups
793 will be performed to the holding disk. If full backups should also be allowed in this case,
794 the amount of holding disk space reserved for incrementals should be lowered.</para>
798 <term><emphasis remap='B'>autoflush</emphasis> <emphasis remap='I'> bool</emphasis></term>
801 <emphasis remap='I'>off</emphasis>.
802 Whether an amdump run will flush the dumps from holding disk to tape.</para>
806 <term><emphasis remap='B'>amrecover_do_fsf</emphasis> <emphasis remap='I'> bool</emphasis></term>
809 <emphasis remap='I'>on</emphasis>.
810 Amrecover will call amrestore with the -f flag for faster positioning of the tape.</para>
814 <term><emphasis remap='B'>amrecover_check_label</emphasis> <emphasis remap='I'> bool</emphasis></term>
817 <emphasis remap='I'>on</emphasis>.
818 Amrecover will call amrestore with the -l flag to check the label.</para>
822 <term><emphasis remap='B'>amrecover_changer</emphasis> <emphasis remap='I'> string</emphasis></term>
825 Amrecover will use the changer if you use 'settape <string>' and that string
826 is the same as the amrecover_changer setting.</para>
830 <term><emphasis remap='B'>columnspec</emphasis> <emphasis remap='I'> string</emphasis></term>
832 <para>Defines the width of columns <emphasis remap='B'>amreport</emphasis>
834 <emphasis remap='I'>String</emphasis>
835 is a comma (',') separated list of triples. Each triple consists
836 of three parts which are separated by a equal sign ('=') and a colon (':') (see the example).
837 These three parts specify:</para>
841 <para>the name of the column, which may be:</para>
844 Compress (compression ratio)
845 Disk (client disk name)
846 DumpRate (dump rate in KBytes/sec)
847 DumpTime (total dump time in hours:minutes)
848 HostName (client host name)
850 OrigKB (original image size in KBytes)
851 OutKB (output image size in KBytes)
852 TapeRate (tape writing rate in KBytes/sec)
853 TapeTime (total tape time in hours:minutes)
859 <para>the amount of space to display before the column (used to get whitespace between columns).</para><para/>
862 <para>the width of the column itself.
863 If set to a negative value, the width will be calculated on demand to fit the largest entry in
868 <para>Here is an example:
870 columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"
871 </programlisting></para>
873 The above will display the disk information in 18 characters
874 and put one space before it. The hostname column will be 10 characters wide with
875 no space to the left. The output KBytes column is seven characters wide
876 with one space before it.</para>
881 <term><emphasis remap='B'>includefile</emphasis> <emphasis remap='I'> string</emphasis></term>
884 <emphasis remap='I'>none</emphasis>.
885 The name of an &A; configuration file to include within the current file.
886 Useful for sharing dumptypes, tapetypes and interface definitions among several configurations.</para>
891 <term><emphasis remap='B'>debug_auth</emphasis> int</term>
894 <emphasis remap='I'>0</emphasis>.
895 Debug level of the auth module</para>
900 <term><emphasis remap='B'>debug_event</emphasis> int</term>
903 <emphasis remap='I'>0</emphasis>.
904 Debug level of the event module</para>
909 <term><emphasis remap='B'>debug_holding</emphasis> int</term>
912 <emphasis remap='I'>0</emphasis>.
913 Debug level of the holdingdisk module</para>
918 <term><emphasis remap='B'>debug_protocol</emphasis> int</term>
921 <emphasis remap='I'>0</emphasis>.
922 Debug level of the protocol module</para>
927 <term><emphasis remap='B'>debug_planner</emphasis> int</term>
930 <emphasis remap='I'>0</emphasis>.
931 Debug level of the planner process</para>
936 <term><emphasis remap='B'>debug_driver</emphasis> int</term>
939 <emphasis remap='I'>0</emphasis>.
940 Debug level of the driver process</para>
945 <term><emphasis remap='B'>debug_dumper</emphasis> int</term>
948 <emphasis remap='I'>0</emphasis>.
949 Debug level of the dumper process</para>
954 <term><emphasis remap='B'>debug_chunker</emphasis> int</term>
957 <emphasis remap='I'>0</emphasis>.
958 Debug level of the chunker process</para>
963 <term><emphasis remap='B'>debug_taper</emphasis> int</term>
966 <emphasis remap='I'>0</emphasis>.
967 Debug level of the taper process</para>
972 <term><emphasis remap='B'>reserved-udp-port</emphasis> int,int</term>
974 <para>Default: --with-udpportrange or
975 <emphasis remap='I'>512,1023</emphasis>.
976 Reserved udp port that will be used (bsd, bsdudp)</para>
981 <term><emphasis remap='B'>reserved-tcp-port</emphasis> int,int</term>
983 <para>Default: --with-low-tcpportrange or
984 <emphasis remap='I'>512,1023</emphasis>.
985 Reserved tcp port that will be used (bsdtcp)</para>
990 <term><emphasis remap='B'>unreserved-tcp-port</emphasis> int,int</term>
992 <para>Default: --with-tcpportrange or
993 <emphasis remap='I'>1025,65536</emphasis>.
994 Unreserved tcp port that will be used (bsd, bsdudp)</para>
1002 <refsect1><title>HOLDINGDISK SECTION</title>
1003 <para>The <emphasis remap='B'>amanda.conf</emphasis>
1004 file may define one or more holding disks used as buffers to hold
1005 backup images before they are written to tape.
1006 The syntax is:</para>
1009 holdingdisk <emphasis remap='I'>name</emphasis> {
1010 <emphasis remap='I'>holdingdisk-option</emphasis> <emphasis remap='I'>holdingdisk-value</emphasis>
1011 <literal>...</literal>
1015 <para><emphasis remap='I'>Name</emphasis>
1016 is a logical name for this holding disk.</para>
1018 <para>The options and values are:</para>
1020 <variablelist remap='TP'>
1022 <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
1025 <emphasis remap='I'>none</emphasis>.
1026 A comment string describing this holding disk.</para>
1031 <term><emphasis remap='B'>directory</emphasis> <emphasis remap='I'> disk</emphasis></term>
1034 <filename>/dumps/amanda</filename>.
1035 The path to this holding area.</para>
1040 <term><emphasis remap='B'>use</emphasis> <emphasis remap='I'> int</emphasis></term>
1043 <emphasis remap='I'>0 Gb</emphasis>.
1044 Amount of space that can be used in this holding disk area.
1045 If the value is zero, all available space on the file system is used.
1046 If the value is negative, &A; will use all available space minus that value.</para>
1051 <term><emphasis remap='B'>chunksize</emphasis> <emphasis remap='I'> int</emphasis></term>
1054 <emphasis remap='I'>1 Gb</emphasis>.
1055 Holding disk chunk size. Dumps larger than the specified size will be stored in multiple
1056 holding disk files. The size of each chunk will not exceed the specified value.
1057 However, even though dump images are split in the holding disk, they are concatenated as
1058 they are written to tape, so each dump image still corresponds to a single continuous
1059 tape section.</para>
1061 <para>If 0 is specified, &A; will create holding disk chunks as large as
1062 ((INT_MAX/1024)-64) Kbytes.</para>
1064 <para>Each holding disk chunk includes a 32 Kbyte header, so the minimum
1065 chunk size is 64 Kbytes (but that would be really silly).</para>
1067 <para>Operating systems that are limited to a maximum file size of 2 Gbytes
1068 actually cannot handle files that large.
1069 They must be at least one byte less than 2 Gbytes.
1070 Since &A; works with 32 Kbyte blocks, and
1071 to handle the final read at the end of the chunk, the chunk size
1072 should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum
1073 file size, e.g. 2047 Mbytes.</para>
1079 <refsect1><title>DUMPTYPE SECTION</title>
1080 <para>The &amconf; file may define multiple sets of backup options
1081 and refer to them by name from the &disklist; file.
1082 For instance, one set of options might be defined for file systems
1083 that can benefit from high compression, another set that does not compress well,
1084 another set for file systems that should always get a full backup and so on.</para>
1086 <para>A set of backup options are entered in a
1087 <emphasis remap='B'>dumptype</emphasis>
1088 section, which looks like this:</para>
1091 define dumptype <emphasis remap='I'>name</emphasis> {
1092 <emphasis remap='I'>dumptype-option</emphasis> <emphasis remap='I'>dumptype-value</emphasis>
1093 <literal>...</literal>
1097 <para><emphasis remap='I'>Name</emphasis>
1098 is the name of this set of backup options.
1099 It is referenced from the &disklist; file.</para>
1101 <para>Some of the options in a
1102 <emphasis remap='B'>dumptype</emphasis>
1103 section are the same as those in the main part of &amconf;.
1104 The main option value is used to set the default for all
1105 <emphasis remap='B'>dumptype</emphasis>
1106 sections. For instance, setting
1107 <emphasis remap='B'>dumpcycle</emphasis>
1108 to 50 in the main part of the config file causes all following
1109 <emphasis remap='B'>dumptype</emphasis>
1110 sections to start with that value,
1111 but the value may be changed on a section by section basis.
1112 Changes to variables in the main part of the config file must be
1113 done before (earlier in the file) any
1114 <emphasis remap='B'>dumptype</emphasis>s
1117 <para>The dumptype options and values are:</para>
1119 <variablelist remap='TP'>
1121 <term><emphasis remap='B'>auth</emphasis> <emphasis remap='I'> string</emphasis></term>
1124 <emphasis remap='I'>bsd</emphasis>.
1125 Type of authorization to perform between tape server and backup client hosts.</para>
1126 <para><emphasis remap='B'>bsd</emphasis>, bsd authorization with udp initial
1127 connection and one tcp connection by data stream.</para>
1128 <para><emphasis remap='B'>bsdtcp</emphasis>, bsd authorization but use only
1129 one tcp connection.</para>
1130 <para><emphasis remap='B'>bsdudp</emphasis>, like bsd, but will use only one
1131 tcp connection for all data stream.</para>
1132 <para><emphasis remap='B'>krb4</emphasis> to use Kerberos-IV
1133 authorization.</para>
1134 <para><emphasis remap='B'>krb5</emphasis> to use Kerberos-V
1135 authorization.</para>
1136 <para><emphasis remap='B'>rsh</emphasis> to use rsh
1137 authorization.</para>
1138 <para><emphasis remap='B'>ssh</emphasis> to use OpenSSH
1139 authorization.</para>
1145 <term><emphasis remap='B'>amandad_path</emphasis> <emphasis remap='I'> string</emphasis></term>
1148 <emphasis remap='I'>$libexec/amandad</emphasis>.
1149 Specify the amandad path of the client, only use with rsh/ssh authentification.
1155 <term><emphasis remap='B'>client_username</emphasis> <emphasis remap='I'> string</emphasis></term>
1158 <emphasis remap='I'>CLIENT_LOGIN</emphasis>.
1159 Specify the username to connect on the client, only use with rsh/ssh authentification.
1164 <!-- bumping parameters yanked from the global section above -->
1167 <term><emphasis remap='B'>bumpsize</emphasis> int</term>
1170 <emphasis remap='I'>10 Mbytes</emphasis>.
1171 The minimum savings required to trigger an automatic
1172 bump from one incremental level to the next, expressed as size.
1173 If &A; determines that the next higher backup level
1174 will be this much smaller than the current level,
1175 it will do the next level.
1176 The value of this parameter is used only if the parameter
1177 <emphasis>bumppercent</emphasis> is set to 0.
1180 See also the options
1181 <emphasis remap='B'>bumppercent</emphasis>,
1182 <emphasis remap='B'>bumpmult</emphasis> and
1183 <emphasis remap='B'>bumpdays</emphasis>.</para>
1188 <term><emphasis remap='B'>bumppercent</emphasis> int</term>
1191 <emphasis remap='I'>0 percent</emphasis>.
1192 The minimum savings required to trigger an automatic
1193 bump from one incremental level to the next, expressed as percentage of the
1194 current size of the DLE (size of current level 0).
1195 If &A; determines that the next higher backup level
1196 will be this much smaller than the current level,
1197 it will do the next level.
1200 If this parameter is set to 0, the value of the
1201 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
1204 See also the options
1205 <emphasis remap='B'>bumpsize</emphasis>,
1206 <emphasis remap='B'>bumpmult</emphasis> and
1207 <emphasis remap='B'>bumpdays</emphasis>.</para>
1212 <term><emphasis remap='B'>bumpmult</emphasis> <emphasis remap='I'> float</emphasis></term>
1215 <literal>1.5</literal>.
1216 The bump size multiplier.
1218 <emphasis remap='B'>bumpsize</emphasis>
1219 by this factor for each level.
1220 This prevents active filesystems from
1221 bumping too much by making it harder to bump to the next level.
1222 For example, with the default
1223 <emphasis remap='B'>bumpsize</emphasis>
1225 <emphasis remap='B'>bumpmult</emphasis>
1226 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
1227 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
1231 <term><emphasis remap='B'>bumpdays</emphasis> <emphasis remap='I'> int</emphasis></term>
1234 <emphasis remap='I'>2 days</emphasis>.
1235 To insure redundancy in the dumps, &A; keeps filesystems at the
1236 same incremental level for at least
1237 <emphasis remap='B'>bumpdays</emphasis>
1238 days, even if the other bump threshold criteria are met.</para>
1243 <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
1246 <emphasis remap='I'>none</emphasis>.
1247 A comment string describing this set of backup options.</para>
1251 <term><emphasis remap='B'>comprate</emphasis> <emphasis remap='I'>float</emphasis> [, <emphasis remap='I'>float</emphasis> ]</term>
1254 <literal>0.50</literal>,
1255 <literal>0.50</literal>.
1256 The expected full and incremental compression factor for dumps.
1257 It is only used if &A; does not have any history information on
1258 compression rates for a filesystem, so should not usually need to be set.
1259 However, it may be useful for the first time a very large filesystem that
1260 compresses very little is backed up.</para>
1264 <term><emphasis remap='B'>compress [client|server]</emphasis> <emphasis remap='I'> string</emphasis></term>
1267 <emphasis remap='I'>client fast</emphasis>.
1268 If &A; does compression of the backup images, it can do so either on the backup client
1269 host before it crosses the network or on the tape server host as it goes from the
1270 network into the holding disk or to tape. Which place to do compression (if at all) depends on how well the
1271 dump image usually compresses, the speed and load on the client or server, network capacity,
1272 holding disk capacity, availability of tape hardware compression, etc.</para>
1274 <para>For either type of compression, &A; also allows the selection
1275 of three styles of compression.
1276 <emphasis remap='B'>Best</emphasis>
1277 is the best compression available, often at the expense of CPU overhead.
1278 <emphasis remap='B'>Fast</emphasis>
1279 is often not as good a compression as
1280 <emphasis remap='B'>best</emphasis>,
1281 but usually less CPU overhead. Or to specify <emphasis remap='B'>Custom</emphasis>
1282 to use your own compression method. (See dumptype custom-compress in example/amanda.conf for reference)</para>
1284 <para>So the <emphasis remap='B'>compress</emphasis> options line may be one of:</para>
1286 <variablelist remap='TP'>
1288 <term>compress none</term><listitem><para/></listitem>
1291 <term>compress client fast</term><listitem><para/></listitem>
1294 <term>compress client best</term><listitem><para/></listitem>
1297 <term>compress client custom</term>
1299 <para>Specify <emphasis>client_custom_compress</emphasis> "PROG"</para>
1300 <para>PROG must not contain white space and it must accept -d for uncompress.</para>
1304 <term>compress server fast</term><listitem><para/></listitem>
1307 <term>compress server best</term><listitem><para/></listitem>
1310 <term>compress server custom</term>
1312 <para>Specify <emphasis>server_custom_compress</emphasis> "PROG"</para>
1313 <para>PROG must not contain white space and it must accept -d for uncompress.</para>
1317 <para>Note that some tape devices do compression and this option has nothing
1318 to do with whether that is used. If hardware compression is used (usually via a particular tape device name
1319 or <emphasis remap='B'>mt</emphasis> option), &A; (software) compression should be disabled.</para>
1323 <term><emphasis remap='B'>dumpcycle</emphasis> <emphasis remap='I'> int</emphasis></term>
1325 <para>Default: <emphasis remap='I'>10 days</emphasis>.
1326 The number of days in the backup cycle. Each disk using this set of options will get a full
1327 backup at least this of
1328 ten. Setting this to zero tries to do a full backup each run.</para>
1333 <term><emphasis remap='B'>encrypt [none|client|server]</emphasis></term>
1335 <para>Default: <emphasis remap='I'>none</emphasis>.
1336 To encrypt backup images, it can do so either on the backup client host before it crosses the network or on the tape
1337 server host as it goes from the network into the holding disk or to tape.</para>
1339 <para>So the <emphasis remap='B'>encrypt</emphasis> options line may be one
1342 <variablelist remap='TP'>
1344 <term>encrypt none</term><listitem><para/></listitem>
1347 <term>encrypt client</term>
1349 <para>Specify client_encrypt "PROG"</para>
1350 <para>PROG must not contain white space.</para>
1351 <para>Specify client_decrypt_option "decryption-parameter" Default: "-d"</para>
1352 <para>decryption-parameter must not contain white space.</para>
1353 <para>(See dumptype server-encrypt-fast in example/amanda.conf for reference)</para>
1357 <term>encrypt server</term>
1359 <para>Specify server_encrypt "PROG"</para>
1360 <para>PROG must not contain white space.</para>
1361 <para>Specify server_decrypt_option "decryption-parameter" Default: "-d"</para>
1362 <para>decryption-parameter must not contain white space.</para>
1363 <para>(See dumptype client-encrypt-nocomp in example/amanda.conf for reference)</para>
1367 <para>Note that current logic assumes compression then encryption during
1368 backup(thus decrypt then uncompress during restore). So specifying
1369 client-encryption AND server-compression is not supported.
1370 <emphasis remap='I'>amcrypt</emphasis> which is a wrapper of
1371 <emphasis remap='I'>aespipe</emphasis> is provided as a reference
1372 symmetric encryption program.</para>
1378 <term><emphasis remap='B'>estimate</emphasis> <emphasis remap='I'>client|calcsize|server</emphasis></term>
1380 <para>Default: <emphasis remap='I'>client</emphasis>.
1381 Determine the way &A; does it's estimate.</para>
1382 <variablelist remap='TP'>
1386 <para>Use the same program as the dumping program, this is the most
1387 accurate way to do estimates, but it can take a long time.</para>
1391 <term>calcsize</term>
1393 <para>Use a faster program to do estimates, but the result is less accurate.</para>
1399 <para>Use only statistics from the previous run to give an estimate,
1400 it takes only a few seconds but the result is not accurate if your disk
1401 usage changes from day to day.</para>
1410 <term><emphasis remap='B'>exclude</emphasis> [ list|file ][[optional][ append ][ <emphasis remap='I'>string</emphasis> ]+]</term>
1413 <emphasis remap='I'>file</emphasis>.
1414 There are two exclude lists,
1415 <emphasis remap='B'>exclude file</emphasis>
1417 <emphasis remap='B'>exclude list.</emphasis>
1419 <emphasis remap='B'>exclude file</emphasis>
1421 <emphasis remap='I'>string</emphasis>
1422 is a &gnutar; exclude expression. With
1423 <emphasis remap='B'>exclude list</emphasis>
1425 <emphasis remap='I'>string</emphasis>
1426 is a file name on the client containing &gnutar; exclude expressions.
1427 The path to the specified exclude list file, if present (see description of
1428 'optional' below), must be readable by the &A; user.</para>
1430 <para>All exclude expressions are concatenated in one file and passed to &gnutar;
1431 as an <option>--exclude-from</option> argument.</para>
1433 <para>Exclude expressions must always be specified as relative to the
1434 head directory of the DLE.</para>
1437 <emphasis remap='B'>append</emphasis> keyword, the
1438 <emphasis remap='I'>string</emphasis> is appended to the current list, without it, the
1439 <emphasis remap='I'>string</emphasis> overwrites the list.</para>
1441 <para>If <emphasis remap='B'>optional</emphasis>
1442 is specified for <emphasis remap='B'>exclude list</emphasis>,
1443 then amcheck will not complain if the file doesn't exist or is not readable.</para>
1445 <para>For <emphasis remap='B'>exclude list</emphasis>,
1446 if the file name is relative, the disk name being backed up is prepended.
1447 So if this is entered:</para>
1450 exclude list ".amanda.excludes"
1453 <para>the actual file used would be
1454 <filename>/var/.amanda.excludes</filename>
1455 for a backup of <filename>/var</filename>,
1456 <filename>/usr/local/.amanda.excludes</filename> for a backup of
1457 <filename>/usr/local</filename>, and so on.</para>
1462 <term><emphasis remap='B'>holdingdisk</emphasis> [ never|auto|required ]</term>
1465 <emphasis remap='I'>auto</emphasis>.
1466 Whether a holding disk should be used for these backups or whether they should go directly to tape.
1467 If the holding disk is a portion of another file system that &A;
1468 is backing up, that file system should refer to a dumptype with
1469 <emphasis remap='B'>holdingdisk</emphasis>
1471 <emphasis remap='I'>never</emphasis>
1472 to avoid backing up the holding disk into itself.</para>
1474 <variablelist remap='TP'>
1476 <term><emphasis remap='B'>never</emphasis>|no|false|off</term>
1478 <para>Never use a holdingdisk, the dump will always go directly to tape. There will be no dump if you have a tape error.</para>
1482 <term><emphasis remap='B'>auto</emphasis>|yes|true|on</term>
1484 <para>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)</para>
1488 <term><emphasis remap='B'>required</emphasis></term>
1490 <para>Always dump to holdingdisk, never directly to tape. There will be no dump if it doesn't fit on holdingdisk</para>
1499 <term><emphasis remap='B'>ignore</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1502 <emphasis remap='I'>no</emphasis>.
1503 Whether disks associated with this backup type should be backed up or not.
1504 This option is useful when the
1505 <emphasis remap='I'>disklist</emphasis>
1506 file is shared among several configurations,
1507 some of which should not back up all the listed file systems.</para>
1511 <term><emphasis remap='B'>include</emphasis> [ list|file ][[optional][ append ][ <emphasis remap='I'>string</emphasis> ]+]</term>
1514 <emphasis remap='I'>file</emphasis>
1516 There are two include lists,
1517 <emphasis remap='B'>include file</emphasis>
1519 <emphasis remap='B'>include list.</emphasis>
1521 <emphasis remap='B'>include file</emphasis>
1523 <emphasis remap='I'>string</emphasis>
1524 is a glob expression. With
1525 <emphasis remap='B'>include list</emphasis>
1527 <emphasis remap='I'>string</emphasis>
1528 is a file name on the client containing glob expressions.</para>
1530 <para>All include expressions are expanded by &A;, concatenated in one file and passed to &gnutar; as a
1531 <option>--files-from</option> argument. They must start with "./" and contain no other "/".</para>
1533 <para>Include expressions must always be specified as relative to the
1534 head directory of the DLE.</para>
1536 <note><para>For globbing to work at all, even the limited single level,
1537 the top level directory of the DLE must be readable by the &A; user.</para>
1540 <para>With the <emphasis remap='B'>append</emphasis> keyword, the
1541 <emphasis remap='I'>string</emphasis> is appended to the current list, without it, the
1542 <emphasis remap='I'>string</emphasis> overwrites the list.</para>
1545 <emphasis remap='B'>optional</emphasis> is specified for
1546 <emphasis remap='B'>include list,</emphasis> then amcheck will not complain if the file
1547 doesn't exist or is not readable.</para>
1549 <para>For <emphasis remap='B'>include list</emphasis>,
1550 If the file name is relative, the disk name being backed up is prepended.</para>
1555 <term><emphasis remap='B'>index</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1557 <para>Default: <emphasis remap='I'>no</emphasis>.
1558 Whether an index (catalogue) of the backup should be generated and saved in
1559 <emphasis remap='B'>indexdir</emphasis>.
1560 These catalogues are used by the <emphasis remap='B'>amrecover</emphasis> utility.</para>
1565 <term><emphasis remap='B'>kencrypt</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1568 <emphasis remap='I'>no</emphasis>.
1569 Whether the backup image should be encrypted by Kerberos as it is sent
1570 across the network from the backup client host to the tape server host.</para>
1574 <term><emphasis remap='B'>maxdumps</emphasis> <emphasis remap='I'> int</emphasis></term>
1577 <literal>1</literal>.
1578 The maximum number of backups from a single host that &A; will attempt to run in parallel.
1579 See also the main section parameter <emphasis remap='B'>inparallel</emphasis>.</para>
1583 <term><emphasis remap='B'>maxpromoteday</emphasis> <emphasis remap='I'> int</emphasis></term>
1586 <literal>10000</literal>.
1587 The maximum number of day for a promotion, set it 0 if you don't want
1588 promotion, set it to 1 or 2 if your disks get overpromoted.</para>
1592 <term><emphasis remap='B'>priority</emphasis> <emphasis remap='I'> string</emphasis></term>
1594 <para>Default: <emphasis remap='I'>medium</emphasis>.
1595 When there is no tape to write to, &A; will do incremental backups
1596 in priority order to the holding disk. The priority may be
1597 high (2), medium (1), low (0) or a number of your choice.</para>
1601 <term><emphasis remap='B'>program</emphasis> <emphasis remap='I'> string</emphasis></term>
1604 <emphasis remap='I'>DUMP</emphasis>.
1605 The type of backup to perform. Valid values are
1606 <emphasis remap='B'>DUMP</emphasis>
1607 for the native operating system backup program, and
1608 <emphasis remap='B'>GNUTAR</emphasis>
1609 to use &gnutar; or to do PC backups using Samba.</para>
1613 <term><emphasis remap='B'>record</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1616 <emphasis remap='I'>yes</emphasis>.
1617 Whether to ask the backup program to update its database (e.g. <filename>/etc/dumpdates</filename>
1618 for DUMP or <filename>/usr/local/var/amanda/gnutar-lists</filename> for GNUTAR) of time stamps.
1619 This is normally enabled for daily backups and turned off for periodic archival runs.</para>
1623 <term><emphasis remap='B'>skip-full</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1626 <emphasis remap='I'>no</emphasis>. If <emphasis remap='I'>true</emphasis> and
1627 <emphasis remap='B'>planner</emphasis> has scheduled a full backup, these disks will be skipped, and
1628 full backups should be run off-line on these days. It was reported that &A; only schedules
1629 level 1 incrementals in this configuration; this is probably a bug.</para>
1633 <term><emphasis remap='B'>skip-incr</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1636 <emphasis remap='I'>no</emphasis>. If <emphasis remap='I'>true</emphasis> and
1637 <emphasis remap='B'>planner</emphasis> has scheduled an incremental backup, these disks will be skipped.</para>
1641 <term><emphasis remap='B'>starttime</emphasis> <emphasis remap='I'> int</emphasis></term>
1644 <emphasis remap='I'>none</emphasis>.
1645 Backups will not start until after this time of day.
1646 The value should be hh*100+mm, e.g. 6:30PM (18:30) would be entered as
1647 <literal>1830</literal>.</para>
1651 <term><emphasis remap='B'>strategy</emphasis> <emphasis remap='I'> string</emphasis></term>
1653 <para>Default: <emphasis remap='I'>standard</emphasis>.
1654 Strategy to use when planning what level of backup to run next. Values are:</para>
1656 <variablelist remap='TP'>
1658 <term><emphasis remap='B'>standard</emphasis></term>
1660 <para>The standard &A; schedule.</para>
1664 <term><emphasis remap='B'>nofull</emphasis></term>
1666 <para>Never do full backups, only level 1 incrementals.</para>
1670 <term><emphasis remap='B'>noinc</emphasis></term>
1672 <para>Never do incremental backups, only full dumps.</para>
1676 <term><emphasis remap='B'>skip</emphasis></term>
1678 <para>Never do backups (useful when sharing the <emphasis remap='I'>disklist</emphasis> file).</para>
1682 <term><emphasis remap='B'>incronly</emphasis></term>
1684 <para>Only do incremental dumps. <command>amadmin force</command> should be used to tell
1685 &A; that a full dump has been performed off-line, so that it resets to level 1.
1686 It is similar to skip-full, but with incronly full dumps may be scheduled manually.
1687 Unfortunately, it appears that &A; will perform full backups with this configuration,
1688 which is probably a bug.</para>
1696 <term><emphasis remap='B'>tape_splitsize</emphasis> <emphasis remap='I'> int</emphasis></term>
1699 <emphasis remap='I'>none</emphasis>.
1700 Split dump file on tape into pieces of a specified size.
1701 This allows dumps to be spread across multiple tapes, and can potentially
1702 make more efficient use of tape space.
1703 Note that if this value is too large (more than half the size of the
1704 average dump being split), substantial tape space can be wasted.
1705 If too small, large dumps will be split into innumerable tiny dumpfiles,
1706 adding to restoration complexity.
1707 A good rule of thumb, usually, is 1/10 of the size of your tape.</para>
1712 <term><emphasis remap='B'>split_diskbuffer</emphasis> <emphasis remap='I'> string</emphasis></term>
1715 <emphasis remap='I'>none</emphasis>.
1716 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.
1722 <term><emphasis remap='B'>fallback_splitsize</emphasis> <emphasis remap='I'> int</emphasis></term>
1725 <emphasis remap='I'>10M</emphasis>.
1726 When dumping a split dump in PORT-WRITE mode, if no split_diskbuffer is
1727 specified (or if we somehow fail to use our split_diskbuffer), we must
1728 buffer split chunks in memory.
1729 This specifies the maximum size split chunks can be in this scenario,
1730 and thus the maximum amount of memory consumed for in-memory splitting.
1731 The size of this buffer can be changed from its (very conservative) default
1732 to a value reflecting the amount of memory that each taper process on
1733 the dump server may reasonably consume.
1739 <para>The following <emphasis remap='B'>dumptype</emphasis> entries are predefined by &A;:</para>
1741 <programlisting remap='.nf'>
1742 define dumptype no-compress {
1745 define dumptype compress-fast {
1746 compress client fast
1748 define dumptype compress-best {
1749 compress client best
1751 define dumptype srvcompress {
1752 compress server fast
1754 define dumptype bsd-auth {
1757 define dumptype krb4-auth {
1760 define dumptype no-record {
1763 define dumptype no-hold {
1766 define dumptype no-full {
1771 <para>In addition to options in a
1772 <emphasis remap='B'>dumptype</emphasis>
1773 section, one or more other
1774 <emphasis remap='B'>dumptype</emphasis>
1775 names may be entered, which make this
1776 <emphasis remap='B'>dumptype</emphasis>
1777 inherit options from other previously defined
1778 <emphasis remap='B'>dumptype</emphasis>s.
1779 For instance, two sections might be the same except for the
1780 <emphasis remap='B'>record</emphasis> option:</para>
1782 <programlisting remap='.nf'>
1783 define dumptype normal {
1784 comment "Normal backup, no compression, do indexing"
1789 define dumptype testing {
1790 comment "Test backup, no compression, do indexing, no recording"
1796 <para>&A; provides a
1797 <emphasis remap='B'>dumptype</emphasis>
1799 <emphasis remap='I'>global</emphasis>
1801 <emphasis remap='B'>amanda.conf</emphasis>
1803 <emphasis remap='B'>dumptype</emphasis>s
1805 This provides an easy place to make changes that will affect every
1806 <emphasis remap='B'>dumptype</emphasis>.</para>
1809 <refsect1><title>TAPETYPE SECTION</title>
1810 <para>The <emphasis remap='B'>amanda.conf</emphasis>
1811 file may define multiple types of tape media and devices.
1812 The information is entered in a
1813 <emphasis remap='B'>tapetype</emphasis>
1814 section, which looks like this in the config file:</para>
1817 define tapetype <emphasis remap='I'>name</emphasis> {
1818 <emphasis remap='I'>tapetype-option</emphasis> <emphasis remap='I'>tapetype-value</emphasis>
1819 <literal>...</literal>
1823 <para><emphasis remap='I'>Name</emphasis>
1824 is the name of this type of tape medium/device.
1825 It is referenced from the
1826 <emphasis remap='B'>tapetype</emphasis>
1827 option in the main part of the config file.</para>
1829 <para>The tapetype options and values are:</para>
1830 <variablelist remap='TP'>
1832 <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
1835 <emphasis remap='I'>none</emphasis>.
1836 A comment string describing this set of tape information.</para>
1840 <term><emphasis remap='B'>filemark</emphasis> <emphasis remap='I'> int</emphasis></term>
1843 <emphasis remap='I'>1 kbytes</emphasis>.
1844 How large a file mark (tape mark) is, measured in kbytes.
1845 If the size is only known in some linear measurement (e.g. inches),
1846 convert it to kbytes using the device density.</para>
1850 <term><emphasis remap='B'>length</emphasis> <emphasis remap='I'> int</emphasis></term>
1853 <emphasis remap='I'>2000 kbytes</emphasis>. How much data will fit on a tape.</para>
1855 <para>Note that this value is only used by &A; to schedule which backups will be run.
1856 Once the backups start, &A; will continue to write to a tape until it gets an error,
1857 regardless of what value is entered for <emphasis remap='B'>length</emphasis>
1858 (but see the section OUTPUT DRIVERS in the
1859 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1860 manpage for exceptions).
1865 <term><emphasis remap='B'>blocksize</emphasis> <emphasis remap='I'> int</emphasis></term>
1868 <emphasis remap='I'>32 kbytes</emphasis>.
1869 How much data will be written in each tape record expressed in KiloBytes.
1870 The tape record size (= blocksize) can not be reduced below the default 32 KBytes.
1871 The parameter blocksize can only be raised if &A; was compiled with the configure option
1872 --with-maxtapeblocksize=N set with "N" greater than 32 during
1878 <term><emphasis remap='B'>readblocksize</emphasis> <emphasis remap='I'> int</emphasis></term>
1881 (<emphasis remap='I'>from configure --with-maxtapeblocksize</emphasis>).
1882 How much data will be read in each tape record expressed in KiloBytes.
1883 Some hardware require a value not too large, and some require it to be equal to the blocksize.
1884 It is useful if you configured amanda with a big --with-maxtapeblocksize and your
1885 hardware don't work with a value that big.
1890 <term><emphasis remap='B'>file-pad</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1893 <emphasis remap='I'>true</emphasis>.
1894 If true, every record, including the last one in the file, will have the same length.
1895 This matches the way &A; wrote tapes prior to the availability of this parameter.
1896 It may also be useful on devices that only support a fixed blocksize.</para>
1898 <para>Note that the last record on the tape probably includes trailing
1899 null byte padding, which will be passed back to
1900 <emphasis remap='B'>gzip</emphasis>,
1901 <emphasis remap='B'>compress</emphasis>
1902 or the restore program. Most programs just ignore this (although possibly with a warning).</para>
1904 <para>If this parameter is false, the last record in a file may be shorter
1905 than the block size. The file will contain the same amount of data the dump program generated,
1906 without trailing null byte padding. When read, the same amount of data that was written
1907 will be returned.</para>
1912 <term><emphasis remap='B'>speed</emphasis> <emphasis remap='I'> int</emphasis></term>
1915 <emphasis remap='I'>200 bps</emphasis>.
1916 How fast the drive will accept data, in bytes per second.
1917 This parameter is NOT currently used by &A;.</para>
1921 <term><emphasis remap='B'>lbl-templ</emphasis> <emphasis remap='I'> string</emphasis></term>
1923 <para>A PostScript template file used by
1924 <emphasis remap='B'>amreport</emphasis>
1925 to generate labels. Several sample files are provided with the &A; sources in the
1926 <emphasis remap='I'>example</emphasis> directory.
1928 <citerefentry><refentrytitle>amreport</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1929 man page for more information.</para>
1934 <para>In addition to options, another
1935 <emphasis remap='B'>tapetype</emphasis>
1936 name may be entered, which makes this
1937 <emphasis remap='B'>tapetype</emphasis>
1938 inherit options from another
1939 <emphasis remap='B'>tapetype</emphasis>.
1940 For instance, the only difference between a DLT4000 tape drive using
1941 Compact-III tapes and one using Compact-IV tapes is the length of the tape.
1942 So they could be entered as:</para>
1944 <programlisting remap='.nf'>
1945 define tapetype DLT4000-III {
1946 comment "DLT4000 tape drives with Compact-III tapes"
1947 length 12500 mbytes # 10 Gig tapes with some compression
1948 filemark 2000 kbytes
1951 define tapetype DLT4000-IV {
1953 comment "DLT4000 tape drives with Compact-IV tapes"
1954 length 25000 mbytes # 20 Gig tapes with some compression
1958 <!-- If anybody has read this, where do all those stupid
1959 pseudo-duplicate FOM-tapetype-entries come from??
1965 <refsect1><title>INTERFACE SECTION</title>
1967 <emphasis remap='B'>amanda.conf</emphasis>
1968 file may define multiple types of network interfaces.
1969 The information is entered in an <emphasis remap='B'>interface</emphasis>
1970 section, which looks like this:</para>
1973 define interface <emphasis remap='I'>name</emphasis> {
1974 <emphasis remap='I'>interface-option</emphasis> <emphasis remap='I'>interface-value</emphasis>
1975 <literal>...</literal>
1979 <para><emphasis remap='I'>name</emphasis>
1980 is the name of this type of network interface. It is referenced from the
1981 <emphasis remap='I'>disklist</emphasis> file.</para>
1983 <para>Note that these sections define network interface characteristics,
1984 not the actual interface that will be used. Nor do they impose limits on the bandwidth that will
1985 actually be taken up by &A;.
1986 &A; computes the estimated bandwidth each file system backup will take
1987 based on the estimated size and time, then compares that plus any other running
1988 backups with the limit as another of the criteria when deciding whether
1989 to start the backup. Once a backup starts, &A; will use as much of the network as it can
1990 leaving throttling up to the operating system and network hardware.</para>
1992 <para>The interface options and values are:</para>
1993 <variablelist remap='TP'>
1995 <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
1998 <emphasis remap='I'>none</emphasis>.
1999 A comment string describing this set of network information.</para>
2003 <term><emphasis remap='B'>use</emphasis> <emphasis remap='I'> int</emphasis></term>
2006 <emphasis remap='I'>300 Kbps</emphasis>.
2007 The speed of the interface in Kbytes per second.</para>
2012 <para>In addition to options, another
2013 <emphasis remap='B'>interface</emphasis>
2014 name may be entered, which makes this
2015 <emphasis remap='B'>interface</emphasis>
2016 inherit options from another
2017 <emphasis remap='B'>interface</emphasis>.
2018 At the moment, this is of little use.</para>
2021 <refsect1><title>AUTHOR</title>
2022 <para>James da Silva, &email.jds;: Original text</para>
2023 <para>&maintainer.sgw;: XML-conversion, major update, splitting</para>
2026 <refsect1><title>SEE ALSO</title>
2028 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
2029 <citerefentry><refentrytitle>amanda-client.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2030 <citerefentry><refentrytitle>amcrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
2031 <citerefentry><refentrytitle>aespipe</refentrytitle><manvolnum>1</manvolnum></citerefentry>,