git.gag.com Git - debian/amanda/blob - man/xml-source/amanda.conf.5.xml

   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"
   4 [
   5   <!-- entities files to use -->
   6   <!ENTITY % global_entities SYSTEM 'global.entities'>
   7   %global_entities;
   8 ]>
   9
  10 <refentry id='amanda.conf.5'>
  11
  12 <refmeta>
  13 <refentrytitle>amanda.conf</refentrytitle>
  14 <manvolnum>5</manvolnum>
  15 &rmi.source;
  16 &rmi.version;
  17 &rmi.manual.5;
  18 </refmeta>
  19 <refnamediv>
  20 <refname>amanda.conf</refname>
  21 <refpurpose>Main configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver</refpurpose>
  22 </refnamediv>
  23 <refentryinfo>
  24 &author.jds;
  25 &author.sgw.xml;
  26 </refentryinfo>
  27 <!-- body begins here -->
  28
  29 <refsect1><title>DESCRIPTION</title>
  30 <para>&amconf; is the main configuration file for Amanda. This manpage lists the
  31 relevant sections and parameters of this file for quick reference.</para>
  32 <para> The file <emphasis remap='B'>&lt;CONFIG_DIR&gt;/&lt;config&gt;/amanda.conf</emphasis> is loaded.</para>
  33 </refsect1>
  34
  35 <refsect1><title>SYNTAX</title>
  36
  37 <para>There are a number of configuration parameters that control the
  38 behavior of the Amanda programs.
  39 All have default values,
  40 so you need not specify the parameter in
  41 <emphasis remap='B'>amanda.conf</emphasis>
  42 if the default is suitable.</para>
  43
  44 <refsect2><title>COMMENTS</title>
  45
  46 <para>Lines starting with # are ignored, as are blank lines.
  47 Comments may be placed on a line with a directive by starting
  48 the comment with a #.
  49 The remainder of the line is ignored.</para>
  50 </refsect2>
  51
  52 <refsect2><title>KEYWORDS AND IDENTIFIERS</title>
  53
  54 <para>Keywords are case insensitive, i.e.
  55 <amkeyword>mailto</amkeyword>
  56 and
  57 <amkeyword>MailTo</amkeyword>
  58 are treated the same.  Also, the characters
  59 '<amkeyword>-</amkeyword>' and '<amkeyword>_</amkeyword>'
  60 are interchangeable in all predefined Amanda keywords:
  61 <amkeyword>device_property</amkeyword>
  62 and
  63 <amkeyword>device-property</amkeyword>
  64 have the same meaning.  This manpage uses the dashed versions, but the
  65 underscored versions will be accepted for backward compatibility</para>
  66
  67 <para>Identifiers are names which are defined in the configuration itself, such
  68 as dumptypes or interfaces.  Identifiers are are case-insensitive, but
  69 sensitive to
  70 '<amkeyword>-</amkeyword>' vs.  '<amkeyword>_</amkeyword>'.
  71 Identifiers should be quoted in the configuration file, although For historical
  72 reasons, the quotes are optional.</para>
  73
  74 <para>Strings are always quoted with double quotes ("), and any double quotes
  75 or backslashes within the string are escaped with a backslash:
  76 <programlisting>
  77 tapelist "/path/to/tapelist"
  78 property "escaped-string" "escaping: \\ (backslash) and \" (double-quote)"
  79 </programlisting>
  80 </para>
  81
  82 <para>To summarize, then:
  83 <programlisting>
  84                           # QUOTES        CASE            -/_
  85 logdir "logs"             # required      sensitive       sensitive
  86 send-amreport-on strange  # prohibited    insensitive     insensitive
  87 tapetype "EXABYTE"        # optional      insensitive     sensitive
  88
  89 define dumptype "dt" {    # optional      insensitive     sensitive
  90   "dumptype-common"       # optional      insensitive     sensitive
  91   strategy noinc          # prohibited    insensitive     insensitive
  92 }
  93 </programlisting>
  94 </para>
  95
  96 </refsect2>
  97
  98 <refsect2><title>VALUE SUFFIXES</title>
  99
 100 <para>Integer arguments may have one of the following (case insensitive) suffixes,
 101 some of which have a multiplier effect:</para>
 102
 103 <variablelist remap='TP'>
 104   <varlistentry>
 105   <term><amkeyword>b byte bytes</amkeyword></term>
 106   <listitem>
 107 <para>Some number of bytes.</para>
 108   </listitem>
 109   </varlistentry>
 110   <varlistentry>
 111   <term><amkeyword>bps</amkeyword></term>
 112   <listitem>
 113 <para>Some number of bytes per second.</para>
 114   </listitem>
 115   </varlistentry>
 116   <varlistentry>
 117   <term><amkeyword>k kb kbyte kbytes kilobyte kilobytes</amkeyword></term>
 118   <listitem>
 119 <para>Some number of kilobytes (bytes*1024).</para>
 120   </listitem>
 121   </varlistentry>
 122   <varlistentry>
 123   <term><amkeyword>kps kbps</amkeyword></term>
 124   <listitem>
 125 <para>Some number of kilobytes per second (bytes*1024).</para>
 126 <para>It is the default multiplier for all size options.</para>
 127   </listitem>
 128   </varlistentry>
 129   <varlistentry>
 130   <term><amkeyword>m mb meg mbyte mbytes megabyte megabytes</amkeyword></term>
 131   <listitem>
 132 <para>Some number of megabytes (bytes*1024*1024).</para>
 133   </listitem>
 134   </varlistentry>
 135   <varlistentry>
 136   <term><amkeyword>mps mbps</amkeyword></term>
 137   <listitem>
 138 <para>Some number of megabytes per second (bytes*1024*1024).</para>
 139   </listitem>
 140   </varlistentry>
 141   <varlistentry>
 142   <term><amkeyword>g gb gbyte gbytes gigabyte gigabytes</amkeyword></term>
 143   <listitem>
 144 <para>Some number of gigabytes (bytes*1024*1024*1024).</para>
 145   </listitem>
 146   </varlistentry>
 147   <varlistentry>
 148   <term><amkeyword>t tb tbyte tbytes terabyte terabytes</amkeyword></term>
 149   <listitem>
 150 <para>Some number of terabytes (bytes*1024*1024*1024*1024).</para>
 151   </listitem>
 152   </varlistentry>
 153   <varlistentry>
 154   <term><amkeyword>tape tapes</amkeyword></term>
 155   <listitem>
 156 <para>Some number of tapes.</para>
 157   </listitem>
 158   </varlistentry>
 159   <varlistentry>
 160   <term><amkeyword>day days</amkeyword></term>
 161   <listitem>
 162 <para>Some number of days.</para>
 163   </listitem>
 164   </varlistentry>
 165   <varlistentry>
 166   <term><amkeyword>week weeks</amkeyword></term>
 167   <listitem>
 168 <para>Some number of weeks (days*7).</para>
 169
 170 <note><para>The value
 171 <amkeyword>inf</amkeyword>
 172 may be used in most places where an integer is expected
 173 to mean an infinite amount.</para>
 174
 175 <para>Boolean arguments may have any of the values
 176 <amkeyword>1</amkeyword>,
 177 <amkeyword>y</amkeyword>,
 178 <amkeyword>yes</amkeyword>,
 179 <amkeyword>t</amkeyword>,
 180 <amkeyword>true</amkeyword>
 181 or
 182 <amkeyword>on</amkeyword>
 183 to indicate a true state, or
 184 <amkeyword>0</amkeyword>,
 185 <amkeyword>n</amkeyword>,
 186 <amkeyword>no</amkeyword>,
 187 <amkeyword>f</amkeyword>,
 188 <amkeyword>false</amkeyword>
 189 or
 190 <amkeyword>off</amkeyword>
 191 to indicate a false state.
 192 If no argument is given,
 193 <amkeyword>true</amkeyword>
 194 is assumed.
 195 </para>
 196 </note>
 197   </listitem>
 198   </varlistentry>
 199 </variablelist>
 200 </refsect2>
 201
 202 <refsect2><title>PARAMETER ORDER</title>
 203
 204 <para>In general, the order in which parameters occur in the configuration file
 205 does not matter, with the exception of subsection inheritance.  For example, if
 206 dumptype "normal-encrypt" which inherits from dumptype "normal", then "normal"
 207 must appear first in the configuration file.</para>
 208
 209 </refsect2>
 210
 211 <refsect2><title>STRINGS</title>
 212 <para>Quoted strings in Amanda follow a common, C-like syntax.  Printable
 213 characters and whitespace are kept as-is, except that the backslash character
 214 (\) is used as an escape character, and a double-quote ends the string.  The allowed
 215 escape sequences are
 216 <programlisting>
 217     ESCAPE SEQUENCE     BECOMES
 218     \\                  \
 219     \"                  "
 220     \n                  (newline)
 221     \t                  (tab)
 222     \r                  (carriage return)
 223     \f                  (form-feed)
 224     \1 - \7
 225     \01 - \77
 226     \001 - \377         (character specified in octal)
 227 </programlisting>
 228 Illegally quoted strings are handled on a "best-effort" basis, which may lead to
 229 unexpected results.
 230 </para>
 231 <para>Examples:
 232 <programlisting>
 233 finserver "/data/finance/XYZ Corp's \"real\" finances" finance-high eth0 -1
 234 property "syspath" "C:\\WINDOWS\\SYSTEM"
 235 </programlisting>
 236 </para>
 237 </refsect2>
 238
 239 <refsect2><title>SUBSECTIONS AND INHERITANCE</title>
 240
 241 <para>Amanda configuration files may include various
 242 <emphasis>subsections</emphasis>, each defining a set of configuration
 243 directives.  Each type of subsection is described below.  Note that all types
 244 of subsections can <emphasis>inherit</emphasis> from other subsections of the
 245 same type by naming the "parent" section in the "child" subsection.  For
 246 example:
 247
 248 <programlisting>
 249 define dumptype global {
 250     record yes
 251     index yes
 252 }
 253
 254 define dumptype nocomp {
 255     global      # inherit the parameters in dumptype 'global'
 256     compress none
 257 }
 258 </programlisting></para>
 259
 260 <para>Note that multiple inheritance is also supported by simply naming
 261 multiple parent sections in a child.  Parents are implicitly expanded in place
 262 in a child, and the last occurrence of each parameter takes precedence.  For
 263 example,
 264 <programlisting>
 265 define tapetype par1 {
 266     comment "Parent 1"
 267     filemark 8k
 268     speed 300bps
 269     length 200M
 270 }
 271 define tapetype par2 {
 272     comment "Parent 2"
 273     filemark 16k
 274     speed 400bps
 275 }
 276 define tapetype child {
 277     par1
 278     par2
 279     filemark 32k
 280 }
 281 </programlisting>
 282 In this example, 'child' will have a filemark of 32k, a speed of 400bps, and a
 283 length of 200M.</para>
 284 </refsect2>
 285
 286 </refsect1>
 287
 288 <refsect1>
 289 <title>GLOBAL PARAMETERS</title>
 290
 291 <variablelist remap='TP'>
 292   <varlistentry>
 293   <term><amkeyword>org</amkeyword> <amtype>string</amtype></term>
 294   <listitem>
 295 <para>Default:
 296 <amdefault>"daily"</amdefault>.
 297 A descriptive name for the configuration.
 298 This string appears in the Subject line of mail reports.
 299 Each Amanda configuration should have a different string to keep
 300 mail reports distinct.</para>
 301   </listitem>
 302   </varlistentry>
 303   <varlistentry>
 304   <term><amkeyword>mailer</amkeyword> <amtype>string</amtype></term>
 305   <listitem>
 306 <para>Default found by configure. A mail program that can send mail with '<emphasis remap='I'>MAILER -s "subject" user &lt; message_file</emphasis>'.</para>
 307   </listitem>
 308   </varlistentry>
 309   <varlistentry>
 310   <term><amkeyword>mailto</amkeyword> <amtype>string</amtype></term>
 311   <listitem>
 312 <para>Default: none.
 313 A space separated list of recipients for mail reports.  If not specified, amdump will not send any mail.</para>
 314   </listitem>
 315   </varlistentry>
 316   <varlistentry>
 317   <term><amkeyword>send-amreport-on</amkeyword> [ <amkeyword>all</amkeyword> | <amkeyword>strange</amkeyword> | <amkeyword>error</amkeyword> | <amkeyword>never</amkeyword> ]</term>
 318   <listitem>
 319 <para>Default:
 320 <amkeyword>all</amkeyword>.
 321 Specify which types of messages will trigger an email from amreport. amreport is used by amdump and amflush.</para>
 322   <!-- .RS -->
 323     <variablelist remap='TP'>
 324       <varlistentry>
 325       <term><amkeyword>all</amkeyword></term>
 326       <listitem>
 327 <para>Send an email on any message.</para>
 328       </listitem>
 329       </varlistentry>
 330       <varlistentry>
 331       <term><amkeyword>strange</amkeyword></term>
 332       <listitem>
 333 <para>Send an email on strange or error message. A strange message occurs when the dump succeeded, but returned one or more errors unknown to Amanda.</para>
 334       </listitem>
 335       </varlistentry>
 336       <varlistentry>
 337       <term><amkeyword>error</amkeyword></term>
 338       <listitem>
 339 <para>Send an email only on error messages.</para>
 340       </listitem>
 341       </varlistentry>
 342       <varlistentry>
 343       <term><amkeyword>never</amkeyword></term>
 344       <listitem>
 345 <para>Never send an email.</para>
 346       </listitem>
 347       </varlistentry>
 348     </variablelist>
 349   </listitem>
 350   </varlistentry>
 351   <varlistentry>
 352   <term><amkeyword>dumpcycle</amkeyword> <amtype>int</amtype></term>
 353   <listitem>
 354 <para>Default:
 355 <amdefault>10 days</amdefault>.
 356 The number of days in the backup cycle.
 357 Each disk will get a full backup at least this often.
 358 Setting this to zero tries to do a full backup each run.</para>
 359 <note><para>This parameter may also be set in a specific
 360 <amkeyword>dumptype</amkeyword>
 361 (see below).
 362 This value sets the default for all
 363 <amkeyword>dumptype</amkeyword>s
 364 so must appear in
 365 <emphasis remap='B'>amanda.conf</emphasis>
 366 before any
 367 <amkeyword>dumptype</amkeyword>s
 368 are defined.</para>
 369 </note>
 370   </listitem>
 371   </varlistentry>
 372
 373   <varlistentry>
 374   <term><amkeyword>runspercycle</amkeyword> <amtype>int</amtype></term>
 375   <listitem>
 376 <para>Default:
 377 <amdefault>same as dumpcycle</amdefault>.
 378 The number of amdump runs in
 379 <amkeyword>dumpcycle</amkeyword>
 380 days.
 381 A value of 0 means the same value as
 382 <amkeyword>dumpcycle</amkeyword>.
 383 A value of -1 means guess the number of runs from the &tapelist; file,
 384 which is the number of tapes used in the last
 385 <amkeyword>dumpcycle</amkeyword>
 386 days /
 387 <amkeyword>runtapes</amkeyword>.</para>
 388   </listitem>
 389   </varlistentry>
 390   <varlistentry>
 391   <term><amkeyword>tapecycle</amkeyword> <amtype>int</amtype></term>
 392   <listitem>
 393 <para>Default:
 394 <amdefault>15 tapes</amdefault>.
 395
 396 Specifies the number of "active" volumes - volumes that Amanda will not
 397 overwrite.  While Amanda is always willing to write to a new volume, it refuses
 398 to overwrite a volume unless at least '<amkeyword>tapecycle</amkeyword> -1'
 399 volumes have been written since.</para>
 400
 401 <para> It is considered good administrative practice to set the
 402 <amkeyword>tapecycle</amkeyword> parameter slightly lower than the actual
 403 number of tapes in use. This allows the administrator to more easily cope
 404 with damaged or misplaced tapes or schedule adjustments that call for
 405 slight adjustments in the rotation order.</para>
 406
 407 <para>Note: Amanda is commonly misconfigured with <amkeyword>tapecycle</amkeyword>
 408 equal to the number of tapes per <amkeyword>dumpcycle</amkeyword>.  In this
 409 misconfiguration, amanda may erase a full dump before a new one is
 410 completed.  Recovery is then impossible. The
 411 <amkeyword>tapecycle</amkeyword> must be at least one tape larger than the
 412 number of tapes per dumpcycle.</para>
 413
 414 <para>
 415 The number of tapes per dumpcycle is calculated by multiplying the number of
 416 &amdump; runs per dump cycle <amkeyword>runspercycle</amkeyword> (the
 417 number of &amdump; runs per dump cycle) and <emphasis
 418 remap='B'>runtapes</emphasis> (the number of tapes used per run). Typically
 419 <amkeyword>tapecycle</amkeyword> is set to two or four times the tapes
 420 per dumpcycle.</para>
 421
 422   </listitem>
 423   </varlistentry>
 424
 425   <varlistentry>
 426   <term><amkeyword>usetimestamps</amkeyword>
 427         <amtype>bool</amtype></term>
 428     <listitem>
 429       <para>Default: <amkeyword>Yes</amkeyword>.
 430 This option allows Amanda to track multiple runs per calendar
 431 day. The only reason one might disable it is that Amanda versions before 2.5.1
 432 can't read logfiles written when this option was enabled.
 433       </para>
 434     </listitem>
 435   </varlistentry>
 436
 437   <varlistentry>
 438   <term><amkeyword>label-new-tapes</amkeyword>
 439         <amtype>string</amtype></term>
 440 <listitem>
 441     <para>Deprecated, use <amkeyword>autolabel</amkeyword> option with options <amkeyword>volume-error empty</amkeyword> to get equivalent behavior.</para>
 442     <para>Default: not set.
 443 When set, this directive will cause Amanda to automatically write an Amanda
 444 tape label to any blank tape she encounters.</para>
 445 </listitem>
 446 </varlistentry>
 447
 448   <varlistentry>
 449   <term><amkeyword>autolabel</amkeyword>
 450         <amtype>string</amtype>
 451         [<amkeyword>any</amkeyword>]
 452         [<amkeyword>other-config</amkeyword>]
 453         [<amkeyword>non-amanda</amkeyword>]
 454         [<amkeyword>volume-error</amkeyword>]
 455         [<amkeyword>empty</amkeyword>]</term>
 456 <listitem>
 457     <para>Default: not set.
 458 When set, this directive will cause Amanda to automatically write an Amanda
 459 tape label to most volume she encounters. This option is DANGEROUS
 460 because when set, Amanda may erase near-failing tapes or tapes accidentally
 461 loaded in the wrong slot.</para>
 462 <para>When using this directive, specify the template for new tape
 463 labels. The template should contain some number of contiguous '%'
 464 characters, which will be replaced with a generated number. Be sure to
 465 specify enough '%' characters that you do not run out of tape labels.
 466 Example:
 467 <markup>autolabel &quot;DailySet1-%%%&quot; empty</markup>
 468 </para>
 469 <para>Note that many devices cannot distinguish an empty tape from an error
 470 condition, so it may is often necessary to include
 471 <amkeyword>volume-error</amkeyword> as an autolabel condition.</para>
 472 <variablelist remap='TP'>
 473 <varlistentry>
 474 <term><amkeyword>any</amkeyword></term>
 475 <listitem>equivalent to '<amkeyword>other-config non-amanda volume-error empty</amkeyword>'
 476 </listitem>
 477 </varlistentry>
 478 <varlistentry>
 479 <term><amkeyword>other-config</amkeyword></term>
 480 <listitem>Label volumes with a valid Amanda label that do not match our
 481 <amkeyword>labelstr</amkeyword>. Danger: this may erase volumes
 482 from other Amanda configurations without warning!
 483 </listitem>
 484 </varlistentry>
 485 <varlistentry>
 486 <term><amkeyword>non-amanda</amkeyword></term>
 487 <listitem>Label volumes which do not start with data that resembles an
 488 Amanda header. Danger: this may erase volumes from other backup applications
 489 without warning!
 490 </listitem>
 491 </varlistentry>
 492 <varlistentry>
 493 <term><amkeyword>volume-error</amkeyword></term>
 494 <listitem>Label volumes where an error occurs while trying to read the label.
 495 Danger: this may erase arbitrary volumes due to transient errors.
 496 </listitem>
 497 </varlistentry>
 498 <varlistentry>
 499 <term><amkeyword>empty</amkeyword></term>
 500 <listitem>Label volumes where a read returns 0 bytes.
 501 </listitem>
 502 </varlistentry>
 503 </variablelist>
 504 </listitem>
 505 </varlistentry>
 506
 507   <varlistentry>
 508   <term><amkeyword>dumpuser</amkeyword> <amtype>string</amtype></term>
 509   <listitem>
 510 <para>Default:
 511 <amdefault>&quot;amanda&quot;</amdefault>.
 512 The login name Amanda uses to run the backups.
 513 The backup client hosts must allow access
 514 from the tape server host as this user via
 515 <markup>.rhosts</markup>
 516 or
 517 <markup>.amandahosts</markup>,
 518 depending on how the Amanda software was built.</para>
 519   </listitem>
 520   </varlistentry>
 521   <varlistentry>
 522   <term><amkeyword>printer</amkeyword> <amtype>string</amtype></term>
 523   <listitem>
 524 <para>Printer to use when doing tape labels.
 525 See the
 526 <amkeyword>lbl-templ</amkeyword>
 527 <amkeyword>tapetype</amkeyword>
 528 option.</para>
 529   </listitem>
 530   </varlistentry>
 531
 532   <varlistentry>
 533   <term><amkeyword>tapedev</amkeyword> <amtype>string</amtype></term>
 534   <listitem>
 535 <para>Default:
 536 <amdefault>&quot;null:&quot;</amdefault>.
 537 This parameter can either specify a device (explicitly or by referencing a device definition - see <manref name="amanda-devices" vol="7" />)
 538 or a tape changer (explicitly or by referencing a device definition - see <manref name="amanda-changers" vol="7" />).</para>
 539
 540   </listitem>
 541   </varlistentry>
 542
 543   <varlistentry>
 544   <term><amkeyword>device-property</amkeyword> <amtype>string</amtype> <amtype>string</amtype></term>
 545   <listitem>
 546 <para>These options can set various device properties.  See
 547 <manref name="amanda-devices" vol="7"/>
 548 for more information on device properties and their syntax.
 549 Both strings are always quoted; the first string contains the name of
 550 the property to set, and the second contains its value. For example, to set
 551 a fixed block size of 128k, write:</para>
 552 <programlisting>
 553 device-property "BLOCK_SIZE" "128k"
 554 </programlisting>
 555
 556   </listitem>
 557   </varlistentry>
 558
 559   <varlistentry>
 560   <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
 561   <listitem>
 562 <para>These options can set various properties, they can be used by third
 563  party software to store information in the configuration file.
 564 Both strings are quoted; the first string contains the name of
 565 the property to set, and the others contains its values.
 566 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
 567 </para>
 568   </listitem>
 569   </varlistentry>
 570
 571   <varlistentry>
 572   <term><amkeyword>tpchanger</amkeyword> <amtype>string</amtype></term>
 573   <listitem>
 574 <para>Default: not set.  The tape changer to use.  In most cases, only one of
 575 <amkeyword>tpchanger</amkeyword> or <amkeyword>tapedev</amkeyword> is
 576 specified, although for backward compatibility both may be specified if
 577 <amkeyword>tpchanger</amkeyword> gives the name of an old changer script.
 578 See <manref name="amanda-changers" vol="7" /> for more information on
 579 configuring changers.</para>
 580   </listitem>
 581   </varlistentry>
 582
 583   <varlistentry>
 584   <term><amkeyword>changerdev</amkeyword> <amtype>string</amtype></term>
 585   <listitem>
 586 <para>Default:
 587 <amdefault>&quot;dev/null&quot;</amdefault>.
 588 A tape changer configuration parameter.
 589 Usage depends on the particular changer defined with the
 590 <amkeyword>tpchanger</amkeyword>
 591 option.</para>
 592   </listitem>
 593   </varlistentry>
 594   <varlistentry>
 595   <term><amkeyword>changerfile</amkeyword> <amtype>string</amtype></term>
 596   <listitem>
 597 <para>Default:
 598 <amdefault>&quot;/usr/adm/amanda/log/changer-status&quot;</amdefault>.
 599 A tape changer configuration parameter.
 600 Usage depends on the particular changer defined with the
 601 <amkeyword>tpchanger</amkeyword>
 602 option.</para>
 603   </listitem>
 604   </varlistentry>
 605   <varlistentry>
 606   <term><amkeyword>runtapes</amkeyword> <amtype>int</amtype></term>
 607   <listitem>
 608 <para>Default:
 609 <amdefault>1</amdefault>.
 610 The maximum number of tapes used in a single run.
 611 If a tape changer is not configured, this option is not used
 612 and should be commented out of the configuration file.</para>
 613 <para>If a tape changer is configured, this may be set larger than one to
 614 let Amanda write to more than one tape.</para>
 615 <para>Note that this is an upper bound on the number of tapes,
 616 and Amanda may use less.</para>
 617   </listitem>
 618   </varlistentry>
 619
 620   <varlistentry>
 621   <term><amkeyword>maxdumpsize</amkeyword> <amtype>int</amtype></term>
 622   <listitem>
 623 <para>Default:
 624 <amdefault><amkeyword>runtapes</amkeyword>*<amkeyword>tape-length</amkeyword></amdefault>.
 625 Maximum number of bytes the planner will schedule for a run.</para>
 626 <para>The default unit is Kbytes if it is not specified.</para>
 627   </listitem>
 628   </varlistentry>
 629   <varlistentry>
 630   <term><amkeyword>taperalgo</amkeyword> [ <amkeyword>first</amkeyword> | <amkeyword>firstfit</amkeyword> | <amkeyword>largest</amkeyword> | <amkeyword>largestfit</amkeyword> | <amkeyword>smallest</amkeyword> | <amkeyword>last</amkeyword> ]</term>
 631   <listitem>
 632 <para>Default:
 633 <amkeyword>first</amkeyword>.
 634 The algorithm used to choose which dump image to send to the taper.</para>
 635   <!-- .RS -->
 636     <variablelist remap='TP'>
 637       <varlistentry>
 638       <term><amkeyword>first</amkeyword></term>
 639       <listitem>
 640 <para>First in, first out.</para>
 641       </listitem>
 642       </varlistentry>
 643       <varlistentry>
 644       <term><amkeyword>firstfit</amkeyword></term>
 645       <listitem>
 646 <para>The first dump image that will fit on the current tape.</para>
 647       </listitem>
 648       </varlistentry>
 649       <varlistentry>
 650       <term><amkeyword>largest</amkeyword></term>
 651       <listitem>
 652 <para>The largest dump image.</para>
 653       </listitem>
 654       </varlistentry>
 655       <varlistentry>
 656       <term><amkeyword>largestfit</amkeyword></term>
 657       <listitem>
 658 <para>The largest dump image that will fit on the current tape.</para>
 659       </listitem>
 660       </varlistentry>
 661       <varlistentry>
 662       <term><amkeyword>smallest</amkeyword></term>
 663       <listitem>
 664 <para>The smallest dump image.</para>
 665       </listitem>
 666       </varlistentry>
 667       <varlistentry>
 668       <term><amkeyword>last</amkeyword></term>
 669       <listitem>
 670 <para>Last in, first out.</para>
 671       </listitem>
 672       </varlistentry>
 673     </variablelist>
 674
 675   </listitem>
 676   </varlistentry>
 677 <varlistentry>
 678 <term><amkeyword>taper-parallel-write</amkeyword> <amtype>int</amtype></term>
 679 <listitem>
 680   </listitem>
 681 <para>Default: <amdefault>1</amdefault>.
 682 Amanda can write simultaneously up to that number of volume at any given
 683 time. The changer must have as many drives.</para>
 684   </varlistentry>
 685 <varlistentry>
 686 <term><amkeyword>labelstr</amkeyword> <amtype>string</amtype></term>
 687 <listitem>
 688 <para>Default:
 689 <amdefault>&quot;.*&quot;</amdefault>.
 690 The tape label constraint regular expression.
 691 All tape labels generated (see
 692 <manref name="amlabel" vol="8"/>)
 693 and used by this configuration must match the regular expression.
 694 If multiple configurations are run from the same tape server host,
 695 it is helpful to set their labels to different strings
 696 (for example, &quot;DAILY[0-9][0-9]*&quot; vs.
 697 &quot;ARCHIVE[0-9][0-9]*&quot;)
 698 to avoid overwriting each other's tapes.</para>
 699 </listitem>
 700 </varlistentry>
 701   <varlistentry>
 702   <term><amkeyword>tapetype</amkeyword> <amtype>string</amtype></term>
 703   <listitem>
 704 <para>Default:
 705 <amdefault>no default</amdefault>.
 706 The type of tape drive associated with
 707 <amkeyword>tapedev</amkeyword>
 708 or
 709 <amkeyword>tpchanger</amkeyword>.
 710 This refers to one of the defined <amkeyword>tapetype</amkeyword>s
 711 in the config file (see below), which specify various tape parameters,
 712 like the
 713 <amkeyword>length</amkeyword>,
 714 <amkeyword>filemark</amkeyword>
 715 size, and
 716 <amkeyword>speed</amkeyword>
 717 of the tape media and device.</para>
 718   </listitem>
 719   </varlistentry>
 720   <varlistentry>
 721   <term><amkeyword>ctimeout</amkeyword> <amtype>int</amtype></term>
 722   <listitem>
 723 <para>Default:
 724 <amdefault>30 seconds</amdefault>.
 725 Maximum amount of time that
 726 <emphasis remap='B'>amcheck</emphasis>
 727 will wait for each client host.</para>
 728   </listitem>
 729   </varlistentry>
 730   <varlistentry>
 731   <term><amkeyword>dtimeout</amkeyword> <amtype>int</amtype></term>
 732   <listitem>
 733 <para>Default:
 734 <amdefault>1800 seconds</amdefault>.
 735 Amount of idle time per disk on a given client that a
 736 <emphasis remap='B'>dumper</emphasis>
 737 running from within
 738 <command>amdump</command>
 739 will wait before it fails with a data timeout error.</para>
 740   </listitem>
 741   </varlistentry>
 742
 743   <varlistentry>
 744   <term><amkeyword>etimeout</amkeyword> <amtype>int</amtype></term>
 745   <listitem>
 746 <para>Default:
 747 <amdefault>300 seconds</amdefault>.
 748 Amount of time per estimate on a given client that the
 749 <emphasis remap='B'>planner</emphasis> step of
 750 <command>amdump</command> will wait to get the dump size estimates
 751 (note: Amanda runs up to 3 estimates for each DLE).  For instance,
 752 with the default of 300 seconds and four DLE's, each estimating level
 753 0 and level 1 on client A, <emphasis remap='B'>planner</emphasis>
 754 will wait up to 40 minutes for that machine.  A negative value will
 755 be interpreted as a total amount of time to wait
 756 per client instead of per disk.</para>
 757   </listitem>
 758   </varlistentry>
 759
 760   <varlistentry>
 761   <term><amkeyword>connect-tries</amkeyword> <amtype>int</amtype></term>
 762   <listitem>
 763 <para>Default:
 764 <amdefault>3</amdefault>.
 765 How many times the server will try a connection.</para>
 766   </listitem>
 767   </varlistentry>
 768
 769   <varlistentry>
 770   <term><amkeyword>req-tries</amkeyword> <amtype>int</amtype></term>
 771   <listitem>
 772 <para>Default:
 773 <amdefault>3</amdefault>.
 774 How many times the server will resend a REQ packet if it doesn't get the ACK packet.</para>
 775   </listitem>
 776   </varlistentry>
 777
 778   <varlistentry>
 779   <term><amkeyword>netusage</amkeyword> <amtype>int</amtype></term>
 780   <listitem>
 781 <para>Default:
 782 <amdefault>8000 Kbps</amdefault>.
 783 The maximum network bandwidth allocated to Amanda, in Kbytes per second.
 784 See also the
 785 <emphasis remap='B'>interface</emphasis>
 786 section.</para>
 787   </listitem>
 788   </varlistentry>
 789   <varlistentry>
 790   <term><amkeyword>inparallel</amkeyword> <amtype>int</amtype></term>
 791   <listitem>
 792 <para>Default:
 793 <amdefault>10</amdefault>.
 794 The maximum number of backups that Amanda will attempt to run in parallel.
 795 Amanda will stay within the constraints of network bandwidth and
 796 holding disk space available, so it doesn't hurt to set
 797 this number a bit high. Some contention can occur with larger numbers
 798 of backups, but this effect is relatively small on most systems.</para>
 799   </listitem>
 800   </varlistentry>
 801
 802   <varlistentry>
 803   <term><amkeyword>displayunit</amkeyword> &quot;k|m|g|t&quot;</term>
 804   <listitem>
 805 <para>Default:
 806 <amdefault>&quot;k&quot;</amdefault>.
 807 The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera.
 808 </para>
 809   </listitem>
 810   </varlistentry>
 811
 812   <varlistentry>
 813   <term><amkeyword>dumporder</amkeyword> <amtype>string</amtype></term>
 814   <listitem>
 815 <para>Default:
 816 <amdefault>&quot;tttTTTTTTT&quot;</amdefault>.
 817 The priority order of each dumper:
 818
 819 <programlisting>
 820 s: smallest size
 821 S: largest size
 822 t: smallest time
 823 T: largest time
 824 b: smallest bandwidth
 825 B: largest bandwidth
 826 </programlisting></para>
 827
 828   </listitem>
 829   </varlistentry>
 830
 831   <varlistentry>
 832   <term><amkeyword>maxdumps</amkeyword> <amtype>int</amtype></term>
 833   <listitem>
 834 <para>Default:
 835 <amdefault>1</amdefault>.
 836 The maximum number of backups from a single host that Amanda will
 837 attempt to run in parallel. See also the
 838 <emphasis remap='B'>inparallel</emphasis>
 839 option.</para>
 840
 841 <para>Note that this parameter may also be set in a specific
 842 <amkeyword>dumptype</amkeyword>
 843 (see below).
 844 This value sets the default for all
 845 <amkeyword>dumptype</amkeyword>s
 846 so must appear in
 847 <emphasis remap='B'>amanda.conf</emphasis>
 848 before any
 849 <amkeyword>dumptype</amkeyword>s
 850 are defined.</para>
 851   </listitem>
 852   </varlistentry>
 853
 854   <varlistentry>
 855   <term><amkeyword>bumpsize</amkeyword> <amtype>int</amtype></term>
 856   <listitem>
 857 <para>Default:
 858 <amdefault>10 Mbytes</amdefault>.
 859 The minimum savings required to trigger an automatic
 860 bump from one incremental level to the next, expressed as size.
 861 If Amanda determines that the next higher backup level
 862 will be this much smaller than the current level,
 863 it will do the next level.
 864 The value of this parameter is used only if the parameter
 865 <emphasis>bumppercent</emphasis> is set to 0.
 866 </para>
 867 <para>The default unit is Kbytes if it is not specified.</para>
 868 <para>
 869 The global setting of this parameter can be overwritten inside of a
 870 dumptype-definition.
 871 </para>
 872 <para>
 873 See also the options
 874 <amkeyword>bumppercent</amkeyword>,
 875 <amkeyword>bumpmult</amkeyword> and
 876 <amkeyword>bumpdays</amkeyword>.</para>
 877   </listitem>
 878   </varlistentry>
 879
 880   <varlistentry>
 881   <term><amkeyword>bumppercent</amkeyword> <amtype>int</amtype></term>
 882   <listitem>
 883 <para>Default:
 884 <amdefault>0</amdefault>.
 885 The minimum savings required to trigger an automatic
 886 bump from one incremental level to the next, expressed as percentage of the
 887 current size of the DLE (size of current level 0).
 888 If Amanda determines that the next higher backup level
 889 will be this much smaller than the current level,
 890 it will do the next level.
 891 </para>
 892 <para>
 893 If this parameter is set to 0, the value of the
 894 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
 895 </para>
 896 <para>
 897 The global setting of this parameter can be overwritten inside of a
 898 dumptype-definition.
 899 </para>
 900 <para>
 901 See also the options
 902 <amkeyword>bumpsize</amkeyword>,
 903 <amkeyword>bumpmult</amkeyword> and
 904 <amkeyword>bumpdays</amkeyword>.</para>
 905   </listitem>
 906   </varlistentry>
 907
 908   <varlistentry>
 909   <term><amkeyword>bumpmult</amkeyword> <amtype>float</amtype></term>
 910   <listitem>
 911 <para>Default:
 912 <amdefault>1.5</amdefault>.
 913 The bump size multiplier.
 914 Amanda multiplies
 915 <amkeyword>bumpsize</amkeyword>
 916 by this factor for each level.
 917 This prevents active filesystems from
 918 bumping too much by making it harder to bump to the next level.
 919 For example, with the default
 920 <amkeyword>bumpsize</amkeyword>
 921 and
 922 <amkeyword>bumpmult</amkeyword>
 923 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
 924 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
 925 <para>
 926 The global setting of this parameter can be overwritten inside of a
 927 dumptype-definition.
 928 </para>
 929   </listitem>
 930   </varlistentry>
 931   <varlistentry>
 932   <term><amkeyword>bumpdays</amkeyword> <amtype>int</amtype></term>
 933   <listitem>
 934 <para>Default:
 935 <amdefault>2 days</amdefault>.
 936 To insure redundancy in the dumps, Amanda keeps filesystems at the
 937 same incremental level for at least
 938 <amkeyword>bumpdays</amkeyword>
 939 days, even if the other bump threshold criteria are met.</para>
 940 <para>
 941 The global setting of this parameter can be overwritten inside of a
 942 dumptype-definition.
 943 </para>
 944   </listitem>
 945   </varlistentry>
 946
 947   <varlistentry>
 948   <term><amkeyword>diskfile</amkeyword> <amtype>string</amtype></term>
 949   <listitem>
 950 <para>Default:
 951 <amdefault>&quot;disklist&quot;</amdefault>.
 952 The file name for the
 953 <emphasis remap='I'>disklist</emphasis>
 954 file holding client hosts, disks and other client dumping information.</para>
 955   </listitem>
 956   </varlistentry>
 957   <varlistentry>
 958   <term><amkeyword>infofile</amkeyword> <amtype>string</amtype></term>
 959   <listitem>
 960 <para>Default:
 961 <amdefault>&quot;/usr/adm/amanda/curinfo&quot;</amdefault>.
 962 The file or directory name for the historical information database.
 963 If Amanda was configured to use DBM databases, this is the base file
 964 name for them.
 965 If it was configured to use text formated databases (the default),
 966 this is the base directory and within here will be a directory per
 967 client, then a directory per disk, then a text file of data.</para>
 968   </listitem>
 969   </varlistentry>
 970   <varlistentry>
 971   <term><amkeyword>logdir</amkeyword> <amtype>string</amtype></term>
 972   <listitem>
 973 <para>Default:
 974 <amdefault>&quot;/usr/adm/amanda&quot;</amdefault>.
 975 The directory for the
 976 <command>amdump</command>
 977 and
 978 <emphasis remap='B'>log</emphasis>
 979 files.</para>
 980   </listitem>
 981   </varlistentry>
 982   <varlistentry>
 983   <term><amkeyword>indexdir</amkeyword> <amtype>string</amtype></term>
 984   <listitem>
 985 <para>Default
 986 <amdefault>&quot;/usr/adm/amanda/index&quot;</amdefault>.
 987 The directory where index files (backup image catalogues) are stored.
 988 Index files are
 989 only generated for filesystems whose
 990 <amkeyword>dumptype</amkeyword>
 991 has the
 992 <amkeyword>index</amkeyword>
 993 option enabled.</para>
 994   </listitem>
 995   </varlistentry>
 996   <varlistentry>
 997   <term><amkeyword>tapelist</amkeyword> <amtype>string</amtype></term>
 998   <listitem>
 999 <para>Default:
1000 <amdefault>&quot;tapelist&quot;</amdefault>.
1001 The file name for the active &tapelist;.
1002 Amanda maintains this file with information about the active set of tapes.</para>
1003   </listitem>
1004   </varlistentry>
1005   <varlistentry>
1006   <term><amkeyword>device-output-buffer-size</amkeyword> <amtype>int</amtype></term>
1007   <listitem>
1008 <para>Default:
1009 <amdefault>1280k</amdefault>.
1010 Controls the amount of memory used by Amanda
1011 to hold data as it is read from the network or disk before it is written to
1012 the output device. Higher values may be
1013 useful on fast tape drives and optical media.</para>
1014 <para>The default unit is bytes if it is not specified.</para>
1015   </listitem>
1016   </varlistentry>
1017   <varlistentry>
1018   <term><amkeyword>tapebufs</amkeyword> <amtype>int</amtype></term>
1019   <listitem>
1020 <para>Default:
1021 <amdefault>20</amdefault>.
1022 This option is deprecated; use
1023 the <amkeyword>device-output-buffer-size</amkeyword> directive
1024 instead. <amkeyword>tapebufs</amkeyword> works the same way,
1025 but the number specified is multiplied by the device blocksize prior
1026 to use.</para>
1027   </listitem>
1028   </varlistentry>
1029   <varlistentry>
1030   <term><amkeyword>reserve</amkeyword> <amtype>int</amtype></term>
1031   <listitem>
1032 <para>Default:
1033 <amdefault>100</amdefault>.
1034 The part of holding-disk space that should be reserved for incremental
1035 backups if no tape is available, expressed as a percentage of the
1036 available holding-disk space (0-100).
1037 By default, when there is no tape to write to, degraded mode (incremental) backups
1038 will be performed to the holding disk. If full backups should also be allowed in this case,
1039 the amount of holding disk space reserved for incrementals should be lowered.</para>
1040   </listitem>
1041   </varlistentry>
1042   <varlistentry>
1043   <term><amkeyword>autoflush</amkeyword> <amtype>bool</amtype></term>
1044   <listitem>
1045 <para>Default:
1046 <amkeyword>off</amkeyword>.
1047 Whether an amdump run will flush the dumps from holding disk to tape.</para>
1048   </listitem>
1049   </varlistentry>
1050   <varlistentry>
1051   <term><amkeyword>amrecover-do-fsf</amkeyword> <amtype>bool</amtype></term>
1052   <listitem>
1053 <para>Deprecated; amrecover always uses fsf, and does not invoke amrestore.</para>
1054 <para>Default:
1055 <amkeyword>on</amkeyword>.
1056 Amrecover will call amrestore with the -f flag for faster positioning of the tape.</para>
1057   </listitem>
1058   </varlistentry>
1059   <varlistentry>
1060   <term><amkeyword>amrecover-check-label</amkeyword> <amtype>bool</amtype></term>
1061   <listitem>
1062 <para>Deprecated; amrecover always checks the label, and does not invoke amrestore.</para>
1063 <para>Default:
1064 <amkeyword>on</amkeyword>.
1065 Amrecover will call amrestore with the -l flag to check the label.</para>
1066   </listitem>
1067   </varlistentry>
1068   <varlistentry>
1069   <term><amkeyword>amrecover-changer</amkeyword> <amtype>string</amtype></term>
1070   <listitem>
1071 <para>Default: not set.
1072 Amrecover will use the changer if you use 'settape &lt;string&gt;' and that string
1073 is the same as the <amkeyword>amrecover-changer</amkeyword> setting.</para>
1074   </listitem>
1075   </varlistentry>
1076   <varlistentry>
1077   <term><amkeyword>columnspec</amkeyword> <amtype>string</amtype></term>
1078   <listitem>
1079 <para> default: "HostName=0:12:12,Disk=1:11:11,Level=1:1:1,OrigKB=1:-7:0,OutKB=1:-7:0,Compress=1:-6:1,DumpTime=1:-7:7,Dumprate=1:-6:1,TapeTime=1:-6:6,TapeRate=1:-6:1"</para>
1080 <para>Defines the width of columns <emphasis remap='B'>amreport</emphasis>
1081 should use.
1082 <emphasis remap='I'>String</emphasis>
1083 is a comma (',') separated list of triples. Each triple consists
1084 of three parts which are separated by a equal sign ('=') and a colon (':') (see the example).
1085 These four parts specify:
1086
1087   <orderedlist>
1088   <listitem>
1089       <para>the name of the column, which may be:
1090
1091 <programlisting>
1092         Compress (compression ratio)
1093         Disk (client disk name)
1094         DumpRate (dump rate in KBytes/sec)
1095         DumpTime (total dump time in hours:minutes)
1096         HostName (client host name)
1097         Level (dump level)
1098         OrigKB (original image size in KBytes)
1099         OutKB (output image size in KBytes)
1100         TapeRate (tape writing rate in KBytes/sec)
1101         TapeTime (total tape time in hours:minutes)
1102 </programlisting></para>
1103
1104   </listitem>
1105
1106   <listitem>
1107 <para>the amount of space to display before the column (used to get whitespace between columns).</para>
1108   </listitem>
1109   <listitem>
1110 <para>the width of the column itself.
1111 If set to a negative value, the width will be calculated on demand to fit the largest entry in
1112 this column.</para>
1113   </listitem>
1114   <listitem>
1115 <para>the precision of the column, number of digit after the decimal point for number.</para>
1116   </listitem>
1117   </orderedlist></para>
1118
1119 <para>Here is an example:
1120 <programlisting>
1121 columnspec &quot;Disk=1:18,HostName=0:10,OrigKB=::2,OutKB=1:7&quot;
1122 </programlisting></para>
1123 <para>
1124 The above will display the disk information in 18 characters
1125 and put one space before it. The hostname column will be 10 characters wide with
1126 no space to the left. The Original KBytes print 2 decimal digit. The output KBytes column is seven characters wide
1127 with one space before it.</para>
1128   </listitem>
1129   </varlistentry>
1130
1131   <varlistentry>
1132   <term><amkeyword>includefile</amkeyword> <amtype>string</amtype></term>
1133   <listitem>
1134 <para>Default:
1135 <amdefault>no default</amdefault>.
1136 The name of an Amanda configuration file to include within the current file.
1137 Useful for sharing dumptypes, tapetypes and interface definitions among several configurations.
1138 Relative pathnames are relative to the configuration directory.
1139 </para>
1140   </listitem>
1141   </varlistentry>
1142
1143   <varlistentry>
1144   <term><amkeyword>debug-days</amkeyword> <amtype>int</amtype></term>
1145   <listitem>
1146 <para>Default:
1147 <amdefault>3</amdefault>.
1148 The number of days the debug files are kept.</para>
1149   </listitem>
1150   </varlistentry>
1151
1152   <varlistentry>
1153   <term><amkeyword>debug-auth</amkeyword> <amtype>int</amtype></term>
1154   <listitem>
1155 <para>Default:
1156 <amdefault>0</amdefault>.
1157 Debug level of the auth module</para>
1158   </listitem>
1159   </varlistentry>
1160
1161   <varlistentry>
1162   <term><amkeyword>debug-event</amkeyword> <amtype>int</amtype></term>
1163   <listitem>
1164 <para>Default:
1165 <amdefault>0</amdefault>.
1166 Debug level of the event module</para>
1167   </listitem>
1168   </varlistentry>
1169
1170   <varlistentry>
1171   <term><amkeyword>debug-holding</amkeyword> <amtype>int</amtype></term>
1172   <listitem>
1173 <para>Default:
1174 <amdefault>0</amdefault>.
1175 Debug level of the holdingdisk module</para>
1176   </listitem>
1177   </varlistentry>
1178
1179   <varlistentry>
1180   <term><amkeyword>debug-protocol</amkeyword> <amtype>int</amtype></term>
1181   <listitem>
1182 <para>Default:
1183 <amdefault>0</amdefault>.
1184 Debug level of the protocol module</para>
1185   </listitem>
1186   </varlistentry>
1187
1188   <varlistentry>
1189   <term><amkeyword>debug-planner</amkeyword> <amtype>int</amtype></term>
1190   <listitem>
1191 <para>Default:
1192 <amdefault>0</amdefault>.
1193 Debug level of the planner process</para>
1194   </listitem>
1195   </varlistentry>
1196
1197   <varlistentry>
1198   <term><amkeyword>debug-driver</amkeyword> <amtype>int</amtype></term>
1199   <listitem>
1200 <para>Default:
1201 <amdefault>0</amdefault>.
1202 Debug level of the driver process</para>
1203   </listitem>
1204   </varlistentry>
1205
1206   <varlistentry>
1207   <term><amkeyword>debug-dumper</amkeyword> <amtype>int</amtype></term>
1208   <listitem>
1209 <para>Default:
1210 <amdefault>0</amdefault>.
1211 Debug level of the dumper process</para>
1212   </listitem>
1213   </varlistentry>
1214
1215   <varlistentry>
1216   <term><amkeyword>debug-chunker</amkeyword> <amtype>int</amtype></term>
1217   <listitem>
1218 <para>Default:
1219 <amdefault>0</amdefault>.
1220 Debug level of the chunker process</para>
1221   </listitem>
1222   </varlistentry>
1223
1224   <varlistentry>
1225   <term><amkeyword>debug-taper</amkeyword> <amtype>int</amtype></term>
1226   <listitem>
1227 <para>Default:
1228 <amdefault>0</amdefault>.
1229 Debug level of the taper process</para>
1230   </listitem>
1231   </varlistentry>
1232
1233   <varlistentry>
1234   <term><amkeyword>flush-threshold-dumped</amkeyword> <amtype>int</amtype></term>
1235   <listitem>
1236 <para>Default: <amdefault>0</amdefault>.
1237   Amanda will not begin writing data to a new volume until the amount of
1238   data on the holding disk is at least this percentage of the volume
1239   size. In other words, Amanda will not begin until the
1240   amount of data on the holding disk is greater than the tape
1241   length times this parameter.
1242   This parameter may be larger than 100%, for example to keep
1243   more recent dumps on the holding disk for faster recovery.</para>
1244 <para> Needless to say, your holding disk must be big enough
1245   that this criterion could be satisfied. If the holding disk cannot
1246   be used for a particular dump (because, for example, there is no
1247   remaining holding space) then Amanda will disregard the constraint
1248   specified by this setting and start a new volume anyway. Once
1249   writing to a volume has begun, this constraint is not applied unless
1250   and until a new volume is needed.</para>
1251 <para> The value of this parameter may not exceed than that of
1252   the <amkeyword>flush-threshold-scheduled</amkeyword>
1253   parameter.</para>
1254   </listitem>
1255   </varlistentry>
1256
1257   <varlistentry>
1258   <term><amkeyword>flush-threshold-scheduled</amkeyword> <amtype>int</amtype></term>
1259   <listitem>
1260 <para>Default: <amdefault>0</amdefault>.
1261   Amanda will not begin writing data to a new volume until the sum of the
1262   amount of data on the holding disk and the estimated amount of data
1263   remaining to be dumped during this run is at least this percentage
1264   of the volume size. In other words, Amanda will not begin until the
1265   inequality <inlineequation><mathphrase>h + s &gt; t &#215;
1266   d</mathphrase></inlineequation> is satisfied,
1267   where <mathphrase>h</mathphrase> is the amount of data on the
1268   holding disk, <mathphrase>s</mathphrase> is the total amount of
1269   data scheduled for this run but not dumped
1270   yet, <mathphrase>t</mathphrase> is the capacity of a volume,
1271   and <mathphrase>d</mathphrase> is this parameter, expressed as a
1272   percentage.  This parameter may be larger than 100%.</para>
1273 <para>  Needless to say, your holding disk must be big enough
1274   that this criterion could be satisfied. If the holding disk cannot
1275   be used for a particular dump (because, for example, there is no
1276   remaining holding space) then Amanda will disregard the constraint
1277   specified by this setting and start a new volume anyway.  Once
1278   writing to a volume has begun, this constraint is not applied unless
1279   and until a new volume is needed.</para>
1280 <para> The value of this parameter may not be less than that of
1281   the <amkeyword>flush-threshold-dumped</amkeyword>
1282   or <amkeyword>taperflush</amkeyword> parameters.</para>
1283   </listitem>
1284   </varlistentry>
1285
1286 <!-- the entity '#215' below is U+00D7 MULTIPLICATION SIGN; the 'times' entity
1287      is not as portable as one might hope. -->
1288   <varlistentry>
1289   <term><amkeyword>taperflush</amkeyword> <amtype>int</amtype></term>
1290   <listitem>
1291 <para>Default: <amdefault>0</amdefault>.
1292   At the end of a run, Amanda will start a new tape to flush remaining
1293   data if there is more data on the holding disk at the end of a run
1294   than this setting allows; the amount is specified as a percentage of
1295   the capacity of a single
1296   volume. In other words, at the end of a run, Amanda will begin
1297   a new tape if the
1298   inequality <inlineequation><mathphrase>h &gt; t &#215;
1299   f</mathphrase></inlineequation> is satisfied,
1300   where <mathphrase>h</mathphrase> is the amount of data remaining on the
1301   holding disk from this or previous runs, <mathphrase>t</mathphrase>
1302   is the capacity of a volume,
1303   and <mathphrase>f</mathphrase> is this parameter, expressed as a
1304   percentage.  This parameter may be greater than 100%.</para>
1305 <para> The value of this parameter may not exceed that of
1306   the <amkeyword>flush-threshold-scheduled</amkeyword>
1307   parameter.; <amkeyword>autoflush</amkeyword> must be set to 'yes' if
1308  <amkeyword>taperflush</amkeyword> is greater than 0.</para>
1309   </listitem>
1310   </varlistentry>
1311
1312   <varlistentry>
1313   <term><amkeyword>reserved-udp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
1314   <listitem>
1315 <para>Default: --with-udpportrange or
1316 <amdefault>512,1023</amdefault>.
1317 Reserved udp port that will be used (bsd, bsdudp).
1318 Range is inclusive.</para>
1319   </listitem>
1320   </varlistentry>
1321
1322   <varlistentry>
1323   <term><amkeyword>reserved-tcp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
1324   <listitem>
1325 <para>Default: --with-low-tcpportrange or
1326 <amdefault>512,1023</amdefault>.
1327 Reserved tcp port that will be used (bsdtcp).
1328 Range is inclusive.</para>
1329   </listitem>
1330   </varlistentry>
1331
1332   <varlistentry>
1333   <term><amkeyword>unreserved-tcp-port</amkeyword> <amtype>int</amtype>,<amtype>int</amtype></term>
1334   <listitem>
1335 <para>Default: --with-tcpportrange or
1336 <amdefault>1024,65535</amdefault>.
1337 Unreserved tcp port that will be used (bsd, bsdudp).
1338 Range is inclusive.</para>
1339   </listitem>
1340   </varlistentry>
1341
1342   <varlistentry>
1343   <term><amkeyword>recovery-limit</amkeyword> [ <amtype>string</amtype> | <amkeyword>same-host</amkeyword> ]</term>
1344   <listitem>
1345 <para>Default: none (no limitations).  This parameter limits the hosts
1346     that may do remote recoveries.  Hosts are identified by their authenticated
1347     peer name, as described in <manref name="amanda-auth" vol="7"/>; if this is
1348     not available and the recovery-limit parameter is present, recovery will be
1349     denied.  The arguments to the parameter are strings giving host match
1350     expressions (see <manref name="amanda-match" vol="7"/>) or the special
1351     keyword same-host, which requires an exact match to the hostname of the
1352     DLE being recovered.  Specifying no arguments at all will disable all
1353     recoveries from any host.</para>
1354
1355 <para>Note that match expressions can be constructed to be
1356     forgiving of e.g., fully-qualified vs. unqualified hostnames, but
1357     <amkeyword>same-host</amkeyword> requires an exact match.</para>
1358
1359 <para>The error messages that appear in amrecover are intentionally vague to
1360     avoid information leakage.  Consult the amindexd debug log for more details
1361     on the reasons a recovery was rejected.</para>
1362
1363 <para>Recovery limits can be refined on a per-DLE basis using the dumptype
1364     parameter of the same name.  Note that the default value will apply to any
1365     dumpfiles for disks which no longer appear in the disklist; thus leaving the
1366     global parameter at its default value but setting it for all DLEs is not
1367     sufficient to maintain secure backups.</para>
1368
1369   </listitem>
1370   </varlistentry>
1371
1372 </variablelist>
1373 </refsect1>
1374
1375 <refsect1><title>HOLDINGDISK SECTION</title>
1376 <para>The <emphasis remap='B'>amanda.conf</emphasis>
1377 file may define one or more holding disks used as buffers to hold
1378 backup images before they are written to tape.
1379 The syntax is:</para>
1380
1381 <programlisting>
1382 define holdingdisk <emphasis remap='I'>name</emphasis> {
1383     <emphasis remap='I'>holdingdisk-option</emphasis> <emphasis remap='I'>holdingdisk-value</emphasis>
1384     <literal>...</literal>
1385 }
1386 </programlisting>
1387
1388 <para>The { must appear at the end of a line, and the } on its own line.</para>
1389 <para><emphasis remap='I'>Name</emphasis>
1390 is a logical name for this holding disk.</para>
1391
1392 <para>The options and values are:</para>
1393
1394 <variablelist remap='TP'>
1395   <varlistentry>
1396   <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
1397   <listitem>
1398 <para>Default: not set.
1399 A comment string describing this holding disk.</para>
1400   </listitem>
1401   </varlistentry>
1402
1403   <varlistentry>
1404   <term><amkeyword>directory</amkeyword> <amtype>string</amtype></term>
1405   <listitem>
1406 <para>Default:
1407 <amdefault>&quot;/dumps/amanda&quot;</amdefault>.
1408 The path to this holding area.</para>
1409   </listitem>
1410   </varlistentry>
1411
1412   <varlistentry>
1413   <term><amkeyword>use</amkeyword> <amtype>int</amtype></term>
1414   <listitem>
1415 <para>Default:
1416 <amdefault>0 Gb</amdefault>.
1417 Amount of space that can be used in this holding disk area.
1418 If the value is zero, all available space on the file system is used.
1419 If the value is negative, Amanda will use all available space minus that value.</para>
1420   </listitem>
1421   </varlistentry>
1422
1423   <varlistentry>
1424   <term><amkeyword>chunksize</amkeyword> <amtype>int</amtype></term>
1425   <listitem>
1426 <para>Default:
1427 <amdefault>1 Gb</amdefault>.
1428 Holding disk chunk size. Dumps larger than the specified size will be stored in multiple
1429 holding disk files. The size of each chunk will not exceed the specified value.
1430 However, even though dump images are split in the holding disk, they are concatenated as
1431 they are written to tape, so each dump image still corresponds to a single continuous
1432 tape section.</para>
1433 <para>The default unit is Kbytes if it is not specified.</para>
1434
1435 <para>If 0 is specified, Amanda will create holding disk chunks as large as
1436 ((INT_MAX/1024)-64) Kbytes.</para>
1437
1438 <para>Each holding disk chunk includes a 32 Kbyte header, so the minimum
1439 chunk size is 64 Kbytes (but that would be really silly).</para>
1440
1441 <para>Operating systems that are limited to a maximum file size of 2 Gbytes
1442 actually cannot handle files that large.
1443 They must be at least one byte less than 2 Gbytes.
1444 Since Amanda works with 32 Kbyte blocks, and
1445 to handle the final read at the end of the chunk, the chunk size
1446 should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum
1447 file size, e.g. 2047 Mbytes.</para>
1448   </listitem>
1449   </varlistentry>
1450 </variablelist>
1451 </refsect1>
1452
1453 <refsect1><title>DUMPTYPE SECTION</title>
1454 <para>The &amconf; file may define multiple sets of backup options
1455 and refer to them by name from the &disklist; file.
1456 For instance, one set of options might be defined for file systems
1457 that can benefit from high compression, another set that does not compress well,
1458 another set for file systems that should always get a full backup and so on.</para>
1459
1460 <para>A set of backup options are entered in a
1461 <amkeyword>dumptype</amkeyword>
1462 section, which looks like this:</para>
1463
1464 <programlisting>
1465 define dumptype "<emphasis remap='I'>name</emphasis>" {
1466     <emphasis remap='I'>dumptype-option</emphasis> <emphasis remap='I'>dumptype-value</emphasis>
1467     <literal>...</literal>
1468 }
1469 </programlisting>
1470
1471 <para>The { must appear at the end of a line, and the } on its own line.</para>
1472 <para><emphasis remap='I'>Name</emphasis>
1473 is the name of this set of backup options.
1474 It is referenced from the &disklist; file.</para>
1475
1476 <para>Some of the options in a
1477 <amkeyword>dumptype</amkeyword>
1478 section are the same as those in the main part of &amconf;.
1479 The main option value is used to set the default for all
1480 <amkeyword>dumptype</amkeyword>
1481 sections. For instance, setting
1482 <amkeyword>dumpcycle</amkeyword>
1483 to 50 in the main part of the config file causes all following
1484 <amkeyword>dumptype</amkeyword>
1485 sections to start with that value,
1486 but the value may be changed on a section by section basis.
1487 Changes to variables in the main part of the config file must be
1488 done before (earlier in the file) any
1489 <amkeyword>dumptype</amkeyword>s
1490 are defined.</para>
1491
1492 <para>The dumptype options and values are:</para>
1493
1494 <variablelist remap='TP'>
1495   <varlistentry>
1496   <term><amkeyword>auth</amkeyword> <amtype>string</amtype></term>
1497   <listitem>
1498 <para>Default:
1499 <amdefault>&quot;bsd&quot;</amdefault>.
1500 Type of authorization to perform between tape server and backup client hosts.  See <manref name="amanda-auth" vol="7"/> for more detail.</para>
1501   </listitem>
1502   </varlistentry>
1503
1504   <varlistentry>
1505   <term><amkeyword>amandad-path</amkeyword> <amtype>string</amtype></term>
1506   <listitem>
1507 <para>Default:
1508 <amdefault>&quot;$libexec/amandad&quot;</amdefault>.
1509 Specify the amandad path of the client, only use with rsh/ssh authentification.
1510 </para>
1511   </listitem>
1512   </varlistentry>
1513
1514   <varlistentry>
1515   <term><amkeyword>client-username</amkeyword> <amtype>string</amtype></term>
1516   <listitem>
1517 <para>Default:
1518 <amdefault>CLIENT_LOGIN</amdefault>.
1519 Specify the username to connect on the client, only use with rsh/ssh authentification.
1520 </para>
1521   </listitem>
1522   </varlistentry>
1523
1524   <varlistentry>
1525   <term><amkeyword>client-port</amkeyword> [ <amtype>int</amtype> | <amtype>string</amtype> ]</term>
1526   <listitem>
1527 <para>Default:
1528 <amdefault>&quot;amanda&quot;</amdefault>.
1529 Specifies the port to connect to on the client.  It can be a service name or a numeric port number.
1530 </para>
1531   </listitem>
1532   </varlistentry>
1533
1534 <!-- bumping parameters yanked from the global section above -->
1535
1536   <varlistentry>
1537   <term><amkeyword>bumpsize</amkeyword> <amtype>int</amtype></term>
1538   <listitem>
1539 <para>Default:
1540 <amdefault>10 Mbytes</amdefault>.
1541 The minimum savings required to trigger an automatic
1542 bump from one incremental level to the next, expressed as size.
1543 If Amanda determines that the next higher backup level
1544 will be this much smaller than the current level,
1545 it will do the next level.
1546 The value of this parameter is used only if the parameter
1547 <emphasis>bumppercent</emphasis> is set to 0.
1548 </para>
1549 <para>The default unit is Kbytes if it is not specified.</para>
1550 <para>
1551 See also the options
1552 <amkeyword>bumppercent</amkeyword>,
1553 <amkeyword>bumpmult</amkeyword> and
1554 <amkeyword>bumpdays</amkeyword>.</para>
1555   </listitem>
1556   </varlistentry>
1557
1558   <varlistentry>
1559   <term><amkeyword>bumppercent</amkeyword> <amtype>int</amtype></term>
1560   <listitem>
1561 <para>Default:
1562 <amdefault>0</amdefault>.
1563 The minimum savings required to trigger an automatic
1564 bump from one incremental level to the next, expressed as percentage of the
1565 current size of the DLE (size of current level 0).
1566 If Amanda determines that the next higher backup level
1567 will be this much smaller than the current level,
1568 it will do the next level.
1569 </para>
1570 <para>
1571 If this parameter is set to 0, the value of the
1572 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
1573 </para>
1574 <para>
1575 See also the options
1576 <amkeyword>bumpsize</amkeyword>,
1577 <amkeyword>bumpmult</amkeyword> and
1578 <amkeyword>bumpdays</amkeyword>.</para>
1579   </listitem>
1580   </varlistentry>
1581
1582   <varlistentry>
1583   <term><amkeyword>bumpmult</amkeyword> <amtype>float</amtype></term>
1584   <listitem>
1585 <para>Default:
1586 <amdefault>1.5</amdefault>.
1587 The bump size multiplier.
1588 Amanda multiplies
1589 <amkeyword>bumpsize</amkeyword>
1590 by this factor for each level.
1591 This prevents active filesystems from
1592 bumping too much by making it harder to bump to the next level.
1593 For example, with the default
1594 <amkeyword>bumpsize</amkeyword>
1595 and
1596 <amkeyword>bumpmult</amkeyword>
1597 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
1598 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
1599   </listitem>
1600   </varlistentry>
1601   <varlistentry>
1602   <term><amkeyword>bumpdays</amkeyword> <amtype>int</amtype></term>
1603   <listitem>
1604 <para>Default:
1605 <amdefault>2 days</amdefault>.
1606 To insure redundancy in the dumps, Amanda keeps filesystems at the
1607 same incremental level for at least
1608 <amkeyword>bumpdays</amkeyword>
1609 days, even if the other bump threshold criteria are met.</para>
1610   </listitem>
1611   </varlistentry>
1612
1613   <varlistentry>
1614   <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
1615   <listitem>
1616 <para>Default: not set.
1617 A comment string describing this set of backup options.</para>
1618   </listitem>
1619   </varlistentry>
1620   <varlistentry>
1621   <term><amkeyword>comprate</amkeyword> <amtype>float</amtype> [, <amtype>float</amtype> ]</term>
1622   <listitem>
1623 <para>Default:
1624 <amdefault>0.50, 0.50</amdefault>.
1625 The expected full and incremental compression factor for dumps.
1626 It is only used if Amanda does not have any history information on
1627 compression rates for a filesystem, so should not usually need to be set.
1628 However, it may be useful for the first time a very large filesystem that
1629 compresses very little is backed up.</para>
1630   </listitem>
1631   </varlistentry>
1632   <varlistentry>
1633   <term><amkeyword>compress</amkeyword> [ <amkeyword>none</amkeyword> | <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ] [ <amkeyword>best</amkeyword> | <amkeyword>fast</amkeyword> | <amkeyword>custom</amkeyword> ]</term>
1634   <listitem>
1635 <para>Default:
1636 <amkeyword>client fast</amkeyword>.
1637 If Amanda does compression of the backup images, it can do so either on the backup client
1638 host before it crosses the network or on the tape server host as it goes from the
1639 network into the holding disk or to tape.  Which place to do compression (if at all) depends on how well the
1640 dump image usually compresses, the speed and load on the client or server, network capacity,
1641 holding disk capacity, availability of tape hardware compression, etc.</para>
1642
1643 <para>For either type of compression, Amanda also allows the selection
1644 of three styles of compression.
1645 <amkeyword>best</amkeyword>
1646 is the best compression available, often at the expense of CPU overhead.
1647 <amkeyword>fast</amkeyword>
1648 is often not as good a compression as
1649 <amkeyword>best</amkeyword>,
1650 but usually less CPU overhead. Or to specify <amkeyword>custom</amkeyword>
1651 to use your own compression method. (See dumptype custom-compress in example/amanda.conf for reference)</para>
1652
1653 <para>So the <amkeyword>compress</amkeyword> options line may be one of:</para>
1654
1655 <variablelist remap='TP'>
1656   <varlistentry>
1657     <term>compress none</term><listitem><para/></listitem>
1658   </varlistentry>
1659   <varlistentry>
1660     <term>compress client fast</term><listitem><para/></listitem>
1661   </varlistentry>
1662   <varlistentry>
1663     <term>compress client best</term><listitem><para/></listitem>
1664   </varlistentry>
1665   <varlistentry>
1666     <term>compress client custom</term>
1667     <listitem>
1668       <para>Specify <amkeyword>client-custom-compress</amkeyword> &quot;PROG&quot;</para>
1669       <para>PROG must not contain white space and it must accept -d for uncompress.</para>
1670     </listitem>
1671   </varlistentry>
1672   <varlistentry>
1673     <term>compress server fast</term><listitem><para/></listitem>
1674   </varlistentry>
1675   <varlistentry>
1676     <term>compress server best</term><listitem><para/></listitem>
1677   </varlistentry>
1678   <varlistentry>
1679     <term>compress server custom</term>
1680     <listitem>
1681       <para>Specify <amkeyword>server-custom-compress</amkeyword> &quot;PROG&quot;</para>
1682       <para>PROG must not contain white space and it must accept -d for uncompress.</para>
1683     </listitem>
1684   </varlistentry>
1685 </variablelist>
1686 <para>Note that some tape devices do compression and this option has nothing
1687 to do with whether that is used. If hardware compression is used (usually via a particular tape device name
1688 or <emphasis remap='B'>mt</emphasis> option), Amanda (software) compression should be disabled.</para>
1689   </listitem>
1690   </varlistentry>
1691
1692   <varlistentry>
1693   <term><amkeyword>client-custom-compress</amkeyword> <amtype>string</amtype></term>
1694   <listitem>
1695 <para>Default: none.
1696     The program to use to perform compression/decompression on the client; used with
1697 "compress client custom".  Must not contain whitespace.  Must accept -d to uncompress.</para>
1698   </listitem>
1699   </varlistentry>
1700
1701   <varlistentry>
1702   <term><amkeyword>server-custom-compress</amkeyword> <amtype>string</amtype></term>
1703   <listitem>
1704 <para>Default: none.
1705     The program to use to perform compression/decompression on the server; used with
1706 "compress server custom".  Must not contain whitespace.  Must accept -d to uncompress.</para>
1707   </listitem>
1708   </varlistentry>
1709
1710   <varlistentry>
1711   <term><amkeyword>dumpcycle</amkeyword> <amtype>int</amtype></term>
1712   <listitem>
1713 <para>Default: <amdefault>10 days</amdefault>.
1714 The number of days in the backup cycle. Each disk using this set of options will get a full
1715 backup at least this of
1716 ten. Setting this to zero tries to do a full backup each run.</para>
1717   </listitem>
1718   </varlistentry>
1719
1720   <varlistentry>
1721   <term><amkeyword>encrypt</amkeyword> [ <amkeyword>none</amkeyword> | <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ]</term>
1722   <listitem>
1723 <para>Default: not set.
1724 To encrypt backup images, it can do so either on the backup client host before it crosses the network or on the tape
1725 server host as it goes from the network into the holding disk or to tape.</para>
1726
1727 <para>So the <amkeyword>encrypt</amkeyword> options line may be one
1728             of:</para>
1729
1730 <variablelist remap='TP'>
1731   <varlistentry>
1732     <term>encrypt none</term><listitem><para/></listitem>
1733   </varlistentry>
1734   <varlistentry>
1735     <term>encrypt client</term>
1736     <listitem>
1737       <para>Specify client-encrypt &quot;PROG&quot;</para>
1738       <para>PROG must not contain white space.</para>
1739       <para>Specify client-decrypt-option &quot;decryption-parameter&quot; Default: &quot;-d&quot;</para>
1740       <para>decryption-parameter must not contain white space.</para>
1741       <para>(See dumptype client-encrypt-nocomp in example/amanda.conf for reference)</para>
1742     </listitem>
1743   </varlistentry>
1744   <varlistentry>
1745     <term>encrypt server</term>
1746     <listitem>
1747       <para>Specify server-encrypt &quot;PROG&quot;</para>
1748       <para>PROG must not contain white space.</para>
1749       <para>Specify server-decrypt-option &quot;decryption-parameter&quot; Default: &quot;-d&quot;</para>
1750       <para>decryption-parameter must not contain white space.</para>
1751       <para>(See dumptype server-encrypt-fast in example/amanda.conf for reference)</para>
1752     </listitem>
1753   </varlistentry>
1754 </variablelist>
1755 <para>Note that current logic assumes compression then encryption during
1756 backup(thus decrypt then uncompress during restore). So specifying
1757 client-encryption AND server-compression is not supported.
1758 <emphasis remap='I'>amcrypt</emphasis> which is a wrapper of
1759             <emphasis remap='I'>aespipe</emphasis> is provided as a reference
1760                 symmetric encryption program.</para>
1761 </listitem>
1762 </varlistentry>
1763
1764   <varlistentry>
1765   <term><amkeyword>client-encrypt</amkeyword> <amtype>string</amtype></term>
1766   <listitem>
1767 <para>Default: none.
1768 The program to use to perform encryption/decryption on the client; used with
1769 "encrypt client".  Must not contain whitespace.</para>
1770   </listitem>
1771   </varlistentry>
1772
1773   <varlistentry>
1774   <term><amkeyword>client-decrypt-option</amkeyword> <amtype>string</amtype></term>
1775   <listitem>
1776 <para>Default: -d.
1777 The option that can be passed to client-encrypt to make it decrypt instead.
1778 Must not contain whitespace.</para>
1779   </listitem>
1780   </varlistentry>
1781
1782   <varlistentry>
1783   <term><amkeyword>server-encrypt</amkeyword> <amtype>string</amtype></term>
1784   <listitem>
1785 <para>Default: none.
1786 The program to use to perform encryption/decryption on the server; used with
1787 "encrypt server".  Must not contain whitespace.</para>
1788   </listitem>
1789   </varlistentry>
1790
1791   <varlistentry>
1792   <term><amkeyword>server-decrypt-option</amkeyword> <amtype>string</amtype></term>
1793   <listitem>
1794 <para>Default: -d.
1795 The option that can be passed to server-encrypt to make it decrypt instead.
1796 Must not contain whitespace.</para>
1797   </listitem>
1798   </varlistentry>
1799
1800   <varlistentry>
1801   <term><amkeyword>estimate</amkeyword> [ <amkeyword>client</amkeyword> | <amkeyword>calcsize</amkeyword> | <amkeyword>server</amkeyword> ]+</term>
1802   <listitem>
1803 <para>Default: <amkeyword>client</amkeyword>.
1804 Determine the way Amanda estimates the size of each DLE before beginning a backup.  This is a list of acceptable estimate methods, and Amanda applies the first method supported by the application.  The methods are:</para>
1805 <variablelist remap='TP'>
1806   <varlistentry>
1807     <term>client</term>
1808     <listitem>
1809       <para>Use the same program as the dumping program. This is the most
1810             accurate method to do estimates, but it can take a long time.</para>
1811     </listitem>
1812   </varlistentry>
1813   <varlistentry>
1814     <term>calcsize</term>
1815     <listitem>
1816       <para>Use a faster program to do estimates, but the result is less
1817       accurate.</para>
1818     </listitem>
1819   </varlistentry>
1820   <varlistentry>
1821     <term>server</term>
1822     <listitem>
1823       <para>Use only statistics from the previous few runs to give an estimate.
1824             This very quick, but the result is not accurate if your disk
1825             usage changes from day to day.  If this method is specified, but the
1826             server does not have enough data to make an estimate, then the option
1827             is internally moved to the end of the list, thereby preferring 'client'
1828             or 'calcsize' in this case.</para>
1829     </listitem>
1830   </varlistentry>
1831 </variablelist>
1832 </listitem>
1833 </varlistentry>
1834
1835
1836   <varlistentry>
1837   <term><amkeyword>exclude</amkeyword> [ <amkeyword>list</amkeyword> | <amkeyword>file</amkeyword> ][[<amkeyword>optional</amkeyword>][<amkeyword>append</amkeyword>][ <amtype>string</amtype> ]+]</term>
1838   <listitem>
1839 <para>Default:
1840 <amkeyword>file</amkeyword>.  Exclude is the opposite of
1841 <amkeyword>include</amkeyword> and specifies files that will be excluded from
1842 the backup.  The format of the exclude expressions depends on the application,
1843 and some applications do not support excluding files at all.</para>
1844
1845 <para>There are two exclude parameters,
1846 <amkeyword>exclude</amkeyword> <amkeyword>file</amkeyword>
1847 and
1848 <amkeyword>exclude</amkeyword> <amkeyword>list.</amkeyword>
1849 With
1850 <amkeyword>exclude</amkeyword> <amkeyword>file</amkeyword>, the
1851 <amtype>string</amtype>
1852 is an exclude expression. With
1853 <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>
1854 , the
1855 <amtype>string</amtype>
1856 is a file name on the client containing &gnutar; exclude expressions.
1857 The path to the specified exclude list file, if present (see description of
1858 'optional' below), must be readable by the Amanda user.</para>
1859
1860 <para>All exclude expressions are concatenated in one file and passed to the
1861 application as an <option>--exclude-from</option> argument.</para>
1862
1863 <para>For &gnutar;, exclude expressions must always be specified as relative to the
1864 top-level directory of the DLE, and must start with "./".  See the manpages for individual
1865 applications for more information on supported exclude expressions.</para>
1866
1867 <para>With the
1868 <amkeyword>append</amkeyword> keyword, the
1869 <amtype>string</amtype> is appended to the current list, without it, the
1870 <amtype>string</amtype> overwrites the list.</para>
1871
1872 <para>If <amkeyword>optional</amkeyword>
1873 is specified for <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>,
1874 then amcheck will not complain if the file doesn't exist or is not readable.</para>
1875
1876 <para>For <amkeyword>exclude</amkeyword> <amkeyword>list</amkeyword>,
1877 if the file name is relative, the disk name being backed up is prepended.
1878 So if this is entered:</para>
1879
1880 <programlisting>
1881     exclude list &quot;.amanda.excludes&quot;
1882 </programlisting>
1883
1884 <para>the actual file used would be
1885 <filename>/var/.amanda.excludes</filename>
1886 for a backup of <filename>/var</filename>,
1887 <filename>/usr/local/.amanda.excludes</filename> for a backup of
1888 <filename>/usr/local</filename>, and so on.</para>
1889 </listitem>
1890 </varlistentry>
1891
1892   <varlistentry>
1893   <term><amkeyword>holdingdisk</amkeyword> [ <amkeyword>never</amkeyword> | <amkeyword>auto</amkeyword> | <amkeyword>required</amkeyword> ]</term>
1894   <listitem>
1895 <para>Default:
1896 <amkeyword>auto</amkeyword>.
1897 Whether a holding disk should be used for these backups or whether they should go directly to tape.
1898 If the holding disk is a portion of another file system that Amanda
1899 is backing up, that file system should refer to a dumptype with
1900 <amkeyword>holdingdisk</amkeyword>
1901 set to
1902 <emphasis remap='I'>never</emphasis>
1903 to avoid backing up the holding disk into itself.</para>
1904
1905   <variablelist remap='TP'>
1906   <varlistentry>
1907   <term><amkeyword>never</amkeyword>|no|false|off</term>
1908   <listitem>
1909   <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>
1910   </listitem>
1911   </varlistentry>
1912   <varlistentry>
1913   <term><amkeyword>auto</amkeyword>|yes|true|on</term>
1914   <listitem>
1915   <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>
1916   </listitem>
1917   </varlistentry>
1918   <varlistentry>
1919   <term><amkeyword>required</amkeyword></term>
1920   <listitem>
1921   <para>Always dump to holdingdisk, never directly to tape. There will be no dump if it doesn't fit on holdingdisk</para>
1922   </listitem>
1923   </varlistentry>
1924   </variablelist>
1925
1926   </listitem>
1927   </varlistentry>
1928
1929   <varlistentry>
1930   <term><amkeyword>ignore</amkeyword> <amtype>boolean</amtype></term>
1931   <listitem>
1932 <para>Default:
1933 <amkeyword>no</amkeyword>.
1934 Whether disks associated with this backup type should be backed up or not.
1935 This option is useful when the
1936 <emphasis remap='I'>disklist</emphasis>
1937 file is shared among several configurations,
1938 some of which should not back up all the listed file systems.</para>
1939   </listitem>
1940   </varlistentry>
1941   <varlistentry>
1942   <term><amkeyword>include</amkeyword> [ <amkeyword>list</amkeyword> | <amkeyword>file</amkeyword> ][[<amkeyword>optional</amkeyword>][<amkeyword>append</amkeyword>][ <amtype>string</amtype> ]+]</term>
1943   <listitem>
1944 <para>Default:
1945 <amkeyword>file</amkeyword>
1946 &quot;.&quot;.
1947 There are two include lists,
1948 <amkeyword>include file</amkeyword>
1949 and
1950 <amkeyword>include list.</amkeyword>
1951 With
1952 <amkeyword>include file</amkeyword>
1953 , the
1954 <amtype>string</amtype>
1955 is a glob expression. With
1956 <amkeyword>include list</amkeyword>
1957 , the
1958 <amtype>string</amtype>
1959 is a file name on the client containing glob expressions.</para>
1960
1961 <para>All include expressions are expanded by Amanda, concatenated in one file and passed to &gnutar; as a
1962 <option>--files-from</option> argument. They must start with &quot;./&quot; and contain no other &quot;/&quot;.</para>
1963
1964 <para>Include expressions must always be specified as relative to the
1965 head directory of the DLE.</para>
1966
1967 <note><para>For globbing to work at all, even the limited single level,
1968 the top level directory of the DLE must be readable by the Amanda user.</para>
1969 </note>
1970
1971 <para>With the <amkeyword>append</amkeyword> keyword, the
1972 <amtype>string</amtype> is appended to the current list, without it, the
1973 <amtype>string</amtype> overwrites the list.</para>
1974
1975 <para>If
1976 <amkeyword>optional</amkeyword> is specified for
1977 <amkeyword>include list</amkeyword>, then amcheck will not complain if the file
1978 doesn't exist or is not readable.</para>
1979
1980 <para>For <amkeyword>include list</amkeyword>,
1981 If the file name is relative, the disk name being backed up is prepended.</para>
1982 </listitem>
1983 </varlistentry>
1984
1985   <varlistentry>
1986   <term><amkeyword>index</amkeyword> <amtype>boolean</amtype></term>
1987   <listitem>
1988 <para>Default: <amkeyword>no</amkeyword>.
1989 Whether an index (catalogue) of the backup should be generated and saved in
1990 <amkeyword>indexdir</amkeyword>.
1991 These catalogues are used by the <emphasis remap='B'>amrecover</emphasis> utility.</para>
1992   </listitem>
1993   </varlistentry>
1994
1995   <varlistentry>
1996   <term><amkeyword>kencrypt</amkeyword> <amtype>boolean</amtype></term>
1997   <listitem>
1998 <para>Default:
1999 <amkeyword>no</amkeyword>.
2000 Whether the backup image should be encrypted by Kerberos as it is sent
2001 across the network from the backup client host to the tape server host.</para>
2002   </listitem>
2003   </varlistentry>
2004   <varlistentry>
2005   <term><amkeyword>maxdumps</amkeyword> <amtype>int</amtype></term>
2006   <listitem>
2007 <para>Default:
2008 <amdefault>1</amdefault>.
2009 The maximum number of backups from a single host that Amanda will attempt to run in parallel.
2010 See also the main section parameter <amkeyword>inparallel</amkeyword>.</para>
2011   </listitem>
2012   </varlistentry>
2013   <varlistentry>
2014   <term><amkeyword>maxpromoteday</amkeyword> <amtype>int</amtype></term>
2015   <listitem>
2016 <para>Default:
2017 <amdefault>10000</amdefault>.
2018 The maximum number of day for a promotion, set it 0 if you don't want
2019 promotion, set it to 1 or 2 if your disks get overpromoted.</para>
2020   </listitem>
2021   </varlistentry>
2022   <varlistentry>
2023   <term><amkeyword>priority</amkeyword> [ <amkeyword>low</amkeyword> | <amkeyword>medium</amkeyword> | <amkeyword>high</amkeyword> ]</term>
2024   <listitem>
2025 <para>Default: <amkeyword>medium</amkeyword>.
2026 When there is no tape to write to, Amanda will do incremental backups
2027 in priority order to the holding disk. The priority may be
2028 high (2), medium (1), low (0) or a number of your choice.</para>
2029   </listitem>
2030   </varlistentry>
2031   <varlistentry>
2032   <term><amkeyword>program</amkeyword> [ <amkeyword>&quot;DUMP&quot;</amkeyword> | <amkeyword>&quot;GNUTAR&quot;</amkeyword> | <amkeyword>&quot;APPLICATION&quot;</amkeyword> ]</term>
2033   <listitem>
2034 <para>Default:
2035 <amdefault>&quot;DUMP&quot;</amdefault>.
2036 The type of backup to perform. Valid values are:</para>
2037   <!-- .RS -->
2038     <variablelist remap='TP'>
2039       <varlistentry>
2040       <term><amkeyword>&quot;DUMP&quot;</amkeyword></term>
2041       <listitem>
2042 <para>The native operating system backup program.</para>
2043       </listitem>
2044       </varlistentry>
2045       <varlistentry>
2046       <term><amkeyword>&quot;GNUTAR&quot;</amkeyword></term>
2047       <listitem>
2048 <para>To use GNU-tar or to do PC backups using Samba.</para>
2049       </listitem>
2050       </varlistentry>
2051       <varlistentry>
2052       <term><amkeyword>&quot;APPLICATION&quot;</amkeyword></term>
2053       <listitem>
2054 <para>To use an application, see the <emphasis>application</emphasis> option.</para>
2055       </listitem>
2056       </varlistentry>
2057     </variablelist>
2058   </listitem>
2059   </varlistentry>
2060   <varlistentry>
2061   <term><amkeyword>application</amkeyword> <amtype>string</amtype></term>
2062   <listitem>
2063 <para>No default. Must be the name of an application if <emphasis>program</emphasis> is set to <emphasis remap='I'>APPLICATION</emphasis>. See APPLICATION SECTION below.</para>
2064   </listitem>
2065   </varlistentry>
2066   <varlistentry>
2067   <term><amkeyword>script</amkeyword> <amtype>string</amtype></term>
2068   <listitem>
2069 <para>No default. Must be the name of a script. You can have many script. See SCRIPT SECTION below.</para>
2070   </listitem>
2071   </varlistentry>
2072   <varlistentry>
2073   <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
2074   <listitem>
2075 <para>These options can set various properties, they can be used by third
2076  party software to store information in the configuration file.
2077 Both strings are quoted; the first string contains the name of
2078 the property to set, and the others contains its values.
2079 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
2080 </para>
2081   </listitem>
2082   </varlistentry>
2083
2084   <varlistentry>
2085   <term><amkeyword>record</amkeyword> <amtype>boolean</amtype></term>
2086   <listitem>
2087 <para>Default:
2088 <amkeyword>yes</amkeyword>.
2089 Whether to ask the backup program to update its database (e.g. <filename>/etc/dumpdates</filename>
2090 for DUMP or <filename>/usr/local/var/amanda/gnutar-lists</filename> for GNUTAR) of time stamps.
2091 This is normally enabled for daily backups and turned off for periodic archival runs.</para>
2092   </listitem>
2093   </varlistentry>
2094   <varlistentry>
2095   <term><amkeyword>skip-full</amkeyword> <amtype>boolean</amtype></term>
2096   <listitem>
2097 <para>Default:
2098 <amkeyword>no</amkeyword>. If <amkeyword>true</amkeyword> and
2099 <emphasis remap='B'>planner</emphasis> has scheduled a full backup, these disks will be skipped, and
2100 full backups should be run off-line on these days. It was reported that Amanda only schedules
2101 level 1 incrementals in this configuration; this is probably a bug.</para>
2102   </listitem>
2103   </varlistentry>
2104   <varlistentry>
2105   <term><amkeyword>skip-incr</amkeyword> <amtype>boolean</amtype></term>
2106   <listitem>
2107 <para>Default:
2108 <amkeyword>no</amkeyword>. If <amkeyword>true</amkeyword> and
2109 <emphasis remap='B'>planner</emphasis> has scheduled an incremental backup, these disks will be skipped.</para>
2110   </listitem>
2111   </varlistentry>
2112   <varlistentry>
2113   <term><amkeyword>ssh-keys</amkeyword> <amtype>string</amtype></term>
2114   <listitem>
2115 <para>Default: not set.
2116 The key file the ssh auth will use, it must be the private key. If this parameter is not specified, then the default ssh key will be used.</para>
2117   </listitem>
2118   </varlistentry>
2119   <varlistentry>
2120   <term><amkeyword>starttime</amkeyword> <amtype>int</amtype></term>
2121   <listitem>
2122 <para>Default: not set.
2123 Backup of these disks will not start until after this time of day.
2124 The value should be hh*100+mm, e.g. 6:30PM (18:30) would be entered as
2125 <literal>1830</literal>.</para>
2126   </listitem>
2127   </varlistentry>
2128   <varlistentry>
2129   <term><amkeyword>strategy</amkeyword> [ <amkeyword>standard</amkeyword> | <amkeyword>nofull</amkeyword> | <amkeyword>noinc</amkeyword> | <amkeyword>skip</amkeyword> | <amkeyword>incronly</amkeyword> ]</term>
2130   <listitem>
2131   <para>Default: <amkeyword>standard</amkeyword>.
2132   Strategy to use when planning what level of backup to run next. Values are:</para>
2133
2134   <variablelist remap='TP'>
2135   <varlistentry>
2136   <term><amkeyword>standard</amkeyword></term>
2137   <listitem>
2138   <para>The standard Amanda schedule.</para>
2139   </listitem>
2140   </varlistentry>
2141   <varlistentry>
2142   <term><amkeyword>nofull</amkeyword></term>
2143   <listitem>
2144   <para>Never do full backups, only level 1 incrementals.</para>
2145   </listitem>
2146   </varlistentry>
2147   <varlistentry>
2148   <term><amkeyword>noinc</amkeyword></term>
2149   <listitem>
2150   <para>Never do incremental backups, only full dumps.</para>
2151   </listitem>
2152   </varlistentry>
2153   <varlistentry>
2154   <term><amkeyword>skip</amkeyword></term>
2155   <listitem>
2156   <para>Treat this DLE as if it doesn't exist (useful to disable DLEs
2157   when sharing the <emphasis remap='I'>disklist</emphasis> file between
2158   multiple configurations). Skipped DLEs will not be checked or
2159   dumped, and will not be matched by disklist expressions.</para>
2160   </listitem>
2161   </varlistentry>
2162   <varlistentry>
2163   <term><amkeyword>incronly</amkeyword></term>
2164   <listitem>
2165   <para>Only do incremental dumps. <command>amadmin force</command> should be used to tell
2166   Amanda that a full dump has been performed off-line, so that it resets to level 1.</para>
2167   </listitem>
2168   </varlistentry>
2169   </variablelist>
2170   </listitem>
2171   </varlistentry>
2172
2173   <varlistentry>
2174   <term><amkeyword>allow-split</amkeyword> <amtype>bool</amtype></term>
2175   <listitem>
2176 <para>Default: true.
2177 If true, then dumps with this dumptype can be split on the storage media.  If false, then
2178 the dump will be written in a single file on the media.  See "Dump Splitting Configuration"
2179 below.</para>
2180   </listitem>
2181   </varlistentry>
2182
2183   <varlistentry>
2184   <term><amkeyword>tape-splitsize</amkeyword> <amtype>int</amtype></term>
2185   <listitem>
2186       <para>Deprecated.  See "Dump Splitting Configuration" below.</para>
2187 <para>Default: not set.
2188 Split dump file on tape into pieces of a specified size.
2189 The default unit is Kbytes if it is not specified.</para>
2190   </listitem>
2191   </varlistentry>
2192
2193   <varlistentry>
2194   <term><amkeyword>split-diskbuffer</amkeyword> <amtype>string</amtype></term>
2195       <para>Deprecated.  See "Dump Splitting Configuration" below.</para>
2196   <listitem>
2197 <para>Default: not set.
2198 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.
2199 </para>
2200   </listitem>
2201   </varlistentry>
2202
2203   <varlistentry>
2204   <term><amkeyword>fallback-splitsize</amkeyword> <amtype>int</amtype></term>
2205   <listitem>
2206       <para>Deprecated.  See "Dump Splitting Configuration" below.</para>
2207 <para>Default:
2208 <amdefault>10M</amdefault>.
2209 This specifies the part size used when no <amkeyword>split-diskbuffer</amkeyword> is specified, or when it is too small or does not exist,
2210 and thus the maximum amount of memory consumed for in-memory splitting.
2211 The default unit is Kbytes if it is not specified.</para>
2212   </listitem>
2213   </varlistentry>
2214
2215   <varlistentry>
2216       <term><amkeyword>recovery-limit</amkeyword>
2217             [ <amkeyword>same-host</amkeyword> | <amtype>string</amtype> ]*</term>
2218   <listitem>
2219
2220 <para>Default: global value.  This parameter overrides the global
2221     <amkeyword>recovery-limit</amkeyword> parameter for DLEs of this
2222     dumptype.</para>
2223
2224   </listitem>
2225   </varlistentry>
2226 </variablelist>
2227
2228 <para>The following <amkeyword>dumptype</amkeyword> entries are predefined by Amanda:</para>
2229
2230 <programlisting remap='.nf'>
2231 define dumptype "no-compress" {
2232     compress none
2233 }
2234 define dumptype "compress-fast" {
2235     compress client fast
2236 }
2237 define dumptype "compress-best" {
2238     compress client best
2239 }
2240 define dumptype "srvcompress" {
2241     compress server fast
2242 }
2243 define dumptype "bsd-auth" {
2244     auth bsd
2245 }
2246 define dumptype "no-record" {
2247     record no
2248 }
2249 define dumptype "no-hold" {
2250     holdingdisk no
2251 }
2252 define dumptype "no-full" {
2253     skip-full yes
2254 }
2255 </programlisting>
2256
2257 <para>In addition to options in a
2258 <amkeyword>dumptype</amkeyword>
2259 section, one or more other
2260 <amkeyword>dumptype</amkeyword>
2261 names may be supplied as identifiers, which make this
2262 <amkeyword>dumptype</amkeyword>
2263 inherit options from other previously defined
2264 <amkeyword>dumptype</amkeyword>s.
2265 For instance, two sections might be the same except for the
2266 <amkeyword>record</amkeyword> option:</para>
2267
2268 <programlisting remap='.nf'>
2269 define dumptype "normal" {
2270     comment &quot;Normal backup, no compression, do indexing&quot;
2271     no-compress
2272     index yes
2273     maxdumps 2
2274 }
2275 define dumptype "testing" {
2276     comment &quot;Test backup, no compression, do indexing, no recording&quot;
2277     "normal"
2278     record no
2279 }
2280 </programlisting>
2281
2282 <para>Amanda provides a
2283 <amkeyword>dumptype</amkeyword>
2284 named
2285 <emphasis remap='I'>global</emphasis>
2286 in the sample
2287 <emphasis remap='B'>amanda.conf</emphasis>
2288 file that all
2289 <amkeyword>dumptype</amkeyword>s
2290 should reference.
2291 This provides an easy place to make changes that will affect every
2292 <amkeyword>dumptype</amkeyword>, although you must be careful
2293 that every dumptype explicitly inherits from the
2294 <emphasis remap='I'>global</emphasis>
2295 dumptype - Amanda does not do so automatically.</para>
2296 </refsect1>
2297
2298 <refsect1><title>TAPETYPE SECTION</title>
2299 <para>The <emphasis remap='B'>amanda.conf</emphasis>
2300 file may define multiple types of tape media and devices.
2301 The information is entered in a
2302 <amkeyword>tapetype</amkeyword>
2303 section, which looks like this in the config file:</para>
2304
2305 <programlisting>
2306 define tapetype "<amtype>name</amtype>" {
2307     <emphasis remap='I'>tapetype-option</emphasis> <emphasis remap='I'>tapetype-value</emphasis>
2308     <literal>...</literal>
2309 }
2310 </programlisting>
2311
2312 <para>The { must appear at the end of a line, and the } on its own line.</para>
2313 <para><emphasis remap='I'>Name</emphasis>
2314 is the name of this type of tape medium/device.
2315 It is referenced from the
2316 <amkeyword>tapetype</amkeyword>
2317 option in the main part of the config file.</para>
2318
2319 <para>The tapetype options and values are:</para>
2320 <variablelist remap='TP'>
2321   <varlistentry>
2322   <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2323   <listitem>
2324 <para>Default: not set.
2325 A comment string describing this set of tape information.</para>
2326   </listitem>
2327   </varlistentry>
2328   <varlistentry>
2329   <term><amkeyword>filemark</amkeyword> <amtype>int</amtype></term>
2330   <listitem>
2331 <para>Default:
2332 <amdefault>1 kbytes</amdefault>.
2333 How large a file mark (tape mark) is, measured in kbytes.
2334 If the size is only known in some linear measurement (e.g. inches),
2335 convert it to kbytes using the device density.</para>
2336   </listitem>
2337   </varlistentry>
2338   <varlistentry>
2339   <term><amkeyword>length</amkeyword> <amtype>int</amtype></term>
2340   <listitem>
2341 <para>Default:
2342 <amdefault>2000 kbytes</amdefault>. How much data will fit on a tape, expressed in kbytes.</para>
2343
2344 <para>Note that this value is only used by Amanda to schedule which backups will be run.
2345 Once the backups start, Amanda will continue to write to a tape until it gets an error,
2346 regardless of what value is entered for <amkeyword>length</amkeyword>
2347 (but see <manref name="amanda-devices" vol="7" /> for exceptions).
2348  </para>
2349   </listitem>
2350   </varlistentry>
2351
2352 <varlistentry>
2353 <term><amkeyword>blocksize</amkeyword> <amtype>int</amtype></term>
2354 <listitem>
2355 <para>Default:
2356 <amdefault>32 kbytes</amdefault>.
2357 How much data will be written in each tape record, expressed in kbytes.  This is similar to the <emphasis remap="I">BLOCK_SIZE</emphasis> device property, but if the blocksize is not a multiple of 1024 bytes, then this parameter cannot be used to specify it, and the property must be used instead.</para>
2358   </listitem>
2359   </varlistentry>
2360 <varlistentry>
2361 <term><amkeyword>readblocksize</amkeyword> <amtype>int</amtype></term>
2362 <listitem>
2363 <para>Default: <amdefault>32 kytes</amdefault>
2364 How much data will be read in each tape record.  This can be used to override a
2365 device's block size for reads only.  This may be useful, for example, in
2366 reading a tape written with a 256k block size when Amanda is configured to use
2367 128k blocks.  This unusual feature is not supported by all operating systems and
2368 tape devices.
2369 </para>
2370 <para>The default unit is Kbytes if it is not specified.</para>
2371   </listitem>
2372   </varlistentry>
2373
2374   <varlistentry>
2375   <term><amkeyword>part-size</amkeyword> <amtype>int</amtype></term>
2376   <listitem>
2377 <para>Default: none.  This is the size (in KB if no units are specified) of
2378 each split part written to the volume.  It is reduced to
2379 <amkeyword>part-cache-max-size</amkeyword> when part caching is required.
2380 If this is set to zero, then no splitting will take place; in this case,
2381 some devices can span dumps from volume to volume, while others will cause
2382 the entire dump to fail if they encounter end-of-medium before the dump is
2383 complete.  See "Dump Splitting Configuration" below.</para>
2384   </listitem>
2385   </varlistentry>
2386
2387   <varlistentry>
2388   <term><amkeyword>part-cache-type</amkeyword> [ <amkeyword>none</amkeyword> | <amkeyword>disk</amkeyword> | <amkeyword>memory</amkeyword> ] </term>
2389   <listitem>
2390 <para>Default: none.  When part caching is required, this parameter specifies
2391 the type of caching that will be used.  The options include no caching
2392 (<amkeyword>none</amkeyword>), in which case a failed part will cause the
2393 entire dump to fail; on-disk caching (<amkeyword>disk</amkeyword>), for
2394 which <amkeyword>part-cache-dir</amkeyword> must be set properly; and
2395 in-memory caching (<amkeyword>memory</amkeyword>), which on most systems
2396 severely restrains the size of the part that can be written.  See "Dump
2397 Splitting Configuration" below.</para>
2398   </listitem>
2399   </varlistentry>
2400
2401   <varlistentry>
2402   <term><amkeyword>part-cache-dir</amkeyword> <amtype>string</amtype></term>
2403   <listitem>
2404 <para>Default: none.
2405 The directory in which part-cache files can be written when caching on disk.
2406 See "Dump Splitting Configuration" below.</para>
2407   </listitem>
2408   </varlistentry>
2409
2410   <varlistentry>
2411   <term><amkeyword>part-cache-max-size</amkeyword> <amtype>int</amtype></term>
2412   <listitem>
2413 <para>Default: none.
2414 The maximum part size to use when caching is in effect.  This is used to limit
2415 the part size when disk or memory space for caching is constrained.  This value
2416 must be greater than zero.</para>
2417   </listitem>
2418   </varlistentry>
2419
2420   <varlistentry>
2421   <term><amkeyword>speed</amkeyword> <amtype>int</amtype></term>
2422   <listitem>
2423 <para>Default:
2424 <amdefault>200 bps</amdefault>.
2425 How fast the drive will accept data, in bytes per second.
2426 This parameter is NOT currently used by Amanda.</para>
2427   </listitem>
2428   </varlistentry>
2429   <varlistentry>
2430   <term><amkeyword>lbl-templ</amkeyword> <amtype>string</amtype></term>
2431   <listitem>
2432 <para>Default: not set.
2433 A PostScript template file used by
2434 <emphasis remap='B'>amreport</emphasis>
2435 to generate labels. Several sample files are provided with the Amanda sources in the
2436 <emphasis remap='I'>example</emphasis> directory.
2437 See the
2438 <manref name="amreport" vol="8"/>
2439 man page for more information.</para>
2440   </listitem>
2441   </varlistentry>
2442 </variablelist>
2443
2444 <para>In addition to options, another
2445 <amkeyword>tapetype</amkeyword>
2446 name may be supplied as an identifier, which makes this
2447 <amkeyword>tapetype</amkeyword>
2448 inherit options from another
2449 <amkeyword>tapetype</amkeyword>.
2450 For instance, the only difference between a DLT4000 tape drive using
2451 Compact-III tapes and one using Compact-IV tapes is the length of the tape.
2452 So they could be entered as:</para>
2453
2454 <programlisting remap='.nf'>
2455 define tapetype "DLT4000-III" {
2456     comment &quot;DLT4000 tape drives with Compact-III tapes&quot;
2457     length 12500 mbytes         # 10 Gig tapes with some compression
2458     filemark 2000 kbytes
2459     speed 1536 kps
2460 }
2461 define tapetype "DLT4000-IV" {
2462     "DLT4000-III"
2463     comment &quot;DLT4000 tape drives with Compact-IV tapes&quot;
2464     length 25000 mbytes         # 20 Gig tapes with some compression
2465 }
2466 </programlisting>
2467
2468 <!-- If anybody has read this, where do all those stupid
2469      pseudo-duplicate FOM-tapetype-entries come from??
2470         - sgw, Jan. 2005
2471 -->
2472
2473 </refsect1>
2474
2475 <refsect1><title>INTERFACE SECTION</title>
2476 <para>The
2477 <emphasis remap='B'>amanda.conf</emphasis>
2478 file may define multiple types of network interfaces.
2479 The information is entered in an <amkeyword>interface</amkeyword>
2480 section, which looks like this:</para>
2481
2482 <programlisting>
2483 define interface "<emphasis remap='I'>name</emphasis>" {
2484     <emphasis remap='I'>interface-option</emphasis> <emphasis remap='I'>interface-value</emphasis>
2485     <literal>...</literal>
2486 }
2487 </programlisting>
2488
2489 <para>The { must appear at the end of a line, and the } on its own line.</para>
2490 <para><emphasis remap='I'>name</emphasis>
2491 is the name of this type of network interface. It is referenced from the
2492 <emphasis remap='I'>disklist</emphasis> file.</para>
2493
2494 <para>Note that these sections define network interface characteristics,
2495 not the actual interface that will be used. Nor do they impose limits on the bandwidth that will
2496 actually be taken up by Amanda.
2497 Amanda computes the estimated bandwidth each file system backup will take
2498 based on the estimated size and time, then compares that plus any other running
2499 backups with the limit as another of the criteria when deciding whether
2500 to start the backup. Once a backup starts, Amanda will use as much of the network as it can
2501 leaving throttling up to the operating system and network hardware.</para>
2502
2503 <para>The interface options and values are:</para>
2504 <variablelist remap='TP'>
2505   <varlistentry>
2506   <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2507   <listitem>
2508 <para>Default: not set.
2509 A comment string describing this set of network information.</para>
2510   </listitem>
2511   </varlistentry>
2512   <varlistentry>
2513   <term><amkeyword>use</amkeyword> <amtype>int</amtype></term>
2514   <listitem>
2515 <para>Default:
2516 <amdefault>8000 Kbps</amdefault>.
2517 The speed of the interface in Kbytes per second.</para>
2518   </listitem>
2519   </varlistentry>
2520 </variablelist>
2521
2522 <para>In addition to options, another
2523 <amkeyword>interface</amkeyword>
2524 name may be supplied as an identifier, which makes this
2525 <amkeyword>interface</amkeyword>
2526 inherit options from another
2527 <amkeyword>interface</amkeyword>.
2528 At the moment, this is of little use.</para>
2529 </refsect1>
2530
2531 <refsect1><title>APPLICATION SECTION</title>
2532 <para>The
2533 <emphasis remap='B'>amanda.conf</emphasis>
2534 file may define multiple types of application.
2535 The information is entered in a <amkeyword>application</amkeyword>
2536 section, which looks like this:</para>
2537
2538 <programlisting>
2539 define application "<emphasis remap='I'>name</emphasis>" {
2540     <emphasis remap='I'>application-option</emphasis> <emphasis remap='I'>application-value</emphasis>
2541     <literal>...</literal>
2542 }
2543 </programlisting>
2544 <para>The { must appear at the end of a line, and the } on its own line.</para>
2545
2546 <para><emphasis remap='I'>name</emphasis>
2547 is the name of this type of application. It is referenced from the
2548 <emphasis remap='I'>dumptype</emphasis></para>
2549
2550 <para>The application options and values are:</para>
2551 <variablelist remap='TP'>
2552   <varlistentry>
2553   <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2554   <listitem>
2555 <para>Default: not set.
2556 A comment string describing this application.</para>
2557   </listitem>
2558   </varlistentry>
2559   <varlistentry>
2560   <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
2561   <listitem>
2562 <para>No default. Must be set to the name of the program. This program must be in the <emphasis remap='I'>$libexecdir/amanda/application</emphasis> directory on the client.</para>
2563   </listitem>
2564   </varlistentry>
2565   <varlistentry>
2566   <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] [<amkeyword>priority</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
2567   <listitem>
2568 <para>No default. You can set property for the application, each application have a different set of property. Both strings are quoted; the first string contains the name of
2569 the property to set, and the others contains its values.
2570 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
2571 <amkeyword>priority</amkeyword> keyword disallow the setting of that property on the client.
2572 </para>
2573   </listitem>
2574   </varlistentry>
2575 </variablelist>
2576 </refsect1>
2577
2578 <refsect1><title>SCRIPT SECTION</title>
2579 <para>The
2580 <emphasis remap='B'>amanda.conf</emphasis>
2581 file may define multiple types of script.
2582 The information is entered in a <amkeyword>script</amkeyword>
2583 section, which looks like this:</para>
2584
2585 <programlisting>
2586 define script "<emphasis remap='I'>name</emphasis>" {
2587     <emphasis remap='I'>script-option</emphasis> <emphasis remap='I'>script-value</emphasis>
2588     <literal>...</literal>
2589 }
2590 </programlisting>
2591 <para>The { must appear at the end of a line, and the } on its own line.</para>
2592
2593 <para><emphasis remap='I'>name</emphasis>
2594 is the name of this type of script. It is referenced from the
2595 <emphasis remap='I'>dumptype</emphasis></para>
2596
2597 <para>The script options and values are:</para>
2598 <variablelist remap='TP'>
2599   <varlistentry>
2600   <term><amkeyword>comment</amkeyword> <amtype>string</amtype></term>
2601   <listitem>
2602 <para>Default: not set.
2603 A comment string describing this script.</para>
2604   </listitem>
2605   </varlistentry>
2606   <varlistentry>
2607   <term><amkeyword>plugin</amkeyword> <amtype>string</amtype></term>
2608   <listitem>
2609 <para>No default. Must be set to the name of the program. This program must be in the <emphasis remap='I'>$libexecdir/amanda/application</emphasis> directory on the client and/or server.</para>
2610   </listitem>
2611   </varlistentry>
2612   <varlistentry>
2613   <term><amkeyword>order</amkeyword> <amtype>int</amtype></term>
2614   <listitem>
2615 <para>Default: <amdefault>5000</amdefault>. Scripts are executed in that order, it is useful if you have many scripts and they must be executed in a spefific order.</para>
2616   </listitem>
2617   </varlistentry>
2618   <varlistentry>
2619   <term><amkeyword>execute-where</amkeyword> [ <amkeyword>client</amkeyword> | <amkeyword>server</amkeyword> ]</term>
2620   <listitem>
2621 <para>Default: <amkeyword>client</amkeyword>. Where the script must be executed, on the client or server.</para>
2622   </listitem>
2623   </varlistentry>
2624   <varlistentry>
2625   <term><amkeyword>execute-on</amkeyword> <amtype>execute_on</amtype> [,<amtype>execute_on</amtype>]*</term>
2626   <listitem>
2627 <para>No default. When the script must be executed, you can specify many of them:</para>
2628     <!-- .RS -->
2629     <variablelist remap='TP'>
2630       <varlistentry>
2631       <term><amkeyword>pre-dle-amcheck</amkeyword></term>
2632       <listitem>
2633 <para>Execute before the amcheck command for the dle.</para>
2634       </listitem>
2635       </varlistentry>
2636       <varlistentry>
2637       <term><amkeyword>pre-host-amcheck</amkeyword></term>
2638       <listitem>
2639 <para>Execute before the amcheck command for all dle for the client.</para>
2640       </listitem>
2641       </varlistentry>
2642       <varlistentry>
2643       <term><amkeyword>post-dle-amcheck</amkeyword></term>
2644       <listitem>
2645 <para>Execute after the amcheck command for the dle.</para>
2646       </listitem>
2647       </varlistentry>
2648       <varlistentry>
2649       <term><amkeyword>post-host-amcheck</amkeyword></term>
2650       <listitem>
2651 <para>Execute after the amcheck command for all dle for the client.</para>
2652       </listitem>
2653       </varlistentry>
2654       <varlistentry>
2655       <term><amkeyword>pre-dle-estimate</amkeyword></term>
2656       <listitem>
2657 <para>Execute before the estimate command for the dle.</para>
2658       </listitem>
2659       </varlistentry>
2660       <varlistentry>
2661       <term><amkeyword>pre-host-estimate</amkeyword></term>
2662       <listitem>
2663 <para>Execute before the estimate command for all dle for the client.</para>
2664       </listitem>
2665       </varlistentry>
2666       <varlistentry>
2667       <term><amkeyword>post-dle-estimate</amkeyword></term>
2668       <listitem>
2669 <para>Execute after the estimate command for the dle.</para>
2670       </listitem>
2671       </varlistentry>
2672       <varlistentry>
2673       <term><amkeyword>post-host-estimate</amkeyword></term>
2674       <listitem>
2675 <para>Execute after the estimate command for all dle for the client.</para>
2676       </listitem>
2677       </varlistentry>
2678       <varlistentry>
2679       <term><amkeyword>pre-dle-backup</amkeyword></term>
2680       <listitem>
2681 <para>Execute before the backup command for the dle.</para>
2682       </listitem>
2683       </varlistentry>
2684       <varlistentry>
2685       <term><amkeyword>pre-host-backup</amkeyword></term>
2686       <listitem>
2687 <para>Execute before the backup command for all dle for the client. It can't be run on client, it must be run on server</para>
2688       </listitem>
2689       </varlistentry>
2690       <varlistentry>
2691       <term><amkeyword>post-dle-backup</amkeyword></term>
2692       <listitem>
2693 <para>Execute after the backup command for the dle.</para>
2694       </listitem>
2695       </varlistentry>
2696       <varlistentry>
2697       <term><amkeyword>post-host-backup</amkeyword></term>
2698       <listitem>
2699 <para>Execute after the backup command for all dle for the client. It can't be run on client, it must be run on server</para>
2700       </listitem>
2701       </varlistentry>
2702       <varlistentry>
2703       <term><amkeyword>pre-recover</amkeyword></term>
2704       <listitem>
2705 <para>Execute before any level is recovered.</para>
2706       </listitem>
2707       </varlistentry>
2708       <varlistentry>
2709       <term><amkeyword>post-recover</amkeyword></term>
2710       <listitem>
2711 <para>Execute after all levels are recovered.</para>
2712       </listitem>
2713       </varlistentry>
2714       <varlistentry>
2715       <term><amkeyword>pre-level-recover</amkeyword></term>
2716       <listitem>
2717 <para>Execute before each level recovery.</para>
2718       </listitem>
2719       </varlistentry>
2720       <varlistentry>
2721       <term><amkeyword>post-level-recover</amkeyword></term>
2722       <listitem>
2723 <para>Execute after each level recovery.</para>
2724       </listitem>
2725       </varlistentry>
2726       <varlistentry>
2727       <term><amkeyword>inter-level-recover</amkeyword></term>
2728       <listitem>
2729 <para>Execute between two levels of recovery.</para>
2730       </listitem>
2731       </varlistentry>
2732     </variablelist>
2733     <para>If you recover level 0 and 2 of the disk /usr with amrecover, it will execute:</para>
2734 <programlisting>
2735 script --pre-recover
2736 script --pre-level-recover --level 0
2737 #recovering level 0
2738 script --post-level-recover --level 0
2739 script --inter-level-recover --level 0 --level 2
2740 script --pre-level-recover --level 2
2741 #recovering level 2
2742 script --post-level-recover --level 2
2743 script --post-recover
2744 </programlisting>
2745   </listitem>
2746   </varlistentry>
2747   <varlistentry>
2748   <term><amkeyword>property</amkeyword> [<amkeyword>append</amkeyword>] [<amkeyword>priority</amkeyword>] <amtype>string</amtype> <amtype>string</amtype>+</term>
2749   <listitem>
2750 <para>No default. You can set property for the script, each script have a different set of property. Both strings are quoted; the first string contains the name of
2751 the property to set, and the others contains its values.
2752 <amkeyword>append</amkeyword> keyword append the values to the list of values for that property.
2753 <amkeyword>priority</amkeyword> keyword disallow the setting of that property on the client.
2754 </para>
2755   </listitem>
2756   </varlistentry>
2757 </variablelist>
2758 </refsect1>
2759
2760 <refsect1><title>DEVICE SECTION</title>
2761 <para>Backend storage devices are specified in
2762 <emphasis remap='B'>amanda.conf</emphasis>
2763 in the form of "device" sections, which look like this:</para>
2764
2765 <programlisting>
2766 define device <emphasis remap='I'>name</emphasis> {
2767     commend "<emphasis remap='I'>comment (optional)</emphasis>"
2768     tapedev "<emphasis remap='I'>device-specifier</emphasis>"
2769     device-property "<emphasis remap='I'>prop-name</emphasis>" "<emphasis remap='I'>prop-value</emphasis>"
2770     <literal>...</literal>
2771 }
2772 </programlisting>
2773
2774 <para>The { must appear at the end of a line, and the } on its own line.</para>
2775 <para><emphasis remap='I'>name</emphasis> is the user-specified name of
2776 this device. It is referenced from the global <emphasis
2777 remap='I'>tapedev</emphasis> parameter.  The <emphasis
2778 remap='I'>device-specifier</emphasis> specifies the device name to use;
2779 see <manref name="amanda-devices" vol="7"/>.
2780 As with most sections, the <emphasis remap='I'>comment</emphasis>
2781 parmeter is optional and only for the user's convenience.</para>
2782
2783 <para>An arbitrary number of <emphasis
2784 remap='I'>device-property</emphasis> parameters can be specified.
2785 Again, see
2786 <manref name="amanda-devices" vol="7"/>
2787 for information on device properties.</para>
2788
2789 </refsect1>
2790
2791 <refsect1><title>CHANGER SECTION</title>
2792 <para>Changers are described in
2793 <emphasis remap='B'>amanda.conf</emphasis>
2794 in the form of "changer" sections, which look like this:</para>
2795
2796 <programlisting>
2797 define changer <emphasis remap='I'>name</emphasis> {
2798     comment "<emphasis remap='I'>comment (optional)</emphasis>"
2799     tpchanger "<emphasis remap='I'>changer-spec</emphasis>"
2800     changerdev "<emphasis remap='I'>device-name</emphasis>"
2801     changerfile "<emphasis remap='I'>state-file</emphasis>"
2802     <literal>...</literal>
2803 }
2804 </programlisting>
2805
2806 <para>The { must appear at the end of a line, and the } on its own line.</para>
2807 <para><emphasis remap='I'>name</emphasis> is the user-specified name of this
2808 device. The remaining parameters are specific to the changer type selected.
2809 </para>
2810
2811 <para>See <manref name="amanda-changers" vol="7" /> for more information on configuring changers.</para>
2812
2813 </refsect1>
2814
2815 <refsect1><title>Dump Splitting Configuration</title>
2816
2817     <para>Amanda can "split" dumps into parts while writing them to storage
2818         media.  This allows Amanda to recover gracefully from a failure while
2819         writing a part to a volume, by simply selecting a new volume and
2820         re-writing the dump from the beginning of the failed part.  Parts also
2821         allow Amanda to seek directly to the required data, although this
2822         functionality is not yet used.</para>
2823
2824     <para>In order to support re-writing from the beginning of a failed part,
2825         Amanda must have access to the contents of the part after it has been
2826         partially written.  If the dump is being read from holding disk, then
2827         the part contents are availble there.  Otherwise, the part must be
2828         cached, and this can be done memory or on disk.  In either of the
2829         latter cases, the cache must have enough space to hold an entire
2830         part.</para>
2831
2832     <para>Because it is common for a single Amanda configuration to use both
2833         holding-disk (FILE-WRITE) and direct (known as PORT-WRITE) dumps, Amanda
2834         allows the configuration of different split sizes for the two cases.  This
2835         allows, for example, for a part size appropriate to large tapes when
2836         performing FILE-WRITE dumps, with a part size limited by available disk
2837         or memory when performing PORT-WRITE dumps.</para>
2838
2839     <para>Selecting a proper split size is a delicate matter.  If the parts are
2840         too large, substantial storage space may be wasted in failed parts.  If
2841         too small, large dumps will be split into innumerable tiny dumpfiles,
2842         adding to restoration complexity; furthermore, an excess of filemarks
2843         will cause slower tape drive operation and reduce the usable space on
2844         tape.  A good rule of thumb is 1/10 of the size of a volume of storage
2845         media.</para>
2846
2847     <para>In versions of Amanda through 3.1.*, splitting was controlled by the
2848         dumptype parameters <amkeyword>tape-splitsize</amkeyword>,
2849         <amkeyword>split-diskbuffer</amkeyword>, and
2850         <amkeyword>fallback-splitsize</amkeyword>.  These keywords had
2851         confusing and non-intuitive interactions, and have since been
2852         deprecated.</para>
2853
2854     <para>If the deprecated keywords are not present, subsequent versions
2855         of Amanda use the dumptype parameter
2856         <amkeyword>allow-split</amkeyword> to control whether a DLE can be
2857         split, and the <emphasis>tapetype</emphasis> parameters
2858         <amkeyword>part-size</amkeyword>,
2859         <amkeyword>part-cache-type</amkeyword>,
2860         <amkeyword>part-cache-dir</amkeyword>, and
2861         <amkeyword>part-cache-max-size</amkeyword>.  The
2862         <amkeyword>part-size</amkeyword> specifies the "normal" part size,
2863         while the <amkeyword>part-cache-*</amkeyword> parameters describe
2864         how to behave when caching is required (on PORT-WRITE).  Full
2865         details on these parameters are given above.</para>
2866
2867 </refsect1>
2868
2869 <seealso>
2870 <manref name="amanda-client.conf" vol="5"/>,
2871 <manref name="amanda-applications" vol="7"/>,
2872 <manref name="amanda-auth" vol="7"/>,
2873 <manref name="amanda-changers" vol="7"/>,
2874 <manref name="amanda-devices" vol="7"/>,
2875 <manref name="amanda-scripts" vol="7"/>
2876 </seealso>
2877
2878
2879 </refentry>
2880