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 '../entities/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 </refmeta>
  16 <refnamediv>
  17 <refname>amanda.conf</refname>
  18 <refpurpose>Main configuration file for &A;, the Advanced Maryland Automatic Network Disk Archiver</refpurpose>
  19 </refnamediv>
  20 <!-- body begins here -->
  21
  22 <refsect1><title>DESCRIPTION</title>
  23 <para>&amconf; is the main configuration file for &A;. This manpage lists the
  24 relevant sections and parameters of this file for quick reference.</para>
  25 <para> The file <emphasis remap='B'>&lt;CONFIG_DIR&gt;/&lt;config&gt;/amanda.conf</emphasis> is loaded.</para>
  26 </refsect1>
  27
  28 <refsect1><title>PARAMETERS</title>
  29
  30 <para>There are a number of configuration parameters that control the
  31 behavior of the &A; programs.
  32 All have default values,
  33 so you need not specify the parameter in
  34 <emphasis remap='B'>amanda.conf</emphasis>
  35 if the default is suitable.</para>
  36
  37 <para>Lines starting with # are ignored, as are blank lines.
  38 Comments may be placed on a line with a directive by starting
  39 the comment with a #.
  40 The remainder of the line is ignored.</para>
  41
  42 <para>Keywords are case insensitive, i.e.
  43 <emphasis remap='B'>mailto</emphasis>
  44 and
  45 <emphasis remap='B'>MailTo</emphasis>
  46 are treated the same.</para>
  47
  48 <para>Integer arguments may have one of the following (case insensitive) suffixes,
  49 some of which have a multiplier effect:</para>
  50
  51 <refsect2><title>POSSIBLE SUFFIXES</title>
  52
  53 <variablelist remap='TP'>
  54   <varlistentry>
  55   <term><emphasis remap='B'>b byte bytes</emphasis></term>
  56   <listitem>
  57 <para>Some number of bytes.</para>
  58   </listitem>
  59   </varlistentry>
  60   <varlistentry>
  61   <term><emphasis remap='B'>bps</emphasis></term>
  62   <listitem>
  63 <para>Some number of bytes per second.</para>
  64   </listitem>
  65   </varlistentry>
  66   <varlistentry>
  67   <term><emphasis remap='B'>k kb kbyte kbytes kilobyte kilobytes</emphasis></term>
  68   <listitem>
  69 <para>Some number of kilobytes (bytes*1024).</para>
  70   </listitem>
  71   </varlistentry>
  72   <varlistentry>
  73   <term><emphasis remap='B'>kps kbps</emphasis></term>
  74   <listitem>
  75 <para>Some number of kilobytes per second (bytes*1024).</para>
  76   </listitem>
  77   </varlistentry>
  78   <varlistentry>
  79   <term><emphasis remap='B'>m mb meg mbyte mbytes megabyte megabytes</emphasis></term>
  80   <listitem>
  81 <para>Some number of megabytes (bytes*1024*1024).</para>
  82   </listitem>
  83   </varlistentry>
  84   <varlistentry>
  85   <term><emphasis remap='B'>mps mbps</emphasis></term>
  86   <listitem>
  87 <para>Some number of megabytes per second (bytes*1024*1024).</para>
  88   </listitem>
  89   </varlistentry>
  90   <varlistentry>
  91   <term><emphasis remap='B'>g gb gbyte gbytes gigabyte gigabytes</emphasis></term>
  92   <listitem>
  93 <para>Some number of gigabytes (bytes*1024*1024*1024).</para>
  94   </listitem>
  95   </varlistentry>
  96   <varlistentry>
  97   <term><emphasis remap='B'>tape tapes</emphasis></term>
  98   <listitem>
  99 <para>Some number of tapes.</para>
 100   </listitem>
 101   </varlistentry>
 102   <varlistentry>
 103   <term><emphasis remap='B'>day days</emphasis></term>
 104   <listitem>
 105 <para>Some number of days.</para>
 106   </listitem>
 107   </varlistentry>
 108   <varlistentry>
 109   <term><emphasis remap='B'>week weeks</emphasis></term>
 110   <listitem>
 111 <para>Some number of weeks (days*7).</para>
 112
 113 <note><para>The value
 114 <emphasis remap='B'>inf</emphasis>
 115 may be used in most places where an integer is expected
 116 to mean an infinite amount.</para>
 117
 118 <para>Boolean arguments may have any of the values
 119 <emphasis remap='B'>y</emphasis>,
 120 <emphasis remap='B'>yes</emphasis>,
 121 <emphasis remap='B'>t</emphasis>,
 122 <emphasis remap='B'>true</emphasis>
 123 or
 124 <emphasis remap='B'>on</emphasis>
 125 to indicate a true state, or
 126 <emphasis remap='B'>n</emphasis>,
 127 <emphasis remap='B'>no</emphasis>,
 128 <emphasis remap='B'>f</emphasis>,
 129 <emphasis remap='B'>false</emphasis>
 130 or
 131 <emphasis remap='B'>off</emphasis>
 132 to indicate a false state.
 133 If no argument is given,
 134 <emphasis remap='B'>true</emphasis>
 135 is assumed.
 136 </para>
 137 </note>
 138   </listitem>
 139   </varlistentry>
 140 </variablelist>
 141 </refsect2>
 142
 143 <refsect2>
 144 <title>PARAMETERS</title>
 145
 146 <variablelist remap='TP'>
 147   <varlistentry>
 148   <term><emphasis remap='B'>org</emphasis> <emphasis remap='I'> string</emphasis></term>
 149   <listitem>
 150 <para>Default:
 151 <emphasis remap='I'>daily</emphasis>.
 152 A descriptive name for the configuration.
 153 This string appears in the Subject line of mail reports.
 154 Each &A; configuration should have a different string to keep
 155 mail reports distinct.</para>
 156   </listitem>
 157   </varlistentry>
 158   <varlistentry>
 159   <term><emphasis remap='B'>mailto</emphasis> <emphasis remap='I'> string</emphasis></term>
 160   <listitem>
 161 <para>Default:
 162 <emphasis remap='I'>operators</emphasis>.
 163 A space separated list of recipients for mail reports.</para>
 164   </listitem>
 165   </varlistentry>
 166   <varlistentry>
 167   <term><emphasis remap='B'>dumpcycle</emphasis> <emphasis remap='I'> int</emphasis></term>
 168   <listitem>
 169 <para>Default:
 170 <emphasis remap='I'>10 days</emphasis>.
 171 The number of days in the backup cycle.
 172 Each disk will get a full backup at least this often.
 173 Setting this to zero tries to do a full backup each run.</para>
 174 <note><para>This parameter may also be set in a specific
 175 <emphasis remap='B'>dumptype</emphasis>
 176 (see below).
 177 This value sets the default for all
 178 <emphasis remap='B'>dumptype</emphasis>s
 179 so must appear in
 180 <emphasis remap='B'>amanda.conf</emphasis>
 181 before any
 182 <emphasis remap='B'>dumptype</emphasis>s
 183 are defined.</para>
 184 </note>
 185   </listitem>
 186   </varlistentry>
 187
 188   <varlistentry>
 189   <term><emphasis remap='B'>runspercycle</emphasis> <emphasis remap='I'> int</emphasis></term>
 190   <listitem>
 191 <para>Default:
 192 <emphasis remap='I'>same as dumpcycle</emphasis>.
 193 The number of amdump runs in
 194 <emphasis remap='B'>dumpcycle</emphasis>
 195 days.
 196 A value of 0 means the same value as
 197 <emphasis remap='B'>dumpcycle</emphasis>.
 198 A value of -1 means guess the number of runs from the
 199 <emphasis remap='I'>tapelist</emphasis>
 200 file,
 201 which is the number of tapes used in the last
 202 <emphasis remap='B'>dumpcycle</emphasis>
 203 days /
 204 <emphasis remap='B'>runtapes</emphasis>.</para>
 205   </listitem>
 206   </varlistentry>
 207   <varlistentry>
 208   <term><emphasis remap='B'>tapecycle</emphasis> <emphasis remap='I'> int</emphasis></term>
 209   <listitem>
 210 <para>Default:
 211 <emphasis remap='I'>15 tapes</emphasis>.
 212 Typically tapes are used by &A; in an ordered rotation. The <emphasis remap='B'>tapecycle</emphasis> parameter
 213 defines the size of that rotation. The number of tapes in rotation must be larger than the number of tapes
 214 required for a complete dump cycle (see the <emphasis remap='B'>dumpcycle</emphasis> parameter).
 215 </para>
 216 <para>
 217 This is calculated by multiplying the number of &amdump; runs per dump cycle
 218 (<emphasis remap='B'>runspercycle</emphasis> parameter) times the number of tapes used per run
 219 (<emphasis remap='B'>runtapes</emphasis> parameter). Typically two to four times this calculated number of tapes are in rotation.
 220 While &A; is always willing to use a new tape in its rotation, it refuses to reuse a tape until at
 221 least '<emphasis remap='B'>tapecycle</emphasis> -1' number of other tapes have been used.
 222 </para>
 223 <para>
 224 It is considered good administrative practice to set the <emphasis remap='B'>tapecycle</emphasis> parameter
 225 slightly lower than the actual number of tapes in rotation. This allows the administrator to more easily cope
 226 with damaged or misplaced tapes or schedule adjustments that call for slight adjustments in the rotation order.
 227 </para>
 228   </listitem>
 229   </varlistentry>
 230
 231   <varlistentry>
 232   <term><emphasis remap='B'>usetimestamps</emphasis>
 233         <emphasis remap='I'> bool</emphasis></term>
 234     <listitem>
 235       <para>Default: <emphasis remap='B'>Yes</emphasis>.
 236 This option allows Amanda to track multiple runs per calendar
 237 day. The only reason one might disable it is that Amanda versions before 2.5.1
 238 can't read logfiles written when this option was enabled.
 239       </para>
 240     </listitem>
 241   </varlistentry>
 242
 243   <varlistentry>
 244   <term><emphasis remap='B'>label_new_tapes</emphasis>
 245         <emphasis remap='I'> string</emphasis></term>
 246 <listitem>
 247     <para>Default: not set.
 248 When set, this directive will cause &A; to automatically write an &A;
 249 tape label to any blank tape she encounters. This option is DANGEROUS
 250 because when set, &A; will ERASE any non-&A; tapes you may have, and may
 251 also ERASE any near-failing tapes. Use with caution.</para>
 252 <para>When using this directive, specify the template for new tape
 253 labels. The template should contain some number of contiguous '%'
 254 characters, which will be replaced with a generated number. Be sure to
 255 specify enough '%' characters that you do not run out of tape labels.
 256 Example:
 257 <markup>label_new_tapes "DailySet1-%%%"</markup>
 258 </para>
 259 </listitem>
 260 </varlistentry>
 261
 262   <varlistentry>
 263   <term><emphasis remap='B'>dumpuser</emphasis> <emphasis remap='I'> string</emphasis></term>
 264   <listitem>
 265 <para>Default:
 266 <emphasis remap='I'>amanda</emphasis>.
 267 The login name &A; uses to run the backups.
 268 The backup client hosts must allow access
 269 from the tape server host as this user via
 270 <markup>.rhosts</markup>
 271 or
 272 <markup>.amandahosts</markup>,
 273 depending on how the &A; software was built.</para>
 274   </listitem>
 275   </varlistentry>
 276   <varlistentry>
 277   <term><emphasis remap='B'>printer</emphasis> string</term>
 278   <listitem>
 279 <para>Printer to use when doing tape labels.
 280 See the
 281 <emphasis remap='B'>lbl-templ</emphasis>
 282 <emphasis remap='B'>tapetype</emphasis>
 283 option.</para>
 284   </listitem>
 285   </varlistentry>
 286
 287   <varlistentry>
 288   <term><emphasis remap='B'>tapedev</emphasis> string</term>
 289   <listitem>
 290 <para>Default:
 291 <filename>null:</filename>.
 292 The path name of the non-rewinding tape device.
 293 Non-rewinding tape device names often have an 'n' in the name,
 294 e.g.
 295 <filename>/dev/rmt/0mn</filename>,
 296 however this is operating system specific and you should consult
 297 that documentation for detailed naming information.</para>
 298
 299 <para>If a tape changer is configured
 300 (see the
 301 <emphasis remap='B'>tpchanger</emphasis>
 302 option), this option might not be used.</para>
 303
 304 <para>If the
 305 <emphasis remap='B'>null</emphasis>
 306 output driver is selected
 307 (see the section OUTPUT DRIVERS in the
 308 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 309 manpage for more information),
 310 programs such as
 311 &amdump;
 312 will run normally but all images will be thrown away.
 313 This should only be used for debugging and testing,
 314 and probably only with the
 315 <emphasis remap='B'>record</emphasis>
 316 option set to
 317 <emphasis remap='I'>no</emphasis>.</para>
 318   </listitem>
 319   </varlistentry>
 320
 321   <varlistentry>
 322   <term><emphasis remap='B'>device_property</emphasis> string string</term>
 323   <listitem>
 324 <para>These options can set various device properties, including block size,
 325 maximum volume usage, authentication information, hardware feature support,
 326 and more.Specifics of how properties are used are device-dependent, though
 327 some common properties are supported across multiple device drivers.</para>
 328
 329 <para> Both strings are quoted; the first string contains the name of
 330 the property to set, and the second contains its value. For example, to set
 331 a fixed block size of 128k, do:</para><programlisting>device_property "BLOCK_SIZE" "131072"</programlisting>
 332 <para></para>
 333 <para>The order in which device properties are set is as follows:
 334 <orderedlist><listitem><para>Tapetype parameters, including length, blocksize,
 335 readblocksize, file-pad, are translated into device properties and set
 336 accordingly.</para></listitem>
 337 <listitem><para>Device properties from any device_property configuration directives
 338 are set, in the order they appear in the configuration file.</para></listitem>
 339 </orderedlist></para>
 340   </listitem>
 341   </varlistentry>
 342
 343   <varlistentry>
 344   <term><emphasis remap='B'>tpchanger</emphasis> string</term>
 345   <listitem>
 346 <para>Default:
 347 <emphasis remap='I'>none</emphasis>.
 348 The name of the tape changer.
 349 If a tape changer is not configured, this option is not used
 350 and should be commented out of the configuration file.</para>
 351 <para>If a tape changer is configured, choose one of the changer scripts
 352 (e.g.  <emphasis remap='B'>chg-scsi</emphasis>)
 353 and enter that here.</para>
 354   </listitem>
 355   </varlistentry>
 356
 357   <varlistentry>
 358   <term><emphasis remap='B'>changerdev</emphasis> string</term>
 359   <listitem>
 360 <para>Default:
 361 <filename>/dev/null</filename>.
 362 A tape changer configuration parameter.
 363 Usage depends on the particular changer defined with the
 364 <emphasis remap='B'>tpchanger</emphasis>
 365 option.</para>
 366   </listitem>
 367   </varlistentry>
 368   <varlistentry>
 369   <term><emphasis remap='B'>changerfile</emphasis> string</term>
 370   <listitem>
 371 <para>Default:
 372 <filename>/usr/adm/amanda/log/changer-status</filename>.
 373 A tape changer configuration parameter.
 374 Usage depends on the particular changer defined with the
 375 <emphasis remap='B'>tpchanger</emphasis>
 376 option.</para>
 377   </listitem>
 378   </varlistentry>
 379   <varlistentry>
 380   <term><emphasis remap='B'>runtapes</emphasis> int</term>
 381   <listitem>
 382 <para>Default:
 383 <literal>1</literal>.
 384 The maximum number of tapes used in a single run.
 385 If a tape changer is not configured, this option is not used
 386 and should be commented out of the configuration file.</para>
 387 <para>If a tape changer is configured, this may be set larger than one to
 388 let &A; write to more than one tape.</para>
 389 <para>Note that this is an upper bound on the number of tapes,
 390 and &A; may use less.</para>
 391 <para>Also note that as of this release, &A; does not support true tape overflow.
 392 When it reaches the end of one tape,
 393 the backup image &A; was processing starts over again on the next tape.</para>
 394   </listitem>
 395   </varlistentry>
 396
 397   <varlistentry>
 398   <term><emphasis remap='B'>maxdumpsize</emphasis> int</term>
 399   <listitem>
 400 <para>Default:
 401 <emphasis remap='I'>runtapes</emphasis>*<emphasis remap='I'>tape_length</emphasis>.
 402 Maximum number of bytes the planner will schedule for a run.</para>
 403   </listitem>
 404   </varlistentry>
 405   <varlistentry>
 406   <term><emphasis remap='B'>taperalgo</emphasis> [first|firstfit|largest|largestfit|smallest|last]</term>
 407   <listitem>
 408 <para>Default:
 409 <emphasis remap='I'>first</emphasis>.
 410 The algorithm used to choose which dump image to send to the taper.</para>
 411   <!-- .RS -->
 412     <variablelist remap='TP'>
 413       <varlistentry>
 414       <term><emphasis remap='B'>first</emphasis></term>
 415       <listitem>
 416 <para>First in, first out.</para>
 417       </listitem>
 418       </varlistentry>
 419       <varlistentry>
 420       <term><emphasis remap='B'>firstfit</emphasis></term>
 421       <listitem>
 422 <para>The first dump image that will fit on the current tape.</para>
 423       </listitem>
 424       </varlistentry>
 425       <varlistentry>
 426       <term><emphasis remap='B'>largest</emphasis></term>
 427       <listitem>
 428 <para>The largest dump image.</para>
 429       </listitem>
 430       </varlistentry>
 431       <varlistentry>
 432       <term><emphasis remap='B'>largestfit</emphasis></term>
 433       <listitem>
 434 <para>The largest dump image that will fit on the current tape.</para>
 435       </listitem>
 436       </varlistentry>
 437       <varlistentry>
 438       <term><emphasis remap='B'>smallest</emphasis></term>
 439       <listitem>
 440 <para>The smallest dump image.</para>
 441       </listitem>
 442       </varlistentry>
 443       <varlistentry>
 444       <term><emphasis remap='B'>last</emphasis></term>
 445       <listitem>
 446 <para>Last in, first out.</para>
 447       </listitem>
 448       </varlistentry>
 449     </variablelist>
 450
 451   </listitem>
 452   </varlistentry>
 453 <varlistentry>
 454 <term><emphasis remap='B'>labelstr</emphasis> <emphasis remap='I'> string</emphasis></term>
 455 <listitem>
 456 <para>Default:
 457 <emphasis remap='I'>.*</emphasis>.
 458 The tape label constraint regular expression.
 459 All tape labels generated (see
 460 <citerefentry><refentrytitle>amlabel</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
 461 and used by this configuration must match the regular expression.
 462 If multiple configurations are run from the same tape server host,
 463 it is helpful to set their labels to different strings
 464 (for example, &quot;DAILY[0-9][0-9]*&quot; vs.
 465 &quot;ARCHIVE[0-9][0-9]*&quot;)
 466 to avoid overwriting each other's tapes.</para>
 467 </listitem>
 468 </varlistentry>
 469   <varlistentry>
 470   <term><emphasis remap='B'>tapetype</emphasis> <emphasis remap='I'> string</emphasis></term>
 471   <listitem>
 472 <para>Default:
 473 <emphasis remap='I'>EXABYTE</emphasis>.
 474 The type of tape drive associated with
 475 <emphasis remap='B'>tapedev</emphasis>
 476 or
 477 <emphasis remap='B'>tpchanger</emphasis>.
 478 This refers to one of the defined <emphasis remap='B'>tapetype</emphasis>s
 479 in the config file (see below), which specify various tape parameters,
 480 like the
 481 <emphasis remap='B'>length</emphasis>,
 482 <emphasis remap='B'>filemark</emphasis>
 483 size, and
 484 <emphasis remap='B'>speed</emphasis>
 485 of the tape media and device.</para>
 486 <para>First character of a <emphasis remap='B'>tapetype</emphasis> string must
 487 be an alphabetic character</para>
 488   </listitem>
 489   </varlistentry>
 490   <varlistentry>
 491   <term><emphasis remap='B'>ctimeout</emphasis> int</term>
 492   <listitem>
 493 <para>Default:
 494 <emphasis remap='I'>30 seconds</emphasis>.
 495 Maximum amount of time that
 496 <emphasis remap='B'>amcheck</emphasis>
 497 will wait for each client host.</para>
 498   </listitem>
 499   </varlistentry>
 500   <varlistentry>
 501   <term><emphasis remap='B'>dtimeout</emphasis> int</term>
 502   <listitem>
 503 <para>Default:
 504 <emphasis remap='I'>1800 seconds</emphasis>.
 505 Amount of idle time per disk on a given client that a
 506 <emphasis remap='B'>dumper</emphasis>
 507 running from within
 508 <command>amdump</command>
 509 will wait before it fails with a data timeout error.</para>
 510   </listitem>
 511   </varlistentry>
 512
 513   <varlistentry>
 514   <term><emphasis remap='B'>etimeout</emphasis> int</term>
 515   <listitem>
 516 <para>Default:
 517 <emphasis remap='I'>300 seconds</emphasis>.
 518 Amount of time per estimate on a given client that the
 519 <emphasis remap='B'>planner</emphasis> step of
 520 <command>amdump</command> will wait to get the dump size estimates
 521 (note: Amanda runs up to 3 estimates for each DLE).  For instance,
 522 with the default of 300 seconds and four DLE's, each estimating level
 523 0 and level 1 on client A, <emphasis remap='B'>planner</emphasis>
 524 will wait up to 40 minutes for that machine.  A negative value will
 525 be interpreted as a total amount of time to wait
 526 per client instead of per disk.</para>
 527   </listitem>
 528   </varlistentry>
 529
 530   <varlistentry>
 531   <term><emphasis remap='B'>connect_tries</emphasis> int</term>
 532   <listitem>
 533 <para>Default:
 534 <emphasis remap='I'>3</emphasis>.
 535 How many times the server will try a connection.</para>
 536   </listitem>
 537   </varlistentry>
 538
 539   <varlistentry>
 540   <term><emphasis remap='B'>req_tries</emphasis> int</term>
 541   <listitem>
 542 <para>Default:
 543 <emphasis remap='I'>3</emphasis>.
 544 How many times the server will resend a REQ packet if it doesn't get the ACK packet.</para>
 545   </listitem>
 546   </varlistentry>
 547
 548   <varlistentry>
 549   <term><emphasis remap='B'>netusage</emphasis> int</term>
 550   <listitem>
 551 <para>Default:
 552 <emphasis remap='I'>8000 Kbps</emphasis>.
 553 The maximum network bandwidth allocated to &A;, in Kbytes per second.
 554 See also the
 555 <emphasis remap='B'>interface</emphasis>
 556 section.</para>
 557   </listitem>
 558   </varlistentry>
 559   <varlistentry>
 560   <term><emphasis remap='B'>inparallel</emphasis> int</term>
 561   <listitem>
 562 <para>Default:
 563 <literal>10</literal>.
 564 The maximum number of backups that &A; will attempt to run in parallel.
 565 &A; will stay within the constraints of network bandwidth and
 566 holding disk space available, so it doesn't hurt to set
 567 this number a bit high. Some contention can occur with larger numbers
 568 of backups, but this effect is relatively small on most systems.</para>
 569   </listitem>
 570   </varlistentry>
 571
 572   <varlistentry>
 573   <term><emphasis remap='B'>displayunit</emphasis> &quot;k|m|g|t&quot;</term>
 574   <listitem>
 575 <para>Default:
 576 <literal>&quot;k&quot;</literal>.
 577 The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera.
 578 </para>
 579   </listitem>
 580   </varlistentry>
 581
 582   <varlistentry>
 583   <term><emphasis remap='B'>dumporder</emphasis> string</term>
 584   <listitem>
 585 <para>Default:
 586 <emphasis remap='I'>tttTTTTTTT</emphasis>.
 587 The priority order of each dumper:
 588
 589 <programlisting>
 590 s: smallest size
 591 S: largest size
 592 t: smallest time
 593 T: largest time
 594 b: smallest bandwidth
 595 B: largest bandwidth
 596 </programlisting></para>
 597
 598   </listitem>
 599   </varlistentry>
 600
 601   <varlistentry>
 602   <term><emphasis remap='B'>maxdumps</emphasis> int</term>
 603   <listitem>
 604 <para>Default:
 605 <literal>1</literal>.
 606 The maximum number of backups from a single host that &A; will
 607 attempt to run in parallel. See also the
 608 <emphasis remap='B'>inparallel</emphasis>
 609 option.</para>
 610
 611 <para>Note that this parameter may also be set in a specific
 612 <emphasis remap='B'>dumptype</emphasis>
 613 (see below).
 614 This value sets the default for all
 615 <emphasis remap='B'>dumptype</emphasis>s
 616 so must appear in
 617 <emphasis remap='B'>amanda.conf</emphasis>
 618 before any
 619 <emphasis remap='B'>dumptype</emphasis>s
 620 are defined.</para>
 621   </listitem>
 622   </varlistentry>
 623
 624   <varlistentry>
 625   <term><emphasis remap='B'>bumpsize</emphasis> int</term>
 626   <listitem>
 627 <para>Default:
 628 <emphasis remap='I'>10 Mbytes</emphasis>.
 629 The minimum savings required to trigger an automatic
 630 bump from one incremental level to the next, expressed as size.
 631 If &A; determines that the next higher backup level
 632 will be this much smaller than the current level,
 633 it will do the next level.
 634 The value of this parameter is used only if the parameter
 635 <emphasis>bumppercent</emphasis> is set to 0.
 636 </para>
 637 <para>
 638 The global setting of this parameter can be overwritten inside of a
 639 dumptype-definition.
 640 </para>
 641 <para>
 642 See also the options
 643 <emphasis remap='B'>bumppercent</emphasis>,
 644 <emphasis remap='B'>bumpmult</emphasis> and
 645 <emphasis remap='B'>bumpdays</emphasis>.</para>
 646   </listitem>
 647   </varlistentry>
 648
 649   <varlistentry>
 650   <term><emphasis remap='B'>bumppercent</emphasis> int</term>
 651   <listitem>
 652 <para>Default:
 653 <emphasis remap='I'>0 percent</emphasis>.
 654 The minimum savings required to trigger an automatic
 655 bump from one incremental level to the next, expressed as percentage of the
 656 current size of the DLE (size of current level 0).
 657 If &A; determines that the next higher backup level
 658 will be this much smaller than the current level,
 659 it will do the next level.
 660 </para>
 661 <para>
 662 If this parameter is set to 0, the value of the
 663 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
 664 </para>
 665 <para>
 666 The global setting of this parameter can be overwritten inside of a
 667 dumptype-definition.
 668 </para>
 669 <para>
 670 See also the options
 671 <emphasis remap='B'>bumpsize</emphasis>,
 672 <emphasis remap='B'>bumpmult</emphasis> and
 673 <emphasis remap='B'>bumpdays</emphasis>.</para>
 674   </listitem>
 675   </varlistentry>
 676
 677   <varlistentry>
 678   <term><emphasis remap='B'>bumpmult</emphasis> <emphasis remap='I'> float</emphasis></term>
 679   <listitem>
 680 <para>Default:
 681 <literal>1.5</literal>.
 682 The bump size multiplier.
 683 &A; multiplies
 684 <emphasis remap='B'>bumpsize</emphasis>
 685 by this factor for each level.
 686 This prevents active filesystems from
 687 bumping too much by making it harder to bump to the next level.
 688 For example, with the default
 689 <emphasis remap='B'>bumpsize</emphasis>
 690 and
 691 <emphasis remap='B'>bumpmult</emphasis>
 692 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
 693 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
 694 <para>
 695 The global setting of this parameter can be overwritten inside of a
 696 dumptype-definition.
 697 </para>
 698   </listitem>
 699   </varlistentry>
 700   <varlistentry>
 701   <term><emphasis remap='B'>bumpdays</emphasis> <emphasis remap='I'> int</emphasis></term>
 702   <listitem>
 703 <para>Default:
 704 <emphasis remap='I'>2 days</emphasis>.
 705 To insure redundancy in the dumps, &A; keeps filesystems at the
 706 same incremental level for at least
 707 <emphasis remap='B'>bumpdays</emphasis>
 708 days, even if the other bump threshold criteria are met.</para>
 709 <para>
 710 The global setting of this parameter can be overwritten inside of a
 711 dumptype-definition.
 712 </para>
 713   </listitem>
 714   </varlistentry>
 715
 716   <varlistentry>
 717   <term><emphasis remap='B'>diskfile</emphasis> <emphasis remap='I'> string</emphasis></term>
 718   <listitem>
 719 <para>Default:
 720 <emphasis remap='I'>disklist</emphasis>.
 721 The file name for the
 722 <emphasis remap='I'>disklist</emphasis>
 723 file holding client hosts, disks and other client dumping information.</para>
 724   </listitem>
 725   </varlistentry>
 726   <varlistentry>
 727   <term><emphasis remap='B'>infofile</emphasis> <emphasis remap='I'> string</emphasis></term>
 728   <listitem>
 729 <para>Default:
 730 <filename>/usr/adm/amanda/curinfo</filename>.
 731 The file or directory name for the historical information database.
 732 If &A; was configured to use DBM databases, this is the base file
 733 name for them.
 734 If it was configured to use text formated databases (the default),
 735 this is the base directory and within here will be a directory per
 736 client, then a directory per disk, then a text file of data.</para>
 737   </listitem>
 738   </varlistentry>
 739   <varlistentry>
 740   <term><emphasis remap='B'>logdir</emphasis> <emphasis remap='I'> string</emphasis></term>
 741   <listitem>
 742 <para>Default:
 743 <filename>/usr/adm/amanda</filename>.
 744 The directory for the
 745 <command>amdump</command>
 746 and
 747 <emphasis remap='B'>log</emphasis>
 748 files.</para>
 749   </listitem>
 750   </varlistentry>
 751   <varlistentry>
 752   <term><emphasis remap='B'>indexdir</emphasis> <emphasis remap='I'> string</emphasis></term>
 753   <listitem>
 754 <para>Default
 755 <filename>/usr/adm/amanda/index</filename>.
 756 The directory where index files (backup image catalogues) are stored.
 757 Index files are
 758 only generated for filesystems whose
 759 <emphasis remap='B'>dumptype</emphasis>
 760 has the
 761 <emphasis remap='B'>index</emphasis>
 762 option enabled.</para>
 763   </listitem>
 764   </varlistentry>
 765   <varlistentry>
 766   <term><emphasis remap='B'>tapelist</emphasis> <emphasis remap='I'> string</emphasis></term>
 767   <listitem>
 768 <para>Default:
 769 <emphasis remap='I'>tapelist</emphasis>.
 770 The file name for the active
 771 <emphasis remap='I'>tapelist</emphasis>
 772 file.
 773 &A; maintains this file with information about the active set of tapes.</para>
 774   </listitem>
 775   </varlistentry>
 776   <varlistentry>
 777   <term><emphasis remap='B'>device_output_buffer_size</emphasis> <emphasis remap='I'> int</emphasis></term>
 778   <listitem>
 779 <para>Default:
 780 <literal>640k</literal>.
 781 Controls the amount of memory used by &A;
 782 to hold data as it is read from the network or disk before it is written to
 783 the output device. Higher values may be
 784 useful on fast tape drives and optical media.</para>
 785   </listitem>
 786   </varlistentry>
 787   <varlistentry>
 788   <term><emphasis remap='B'>tapebufs</emphasis> <emphasis remap='I'> int</emphasis></term>
 789   <listitem>
 790 <para>Default:
 791 <literal>20</literal>.
 792 This option is deprecated; use
 793 the <emphasis remap='B'>device_output_buffer_size</emphasis> directive
 794 instead. <emphasis remap='B'>tapebufs</emphasis> works the same way,
 795 but the number specified is multiplied by the device blocksize prior
 796 to use.</para>
 797   </listitem>
 798   </varlistentry>
 799   <varlistentry>
 800   <term><emphasis remap='B'>reserve</emphasis> <emphasis remap='I'> number</emphasis></term>
 801   <listitem>
 802 <para>Default:
 803 <literal>100</literal>.
 804 The part of holding-disk space that should be reserved for incremental
 805 backups if no tape is available, expressed as a percentage of the
 806 available holding-disk space (0-100).
 807 By default, when there is no tape to write to, degraded mode (incremental) backups
 808 will be performed to the holding disk. If full backups should also be allowed in this case,
 809 the amount of holding disk space reserved for incrementals should be lowered.</para>
 810   </listitem>
 811   </varlistentry>
 812   <varlistentry>
 813   <term><emphasis remap='B'>autoflush</emphasis> <emphasis remap='I'> bool</emphasis></term>
 814   <listitem>
 815 <para>Default:
 816 <emphasis remap='I'>off</emphasis>.
 817 Whether an amdump run will flush the dumps from holding disk to tape.</para>
 818   </listitem>
 819   </varlistentry>
 820   <varlistentry>
 821   <term><emphasis remap='B'>amrecover_do_fsf</emphasis> <emphasis remap='I'> bool</emphasis></term>
 822   <listitem>
 823 <para>Default:
 824 <emphasis remap='I'>on</emphasis>.
 825 Amrecover will call amrestore with the -f flag for faster positioning of the tape.</para>
 826   </listitem>
 827   </varlistentry>
 828   <varlistentry>
 829   <term><emphasis remap='B'>amrecover_check_label</emphasis> <emphasis remap='I'> bool</emphasis></term>
 830   <listitem>
 831 <para>Default:
 832 <emphasis remap='I'>on</emphasis>.
 833 Amrecover will call amrestore with the -l flag to check the label.</para>
 834   </listitem>
 835   </varlistentry>
 836   <varlistentry>
 837   <term><emphasis remap='B'>amrecover_changer</emphasis> <emphasis remap='I'> string</emphasis></term>
 838   <listitem>
 839 <para>Default: ''.
 840 Amrecover will use the changer if you use 'settape &lt;string&gt;' and that string
 841 is the same as the amrecover_changer setting.</para>
 842   </listitem>
 843   </varlistentry>
 844   <varlistentry>
 845   <term><emphasis remap='B'>columnspec</emphasis> <emphasis remap='I'> string</emphasis></term>
 846   <listitem>
 847 <para>Defines the width of columns <emphasis remap='B'>amreport</emphasis>
 848 should use.
 849 <emphasis remap='I'>String</emphasis>
 850 is a comma (',') separated list of triples. Each triple consists
 851 of three parts which are separated by a equal sign ('=') and a colon (':') (see the example).
 852 These three parts specify:</para>
 853
 854   <orderedlist>
 855   <listitem>
 856       <para>the name of the column, which may be:</para>
 857
 858         <programlisting>
 859         Compress (compression ratio)
 860         Disk (client disk name)
 861         DumpRate (dump rate in KBytes/sec)
 862         DumpTime (total dump time in hours:minutes)
 863         HostName (client host name)
 864         Level (dump level)
 865         OrigKB (original image size in KBytes)
 866         OutKB (output image size in KBytes)
 867         TapeRate (tape writing rate in KBytes/sec)
 868         TapeTime (total tape time in hours:minutes)
 869         </programlisting>
 870
 871   </listitem>
 872
 873   <listitem>
 874 <para>the amount of space to display before the column (used to get whitespace between columns).</para><para/>
 875   </listitem>
 876   <listitem>
 877 <para>the width of the column itself.
 878 If set to a negative value, the width will be calculated on demand to fit the largest entry in
 879 this column.</para>
 880   </listitem>
 881   </orderedlist>
 882
 883 <para>Here is an example:
 884 <programlisting>
 885 columnspec &quot;Disk=1:18,HostName=0:10,OutKB=1:7&quot;
 886 </programlisting></para>
 887 <para>
 888 The above will display the disk information in 18 characters
 889 and put one space before it. The hostname column will be 10 characters wide with
 890 no space to the left. The output KBytes column is seven characters wide
 891 with one space before it.</para>
 892   </listitem>
 893   </varlistentry>
 894
 895   <varlistentry>
 896   <term><emphasis remap='B'>includefile</emphasis> <emphasis remap='I'> string</emphasis></term>
 897   <listitem>
 898 <para>Default:
 899 <emphasis remap='I'>none</emphasis>.
 900 The name of an &A; configuration file to include within the current file.
 901 Useful for sharing dumptypes, tapetypes and interface definitions among several configurations.
 902 Relative pathnames are relative to the configuration directory.
 903 </para>
 904   </listitem>
 905   </varlistentry>
 906
 907   <varlistentry>
 908   <term><emphasis remap='B'>debug_auth</emphasis> int</term>
 909   <listitem>
 910 <para>Default:
 911 <emphasis remap='I'>0</emphasis>.
 912 Debug level of the auth module</para>
 913   </listitem>
 914   </varlistentry>
 915
 916   <varlistentry>
 917   <term><emphasis remap='B'>debug_event</emphasis> int</term>
 918   <listitem>
 919 <para>Default:
 920 <emphasis remap='I'>0</emphasis>.
 921 Debug level of the event module</para>
 922   </listitem>
 923   </varlistentry>
 924
 925   <varlistentry>
 926   <term><emphasis remap='B'>debug_holding</emphasis> int</term>
 927   <listitem>
 928 <para>Default:
 929 <emphasis remap='I'>0</emphasis>.
 930 Debug level of the holdingdisk module</para>
 931   </listitem>
 932   </varlistentry>
 933
 934   <varlistentry>
 935   <term><emphasis remap='B'>debug_protocol</emphasis> int</term>
 936   <listitem>
 937 <para>Default:
 938 <emphasis remap='I'>0</emphasis>.
 939 Debug level of the protocol module</para>
 940   </listitem>
 941   </varlistentry>
 942
 943   <varlistentry>
 944   <term><emphasis remap='B'>debug_planner</emphasis> int</term>
 945   <listitem>
 946 <para>Default:
 947 <emphasis remap='I'>0</emphasis>.
 948 Debug level of the planner process</para>
 949   </listitem>
 950   </varlistentry>
 951
 952   <varlistentry>
 953   <term><emphasis remap='B'>debug_driver</emphasis> int</term>
 954   <listitem>
 955 <para>Default:
 956 <emphasis remap='I'>0</emphasis>.
 957 Debug level of the driver process</para>
 958   </listitem>
 959   </varlistentry>
 960
 961   <varlistentry>
 962   <term><emphasis remap='B'>debug_dumper</emphasis> int</term>
 963   <listitem>
 964 <para>Default:
 965 <emphasis remap='I'>0</emphasis>.
 966 Debug level of the dumper process</para>
 967   </listitem>
 968   </varlistentry>
 969
 970   <varlistentry>
 971   <term><emphasis remap='B'>debug_chunker</emphasis> int</term>
 972   <listitem>
 973 <para>Default:
 974 <emphasis remap='I'>0</emphasis>.
 975 Debug level of the chunker process</para>
 976   </listitem>
 977   </varlistentry>
 978
 979   <varlistentry>
 980   <term><emphasis remap='B'>debug_taper</emphasis> int</term>
 981   <listitem>
 982 <para>Default:
 983 <emphasis remap='I'>0</emphasis>.
 984 Debug level of the taper process</para>
 985   </listitem>
 986   </varlistentry>
 987
 988   <varlistentry>
 989   <term><emphasis remap='B'>flush-threshold-dumped</emphasis> int</term>
 990   <listitem>
 991 <para>Default: <emphasis remap='I'>0</emphasis>.
 992   &A; will not begin writing data to a new volume until the amount of
 993   data on the holding disk is at least this percentage of the volume
 994   size. In other words, &A; will not begin until the
 995   inequality <inlineequation><mathphrase>h &lt; t &#215;
 996   d</mathphrase></inlineequation> is satisfied,
 997   where <mathphrase>h</mathphrase> is the amount of data on the
 998   holding disk, <mathphrase>t</mathphrase> is the capacity of a
 999   volume, and <mathphrase>d</mathphrase> is this parameter, expressed as a
1000   percentage.</para>
1001 <para> Needless to say, your holding disk must be big enough
1002   that this criterion could be satisfied. If the holding disk cannot
1003   be used for a particular dump (because, for example, there is no
1004   remaining holding space) then &A; will disregard the constraint
1005   specified by this setting and start a new volume anyway. Once
1006   writing to a volume has begun, this constraint is not applied unless
1007   and until a new volume is needed.</para>
1008 <para> The value of this parameter may not exceed than that of
1009   the <emphasis remap='B'>flush-threshold-scheduled</emphasis>
1010   parameter.</para>
1011   </listitem>
1012   </varlistentry>
1013
1014   <varlistentry>
1015   <term><emphasis remap='B'>flush-threshold-scheduled</emphasis> int</term>
1016   <listitem>
1017 <para>Default: <emphasis remap='I'>0</emphasis>.
1018   &A; will not begin writing data to a new volume until the sum of the
1019   amount of data on the holding disk and the estimated amount of data
1020   remaining to be dumped during this run is at least this percentage
1021   of the volume size. In other words, &A; will not begin until the
1022   inequality <inlineequation><mathphrase>h + s &lt; t &#215;
1023   d</mathphrase></inlineequation> is satisfied,
1024   where <mathphrase>h</mathphrase> is the amount of data on the
1025   holding disk, <mathphrase>s</mathphrase> is the total amount of
1026   data scheduled for this run but not dumped
1027   yet, <mathphrase>t</mathphrase> is the capacity of a volume,
1028   and <mathphrase>d</mathphrase> is this parameter, expressed as a
1029   percentage.</para>
1030 <para>  Needless to say, your holding disk must be big enough
1031   that this criterion could be satisfied. If the holding disk cannot
1032   be used for a particular dump (because, for example, there is no
1033   remaining holding space) then &A; will disregard the constraint
1034   specified by this setting and start a new volume anyway.  Once
1035   writing to a volume has begun, this constraint is not applied unless
1036   and until a new volume is needed.</para>
1037 <para> The value of this parameter may not be less than that of
1038   the <emphasis remap='B'>flush-threshold-dumped</emphasis>
1039   or <emphasis remap='B'>taperflush</emphasis> parameters.</para>
1040   </listitem>
1041   </varlistentry>
1042
1043 <!-- the entity '#215' below is U+00D7 MULTIPLICATION SIGN; the 'times' entity
1044      is not as portable as one might hope. -->
1045   <varlistentry>
1046   <term><emphasis remap='B'>taperflush</emphasis> int</term>
1047   <listitem>
1048 <para>Default: <emphasis remap='I'>0</emphasis>.
1049   At the end of a run, &A; will start a new tape to flush remaining
1050   data if there is more data on the holding disk at the end of a run
1051   than this setting allows; the amount is specified as a percentage of
1052   the capacity of a single
1053   volume. In other words, at the end of a run, &A; will begin
1054   a new tape if the
1055   inequality <inlineequation><mathphrase>h &lt; t &#215;
1056   f</mathphrase></inlineequation> is satisfied,
1057   where <mathphrase>h</mathphrase> is the amount of data remaining on the
1058   holding disk from this or previous runs, <mathphrase>t</mathphrase>
1059   is the capacity of a volume,
1060   and <mathphrase>f</mathphrase> is this parameter, expressed as a
1061   percentage.</para>
1062 <para> The value of this parameter may not exceed that of
1063   the <emphasis remap='B'>flush-threshold-scheduled</emphasis>
1064   parameter.; <emphasis remap='B'>autoflush</emphasis> must be set to 'yes' if
1065  <emphasis remap='B'>taperflush</emphasis> is greater than 0.</para>
1066   </listitem>
1067   </varlistentry>
1068
1069   <varlistentry>
1070   <term><emphasis remap='B'>reserved-udp-port</emphasis> int,int</term>
1071   <listitem>
1072 <para>Default: --with-udpportrange or
1073 <emphasis remap='I'>512,1023</emphasis>.
1074 Reserved udp port that will be used (bsd, bsdudp).
1075 Range is inclusive.</para>
1076   </listitem>
1077   </varlistentry>
1078
1079   <varlistentry>
1080   <term><emphasis remap='B'>reserved-tcp-port</emphasis> int,int</term>
1081   <listitem>
1082 <para>Default: --with-low-tcpportrange or
1083 <emphasis remap='I'>512,1023</emphasis>.
1084 Reserved tcp port that will be used (bsdtcp).
1085 Range is inclusive.</para>
1086   </listitem>
1087   </varlistentry>
1088
1089   <varlistentry>
1090   <term><emphasis remap='B'>unreserved-tcp-port</emphasis> int,int</term>
1091   <listitem>
1092 <para>Default: --with-tcpportrange or
1093 <emphasis remap='I'>1024,65535</emphasis>.
1094 Unreserved tcp port that will be used (bsd, bsdudp).
1095 Range is inclusive.</para>
1096   </listitem>
1097   </varlistentry>
1098
1099 </variablelist>
1100 </refsect2>
1101 </refsect1>
1102
1103 <refsect1><title>HOLDINGDISK SECTION</title>
1104 <para>The <emphasis remap='B'>amanda.conf</emphasis>
1105 file may define one or more holding disks used as buffers to hold
1106 backup images before they are written to tape.
1107 The syntax is:</para>
1108
1109 <programlisting>
1110 holdingdisk <emphasis remap='I'>name</emphasis> {
1111     <emphasis remap='I'>holdingdisk-option</emphasis> <emphasis remap='I'>holdingdisk-value</emphasis>
1112     <literal>...</literal>
1113 }
1114 </programlisting>
1115
1116 <para><emphasis remap='I'>Name</emphasis>
1117 is a logical name for this holding disk.</para>
1118
1119 <para>The options and values are:</para>
1120
1121 <variablelist remap='TP'>
1122   <varlistentry>
1123   <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
1124   <listitem>
1125 <para>Default:
1126 <emphasis remap='I'>none</emphasis>.
1127 A comment string describing this holding disk.</para>
1128   </listitem>
1129   </varlistentry>
1130
1131   <varlistentry>
1132   <term><emphasis remap='B'>directory</emphasis> <emphasis remap='I'> disk</emphasis></term>
1133   <listitem>
1134 <para>Default:
1135 <filename>/dumps/amanda</filename>.
1136 The path to this holding area.</para>
1137   </listitem>
1138   </varlistentry>
1139
1140   <varlistentry>
1141   <term><emphasis remap='B'>use</emphasis> <emphasis remap='I'> int</emphasis></term>
1142   <listitem>
1143 <para>Default:
1144 <emphasis remap='I'>0 Gb</emphasis>.
1145 Amount of space that can be used in this holding disk area.
1146 If the value is zero, all available space on the file system is used.
1147 If the value is negative, &A; will use all available space minus that value.</para>
1148   </listitem>
1149   </varlistentry>
1150
1151   <varlistentry>
1152   <term><emphasis remap='B'>chunksize</emphasis> <emphasis remap='I'> int</emphasis></term>
1153   <listitem>
1154 <para>Default:
1155 <emphasis remap='I'>1 Gb</emphasis>.
1156 Holding disk chunk size. Dumps larger than the specified size will be stored in multiple
1157 holding disk files. The size of each chunk will not exceed the specified value.
1158 However, even though dump images are split in the holding disk, they are concatenated as
1159 they are written to tape, so each dump image still corresponds to a single continuous
1160 tape section.</para>
1161
1162 <para>If 0 is specified, &A; will create holding disk chunks as large as
1163 ((INT_MAX/1024)-64) Kbytes.</para>
1164
1165 <para>Each holding disk chunk includes a 32 Kbyte header, so the minimum
1166 chunk size is 64 Kbytes (but that would be really silly).</para>
1167
1168 <para>Operating systems that are limited to a maximum file size of 2 Gbytes
1169 actually cannot handle files that large.
1170 They must be at least one byte less than 2 Gbytes.
1171 Since &A; works with 32 Kbyte blocks, and
1172 to handle the final read at the end of the chunk, the chunk size
1173 should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum
1174 file size, e.g. 2047 Mbytes.</para>
1175   </listitem>
1176   </varlistentry>
1177 </variablelist>
1178 </refsect1>
1179
1180 <refsect1><title>DUMPTYPE SECTION</title>
1181 <para>The &amconf; file may define multiple sets of backup options
1182 and refer to them by name from the &disklist; file.
1183 For instance, one set of options might be defined for file systems
1184 that can benefit from high compression, another set that does not compress well,
1185 another set for file systems that should always get a full backup and so on.</para>
1186
1187 <para>A set of backup options are entered in a
1188 <emphasis remap='B'>dumptype</emphasis>
1189 section, which looks like this:</para>
1190
1191 <programlisting>
1192 define dumptype <emphasis remap='I'>name</emphasis> {
1193     <emphasis remap='I'>dumptype-option</emphasis> <emphasis remap='I'>dumptype-value</emphasis>
1194     <literal>...</literal>
1195 }
1196 </programlisting>
1197
1198 <para><emphasis remap='I'>Name</emphasis>
1199 is the name of this set of backup options.
1200 It is referenced from the &disklist; file.</para>
1201
1202 <para>Some of the options in a
1203 <emphasis remap='B'>dumptype</emphasis>
1204 section are the same as those in the main part of &amconf;.
1205 The main option value is used to set the default for all
1206 <emphasis remap='B'>dumptype</emphasis>
1207 sections. For instance, setting
1208 <emphasis remap='B'>dumpcycle</emphasis>
1209 to 50 in the main part of the config file causes all following
1210 <emphasis remap='B'>dumptype</emphasis>
1211 sections to start with that value,
1212 but the value may be changed on a section by section basis.
1213 Changes to variables in the main part of the config file must be
1214 done before (earlier in the file) any
1215 <emphasis remap='B'>dumptype</emphasis>s
1216 are defined.</para>
1217
1218 <para>The dumptype options and values are:</para>
1219
1220 <variablelist remap='TP'>
1221   <varlistentry>
1222   <term><emphasis remap='B'>auth</emphasis> <emphasis remap='I'> string</emphasis></term>
1223   <listitem>
1224 <para>Default:
1225 <emphasis remap='I'>bsd</emphasis>.
1226 Type of authorization to perform between tape server and backup client hosts.</para>
1227 <para><emphasis remap='B'>bsd</emphasis>, bsd authorization with udp initial
1228 connection and one tcp connection by data stream.</para>
1229 <para><emphasis remap='B'>bsdtcp</emphasis>, bsd authorization but use only
1230 one tcp connection.</para>
1231 <para><emphasis remap='B'>bsdudp</emphasis>, like bsd, but will use only one
1232 tcp connection for all data stream.</para>
1233 <para><emphasis remap='B'>krb4</emphasis> to use Kerberos-IV
1234 authorization.</para>
1235 <para><emphasis remap='B'>krb5</emphasis> to use Kerberos-V
1236 authorization.</para>
1237 <para><emphasis remap='B'>local</emphasis>, if the client is the server, it
1238 doesn't require authencation setup.</para>
1239 <para><emphasis remap='B'>rsh</emphasis> to use rsh
1240 authorization.</para>
1241 <para><emphasis remap='B'>ssh</emphasis> to use OpenSSH
1242 authorization.</para>
1243
1244   </listitem>
1245   </varlistentry>
1246
1247   <varlistentry>
1248   <term><emphasis remap='B'>amandad_path</emphasis> <emphasis remap='I'> string</emphasis></term>
1249   <listitem>
1250 <para>Default:
1251 <emphasis remap='I'>$libexec/amandad</emphasis>.
1252 Specify the amandad path of the client, only use with rsh/ssh authentification.
1253 </para>
1254   </listitem>
1255   </varlistentry>
1256
1257   <varlistentry>
1258   <term><emphasis remap='B'>client_username</emphasis> <emphasis remap='I'> string</emphasis></term>
1259   <listitem>
1260 <para>Default:
1261 <emphasis remap='I'>CLIENT_LOGIN</emphasis>.
1262 Specify the username to connect on the client, only use with rsh/ssh authentification.
1263 </para>
1264   </listitem>
1265   </varlistentry>
1266
1267 <!-- bumping parameters yanked from the global section above -->
1268
1269   <varlistentry>
1270   <term><emphasis remap='B'>bumpsize</emphasis> int</term>
1271   <listitem>
1272 <para>Default:
1273 <emphasis remap='I'>10 Mbytes</emphasis>.
1274 The minimum savings required to trigger an automatic
1275 bump from one incremental level to the next, expressed as size.
1276 If &A; determines that the next higher backup level
1277 will be this much smaller than the current level,
1278 it will do the next level.
1279 The value of this parameter is used only if the parameter
1280 <emphasis>bumppercent</emphasis> is set to 0.
1281 </para>
1282 <para>
1283 See also the options
1284 <emphasis remap='B'>bumppercent</emphasis>,
1285 <emphasis remap='B'>bumpmult</emphasis> and
1286 <emphasis remap='B'>bumpdays</emphasis>.</para>
1287   </listitem>
1288   </varlistentry>
1289
1290   <varlistentry>
1291   <term><emphasis remap='B'>bumppercent</emphasis> int</term>
1292   <listitem>
1293 <para>Default:
1294 <emphasis remap='I'>0 percent</emphasis>.
1295 The minimum savings required to trigger an automatic
1296 bump from one incremental level to the next, expressed as percentage of the
1297 current size of the DLE (size of current level 0).
1298 If &A; determines that the next higher backup level
1299 will be this much smaller than the current level,
1300 it will do the next level.
1301 </para>
1302 <para>
1303 If this parameter is set to 0, the value of the
1304 parameter <emphasis>bumpsize</emphasis> is used to trigger bumping.
1305 </para>
1306 <para>
1307 See also the options
1308 <emphasis remap='B'>bumpsize</emphasis>,
1309 <emphasis remap='B'>bumpmult</emphasis> and
1310 <emphasis remap='B'>bumpdays</emphasis>.</para>
1311   </listitem>
1312   </varlistentry>
1313
1314   <varlistentry>
1315   <term><emphasis remap='B'>bumpmult</emphasis> <emphasis remap='I'> float</emphasis></term>
1316   <listitem>
1317 <para>Default:
1318 <literal>1.5</literal>.
1319 The bump size multiplier.
1320 &A; multiplies
1321 <emphasis remap='B'>bumpsize</emphasis>
1322 by this factor for each level.
1323 This prevents active filesystems from
1324 bumping too much by making it harder to bump to the next level.
1325 For example, with the default
1326 <emphasis remap='B'>bumpsize</emphasis>
1327 and
1328 <emphasis remap='B'>bumpmult</emphasis>
1329 set to 2.0, the bump threshold will be 10 Mbytes for level one, 20
1330 Mbytes for level two, 40 Mbytes for level three, and so on.</para>
1331   </listitem>
1332   </varlistentry>
1333   <varlistentry>
1334   <term><emphasis remap='B'>bumpdays</emphasis> <emphasis remap='I'> int</emphasis></term>
1335   <listitem>
1336 <para>Default:
1337 <emphasis remap='I'>2 days</emphasis>.
1338 To insure redundancy in the dumps, &A; keeps filesystems at the
1339 same incremental level for at least
1340 <emphasis remap='B'>bumpdays</emphasis>
1341 days, even if the other bump threshold criteria are met.</para>
1342   </listitem>
1343   </varlistentry>
1344
1345   <varlistentry>
1346   <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
1347   <listitem>
1348 <para>Default:
1349 <emphasis remap='I'>none</emphasis>.
1350 A comment string describing this set of backup options.</para>
1351   </listitem>
1352   </varlistentry>
1353   <varlistentry>
1354   <term><emphasis remap='B'>comprate</emphasis> <emphasis remap='I'>float</emphasis> [, <emphasis remap='I'>float</emphasis> ]</term>
1355   <listitem>
1356 <para>Default:
1357 <literal>0.50</literal>,
1358 <literal>0.50</literal>.
1359 The expected full and incremental compression factor for dumps.
1360 It is only used if &A; does not have any history information on
1361 compression rates for a filesystem, so should not usually need to be set.
1362 However, it may be useful for the first time a very large filesystem that
1363 compresses very little is backed up.</para>
1364   </listitem>
1365   </varlistentry>
1366   <varlistentry>
1367   <term><emphasis remap='B'>compress [client|server]</emphasis> <emphasis remap='I'> string</emphasis></term>
1368   <listitem>
1369 <para>Default:
1370 <emphasis remap='I'>client fast</emphasis>.
1371 If &A; does compression of the backup images, it can do so either on the backup client
1372 host before it crosses the network or on the tape server host as it goes from the
1373 network into the holding disk or to tape.  Which place to do compression (if at all) depends on how well the
1374 dump image usually compresses, the speed and load on the client or server, network capacity,
1375 holding disk capacity, availability of tape hardware compression, etc.</para>
1376
1377 <para>For either type of compression, &A; also allows the selection
1378 of three styles of compression.
1379 <emphasis remap='B'>Best</emphasis>
1380 is the best compression available, often at the expense of CPU overhead.
1381 <emphasis remap='B'>Fast</emphasis>
1382 is often not as good a compression as
1383 <emphasis remap='B'>best</emphasis>,
1384 but usually less CPU overhead. Or to specify <emphasis remap='B'>Custom</emphasis>
1385 to use your own compression method. (See dumptype custom-compress in example/amanda.conf for reference)</para>
1386
1387 <para>So the <emphasis remap='B'>compress</emphasis> options line may be one of:</para>
1388
1389 <variablelist remap='TP'>
1390   <varlistentry>
1391     <term>compress none</term><listitem><para/></listitem>
1392   </varlistentry>
1393   <varlistentry>
1394     <term>compress client fast</term><listitem><para/></listitem>
1395   </varlistentry>
1396   <varlistentry>
1397     <term>compress client best</term><listitem><para/></listitem>
1398   </varlistentry>
1399   <varlistentry>
1400     <term>compress client custom</term>
1401     <listitem>
1402       <para>Specify <emphasis>client_custom_compress</emphasis> &quot;PROG&quot;</para>
1403       <para>PROG must not contain white space and it must accept -d for uncompress.</para>
1404     </listitem>
1405   </varlistentry>
1406   <varlistentry>
1407     <term>compress server fast</term><listitem><para/></listitem>
1408   </varlistentry>
1409   <varlistentry>
1410     <term>compress server best</term><listitem><para/></listitem>
1411   </varlistentry>
1412   <varlistentry>
1413     <term>compress server custom</term>
1414     <listitem>
1415       <para>Specify <emphasis>server_custom_compress</emphasis> &quot;PROG&quot;</para>
1416       <para>PROG must not contain white space and it must accept -d for uncompress.</para>
1417     </listitem>
1418   </varlistentry>
1419 </variablelist>
1420 <para>Note that some tape devices do compression and this option has nothing
1421 to do with whether that is used. If hardware compression is used (usually via a particular tape device name
1422 or <emphasis remap='B'>mt</emphasis> option), &A; (software) compression should be disabled.</para>
1423   </listitem>
1424   </varlistentry>
1425   <varlistentry>
1426   <term><emphasis remap='B'>dumpcycle</emphasis> <emphasis remap='I'> int</emphasis></term>
1427   <listitem>
1428 <para>Default: <emphasis remap='I'>10 days</emphasis>.
1429 The number of days in the backup cycle. Each disk using this set of options will get a full
1430 backup at least this of
1431 ten. Setting this to zero tries to do a full backup each run.</para>
1432   </listitem>
1433   </varlistentry>
1434
1435   <varlistentry>
1436   <term><emphasis remap='B'>encrypt [none|client|server]</emphasis></term>
1437   <listitem>
1438 <para>Default: <emphasis remap='I'>none</emphasis>.
1439 To encrypt backup images, it can do so either on the backup client host before it crosses the network or on the tape
1440 server host as it goes from the network into the holding disk or to tape.</para>
1441
1442 <para>So the <emphasis remap='B'>encrypt</emphasis> options line may be one
1443             of:</para>
1444
1445 <variablelist remap='TP'>
1446   <varlistentry>
1447     <term>encrypt none</term><listitem><para/></listitem>
1448   </varlistentry>
1449   <varlistentry>
1450     <term>encrypt client</term>
1451     <listitem>
1452       <para>Specify client_encrypt &quot;PROG&quot;</para>
1453       <para>PROG must not contain white space.</para>
1454       <para>Specify client_decrypt_option &quot;decryption-parameter&quot; Default: &quot;-d&quot;</para>
1455       <para>decryption-parameter must not contain white space.</para>
1456       <para>(See dumptype server-encrypt-fast in example/amanda.conf for reference)</para>
1457     </listitem>
1458   </varlistentry>
1459   <varlistentry>
1460     <term>encrypt server</term>
1461     <listitem>
1462       <para>Specify server_encrypt &quot;PROG&quot;</para>
1463       <para>PROG must not contain white space.</para>
1464       <para>Specify server_decrypt_option &quot;decryption-parameter&quot; Default: &quot;-d&quot;</para>
1465       <para>decryption-parameter must not contain white space.</para>
1466       <para>(See dumptype client-encrypt-nocomp in example/amanda.conf for reference)</para>
1467     </listitem>
1468   </varlistentry>
1469 </variablelist>
1470 <para>Note that current logic assumes compression then encryption during
1471 backup(thus decrypt then uncompress during restore). So specifying
1472 client-encryption AND server-compression is not supported.
1473 <emphasis remap='I'>amcrypt</emphasis> which is a wrapper of
1474             <emphasis remap='I'>aespipe</emphasis> is provided as a reference
1475                 symmetric encryption program.</para>
1476 </listitem>
1477 </varlistentry>
1478
1479
1480   <varlistentry>
1481   <term><emphasis remap='B'>estimate</emphasis> <emphasis remap='I'>client|calcsize|server</emphasis></term>
1482   <listitem>
1483 <para>Default: <emphasis remap='I'>client</emphasis>.
1484 Determine the way &A; does it's estimate.</para>
1485 <variablelist remap='TP'>
1486   <varlistentry>
1487     <term>client</term>
1488     <listitem>
1489       <para>Use the same program as the dumping program, this is the most
1490             accurate way to do estimates, but it can take a long time.</para>
1491     </listitem>
1492   </varlistentry>
1493   <varlistentry>
1494     <term>calcsize</term>
1495     <listitem>
1496       <para>Use a faster program to do estimates, but the result is less accurate.</para>
1497     </listitem>
1498   </varlistentry>
1499   <varlistentry>
1500     <term>server</term>
1501     <listitem>
1502       <para>Use only statistics from the previous run to give an estimate,
1503             it takes only a few seconds but the result is not accurate if your disk
1504             usage changes from day to day.</para>
1505     </listitem>
1506   </varlistentry>
1507 </variablelist>
1508 </listitem>
1509 </varlistentry>
1510
1511
1512   <varlistentry>
1513   <term><emphasis remap='B'>exclude</emphasis> [ list|file ][[optional][ append ][ <emphasis remap='I'>string</emphasis> ]+]</term>
1514   <listitem>
1515 <para>Default:
1516 <emphasis remap='I'>file</emphasis>.
1517 There are two exclude lists,
1518 <emphasis remap='B'>exclude file</emphasis>
1519 and
1520 <emphasis remap='B'>exclude list.</emphasis>
1521 With
1522 <emphasis remap='B'>exclude file</emphasis>
1523 , the
1524 <emphasis remap='I'>string</emphasis>
1525 is a &gnutar; exclude expression. With
1526 <emphasis remap='B'>exclude list</emphasis>
1527 , the
1528 <emphasis remap='I'>string</emphasis>
1529 is a file name on the client containing &gnutar; exclude expressions.
1530 The path to the specified exclude list file, if present (see description of
1531 'optional' below), must be readable by the &A; user.</para>
1532
1533 <para>All exclude expressions are concatenated in one file and passed to &gnutar;
1534 as an <option>--exclude-from</option> argument.</para>
1535
1536 <para>Exclude expressions must always be specified as relative to the
1537 head directory of the DLE.</para>
1538
1539 <para>With the
1540 <emphasis remap='B'>append</emphasis> keyword, the
1541 <emphasis remap='I'>string</emphasis> is appended to the current list, without it, the
1542 <emphasis remap='I'>string</emphasis> overwrites the list.</para>
1543
1544 <para>If <emphasis remap='B'>optional</emphasis>
1545 is specified for <emphasis remap='B'>exclude list</emphasis>,
1546 then amcheck will not complain if the file doesn't exist or is not readable.</para>
1547
1548 <para>For <emphasis remap='B'>exclude list</emphasis>,
1549 if the file name is relative, the disk name being backed up is prepended.
1550 So if this is entered:</para>
1551
1552 <programlisting>
1553     exclude list &quot;.amanda.excludes&quot;
1554 </programlisting>
1555
1556 <para>the actual file used would be
1557 <filename>/var/.amanda.excludes</filename>
1558 for a backup of <filename>/var</filename>,
1559 <filename>/usr/local/.amanda.excludes</filename> for a backup of
1560 <filename>/usr/local</filename>, and so on.</para>
1561 </listitem>
1562 </varlistentry>
1563
1564   <varlistentry>
1565   <term><emphasis remap='B'>holdingdisk</emphasis> [ never|auto|required ]</term>
1566   <listitem>
1567 <para>Default:
1568 <emphasis remap='I'>auto</emphasis>.
1569 Whether a holding disk should be used for these backups or whether they should go directly to tape.
1570 If the holding disk is a portion of another file system that &A;
1571 is backing up, that file system should refer to a dumptype with
1572 <emphasis remap='B'>holdingdisk</emphasis>
1573 set to
1574 <emphasis remap='I'>never</emphasis>
1575 to avoid backing up the holding disk into itself.</para>
1576
1577   <variablelist remap='TP'>
1578   <varlistentry>
1579   <term><emphasis remap='B'>never</emphasis>|no|false|off</term>
1580   <listitem>
1581   <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>
1582   </listitem>
1583   </varlistentry>
1584   <varlistentry>
1585   <term><emphasis remap='B'>auto</emphasis>|yes|true|on</term>
1586   <listitem>
1587   <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>
1588   </listitem>
1589   </varlistentry>
1590   <varlistentry>
1591   <term><emphasis remap='B'>required</emphasis></term>
1592   <listitem>
1593   <para>Always dump to holdingdisk, never directly to tape. There will be no dump if it doesn't fit on holdingdisk</para>
1594   </listitem>
1595   </varlistentry>
1596   </variablelist>
1597
1598   </listitem>
1599   </varlistentry>
1600
1601   <varlistentry>
1602   <term><emphasis remap='B'>ignore</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1603   <listitem>
1604 <para>Default:
1605 <emphasis remap='I'>no</emphasis>.
1606 Whether disks associated with this backup type should be backed up or not.
1607 This option is useful when the
1608 <emphasis remap='I'>disklist</emphasis>
1609 file is shared among several configurations,
1610 some of which should not back up all the listed file systems.</para>
1611   </listitem>
1612   </varlistentry>
1613   <varlistentry>
1614   <term><emphasis remap='B'>include</emphasis> [ list|file ][[optional][ append ][ <emphasis remap='I'>string</emphasis> ]+]</term>
1615   <listitem>
1616 <para>Default:
1617 <emphasis remap='I'>file</emphasis>
1618 &quot;.&quot;.
1619 There are two include lists,
1620 <emphasis remap='B'>include file</emphasis>
1621 and
1622 <emphasis remap='B'>include list.</emphasis>
1623 With
1624 <emphasis remap='B'>include file</emphasis>
1625 , the
1626 <emphasis remap='I'>string</emphasis>
1627 is a glob expression. With
1628 <emphasis remap='B'>include list</emphasis>
1629 , the
1630 <emphasis remap='I'>string</emphasis>
1631 is a file name on the client containing glob expressions.</para>
1632
1633 <para>All include expressions are expanded by &A;, concatenated in one file and passed to &gnutar; as a
1634 <option>--files-from</option> argument. They must start with &quot;./&quot; and contain no other &quot;/&quot;.</para>
1635
1636 <para>Include expressions must always be specified as relative to the
1637 head directory of the DLE.</para>
1638
1639 <note><para>For globbing to work at all, even the limited single level,
1640 the top level directory of the DLE must be readable by the &A; user.</para>
1641 </note>
1642
1643 <para>With the <emphasis remap='B'>append</emphasis> keyword, the
1644 <emphasis remap='I'>string</emphasis> is appended to the current list, without it, the
1645 <emphasis remap='I'>string</emphasis> overwrites the list.</para>
1646
1647 <para>If
1648 <emphasis remap='B'>optional</emphasis> is specified for
1649 <emphasis remap='B'>include list,</emphasis> then amcheck will not complain if the file
1650 doesn't exist or is not readable.</para>
1651
1652 <para>For <emphasis remap='B'>include list</emphasis>,
1653 If the file name is relative, the disk name being backed up is prepended.</para>
1654 </listitem>
1655 </varlistentry>
1656
1657   <varlistentry>
1658   <term><emphasis remap='B'>index</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1659   <listitem>
1660 <para>Default: <emphasis remap='I'>no</emphasis>.
1661 Whether an index (catalogue) of the backup should be generated and saved in
1662 <emphasis remap='B'>indexdir</emphasis>.
1663 These catalogues are used by the <emphasis remap='B'>amrecover</emphasis> utility.</para>
1664   </listitem>
1665   </varlistentry>
1666
1667   <varlistentry>
1668   <term><emphasis remap='B'>kencrypt</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1669   <listitem>
1670 <para>Default:
1671 <emphasis remap='I'>no</emphasis>.
1672 Whether the backup image should be encrypted by Kerberos as it is sent
1673 across the network from the backup client host to the tape server host.</para>
1674   </listitem>
1675   </varlistentry>
1676   <varlistentry>
1677   <term><emphasis remap='B'>maxdumps</emphasis> <emphasis remap='I'> int</emphasis></term>
1678   <listitem>
1679 <para>Default:
1680 <literal>1</literal>.
1681 The maximum number of backups from a single host that &A; will attempt to run in parallel.
1682 See also the main section parameter <emphasis remap='B'>inparallel</emphasis>.</para>
1683   </listitem>
1684   </varlistentry>
1685   <varlistentry>
1686   <term><emphasis remap='B'>maxpromoteday</emphasis> <emphasis remap='I'> int</emphasis></term>
1687   <listitem>
1688 <para>Default:
1689 <literal>10000</literal>.
1690 The maximum number of day for a promotion, set it 0 if you don't want
1691 promotion, set it to 1 or 2 if your disks get overpromoted.</para>
1692   </listitem>
1693   </varlistentry>
1694   <varlistentry>
1695   <term><emphasis remap='B'>priority</emphasis> <emphasis remap='I'> string</emphasis></term>
1696   <listitem>
1697 <para>Default: <emphasis remap='I'>medium</emphasis>.
1698 When there is no tape to write to, &A; will do incremental backups
1699 in priority order to the holding disk. The priority may be
1700 high (2), medium (1), low (0) or a number of your choice.</para>
1701   </listitem>
1702   </varlistentry>
1703   <varlistentry>
1704   <term><emphasis remap='B'>program</emphasis> <emphasis remap='I'> string</emphasis></term>
1705   <listitem>
1706 <para>Default:
1707 <emphasis remap='I'>DUMP</emphasis>.
1708 The type of backup to perform. Valid values are
1709 <emphasis remap='B'>DUMP</emphasis>
1710 for the native operating system backup program, and
1711 <emphasis remap='B'>GNUTAR</emphasis>
1712 to use &gnutar; or to do PC backups using Samba.</para>
1713   </listitem>
1714   </varlistentry>
1715   <varlistentry>
1716   <term><emphasis remap='B'>record</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1717   <listitem>
1718 <para>Default:
1719 <emphasis remap='I'>yes</emphasis>.
1720 Whether to ask the backup program to update its database (e.g. <filename>/etc/dumpdates</filename>
1721 for DUMP or <filename>/usr/local/var/amanda/gnutar-lists</filename> for GNUTAR) of time stamps.
1722 This is normally enabled for daily backups and turned off for periodic archival runs.</para>
1723   </listitem>
1724   </varlistentry>
1725   <varlistentry>
1726   <term><emphasis remap='B'>skip-full</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1727   <listitem>
1728 <para>Default:
1729 <emphasis remap='I'>no</emphasis>. If <emphasis remap='I'>true</emphasis> and
1730 <emphasis remap='B'>planner</emphasis> has scheduled a full backup, these disks will be skipped, and
1731 full backups should be run off-line on these days. It was reported that &A; only schedules
1732 level 1 incrementals in this configuration; this is probably a bug.</para>
1733   </listitem>
1734   </varlistentry>
1735   <varlistentry>
1736   <term><emphasis remap='B'>skip-incr</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1737   <listitem>
1738 <para>Default:
1739 <emphasis remap='I'>no</emphasis>. If <emphasis remap='I'>true</emphasis> and
1740 <emphasis remap='B'>planner</emphasis> has scheduled an incremental backup, these disks will be skipped.</para>
1741   </listitem>
1742   </varlistentry>
1743   <varlistentry>
1744   <term><emphasis remap='B'>starttime</emphasis> <emphasis remap='I'> int</emphasis></term>
1745   <listitem>
1746 <para>Default:
1747 <emphasis remap='I'>none</emphasis>.
1748 Backups will not start until after this time of day.
1749 The value should be hh*100+mm, e.g. 6:30PM (18:30) would be entered as
1750 <literal>1830</literal>.</para>
1751   </listitem>
1752   </varlistentry>
1753   <varlistentry>
1754   <term><emphasis remap='B'>strategy</emphasis> <emphasis remap='I'> string</emphasis></term>
1755   <listitem>
1756   <para>Default: <emphasis remap='I'>standard</emphasis>.
1757   Strategy to use when planning what level of backup to run next. Values are:</para>
1758
1759   <variablelist remap='TP'>
1760   <varlistentry>
1761   <term><emphasis remap='B'>standard</emphasis></term>
1762   <listitem>
1763   <para>The standard &A; schedule.</para>
1764   </listitem>
1765   </varlistentry>
1766   <varlistentry>
1767   <term><emphasis remap='B'>nofull</emphasis></term>
1768   <listitem>
1769   <para>Never do full backups, only level 1 incrementals.</para>
1770   </listitem>
1771   </varlistentry>
1772   <varlistentry>
1773   <term><emphasis remap='B'>noinc</emphasis></term>
1774   <listitem>
1775   <para>Never do incremental backups, only full dumps.</para>
1776   </listitem>
1777   </varlistentry>
1778   <varlistentry>
1779   <term><emphasis remap='B'>skip</emphasis></term>
1780   <listitem>
1781   <para>Never do backups (useful when sharing the <emphasis remap='I'>disklist</emphasis> file).</para>
1782   </listitem>
1783   </varlistentry>
1784   <varlistentry>
1785   <term><emphasis remap='B'>incronly</emphasis></term>
1786   <listitem>
1787   <para>Only do incremental dumps. <command>amadmin force</command> should be used to tell
1788   &A; that a full dump has been performed off-line, so that it resets to level 1.</para>
1789   </listitem>
1790   </varlistentry>
1791   </variablelist>
1792   </listitem>
1793   </varlistentry>
1794
1795   <varlistentry>
1796   <term><emphasis remap='B'>tape_splitsize</emphasis> <emphasis remap='I'> int</emphasis></term>
1797   <listitem>
1798 <para>Default:
1799 <emphasis remap='I'>none</emphasis>.
1800 Split dump file on tape into pieces of a specified size.
1801 This allows dumps to be spread across multiple tapes, and can potentially
1802 make more efficient use of tape space.
1803 Note that if this value is too large (more than half the size of the
1804 average dump being split), substantial tape space can be wasted.
1805 If too small, large dumps will be split into innumerable tiny dumpfiles,
1806 adding to restoration complexity.
1807 A good rule of thumb, usually, is 1/10 of the size of your tape.</para>
1808   </listitem>
1809   </varlistentry>
1810
1811   <varlistentry>
1812   <term><emphasis remap='B'>split_diskbuffer</emphasis> <emphasis remap='I'> string</emphasis></term>
1813   <listitem>
1814 <para>Default:
1815 <emphasis remap='I'>none</emphasis>.
1816 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.
1817 </para>
1818   </listitem>
1819   </varlistentry>
1820
1821   <varlistentry>
1822   <term><emphasis remap='B'>fallback_splitsize</emphasis> <emphasis remap='I'> int</emphasis></term>
1823   <listitem>
1824 <para>Default:
1825 <emphasis remap='I'>10M</emphasis>.
1826 When dumping a split dump in PORT-WRITE mode, if no split_diskbuffer is
1827 specified (or if we somehow fail to use our split_diskbuffer), we must
1828 buffer split chunks in memory.
1829 This specifies the maximum size split chunks can be in this scenario,
1830 and thus the maximum amount of memory consumed for in-memory splitting.
1831 The size of this buffer can be changed from its (very conservative) default
1832 to a value reflecting the amount of memory that each taper process on
1833 the dump server may reasonably consume.
1834 </para>
1835   </listitem>
1836   </varlistentry>
1837 </variablelist>
1838
1839 <para>The following <emphasis remap='B'>dumptype</emphasis> entries are predefined by &A;:</para>
1840
1841 <programlisting remap='.nf'>
1842 define dumptype no-compress {
1843     compress none
1844 }
1845 define dumptype compress-fast {
1846     compress client fast
1847 }
1848 define dumptype compress-best {
1849     compress client best
1850 }
1851 define dumptype srvcompress {
1852     compress server fast
1853 }
1854 define dumptype bsd-auth {
1855     auth bsd
1856 }
1857 define dumptype krb4-auth {
1858     auth krb4
1859 }
1860 define dumptype no-record {
1861     record no
1862 }
1863 define dumptype no-hold {
1864     holdingdisk no
1865 }
1866 define dumptype no-full {
1867     skip-full yes
1868 }
1869 </programlisting>
1870
1871 <para>In addition to options in a
1872 <emphasis remap='B'>dumptype</emphasis>
1873 section, one or more other
1874 <emphasis remap='B'>dumptype</emphasis>
1875 names may be entered, which make this
1876 <emphasis remap='B'>dumptype</emphasis>
1877 inherit options from other previously defined
1878 <emphasis remap='B'>dumptype</emphasis>s.
1879 For instance, two sections might be the same except for the
1880 <emphasis remap='B'>record</emphasis> option:</para>
1881
1882 <programlisting remap='.nf'>
1883 define dumptype normal {
1884     comment &quot;Normal backup, no compression, do indexing&quot;
1885     no-compress
1886     index yes
1887     maxdumps 2
1888 }
1889 define dumptype testing {
1890     comment &quot;Test backup, no compression, do indexing, no recording&quot;
1891     normal
1892     record no
1893 }
1894 </programlisting>
1895
1896 <para>&A; provides a
1897 <emphasis remap='B'>dumptype</emphasis>
1898 named
1899 <emphasis remap='I'>global</emphasis>
1900 in the sample
1901 <emphasis remap='B'>amanda.conf</emphasis>
1902 file that all
1903 <emphasis remap='B'>dumptype</emphasis>s
1904 should reference.
1905 This provides an easy place to make changes that will affect every
1906 <emphasis remap='B'>dumptype</emphasis>.</para>
1907 </refsect1>
1908
1909 <refsect1><title>TAPETYPE SECTION</title>
1910 <para>The <emphasis remap='B'>amanda.conf</emphasis>
1911 file may define multiple types of tape media and devices.
1912 The information is entered in a
1913 <emphasis remap='B'>tapetype</emphasis>
1914 section, which looks like this in the config file:</para>
1915
1916 <programlisting>
1917 define tapetype <emphasis remap='I'>name</emphasis> {
1918     <emphasis remap='I'>tapetype-option</emphasis> <emphasis remap='I'>tapetype-value</emphasis>
1919     <literal>...</literal>
1920 }
1921 </programlisting>
1922
1923 <para><emphasis remap='I'>Name</emphasis>
1924 is the name of this type of tape medium/device.
1925 It is referenced from the
1926 <emphasis remap='B'>tapetype</emphasis>
1927 option in the main part of the config file.</para>
1928
1929 <para>The tapetype options and values are:</para>
1930 <variablelist remap='TP'>
1931   <varlistentry>
1932   <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
1933   <listitem>
1934 <para>Default:
1935 <emphasis remap='I'>none</emphasis>.
1936 A comment string describing this set of tape information.</para>
1937   </listitem>
1938   </varlistentry>
1939   <varlistentry>
1940   <term><emphasis remap='B'>filemark</emphasis> <emphasis remap='I'> int</emphasis></term>
1941   <listitem>
1942 <para>Default:
1943 <emphasis remap='I'>1 kbytes</emphasis>.
1944 How large a file mark (tape mark) is, measured in kbytes.
1945 If the size is only known in some linear measurement (e.g. inches),
1946 convert it to kbytes using the device density.</para>
1947   </listitem>
1948   </varlistentry>
1949   <varlistentry>
1950   <term><emphasis remap='B'>length</emphasis> <emphasis remap='I'> int</emphasis></term>
1951   <listitem>
1952 <para>Default:
1953 <emphasis remap='I'>2000 kbytes</emphasis>. How much data will fit on a tape.</para>
1954
1955 <para>Note that this value is only used by &A; to schedule which backups will be run.
1956 Once the backups start, &A; will continue to write to a tape until it gets an error,
1957 regardless of what value is entered for <emphasis remap='B'>length</emphasis>
1958 (but see the section OUTPUT DRIVERS in the
1959 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1960 manpage for exceptions).
1961  </para> </listitem>
1962   </varlistentry>
1963
1964 <varlistentry>
1965 <term><emphasis remap='B'>blocksize</emphasis> <emphasis remap='I'> int</emphasis></term>
1966 <listitem>
1967 <para>Default:
1968 <emphasis remap='I'>32 kbytes</emphasis>.
1969 How much data will be written in each tape record expressed in KiloBytes.
1970 The tape record size (= blocksize) can not be reduced below the default 32 KBytes.
1971 The parameter blocksize can only be raised if &A; was compiled with the configure option
1972 --with-maxtapeblocksize=N set with &quot;N&quot; greater than 32 during
1973 &configure;.
1974 </para>
1975   </listitem>
1976   </varlistentry>
1977 <varlistentry>
1978 <term><emphasis remap='B'>readblocksize</emphasis> <emphasis remap='I'> int</emphasis></term>
1979 <listitem>
1980 <para>Default:
1981 (<emphasis remap='I'>from configure --with-maxtapeblocksize</emphasis>).
1982 How much data will be read in each tape record expressed in KiloBytes.
1983 Some hardware require a value not too large, and some require it to be equal to the blocksize.
1984 It is useful if you configured amanda with a big --with-maxtapeblocksize and your
1985 hardware don't work with a value that big.
1986 </para>
1987   </listitem>
1988   </varlistentry>
1989   <varlistentry>
1990   <term><emphasis remap='B'>file-pad</emphasis> <emphasis remap='I'> boolean</emphasis></term>
1991   <listitem>
1992 <para>Default:
1993 <emphasis remap='I'>true</emphasis>.
1994 If true, every record, including the last one in the file, will have the same length.
1995 This matches the way &A; wrote tapes prior to the availability of this parameter.
1996 It may also be useful on devices that only support a fixed blocksize.</para>
1997
1998 <para>Note that the last record on the tape probably includes trailing
1999 null byte padding, which will be passed back to
2000 <emphasis remap='B'>gzip</emphasis>,
2001 <emphasis remap='B'>compress</emphasis>
2002 or the restore program. Most programs just ignore this (although possibly with a warning).</para>
2003
2004 <para>If this parameter is false, the last record in a file may be shorter
2005 than the block size. The file will contain the same amount of data the dump program generated,
2006 without trailing null byte padding. When read, the same amount of data that was written
2007 will be returned.</para>
2008   </listitem>
2009   </varlistentry>
2010
2011   <varlistentry>
2012   <term><emphasis remap='B'>speed</emphasis> <emphasis remap='I'> int</emphasis></term>
2013   <listitem>
2014 <para>Default:
2015 <emphasis remap='I'>200 bps</emphasis>.
2016 How fast the drive will accept data, in bytes per second.
2017 This parameter is NOT currently used by &A;.</para>
2018   </listitem>
2019   </varlistentry>
2020   <varlistentry>
2021   <term><emphasis remap='B'>lbl-templ</emphasis> <emphasis remap='I'> string</emphasis></term>
2022   <listitem>
2023 <para>A PostScript template file used by
2024 <emphasis remap='B'>amreport</emphasis>
2025 to generate labels. Several sample files are provided with the &A; sources in the
2026 <emphasis remap='I'>example</emphasis> directory.
2027 See the
2028 <citerefentry><refentrytitle>amreport</refentrytitle><manvolnum>8</manvolnum></citerefentry>
2029 man page for more information.</para>
2030   </listitem>
2031   </varlistentry>
2032 </variablelist>
2033
2034 <para>In addition to options, another
2035 <emphasis remap='B'>tapetype</emphasis>
2036 name may be entered, which makes this
2037 <emphasis remap='B'>tapetype</emphasis>
2038 inherit options from another
2039 <emphasis remap='B'>tapetype</emphasis>.
2040 For instance, the only difference between a DLT4000 tape drive using
2041 Compact-III tapes and one using Compact-IV tapes is the length of the tape.
2042 So they could be entered as:</para>
2043
2044 <programlisting remap='.nf'>
2045 define tapetype DLT4000-III {
2046     comment &quot;DLT4000 tape drives with Compact-III tapes&quot;
2047     length 12500 mbytes         # 10 Gig tapes with some compression
2048     filemark 2000 kbytes
2049     speed 1536 kps
2050 }
2051 define tapetype DLT4000-IV {
2052     DLT4000-III
2053     comment &quot;DLT4000 tape drives with Compact-IV tapes&quot;
2054     length 25000 mbytes         # 20 Gig tapes with some compression
2055 }
2056 </programlisting>
2057
2058 <!-- If anybody has read this, where do all those stupid
2059      pseudo-duplicate FOM-tapetype-entries come from??
2060         - sgw, Jan. 2005
2061 -->
2062
2063 </refsect1>
2064
2065 <refsect1><title>INTERFACE SECTION</title>
2066 <para>The
2067 <emphasis remap='B'>amanda.conf</emphasis>
2068 file may define multiple types of network interfaces.
2069 The information is entered in an <emphasis remap='B'>interface</emphasis>
2070 section, which looks like this:</para>
2071
2072 <programlisting>
2073 define interface <emphasis remap='I'>name</emphasis> {
2074     <emphasis remap='I'>interface-option</emphasis> <emphasis remap='I'>interface-value</emphasis>
2075     <literal>...</literal>
2076 }
2077 </programlisting>
2078
2079 <para><emphasis remap='I'>name</emphasis>
2080 is the name of this type of network interface. It is referenced from the
2081 <emphasis remap='I'>disklist</emphasis> file.</para>
2082
2083 <para>Note that these sections define network interface characteristics,
2084 not the actual interface that will be used. Nor do they impose limits on the bandwidth that will
2085 actually be taken up by &A;.
2086 &A; computes the estimated bandwidth each file system backup will take
2087 based on the estimated size and time, then compares that plus any other running
2088 backups with the limit as another of the criteria when deciding whether
2089 to start the backup. Once a backup starts, &A; will use as much of the network as it can
2090 leaving throttling up to the operating system and network hardware.</para>
2091
2092 <para>The interface options and values are:</para>
2093 <variablelist remap='TP'>
2094   <varlistentry>
2095   <term><emphasis remap='B'>comment</emphasis> <emphasis remap='I'> string</emphasis></term>
2096   <listitem>
2097 <para>Default:
2098 <emphasis remap='I'>none</emphasis>.
2099 A comment string describing this set of network information.</para>
2100   </listitem>
2101   </varlistentry>
2102   <varlistentry>
2103   <term><emphasis remap='B'>use</emphasis> <emphasis remap='I'> int</emphasis></term>
2104   <listitem>
2105 <para>Default:
2106 <emphasis remap='I'>8000 Kbps</emphasis>.
2107 The speed of the interface in Kbytes per second.</para>
2108   </listitem>
2109   </varlistentry>
2110 </variablelist>
2111
2112 <para>In addition to options, another
2113 <emphasis remap='B'>interface</emphasis>
2114 name may be entered, which makes this
2115 <emphasis remap='B'>interface</emphasis>
2116 inherit options from another
2117 <emphasis remap='B'>interface</emphasis>.
2118 At the moment, this is of little use.</para>
2119 </refsect1>
2120
2121 <refsect1><title>AUTHOR</title>
2122 <para>James da Silva, &email.jds;: Original text</para>
2123 <para>&maintainer.sgw;: XML-conversion, major update, splitting</para>
2124 </refsect1>
2125
2126 <refsect1><title>SEE ALSO</title>
2127 <para>
2128 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
2129 <citerefentry><refentrytitle>amanda-client.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2130 <citerefentry><refentrytitle>amcrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
2131 <citerefentry><refentrytitle>aespipe</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2132 <ulink url="http://wiki.zmanda.com"/>
2133 </para>
2134
2135 <para>
2136 An updated version of this man page may be available at http://wiki.zmanda.com/index.php/Amanda.conf.
2137 </para>
2138 </refsect1>
2139 </refentry>
2140