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>
27 <refsect1><title>PARAMETERS</title>
29 <para>There are a number of configuration parameters that control the
30 behavior of the &A; programs.
31 All have default values,
32 so you need not specify the parameter in
33 <emphasis remap='B'>amanda.conf</emphasis>
34 if the default is suitable.</para>
36 <para>Lines starting with # are ignored, as are blank lines.
37 Comments may be placed on a line with a directive by starting
39 The remainder of the line is ignored.</para>
41 <para>Keywords are case insensitive, i.e.
42 <emphasis remap='B'>mailto</emphasis>
44 <emphasis remap='B'>MailTo</emphasis>
45 are treated the same.</para>
47 <para>Integer arguments may have one of the following (case insensitive) suffixes,
48 some of which have a multiplier effect:</para>
50 <refsect2><title>POSSIBLE SUFFIXES</title>
52 <variablelist remap='TP'>
54 <term><emphasis remap='B'>b byte bytes</emphasis></term>
56 <para>Some number of bytes.</para>
60 <term><emphasis remap='B'>bps</emphasis></term>
62 <para>Some number of bytes per second.</para>
66 <term><emphasis remap='B'>k kb kbyte kbytes kilobyte kilobytes</emphasis></term>
68 <para>Some number of kilobytes (bytes*1024).</para>
72 <term><emphasis remap='B'>kps kbps</emphasis></term>
74 <para>Some number of kilobytes per second (bytes*1024).</para>
78 <term><emphasis remap='B'>m mb meg mbyte mbytes megabyte megabytes</emphasis></term>
80 <para>Some number of megabytes (bytes*1024*1024).</para>
84 <term><emphasis remap='B'>mps mbps</emphasis></term>
86 <para>Some number of megabytes per second (bytes*1024*1024).</para>
90 <term><emphasis remap='B'>g gb gbyte gbytes gigabyte gigabytes</emphasis></term>
92 <para>Some number of gigabytes (bytes*1024*1024*1024).</para>
96 <term><emphasis remap='B'>tape tapes</emphasis></term>
98 <para>Some number of tapes.</para>
102 <term><emphasis remap='B'>day days</emphasis></term>
104 <para>Some number of days.</para>
108 <term><emphasis remap='B'>week weeks</emphasis></term>
110 <para>Some number of weeks (days*7).</para>
113 <emphasis remap='B'>inf</emphasis>
114 may be used in most places where an integer is expected
115 to mean an infinite amount.
117 <para>Boolean arguments may have any of the values
118 <emphasis remap='B'>y</emphasis>,
119 <emphasis remap='B'>yes</emphasis>,
120 <emphasis remap='B'>t</emphasis>,
121 <emphasis remap='B'>true</emphasis>
123 <emphasis remap='B'>on</emphasis>
124 to indicate a true state, or
125 <emphasis remap='B'>n</emphasis>,
126 <emphasis remap='B'>no</emphasis>,
127 <emphasis remap='B'>f</emphasis>,
128 <emphasis remap='B'>false</emphasis>
130 <emphasis remap='B'>off</emphasis>
131 to indicate a false state.
132 If no argument is given,
133 <emphasis remap='B'>true</emphasis>
143 <title>PARAMETERS</title>
145 <variablelist remap='TP'>
147 <term><emphasis remap='B'>org</emphasis> <emphasis remap='I'> string</emphasis></term>
150 <emphasis remap='I'>daily</emphasis>.
151 A descriptive name for the configuration.
152 This string appears in the Subject line of mail reports.
153 Each &A; configuration should have a different string to keep
154 mail reports distinct.</para>
158 <term><emphasis remap='B'>mailto</emphasis> <emphasis remap='I'> string</emphasis></term>
161 <emphasis remap='I'>operators</emphasis>.
162 A space separated list of recipients for mail reports.</para>
166 <term><emphasis remap='B'>dumpcycle</emphasis> <emphasis remap='I'> int</emphasis></term>
169 <emphasis remap='I'>10 days</emphasis>.
170 The number of days in the backup cycle.
171 Each disk will get a full backup at least this often.
172 Setting this to zero tries to do a full backup each run.</para>
173 <note>This parameter may also be set in a specific
174 <emphasis remap='B'>dumptype</emphasis>
176 This value sets the default for all
177 <emphasis remap='B'>dumptype</emphasis>s
179 <emphasis remap='B'>amanda.conf</emphasis>
181 <emphasis remap='B'>dumptype</emphasis>s
187 <term><emphasis remap='B'>runspercycle</emphasis> <emphasis remap='I'> int</emphasis></term>
190 <emphasis remap='I'>same as dumpcycle</emphasis>.
191 The number of amdump runs in
192 <emphasis remap='B'>dumpcycle</emphasis>
194 A value of 0 means the same value as
195 <emphasis remap='B'>dumpcycle</emphasis>.
196 A value of -1 means guess the number of runs from the
197 <emphasis remap='I'>tapelist</emphasis>
199 which is the number of tapes used in the last
200 <emphasis remap='B'>dumpcycle</emphasis>
202 <emphasis remap='B'>runtapes</emphasis>.</para>
206 <term><emphasis remap='B'>tapecycle</emphasis> <emphasis remap='I'> int</emphasis></term>
209 <emphasis remap='I'>15 tapes</emphasis>.
210 Typically tapes are used by &A; in an ordered rotation. The <emphasis remap='B'>tapecycle</emphasis> parameter
211 defines the size of that rotation. The number of tapes in rotation must be larger than the number of tapes
212 required for a complete dump cycle (see the <emphasis remap='B'>dumpcycle</emphasis> parameter).
215 This is calculated by multiplying the number of &amdump; runs per dump cycle
216 (<emphasis remap='B'>runspercycle</emphasis> parameter) times the number of tapes used per run
217 (<emphasis remap='B'>runtapes</emphasis> parameter). Typically two to four times this calculated number of tapes are in rotation.
218 While &A; is always willing to use a new tape in its rotation, it refuses to reuse a tape until at
219 least '<emphasis remap='B'>tapecycle</emphasis> -1' number of other tapes have been used.
222 It is considered good administrative practice to set the <emphasis remap='B'>tapecycle</emphasis> parameter
223 slightly lower than the actual number of tapes in rotation. This allows the administrator to more easily cope
224 with damaged or misplaced tapes or schedule adjustments that call for slight adjustments in the rotation order.
230 <term><emphasis remap='B'>label_new_tapes</emphasis>
231 <emphasis remap='I'> string</emphasis></term>
233 <para>Default: not set.
234 When set, this directive will cause &A; to automatically write an &A;
235 tape label to any blank tape she encounters. This option is DANGEROUS
236 because when set, &A; will ERASE any non-&A; tapes you may have, and may
237 also ERASE any near-failing tapes. Use with caution.</para>
238 <para>When using this directive, specify the template for new tape
239 labels. The template should contain some number of contiguous '%'
240 characters, which will be replaced with a generated number. Be sure to
241 specify enough '%' characters that you do not run out of tape labels.
243 <markup>label_new_tapes "DailySet1-%%%"</markup>
250 <term><emphasis remap='B'>label_new_tapes</emphasis>
251 <emphasis remap='I'> string</emphasis></term>
253 <para>Default: not set.
254 When set, this directive will cause &A; to automatically write an Amanda
255 tape label to any black tape she encounters. This option is DANGEROUS
256 because when set, &A; will ERASE any non-&A; tapes you may have, and may
257 also ERASE any near-failing tapes. Use with caution.</para>
258 <para>When using this directive, specify the template for new tape
259 labels. The template should contain some number of contiguous '%'
260 characters, which will be replaced with a generated number. Be sure to
261 specify enough '%' characters that you do not run out of tape labels.
263 <markup>label_new_tapes "DailySet1-%%%"</markup>
269 <term><emphasis remap='B'>dumpuser</emphasis> <emphasis remap='I'> string</emphasis></term>
272 <emphasis remap='I'>amanda</emphasis>.
273 The login name &A; uses to run the backups.
274 The backup client hosts must allow access
275 from the tape server host as this user via
276 <markup>.rhosts</markup>
278 <markup>.amandahosts</markup>,
279 depending on how the &A; software was built.</para>
283 <term><emphasis remap='B'>printer</emphasis> string</term>
285 <para>Printer to use when doing tape labels.
287 <emphasis remap='B'>lbl-templ</emphasis>
288 <emphasis remap='B'>tapetype</emphasis>
293 <term><emphasis remap='B'>tapedev</emphasis> string</term>
296 <filename>null:</filename>.
297 The path name of the non-rewinding tape device.
298 Non-rewinding tape device names often have an 'n' in the name,
300 <filename>/dev/rmt/0mn</filename>,
301 however this is operating system specific and you should consult
302 that documentation for detailed naming information.</para>
304 <para>If a tape changer is configured
306 <emphasis remap='B'>tpchanger</emphasis>
307 option), this option might not be used.</para>
310 <emphasis remap='B'>null</emphasis>
311 output driver is selected
312 (see the section OUTPUT DRIVERS in the
313 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
314 manpage for more information),
317 will run normally but all images will be thrown away.
318 This should only be used for debugging and testing,
319 and probably only with the
320 <emphasis remap='B'>record</emphasis>
322 <emphasis remap='I'>no</emphasis>.</para>
327 <term><emphasis remap='B'>rawtapedev</emphasis> string</term>
330 <filename>null:</filename>.
331 The path name of the raw tape device.
332 This is only used if &A; is compiled for Linux machines with floppy tapes
333 and is needed for QIC volume table operations.</para>
337 <term><emphasis remap='B'>tpchanger</emphasis> string</term>
340 <emphasis remap='I'>none</emphasis>.
341 The name of the tape changer.
342 If a tape changer is not configured, this option is not used
343 and should be commented out of the configuration file.</para>
344 <para>If a tape changer is configured, choose one of the changer scripts
345 (e.g. <emphasis remap='B'>chg-scsi</emphasis>)
346 and enter that here.</para>
351 <term><emphasis remap='B'>changerdev</emphasis> string</term>
354 <filename>/dev/null</filename>.
355 A tape changer configuration parameter.
356 Usage depends on the particular changer defined with the
357 <emphasis remap='B'>tpchanger</emphasis>
362 <term><emphasis remap='B'>changerfile</emphasis> string</term>
365 <filename>/usr/adm/amanda/log/changer-status</filename>.
366 A tape changer configuration parameter.
367 Usage depends on the particular changer defined with the
368 <emphasis remap='B'>tpchanger</emphasis>
373 <term><emphasis remap='B'>runtapes</emphasis> int</term>
376 <literal>1</literal>.
377 The maximum number of tapes used in a single run.
378 If a tape changer is not configured, this option is not used
379 and should be commented out of the configuration file.</para>
380 <para>If a tape changer is configured, this may be set larger than one to
381 let &A; write to more than one tape.</para>
382 <para>Note that this is an upper bound on the number of tapes,
383 and &A; may use less.</para>
384 <para>Also note that as of this release, &A; does not support true tape overflow.
385 When it reaches the end of one tape,
386 the backup image &A; was processing starts over again on the next tape.</para>
391 <term><emphasis remap='B'>maxdumpsize</emphasis> int</term>
394 <emphasis remap='I'>runtapes</emphasis>*<emphasis remap='I'>tape_length</emphasis>.
395 Maximum number of bytes the planner will schedule for a run.</para>
399 <term><emphasis remap='B'>taperalgo</emphasis> [first|firstfit|largest|largestfit|smallest|last]</term>
402 <emphasis remap='I'>first</emphasis>.
403 The algorithm used to choose which dump image to send to the taper.</para>
405 <variablelist remap='TP'>
407 <term><emphasis remap='B'>first</emphasis></term>
409 <para>First in, first out.</para>
413 <term><emphasis remap='B'>firstfit</emphasis></term>
415 <para>The first dump image that will fit on the current tape.</para>
419 <term><emphasis remap='B'>largest</emphasis></term>
421 <para>The largest dump image.</para>
425 <term><emphasis remap='B'>largestfit</emphasis></term>
427 <para>The largest dump image that will fit on the current tape.</para>
431 <term><emphasis remap='B'>smallest</emphasis></term>
433 <para>The smallest dump image.</para>
437 <term><emphasis remap='B'>last</emphasis></term>
439 <para>Last in, first out.</para>
447 <term><emphasis remap='B'>labelstr</emphasis> <emphasis remap='I'> string</emphasis></term>
450 <emphasis remap='I'>.*</emphasis>.
451 The tape label constraint regular expression.
452 All tape labels generated (see
453 <citerefentry><refentrytitle>amlabel</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
454 and used by this configuration must match the regular expression.
455 If multiple configurations are run from the same tape server host,
456 it is helpful to set their labels to different strings
457 (for example, "DAILY[0-9][0-9]*" vs.
458 "ARCHIVE[0-9][0-9]*")
459 to avoid overwriting each other's tapes.</para>
463 <term><emphasis remap='B'>tapetype</emphasis> <emphasis remap='I'> string</emphasis></term>
466 <emphasis remap='I'>EXABYTE</emphasis>.
467 The type of tape drive associated with
468 <emphasis remap='B'>tapedev</emphasis>
470 <emphasis remap='B'>tpchanger</emphasis>.
471 This refers to one of the defined <emphasis remap='B'>tapetype</emphasis>s
472 in the config file (see below), which specify various tape parameters,
474 <emphasis remap='B'>length</emphasis>,
475 <emphasis remap='B'>filemark</emphasis>
477 <emphasis remap='B'>speed</emphasis>
478 of the tape media and device.</para>
479 <para>First character of a <emphasis remap='B'>tapetype</emphasis> string must
480 be an alphabetic character</para>
484 <term><emphasis remap='B'>ctimeout</emphasis> int</term>
487 <emphasis remap='I'>30 seconds</emphasis>.
488 Maximum amount of time that
489 <emphasis remap='B'>amcheck</emphasis>
490 will wait for each client host.</para>
494 <term><emphasis remap='B'>dtimeout</emphasis> int</term>
497 <emphasis remap='I'>1800 seconds</emphasis>.
498 Amount of idle time per disk on a given client that a
499 <emphasis remap='B'>dumper</emphasis>
501 <command>amdump</command>
502 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>
523 <term><emphasis remap='B'>netusage</emphasis> int</term>
526 <emphasis remap='I'>300 Kbps</emphasis>.
527 The maximum network bandwidth allocated to &A;, in Kbytes per second.
529 <emphasis remap='B'>interface</emphasis>
534 <term><emphasis remap='B'>inparallel</emphasis> int</term>
537 <literal>10</literal>.
538 The maximum number of backups that &A; will attempt to run in parallel.
539 &A; will stay within the constraints of network bandwidth and
540 holding disk space available, so it doesn't hurt to set
541 this number a bit high. Some contention can occur with larger numbers
542 of backups, but this effect is relatively small on most systems.</para>
547 <term><emphasis remap='B'>displayunit</emphasis> "k|m|g|t"</term>
550 <literal>"k"</literal>.
551 The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera.
557 <term><emphasis remap='B'>dumporder</emphasis> string</term>
560 <emphasis remap='I'>tttTTTTTTT</emphasis>.
561 The priority order of each dumper:</para>
564 <listitem><para>s: smallest size</para></listitem>
565 <listitem><para>S: largest size</para></listitem>
566 <listitem><para>t: smallest time</para></listitem>
567 <listitem><para>T: largest time</para></listitem>
568 <listitem><para>b: smallest bandwidth</para></listitem>
569 <listitem><para>B: largest bandwidth</para></listitem>
576 <term><emphasis remap='B'>maxdumps</emphasis> int</term>
579 <literal>1</literal>.
580 The maximum number of backups from a single host that &A; will
581 attempt to run in parallel. See also the
582 <emphasis remap='B'>inparallel</emphasis>
585 <para>Note that this parameter may also be set in a specific
586 <emphasis remap='B'>dumptype</emphasis>
588 This value sets the default for all
589 <emphasis remap='B'>dumptype</emphasis>s
591 <emphasis remap='B'>amanda.conf</emphasis>
593 <emphasis remap='B'>dumptype</emphasis>s
599 <term><emphasis remap='B'>bumpsize</emphasis> int</term>
602 <emphasis remap='I'>10 Mbytes</emphasis>.
603 The minimum savings required to trigger an automatic
604 bump from one incremental level to the next, expressed as size.
605 If &A; determines that the next higher backup level
606 will be this much smaller than the current level,
607 it will do the next level.
608 The value of this parameter is used only if the parameter
609 <emphasis>bumppercent</emphasis> is set to 0.
612 The global setting of this parameter can be overwritten inside of a
617 <emphasis remap='B'>bumppercent</emphasis>,
618 <emphasis remap='B'>bumpmult</emphasis> and
619 <emphasis remap='B'>bumpdays</emphasis>.</para>
624 <term><emphasis remap='B'>bumppercent</emphasis> int</term>
627 <emphasis remap='I'>0 percent</emphasis>.
628 The minimum savings required to trigger an automatic
629 bump from one incremental level to the next, expressed as percentage of the
630 current size of the DLE (size of current level 0).
631 If &A; determines that the next higher backup level
632 will be this much smaller than the current level,
633 it will do the next level.
636 If this parameter is set to 0, the value of the
637 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
640 The global setting of this parameter can be overwritten inside of a
645 <emphasis remap='B'>bumpsize</emphasis>,
646 <emphasis remap='B'>bumpmult</emphasis> and
647 <emphasis remap='B'>bumpdays</emphasis>.</para>
652 <term><emphasis remap='B'>bumpmult</emphasis> <emphasis remap='I'> float</emphasis></term>
655 <literal>1.5</literal>.
656 The bump size multiplier.
658 <emphasis remap='B'>bumpsize</emphasis>
659 by this factor for each level.
660 This prevents active filesystems from
661 bumping too much by making it harder to bump to the next level.
662 For example, with the default
663 <emphasis remap='B'>bumpsize</emphasis>
665 <emphasis remap='B'>bumpmult</emphasis>
666 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
667 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
669 The global setting of this parameter can be overwritten inside of a
675 <term><emphasis remap='B'>bumpdays</emphasis> <emphasis remap='I'> int</emphasis></term>
678 <emphasis remap='I'>2 days</emphasis>.
679 To insure redundancy in the dumps, &A; keeps filesystems at the
680 same incremental level for at least
681 <emphasis remap='B'>bumpdays</emphasis>
682 days, even if the other bump threshold criteria are met.</para>
684 The global setting of this parameter can be overwritten inside of a
691 <term><emphasis remap='B'>diskfile</emphasis> <emphasis remap='I'> string</emphasis></term>
694 <emphasis remap='I'>disklist</emphasis>.
695 The file name for the
696 <emphasis remap='I'>disklist</emphasis>
697 file holding client hosts, disks and other client dumping information.</para>
701 <term><emphasis remap='B'>infofile</emphasis> <emphasis remap='I'> string</emphasis></term>
704 <filename>/usr/adm/amanda/curinfo</filename>.
705 The file or directory name for the historical information database.
706 If &A; was configured to use DBM databases, this is the base file
708 If it was configured to use text formated databases (the default),
709 this is the base directory and within here will be a directory per
710 client, then a directory per disk, then a text file of data.</para>
714 <term><emphasis remap='B'>logdir</emphasis> <emphasis remap='I'> string</emphasis></term>
717 <filename>/usr/adm/amanda</filename>.
718 The directory for the
719 <command>amdump</command>
721 <emphasis remap='B'>log</emphasis>
726 <term><emphasis remap='B'>indexdir</emphasis> <emphasis remap='I'> string</emphasis></term>
729 <filename>/usr/adm/amanda/index</filename>.
730 The directory where index files (backup image catalogues) are stored.
732 only generated for filesystems whose
733 <emphasis remap='B'>dumptype</emphasis>
735 <emphasis remap='B'>index</emphasis>
736 option enabled.</para>
740 <term><emphasis remap='B'>tapelist</emphasis> <emphasis remap='I'> string</emphasis></term>
743 <emphasis remap='I'>tapelist</emphasis>.
744 The file name for the active
745 <emphasis remap='I'>tapelist</emphasis>
747 &A; maintains this file with information about the active set of tapes.</para>
751 <term><emphasis remap='B'>tapebufs</emphasis> <emphasis remap='I'> int</emphasis></term>
754 <literal>20</literal>.
755 The number of buffers used by the
756 <emphasis remap='B'>taper</emphasis>
758 <command>amdump</command>
760 <emphasis remap='B'>amflush</emphasis>
761 to hold data as it is read from the network or disk before it is written to tape.
762 Each buffer is a little larger than 32 KBytes and is held in a shared memory region.</para>
766 <term><emphasis remap='B'>reserve</emphasis> <emphasis remap='I'> number</emphasis></term>
769 <literal>100</literal>.
770 The part of holding-disk space that should be reserved for incremental
771 backups if no tape is available, expressed as a percentage of the
772 available holding-disk space (0-100).
773 By default, when there is no tape to write to, degraded mode (incremental) backups
774 will be performed to the holding disk. If full backups should also be allowed in this case,
775 the amount of holding disk space reserved for incrementals should be lowered.</para>
779 <term><emphasis remap='B'>autoflush</emphasis> <emphasis remap='I'> bool</emphasis></term>
782 <emphasis remap='I'>off</emphasis>.
783 Whether an amdump run will flush the dumps from holding disk to tape.</para>
787 <term><emphasis remap='B'>amrecover_do_fsf</emphasis> <emphasis remap='I'> bool</emphasis></term>
790 <emphasis remap='I'>off</emphasis>.
791 Amrecover will call amrestore with the -f flag for faster positioning of the tape.</para>
795 <term><emphasis remap='B'>amrecover_check_label</emphasis> <emphasis remap='I'> bool</emphasis></term>
798 <emphasis remap='I'>off</emphasis>.
799 Amrecover will call amrestore with the -l flag to check the label.</para>
803 <term><emphasis remap='B'>amrecover_changer</emphasis> <emphasis remap='I'> string</emphasis></term>
806 Amrecover will use the changer if you use 'settape <string>' and that string
807 is the same as the amrecover_changer setting.</para>
811 <term><emphasis remap='B'>columnspec</emphasis> <emphasis remap='I'> string</emphasis></term>
813 <para>Defines the width of columns <emphasis remap='B'>amreport</emphasis>
815 <emphasis remap='I'>String</emphasis>
816 is a comma (',') separated list of triples. Each triple consists
817 of three parts which are separated by a equal sign ('=') and a colon (':') (see the example).
818 These three parts specify:</para>
822 <para>the name of the column, which may be:</para>
825 <listitem><para>Compress (compression ratio)</para></listitem>
826 <listitem><para>Disk (client disk name)</para></listitem>
827 <listitem><para>DumpRate (dump rate in KBytes/sec)</para></listitem>
828 <listitem><para>DumpTime (total dump time in hours:minutes)</para></listitem>
829 <listitem><para>HostName (client host name)</para></listitem>
830 <listitem><para>Level (dump level)</para></listitem>
831 <listitem><para>OrigKB (original image size in KBytes)</para></listitem>
832 <listitem><para>OutKB (output image size in KBytes)</para></listitem>
833 <listitem><para>TapeRate (tape writing rate in KBytes/sec)</para></listitem>
834 <listitem><para>TapeTime (total tape time in hours:minutes)</para></listitem>
840 <para>the amount of space to display before the column (used to get whitespace between columns).</para>
843 <para>the width of the column itself.
844 If set to a negative value, the width will be calculated on demand to fit the largest entry in
849 <para>Here is an example:</para>
852 <para>columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"</para>
854 The above will display the disk information in 18 characters
855 and put one space before it. The hostname column will be 10 characters wide with
856 no space to the left. The output KBytes column is seven characters wide
857 with one space before it.
862 <term><emphasis remap='B'>includefile</emphasis> <emphasis remap='I'> string</emphasis></term>
865 <emphasis remap='I'>none</emphasis>.
866 The name of an &A; configuration file to include within the current file.
867 Useful for sharing dumptypes, tapetypes and interface definitions among several configurations.</para>
874 <refsect1><title>HOLDINGDISK SECTION</title>
875 <para>The <emphasis remap='B'>amanda.conf</emphasis>
876 file may define one or more holding disks used as buffers to hold
877 backup images before they are written to tape.
878 The syntax is:</para>
881 holdingdisk <emphasis remap='I'>name</emphasis> {
882 <emphasis remap='I'>holdingdisk-option</emphasis> <emphasis remap='I'>holdingdisk-value</emphasis>
883 <literal>...</literal>
886 <para><emphasis remap='I'>Name</emphasis>
887 is a logical name for this holding disk.</para>
889 <para>The options and values are:</para>
891 <variablelist remap='TP'>
893 <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
896 <emphasis remap='I'>none</emphasis>.
897 A comment string describing this holding disk.</para>
901 <term><emphasis remap='B'>directory</emphasis> <emphasis remap='I'> disk</emphasis></term>
904 <filename>/dumps/amanda</filename>.
905 The path to this holding area.</para>
909 <term><emphasis remap='B'>use</emphasis> <emphasis remap='I'> int</emphasis></term>
912 <emphasis remap='I'>0 Gb</emphasis>.
913 Amount of space that can be used in this holding disk area.
914 If the value is zero, all available space on the file system is used.
915 If the value is negative, &A; will use all available space minus that value.
919 <term><emphasis remap='B'>chunksize</emphasis> <emphasis remap='I'> int</emphasis></term>
922 <emphasis remap='I'>1 Gb</emphasis>.
923 Holding disk chunk size. Dumps larger than the specified size will be stored in multiple
924 holding disk files. The size of each chunk will not exceed the specified value.
925 However, even though dump images are split in the holding disk, they are concatenated as
926 they are written to tape, so each dump image still corresponds to a single continuous
929 If 0 is specified, &A; will create holding disk chunks as large as
930 ((INT_MAX/1024)-64) Kbytes.
932 Each holding disk chunk includes a 32 Kbyte header, so the minimum
933 chunk size is 64 Kbytes (but that would be really silly).
935 Operating systems that are limited to a maximum file size of 2 Gbytes
936 actually cannot handle files that large.
937 They must be at least one byte less than 2 Gbytes.
938 Since &A; works with 32 Kbyte blocks, and
939 to handle the final read at the end of the chunk, the chunk size
940 should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum
941 file size, e.g. 2047 Mbytes.
947 <refsect1><title>DUMPTYPE SECTION</title>
948 <para>The &amconf; file may define multiple sets of backup options
949 and refer to them by name from the &disklist; file.
950 For instance, one set of options might be defined for file systems
951 that can benefit from high compression, another set that does not compress well,
952 another set for file systems that should always get a full backup and so on.</para>
954 <para>A set of backup options are entered in a
955 <emphasis remap='B'>dumptype</emphasis>
956 section, which looks like this:</para>
959 define dumptype <emphasis remap='I'>name</emphasis> {
960 <emphasis remap='I'>dumptype-option</emphasis> <emphasis remap='I'>dumptype-value</emphasis>
961 <literal>...</literal>
965 <para><emphasis remap='I'>Name</emphasis>
966 is the name of this set of backup options.
967 It is referenced from the &disklist; file.</para>
969 <para>Some of the options in a
970 <emphasis remap='B'>dumptype</emphasis>
971 section are the same as those in the main part of &amconf;.
972 The main option value is used to set the default for all
973 <emphasis remap='B'>dumptype</emphasis>
974 sections. For instance, setting
975 <emphasis remap='B'>dumpcycle</emphasis>
976 to 50 in the main part of the config file causes all following
977 <emphasis remap='B'>dumptype</emphasis>
978 sections to start with that value,
979 but the value may be changed on a section by section basis.
980 Changes to variables in the main part of the config file must be
981 done before (earlier in the file) any
982 <emphasis remap='B'>dumptype</emphasis>s
985 <para>The dumptype options and values are:</para>
987 <variablelist remap='TP'>
989 <term><emphasis remap='B'>auth</emphasis> <emphasis remap='I'> string</emphasis></term>
992 <emphasis remap='I'>bsd</emphasis>.
993 Type of authorization to perform between tape server and backup client hosts.</para>
994 <para><emphasis remap='B'>krb4</emphasis> to use Kerberos-IV
995 authorization.</para>
996 <para><emphasis remap='B'>krb5</emphasis> to use Kerberos-V
997 authorization.</para>
998 <para><emphasis remap='B'>ssh</emphasis> to use OpenSSH
999 authorization.</para>
1004 <!-- bumping parameters yanked from the global section above -->
1007 <term><emphasis remap='B'>bumpsize</emphasis> int</term>
1010 <emphasis remap='I'>10 Mbytes</emphasis>.
1011 The minimum savings required to trigger an automatic
1012 bump from one incremental level to the next, expressed as size.
1013 If &A; determines that the next higher backup level
1014 will be this much smaller than the current level,
1015 it will do the next level.
1016 The value of this parameter is used only if the parameter
1017 <emphasis>bumppercent</emphasis> is set to 0.
1020 See also the options
1021 <emphasis remap='B'>bumppercent</emphasis>,
1022 <emphasis remap='B'>bumpmult</emphasis> and
1023 <emphasis remap='B'>bumpdays</emphasis>.</para>
1028 <term><emphasis remap='B'>bumppercent</emphasis> int</term>
1031 <emphasis remap='I'>0 percent</emphasis>.
1032 The minimum savings required to trigger an automatic
1033 bump from one incremental level to the next, expressed as percentage of the
1034 current size of the DLE (size of current level 0).
1035 If &A; determines that the next higher backup level
1036 will be this much smaller than the current level,
1037 it will do the next level.
1040 If this parameter is set to 0, the value of the
1041 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
1044 See also the options
1045 <emphasis remap='B'>bumpsize</emphasis>,
1046 <emphasis remap='B'>bumpmult</emphasis> and
1047 <emphasis remap='B'>bumpdays</emphasis>.</para>
1052 <term><emphasis remap='B'>bumpmult</emphasis> <emphasis remap='I'> float</emphasis></term>
1055 <literal>1.5</literal>.
1056 The bump size multiplier.
1058 <emphasis remap='B'>bumpsize</emphasis>
1059 by this factor for each level.
1060 This prevents active filesystems from
1061 bumping too much by making it harder to bump to the next level.
1062 For example, with the default
1063 <emphasis remap='B'>bumpsize</emphasis>
1065 <emphasis remap='B'>bumpmult</emphasis>
1066 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
1067 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
1071 <term><emphasis remap='B'>bumpdays</emphasis> <emphasis remap='I'> int</emphasis></term>
1074 <emphasis remap='I'>2 days</emphasis>.
1075 To insure redundancy in the dumps, &A; keeps filesystems at the
1076 same incremental level for at least
1077 <emphasis remap='B'>bumpdays</emphasis>
1078 days, even if the other bump threshold criteria are met.</para>
1083 <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
1086 <emphasis remap='I'>none</emphasis>.
1087 A comment string describing this set of backup options.</para>
1091 <term><emphasis remap='B'>comprate</emphasis> <emphasis remap='I'>float</emphasis> [, <emphasis remap='I'>float</emphasis> ]</term>
1094 <literal>0.50</literal>,
1095 <literal>0.50</literal>.
1096 The expected full and incremental compression factor for dumps.
1097 It is only used if &A; does not have any history information on
1098 compression rates for a filesystem, so should not usually need to be set.
1099 However, it may be useful for the first time a very large filesystem that
1100 compresses very little is backed up.</para>
1104 <term><emphasis remap='B'>compress [client|server]</emphasis> <emphasis remap='I'> string</emphasis></term>
1107 <emphasis remap='I'>client fast</emphasis>.
1108 If &A; does compression of the backup images, it can do so either on the backup client
1109 host before it crosses the network or on the tape server host as it goes from the
1110 network into the holding disk or to tape. Which place to do compression (if at all) depends on how well the
1111 dump image usually compresses, the speed and load on the client or server, network capacity,
1112 holding disk capacity, availability of tape hardware compression, etc.</para>
1114 <para>For either type of compression, &A; also allows the selection
1115 of three styles of compression.
1116 <emphasis remap='B'>Best</emphasis>
1117 is the best compression available, often at the expense of CPU overhead.
1118 <emphasis remap='B'>Fast</emphasis>
1119 is often not as good a compression as
1120 <emphasis remap='B'>best</emphasis>,
1121 but usually less CPU overhead. Or to specify <emphasis remap='B'>Custom</emphasis>
1122 to use your own compression method. (See dumptype custom-compress in example/amanda.conf for reference)</para>
1126 <para>So the <emphasis remap='B'>compress</emphasis> options line may be one of:</para>
1129 <listitem><para>compress none</para></listitem>
1130 <listitem><para>compress [client] fast</para></listitem>
1131 <listitem><para>compress [client] best</para></listitem>
1132 <listitem><para>compress client custom</para>
1133 <para>Specify client_custom_compress "PROG"</para>
1134 <para>PROG must not contain white space and it must accept -d for uncompress.</para></listitem>
1135 <listitem><para>compress server fast</para></listitem>
1136 <listitem><para>compress server best</para></listitem>
1137 <listitem><para>compress server custom</para>
1138 <para>Specify server_custom_compress "PROG"</para>
1139 <para>PROG must not contain white space and it must accept -d for uncompress.</para></listitem>
1142 <para>Note that some tape devices do compression and this option has nothing
1143 to do with whether that is used. If hardware compression is used (usually via a particular tape device name
1144 or <emphasis remap='B'>mt</emphasis> option), &A; (software) compression should be disabled.</para>
1148 <term><emphasis remap='B'>dumpcycle</emphasis> <emphasis remap='I'> int</emphasis></term>
1150 <para>Default: <emphasis remap='I'>10 days</emphasis>.
1151 The number of days in the backup cycle. Each disk using this set of options will get a full
1152 backup at least this of
1153 ten. Setting this to zero tries to do a full backup each run.</para>
1158 <term><emphasis remap='B'>encrypt [none|client|server]</emphasis></term>
1160 <para>Default: <emphasis remap='I'>none</emphasis>.
1161 To encrypt backup images, it can do so either on the backup client host before it crosses the network or on the tape
1162 server host as it goes from the network into the holding disk or to tape.</para>
1164 <para>So the <emphasis remap='B'>encrypt</emphasis> options line may be one
1168 <listitem><para>encrypt none</para></listitem>
1169 <listitem><para>encrypt client</para>
1170 <para>Specify client_encrypt "PROG"</para>
1171 <para>PROG must not contain white space.</para>
1172 <para>Specify client_decrypt_option "decryption-parameter" Default: "-d"</para>
1173 <para>decryption-parameter must not contain white space.</para>
1174 <para>(See dumptype encrypt-fast in example/amanda.conf for reference)</para>
1176 <listitem><para>encrypt server</para>
1177 <para>Specify server_encrypt "PROG"</para>
1178 <para>PROG must not contain white space.</para>
1179 <para>Specify server_decrypt_option "decryption-parameter" Default: "-d"</para>
1180 <para>decryption-parameter must not contain white space.</para>
1184 <para>Note that current logic assumes compression then encryption during
1185 backup(thus decrypt then uncompress during restore). So specifying
1186 client-encryption AND server-compression is not supported.
1187 <emphasis remap='I'>amcrypt</emphasis> which is a wrapper of
1188 <emphasis remap='I'>aespipe</emphasis> is provided as a reference
1189 encryption program.</para>
1194 <term><emphasis remap='B'>estimate</emphasis> <emphasis remap='I'>client|calcsize|server</emphasis></term>
1196 <para>Default: <emphasis remap='I'>client</emphasis>.
1197 Determine the way &A; does it's estimate.</para>
1200 <para>client:</para>
1202 Use the same program as the dumping program, this is the most accurate way to do estimates, but it can take a long time.
1206 <para>calcsize:</para>
1207 <para>Use a faster program to do estimates, but the result is less accurate.</para>
1210 <para>server:</para>
1211 <para>Use only statistics from the previous run to give an estimate,
1212 it takes only a few seconds but the result is not accurate if your disk
1213 usage changes from day to day.
1222 <term><emphasis remap='B'>exclude</emphasis> [ <emphasis remap='I'>list|file</emphasis> ][[optional][ <emphasis remap='I'>append</emphasis> ][ <emphasis remap='I'> string</emphasis> ]+]</term>
1225 <emphasis remap='I'>file</emphasis>.
1226 There are two exclude lists,
1227 <emphasis remap='B'>exclude file</emphasis>
1229 <emphasis remap='B'>exclude list.</emphasis>
1231 <emphasis remap='B'>exclude file</emphasis>
1233 <emphasis remap='I'>string</emphasis>
1234 is a &gnutar; exclude expression. With
1235 <emphasis remap='B'>exclude list</emphasis>
1237 <emphasis remap='I'>string</emphasis>
1238 is a file name on the client containing &gnutar; exclude expressions.
1239 The path to the specified exclude list file, if present (see description of
1240 'optional' below), must be readable by the &A; user.</para>
1242 <para>All exclude expressions are concatenated in one file and passed to &gnutar;
1243 as an <option>--exclude-from</option> argument.</para>
1245 <para>Exclude expressions must always be specified as relative to the
1246 head directory of the DLE.</para>
1249 <emphasis remap='B'>append</emphasis> keyword, the
1250 <emphasis remap='I'>string</emphasis> is appended to the current list, without it, the
1251 <emphasis remap='I'>string</emphasis> overwrites the list.</para>
1253 <para>If <emphasis remap='B'>optional</emphasis>
1254 is specified for <emphasis remap='B'>exclude list</emphasis>,
1255 then amcheck will not complain if the file doesn't exist or is not readable.</para>
1257 <para>For <emphasis remap='B'>exclude list</emphasis>,
1258 if the file name is relative, the disk name being backed up is prepended.
1259 So if this is entered:</para>
1262 exclude list ".amanda.excludes"
1265 <para>the actual file used would be
1266 <filename>/var/.amanda.excludes</filename>
1267 for a backup of <filename>/var</filename>,
1268 <filename>/usr/local/.amanda.excludes</filename> for a backup of
1269 <filename>/usr/local</filename>, and so on.</para>
1274 <term><emphasis remap='B'>holdingdisk</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1277 <emphasis remap='I'>yes</emphasis>.
1278 Whether a holding disk should be used for these backups or whether they should go directly to tape.
1279 If the holding disk is a portion of another file system that &A;
1280 is backing up, that file system should refer to a dumptype with
1281 <emphasis remap='B'>holdingdisk</emphasis>
1283 <emphasis remap='I'>no</emphasis>
1284 to avoid backing up the holding disk into itself.</para>
1289 <term><emphasis remap='B'>ignore</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1292 <emphasis remap='I'>no</emphasis>.
1293 Whether disks associated with this backup type should be backed up or not.
1294 This option is useful when the
1295 <emphasis remap='I'>disklist</emphasis>
1296 file is shared among several configurations,
1297 some of which should not back up all the listed file systems.</para>
1301 <term><emphasis remap='B'>include</emphasis> [ <emphasis remap='I'>list|file</emphasis> ][[optional][ <emphasis remap='I'>append</emphasis> ][ <emphasis remap='I'> string</emphasis> ]+]</term>
1304 <emphasis remap='I'>file</emphasis>
1306 There are two include lists,
1307 <emphasis remap='B'>include file</emphasis>
1309 <emphasis remap='B'>include list.</emphasis>
1311 <emphasis remap='B'>include file</emphasis>
1313 <emphasis remap='I'>string</emphasis>
1314 is a glob expression. With
1315 <emphasis remap='B'>include list</emphasis>
1317 <emphasis remap='I'>string</emphasis>
1318 is a file name on the client containing glob expressions.</para>
1320 <para>All include expressions are expanded by &A;, concatenated in one file and passed to &gnutar; as a
1321 <option>--files-from</option> argument. They must start with "./" and contain no other "/".</para>
1323 <para>Include expressions must always be specified as relative to the
1324 head directory of the DLE.</para>
1326 <note>For globbing to work at all, even the limited single level,
1327 the top level directory of the DLE must be readable by the &A; user.</note>
1329 <para>With the <emphasis remap='B'>append</emphasis> keyword, the
1330 <emphasis remap='I'>string</emphasis> is appended to the current list, without it, the
1331 <emphasis remap='I'>string</emphasis> overwrites the list.</para>
1334 <emphasis remap='B'>optional</emphasis> is specified for
1335 <emphasis remap='B'>include list,</emphasis> then amcheck will not complain if the file
1336 doesn't exist or is not readable.</para>
1338 <para>For <emphasis remap='B'>include list</emphasis>,
1339 If the file name is relative, the disk name being backed up is prepended.</para>
1344 <term><emphasis remap='B'>index</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1346 <para>Default: <emphasis remap='I'>no</emphasis>.
1347 Whether an index (catalogue) of the backup should be generated and saved in
1348 <emphasis remap='B'>indexdir</emphasis>.
1349 These catalogues are used by the <emphasis remap='B'>amrecover</emphasis> utility.</para>
1354 <term><emphasis remap='B'>kencrypt</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1357 <emphasis remap='I'>no</emphasis>.
1358 Whether the backup image should be encrypted by Kerberos as it is sent
1359 across the network from the backup client host to the tape server host.</para>
1363 <term><emphasis remap='B'>maxdumps</emphasis> <emphasis remap='I'> int</emphasis></term>
1366 <literal>1</literal>.
1367 The maximum number of backups from a single host that &A; will attempt to run in parallel.
1368 See also the main section parameter <emphasis remap='B'>inparallel</emphasis>.</para>
1372 <term><emphasis remap='B'>maxpromoteday</emphasis> <emphasis remap='I'> int</emphasis></term>
1375 <literal>10000</literal>.
1376 The maximum number of day for a promotion, set it 0 if you don't want
1377 promotion, set it to 1 or 2 if your disks get overpromoted.</para>
1381 <term><emphasis remap='B'>priority</emphasis> <emphasis remap='I'> string</emphasis></term>
1383 <para>Default: <emphasis remap='I'>medium</emphasis>.
1384 When there is no tape to write to, &A; will do incremental backups
1385 in priority order to the holding disk. The priority may be
1386 high (2), medium (1), low (0) or a number of your choice.</para>
1390 <term><emphasis remap='B'>program</emphasis> <emphasis remap='I'> string</emphasis></term>
1393 <emphasis remap='I'>DUMP</emphasis>.
1394 The type of backup to perform. Valid values are
1395 <emphasis remap='B'>DUMP</emphasis>
1396 for the native operating system backup program, and
1397 <emphasis remap='B'>GNUTAR</emphasis>
1398 to use &gnutar; or to do PC backups using Samba.</para>
1402 <term><emphasis remap='B'>record</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1405 <emphasis remap='I'>yes</emphasis>.
1406 Whether to ask the backup program to update its database (e.g. <filename>/etc/dumpdates</filename>
1407 for DUMP or <filename>/usr/local/var/amanda/gnutar-lists</filename> for GNUTAR) of time stamps.
1408 This is normally enabled for daily backups and turned off for periodic archival runs.</para>
1412 <term><emphasis remap='B'>skip-full</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1415 <emphasis remap='I'>no</emphasis>. If <emphasis remap='I'>true</emphasis> and
1416 <emphasis remap='B'>planner</emphasis> has scheduled a full backup, these disks will be skipped, and
1417 full backups should be run off-line on these days. It was reported that &A; only schedules
1418 level 1 incrementals in this configuration; this is probably a bug.</para>
1422 <term><emphasis remap='B'>skip-incr</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1425 <emphasis remap='I'>no</emphasis>. If <emphasis remap='I'>true</emphasis> and
1426 <emphasis remap='B'>planner</emphasis> has scheduled an incremental backup, these disks will be skipped.</para>
1430 <term><emphasis remap='B'>starttime</emphasis> <emphasis remap='I'> int</emphasis></term>
1433 <emphasis remap='I'>none</emphasis>.
1434 Backups will not start until after this time of day.
1435 The value should be hh*100+mm, e.g. 6:30PM (18:30) would be entered as
1436 <literal>1830</literal>.</para>
1440 <term><emphasis remap='B'>strategy</emphasis> <emphasis remap='I'> string</emphasis></term>
1442 <para>Default: <emphasis remap='I'>standard</emphasis>.
1443 Strategy to use when planning what level of backup to run next. Values are:</para>
1445 <variablelist remap='TP'>
1447 <term><emphasis remap='B'>standard</emphasis></term>
1449 <para>The standard &A; schedule.</para>
1453 <term><emphasis remap='B'>nofull</emphasis></term>
1455 <para>Never do full backups, only level 1 incrementals.</para>
1459 <term><emphasis remap='B'>noinc</emphasis></term>
1461 <para>Never do incremental backups, only full dumps.</para>
1465 <term><emphasis remap='B'>skip</emphasis></term>
1467 <para>Never do backups (useful when sharing the <emphasis remap='I'>disklist</emphasis> file).</para>
1471 <term><emphasis remap='B'>incronly</emphasis></term>
1473 <para>Only do incremental dumps. <command>amadmin force</command> should be used to tell
1474 &A; that a full dump has been performed off-line, so that it resets to level 1.
1475 It is similar to skip-full, but with incronly full dumps may be scheduled manually.
1476 Unfortunately, it appears that &A; will perform full backups with this configuration,
1477 which is probably a bug.</para>
1485 <term><emphasis remap='B'>tape_splitsize</emphasis> <emphasis remap='I'> int</emphasis></term>
1488 <emphasis remap='I'>none</emphasis>.
1489 Split dump file on tape into pieces of a specified size.
1490 This allows dumps to be spread across multiple tapes, and can potentially
1491 make more efficient use of tape space.
1492 Note that if this value is too large (more than half the size of the
1493 average dump being split), substantial tape space can be wasted.
1494 If too small, large dumps will be split into innumerable tiny dumpfiles,
1495 adding to restoration complexity.
1496 A good rule of thumb, usually, is 1/10 of the size of your tape.</para>
1501 <term><emphasis remap='B'>split_diskbuffer</emphasis> <emphasis remap='I'> string</emphasis></term>
1504 <emphasis remap='I'>none</emphasis>.
1505 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.
1511 <term><emphasis remap='B'>fallback_splitsize</emphasis> <emphasis remap='I'> int</emphasis></term>
1514 <emphasis remap='I'>10M</emphasis>.
1515 When dumping a split dump in PORT-WRITE mode, if no split_diskbuffer is
1516 specified (or if we somehow fail to use our split_diskbuffer), we must
1517 buffer split chunks in memory.
1518 This specifies the maximum size split chunks can be in this scenario,
1519 and thus the maximum amount of memory consumed for in-memory splitting.
1520 The size of this buffer can be changed from its (very conservative) default
1521 to a value reflecting the amount of memory that each taper process on
1522 the dump server may reasonably consume.
1528 <para>The following <emphasis remap='B'>dumptype</emphasis> entries are predefined by &A;:</para>
1530 <programlisting remap='.nf'>
1531 define dumptype no-compress {
1534 define dumptype compress-fast {
1535 compress client fast
1537 define dumptype compress-best {
1538 compress client best
1540 define dumptype srvcompress {
1541 compress server fast
1543 define dumptype bsd-auth {
1546 define dumptype krb4-auth {
1549 define dumptype no-record {
1552 define dumptype no-hold {
1555 define dumptype no-full {
1560 <para>In addition to options in a
1561 <emphasis remap='B'>dumptype</emphasis>
1562 section, one or more other
1563 <emphasis remap='B'>dumptype</emphasis>
1564 names may be entered, which make this
1565 <emphasis remap='B'>dumptype</emphasis>
1566 inherit options from other previously defined
1567 <emphasis remap='B'>dumptype</emphasis>s.
1568 For instance, two sections might be the same except for the
1569 <emphasis remap='B'>record</emphasis> option:</para>
1571 <programlisting remap='.nf'>
1572 define dumptype normal {
1573 comment "Normal backup, no compression, do indexing"
1578 define dumptype testing {
1579 comment "Test backup, no compression, do indexing, no recording"
1585 <para>&A; provides a
1586 <emphasis remap='B'>dumptype</emphasis>
1588 <emphasis remap='I'>global</emphasis>
1590 <emphasis remap='B'>amanda.conf</emphasis>
1592 <emphasis remap='B'>dumptype</emphasis>s
1594 This provides an easy place to make changes that will affect every
1595 <emphasis remap='B'>dumptype</emphasis>.</para>
1598 <refsect1><title>TAPETYPE SECTION</title>
1599 <para>The <emphasis remap='B'>amanda.conf</emphasis>
1600 file may define multiple types of tape media and devices.
1601 The information is entered in a
1602 <emphasis remap='B'>tapetype</emphasis>
1603 section, which looks like this in the config file:</para>
1606 define tapetype <emphasis remap='I'>name</emphasis> {
1607 <emphasis remap='I'>tapetype-option</emphasis> <emphasis remap='I'>tapetype-value</emphasis>
1608 <literal>...</literal>
1612 <para><emphasis remap='I'>Name</emphasis>
1613 is the name of this type of tape medium/device.
1614 It is referenced from the
1615 <emphasis remap='B'>tapetype</emphasis>
1616 option in the main part of the config file.</para>
1618 <para>The tapetype options and values are:</para>
1619 <variablelist remap='TP'>
1621 <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
1624 <emphasis remap='I'>none</emphasis>.
1625 A comment string describing this set of tape information.</para>
1629 <term><emphasis remap='B'>filemark</emphasis> <emphasis remap='I'> int</emphasis></term>
1632 <emphasis remap='I'>1000 bytes</emphasis>.
1633 How large a file mark (tape mark) is, measured in bytes.
1634 If the size is only known in some linear measurement (e.g. inches),
1635 convert it to bytes using the device density.</para>
1639 <term><emphasis remap='B'>length</emphasis> <emphasis remap='I'> int</emphasis></term>
1642 <emphasis remap='I'>2000 kbytes</emphasis>. How much data will fit on a tape.</para>
1644 <para>Note that this value is only used by &A; to schedule which backups will be run.
1645 Once the backups start, &A; will continue to write to a tape until it gets an error,
1646 regardless of what value is entered for <emphasis remap='B'>length</emphasis>
1647 (but see the section OUTPUT DRIVERS in the
1648 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1649 manpage for exceptions).
1654 <term><emphasis remap='B'>blocksize</emphasis> <emphasis remap='I'> int</emphasis></term>
1657 <emphasis remap='I'>32</emphasis>.
1658 How much data will be written in each tape record expressed in KiloBytes.
1659 The tape record size (= blocksize) can not be reduced below the default 32 KBytes.
1660 The parameter blocksize can only be raised if &A; was compiled with the configure option
1661 --with-maxtapeblocksize=N set with "N" greater than 32 during
1667 <term><emphasis remap='B'>file-pad</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1670 <emphasis remap='I'>true</emphasis>.
1671 If true, every record, including the last one in the file, will have the same length.
1672 This matches the way &A; wrote tapes prior to the availability of this parameter.
1673 It may also be useful on devices that only support a fixed blocksize.</para>
1675 <para>Note that the last record on the tape probably includes trailing
1676 null byte padding, which will be passed back to
1677 <emphasis remap='B'>gzip</emphasis>,
1678 <emphasis remap='B'>compress</emphasis>
1679 or the restore program. Most programs just ignore this (although possibly with a warning).</para>
1681 <para>If this parameter is false, the last record in a file may be shorter
1682 than the block size. The file will contain the same amount of data the dump program generated,
1683 without trailing null byte padding. When read, the same amount of data that was written
1684 will be returned.</para>
1689 <term><emphasis remap='B'>speed</emphasis> <emphasis remap='I'> int</emphasis></term>
1692 <emphasis remap='I'>200 bps</emphasis>.
1693 How fast the drive will accept data, in bytes per second.
1694 This parameter is NOT currently used by &A;.</para>
1698 <term><emphasis remap='B'>lbl-templ</emphasis> <emphasis remap='I'> string</emphasis></term>
1700 <para>A PostScript template file used by
1701 <emphasis remap='B'>amreport</emphasis>
1702 to generate labels. Several sample files are provided with the &A; sources in the
1703 <emphasis remap='I'>example</emphasis> directory.
1705 <citerefentry><refentrytitle>amreport</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1706 man page for more information.</para>
1711 <para>In addition to options, another
1712 <emphasis remap='B'>tapetype</emphasis>
1713 name may be entered, which makes this
1714 <emphasis remap='B'>tapetype</emphasis>
1715 inherit options from another
1716 <emphasis remap='B'>tapetype</emphasis>.
1717 For instance, the only difference between a DLT4000 tape drive using
1718 Compact-III tapes and one using Compact-IV tapes is the length of the tape.
1719 So they could be entered as:</para>
1721 <programlisting remap='.nf'>
1722 define tapetype DLT4000-III {
1723 comment "DLT4000 tape drives with Compact-III tapes"
1724 length 12500 mbytes # 10 Gig tapes with some compression
1725 filemark 2000 kbytes
1728 define tapetype DLT4000-IV {
1730 comment "DLT4000 tape drives with Compact-IV tapes"
1731 length 25000 mbytes # 20 Gig tapes with some compression
1735 <!-- If anybody has read this, where do all those stupid
1736 pseudo-duplicate FOM-tapetype-entries come from??
1742 <refsect1><title>INTERFACE SECTION</title>
1744 <emphasis remap='B'>amanda.conf</emphasis>
1745 file may define multiple types of network interfaces.
1746 The information is entered in an <emphasis remap='B'>interface</emphasis>
1747 section, which looks like this:</para>
1750 define interface <emphasis remap='I'>name</emphasis> {
1751 <emphasis remap='I'>interface-option</emphasis> <emphasis remap='I'>interface-value</emphasis>
1752 <literal>...</literal>
1756 <para><emphasis remap='I'>name</emphasis>
1757 is the name of this type of network interface. It is referenced from the
1758 <emphasis remap='I'>disklist</emphasis> file.</para>
1760 <para>Note that these sections define network interface characteristics,
1761 not the actual interface that will be used. Nor do they impose limits on the bandwidth that will
1762 actually be taken up by &A;.
1763 &A; computes the estimated bandwidth each file system backup will take
1764 based on the estimated size and time, then compares that plus any other running
1765 backups with the limit as another of the criteria when deciding whether
1766 to start the backup. Once a backup starts, &A; will use as much of the network as it can
1767 leaving throttling up to the operating system and network hardware.</para>
1769 <para>The interface options and values are:</para>
1770 <variablelist remap='TP'>
1772 <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
1775 <emphasis remap='I'>none</emphasis>.
1776 A comment string describing this set of network information.</para>
1780 <term><emphasis remap='B'>use</emphasis> <emphasis remap='I'> int</emphasis></term>
1783 <emphasis remap='I'>300 Kbps</emphasis>.
1784 The speed of the interface in Kbytes per second.</para>
1789 <para>In addition to options, another
1790 <emphasis remap='B'>interface</emphasis>
1791 name may be entered, which makes this
1792 <emphasis remap='B'>interface</emphasis>
1793 inherit options from another
1794 <emphasis remap='B'>interface</emphasis>.
1795 At the moment, this is of little use.</para>
1798 <refsect1><title>AUTHOR</title>
1799 <para>James da Silva, &email.jds;: Original text</para>
1800 <para>&maintainer.sgw;: XML-conversion, major update, splitting</para>
1803 <refsect1><title>SEE ALSO</title>
1805 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1806 <citerefentry><refentrytitle>amcrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1807 <citerefentry><refentrytitle>aespipe</refentrytitle><manvolnum>1</manvolnum></citerefentry>,