Imported Upstream version 3.1.0
[debian/amanda] / example / amanda.conf.in
index 1baa5095eeb9cb6e8ca4fc756d80a194ac61a94c..cec4ac521444b9225d59a6548b996ab1867acd33 100644 (file)
@@ -1,23 +1,8 @@
-###  !!! WARNING !!!  !!! WARNING !!!  !!! WARNING !!!  !!! WARNING !!!  ###
-###                                                                      ###
-###  This file is not meant to be installed "as is", and in fact, it     ###
-###  WILL NOT WORK!  You must go through it and make changes appropriate ###
-###  to your own situation.  See the documentation in this file, in the  ###
-###  "man amanda" man page, in the "docs" directory and at the Amanda    ###
-###  web page (www.amanda.org).                                          ###
-###                                                                      ###
-###  !!! WARNING !!!  !!! WARNING !!!  !!! WARNING !!!  !!! WARNING !!!  ###
+# amanda.conf - sample Amanda configuration file. See amanda.conf(5) for 
+# details
 
-#
-# amanda.conf - sample Amanda configuration file.  This started off life as
-#               the actual config file in use at CS.UMD.EDU.
-#
-# If your configuration is called, say, "csd", then this file normally goes
-# in @CONFIG_DIR@/csd/amanda.conf.
-#
-
-org "@DEFAULT_CONFIG@"         # your organization name for reports
-mailto "@CLIENT_LOGIN@"                # space separated list of operators at your site
+org     "@DEFAULT_CONFIG@"     # your organization name for reports
+mailto          "@CLIENT_LOGIN@"       # space separated list of operators at your site
 dumpuser "@CLIENT_LOGIN@"      # the user to run dumps under
 
 inparallel 4           # maximum dumpers that will run in parallel (max 63)
@@ -35,14 +20,15 @@ dumporder "sssS"    # specify the priority order of each dumper
 
 taperalgo first                # The algorithm used to choose which dump image to send
                        # to the taper.
-
-                       # Possible values: [first|firstfit|largest|largestfit|smallest|last]
+                       # Possible values: 
+                       # [first|firstfit|largest|largestfit|smallest|last]
                        # Default: first. 
-
                        # first         First in - first out.
-                       # firstfit      The first dump image that will fit on the current tape.
+                       # firstfit      The first dump image that will fit 
+                        #               on the current tape.
                        # largest       The largest dump image.
-                       # largestfit    The largest dump image that will fit on the current tape.
+                       # largestfit    The largest dump image that will fit 
+                        #               on the current tape.
                        # smallest      The smallest dump image.
                        # last          Last in - first out.
 
@@ -51,7 +37,7 @@ displayunit "k"               # Possible values: "k|m|g|t"
                        # The unit used to print many numbers.
                        # k=kilo, m=mega, g=giga, t=tera
                        
-netusage  600 Kbps     # maximum net bandwidth for Amanda, in KB per sec
+netusage  8000 Kbps    # maximum net bandwidth for Amanda, in KB per sec
 
 dumpcycle 4 weeks      # the number of days in the normal dump cycle
 runspercycle 20         # the number of amdump runs in dumpcycle days
@@ -69,48 +55,79 @@ bumpdays 1          # minimum days at each level
 bumpmult 4             # threshold = bumpsize * bumpmult^(level-1)
 
 etimeout 300           # number of seconds per filesystem for estimates.
-#etimeout -600         # total number of seconds for estimates.
-# a positive number will be multiplied by the number of filesystems on
-# each host; a negative number will be taken as an absolute total time-out.
-# The default is 5 minutes per filesystem.
-
 dtimeout 1800          # number of idle seconds before a dump is aborted.
-
 ctimeout 30            # maximum number of seconds that amcheck waits
                        # for each client host
  
-tapebufs 20
-# A positive integer telling taper how many 32k buffers to allocate.
-# WARNING! If this is set too high, taper will not be able to allocate
-# the memory and will die.  The default is 20 (640k).
-
-
-# Specify tape device and/or tape changer.  If you don't have a tape
-# changer, and you don't want to use more than one tape per run of
-# amdump, just comment out the definition of tpchanger.
-
-# Some tape changers require tapedev to be defined; others will use
-# their own tape device selection mechanism.  Some use a separate tape
-# changer device (changerdev), others will simply ignore this
-# parameter.  Some rely on a configuration file (changerfile) to
-# obtain more information about tape devices, number of slots, etc;
-# others just need to store some data in files, whose names will start
-# with changerfile.  For more information about individual tape
-# changers, read docs/TAPE.CHANGERS.
-
-# At most one changerfile entry must be defined; select the most
-# appropriate one for your configuration.  If you select man-changer,
-# keep the first one; if you decide not to use a tape changer, you may
-# comment them all out.
-
-runtapes 1             # number of tapes to be used in a single run of amdump
-tpchanger "chg-manual" # the tape-changer glue script
-tapedev "@DEFAULT_TAPE_DEVICE@"        # the no-rewind tape device to be used
-rawtapedev "@DEFAULT_RAW_TAPE_DEVICE@" # the raw device to be used (ftape only)
-#changerfile "@CONFIG_DIR@/@DEFAULT_CONFIG@/changer"
-#changerfile "@CONFIG_DIR@/@DEFAULT_CONFIG@/changer-status"
-changerfile "@CONFIG_DIR@/@DEFAULT_CONFIG@/changer.conf"
-changerdev "@DEFAULT_CHANGER_DEVICE@"
+device_output_buffer_size 1280k
+                        # amount of buffer space to use when writing to devices
+
+# By default, Amanda can only track at most one run per calendar day. When
+# the usetimestamps option is enabled, however, Amanda can track as many
+# runs as you care to make.
+# WARNING: This option is not backward-compatible. Do not enable it if you
+#          intend to downgrade your server installation to Amanda community 
+#          edition 2.5
+usetimestamps yes
+
+# flush-threshold-dumped, flush-threshold-scheduled, taperflush, and autoflush
+# are used to control tape utilization. See the amanda.conf (5) manpage for
+# details on how they work. Taping will not start until all criteria are
+# satisfied. Here are some examples:
+#
+# You want to fill tapes completely even in the case of failed dumps, and
+# don't care if some dumps are left on the holding disk after a run:
+# flush-threshold-dumped       100 # (or more)
+# flush-threshold-scheduled    100 # (or more)
+# taperflush                   100
+# autoflush                    yes
+#
+# You want to improve tape performance by waiting for a complete tape of data
+# before writing anything. However, all dumps will be flushed; none will
+# be left on the holding disk.
+# flush-threshold-dumped       100 # (or more)
+# flush-threshold-scheduled    100 # (or more)
+# taperflush   0
+#
+# You don't want to use a new tape for every run, but want to start writing
+# to tape as soon as possible:
+# flush-threshold-dumped       0   # (or more)
+# flush-threshold-scheduled    100 # (or more)
+# taperflush   100
+# autoflush     yes
+# maxdumpsize   100k # amount of data to dump each run; see above.
+#
+# You want to keep the most recent dumps on holding disk, for faster recovery.
+# Older dumps will be rotated to tape during each run.
+# flush-threshold-dumped       300 # (or more)
+# flush-threshold-scheduled    300 # (or more)
+# taperflush   300
+# autoflush     yes
+#
+# Defaults:
+# (no restrictions; flush to tape immediately; don't flush old dumps.)
+flush-threshold-dumped 0
+flush-threshold-scheduled 0
+taperflush 0
+autoflush no
+
+# Specify tape device or tape changer.
+
+runtapes 1                     # number of tapes to be used in a single run of amdump
+tapedev "@EXAMPLE_TAPEDEV@"    # tape changer or device to use
+
+# To use vtapes, create some slotN directories (slot0, slot1, etc.) under
+# /var/amanda/vtapes and use this tapedev:
+## tapedev "chg-disk:/var/amanda/vtapes"
+
+# To use a tape library, uncomment this definition.  See amanda-changers(7)
+# for more configuration options.
+#
+# define changer myrobot {
+#   tpchanger "chg-robot:/dev/sg0"  # your changer device file
+#   tapedev "tape:@EXAMPLE_TAPEDEV@"   # your tape drive device file
+# }
+# tapedev "myrobot"
 
 # If you want Amanda to automatically label any non-Amanda tapes it
 # encounters, uncomment the line below. Note that this will ERASE any
@@ -127,11 +144,10 @@ amrecover_do_fsf yes              # amrecover will call amrestore with the
                                # -f flag for faster positioning of the tape.
 amrecover_check_label yes      # amrecover will call amrestore with the
                                # -l flag to check the label.
-amrecover_changer "@DEFAULT_TAPE_DEVICE@"      # amrecover will use the changer if you restore
-                               # from this device.
-                               # It could be a string like 'changer' and
-                               # amrecover will use your changer if you
-                               # set your tape with 'settape changer'
+amrecover_changer "changer"    # amrecover will use the changer if you restore
+    # from this device. It could be a string like 'changer' and amrecover will use your
+    # changer if you set your tape to 'changer' with 'setdevice changer' or via 
+    # 'tapedev "changer"' in amanda-client.conf
 
 # Specify holding disks.  These are used as a temporary staging area for
 # dumps before they are written to tape and are recommended for most sites.
@@ -148,9 +164,9 @@ amrecover_changer "@DEFAULT_TAPE_DEVICE@"   # amrecover will use the changer if yo
 holdingdisk hd1 {
     comment "main holding disk"
     directory "/dumps/amanda"  # where the holding disk is
-    use -100 Mb                # how much space can we use on it
-                       # a non-positive value means:
-                       #        use all space but that value
+    use -100 Mb                        # how much space can we use on it
+                               # a non-positive value means:
+                               # use all space but that value
     chunksize 1Gb      # size of chunk if you want big dump to be
                        # dumped on multiple files on holding disks
                        #  N Kb/Mb/Gb split images in chunks of size N
@@ -181,10 +197,6 @@ holdingdisk hd1 {
 # This means save at least 30% of the holding disk space for degraded
 # mode backups.  
 
-autoflush no #
-# if autoflush is set to yes, then amdump will schedule all dump on
-# holding disks to be flush to tape during the run.
-
 # The format for a ColumnSpec is a ',' seperated list of triples.
 # Each triple consists of
 #   + the name of the column (as in ColumnNameStrings)
@@ -219,8 +231,8 @@ autoflush no #
 # you have selected some database format other than the `text' default)
 infofile "@CONFIG_DIR@/@DEFAULT_CONFIG@/curinfo"       # database DIRECTORY
 logdir   "@CONFIG_DIR@/@DEFAULT_CONFIG@"               # log directory
-indexdir "@CONFIG_DIR@/@DEFAULT_CONFIG@/index" # index directory
-#tapelist "@CONFIG_DIR/@DEFAULT_CONFIG@/tapelist"      # list of used tapes
+indexdir "@CONFIG_DIR@/@DEFAULT_CONFIG@/index"         # index directory
+#tapelist "@CONFIG_DIR@/@DEFAULT_CONFIG@/tapelist"     # list of used tapes
 # tapelist is stored, by default, in the directory that contains amanda.conf
 
 # tapetypes
@@ -231,11 +243,7 @@ indexdir "@CONFIG_DIR@/@DEFAULT_CONFIG@/index"     # index directory
 # are, and how fast the tape device is.
 
 # A filemark is the amount of wasted space every time a tape section
-# ends.  If you run `make tapetype' in tape-src, you'll get a program
-# that generates tapetype entries, but it is slow as hell, use it only
-# if you really must and, if you do, make sure you post the data to
-# the amanda mailing list, so that others can use what you found out
-# by searching the archives.
+# ends.
 
 # For completeness Amanda should calculate the inter-record gaps too,
 # but it doesn't.  For EXABYTE and DAT tapes this is ok.  Anyone using
@@ -327,14 +335,21 @@ define tapetype MIMSY-MEGATAPE {
     speed 170 kbytes           # limited by the Emulex bus interface, ugh
 }
 
+define tapetype SEAGATE-ULTRIUM-LTO {
+     comment "SEAGATE ULTRIUM 06242 LTO, compression off"
+     length 99584 mbytes
+     filemark 0 kbytes
+     speed 11288 kps
+}
 
 # dumptypes
 #
 # These are referred to by the disklist file.  The dumptype specifies
 # certain parameters for dumping including:
 #   auth       - authentication scheme to use between server and client.
-#                Valid values are "bsd", "krb4", "krb5" and "ssh".  
-#                Default: [auth bsd]
+#                Valid values are "bsd", "bsdudp", "bsdtcp", "krb5", "local",
+#                "rsh" and "ssh".  
+#                Default: [auth "bsd"]
 #   comment    - just a comment string
 #   comprate   - set default compression rate.  Should be followed by one or
 #                two numbers, optionally separated by a comma.  The 1st is
@@ -375,7 +390,7 @@ define tapetype MIMSY-MEGATAPE {
 #                              it takes only a few seconds but the result is not 
 #                              accurate if your disk usage changes from day to day.
 #                Default: [client]
-#   encrypt     - specify encryption of the backed up data. Valid values are:
+#   encrypt  - specify encryption of the backed up data. Valid values are:
 #                "none"   - don't encrypt the dump output.
 #                "client" - encrypt on the client using the program specified by 
 #                            client_encrypt "PROG".
@@ -411,7 +426,10 @@ define tapetype MIMSY-MEGATAPE {
 #                going to be backed up.
 #                Default: include all files
 #   holdingdisk        - should the holding disk be used for this dump.  Useful for
-#                dumping the holding disk itself.  Default: [holdingdisk yes]
+#                dumping the holding disk itself.  Default: [holdingdisk auto]
+#                "never"    - Never use the holding disk.
+#                "auto"     - Use the holding disk if possible.
+#                "required" - Always use the holding disk.
 #   ignore     - do not back this filesystem up.  Useful for sharing a single
 #                disklist in several configurations.
 #   index      - keep an index of the files backed up.  Default: [index no]
@@ -429,8 +447,8 @@ define tapetype MIMSY-MEGATAPE {
 #                mode", as many incrementals as will fit on the holding disk
 #                are done, higher priority first, to insure the important
 #                disks are at least dumped.  Default: [priority medium]
-#   program    - specify the dump system to use.  Valid values are "DUMP" and
-#                "GNUTAR".  Default: [program "DUMP"].
+#   program    - specify the dump system to use.  Valid values are "DUMP",
+#                 or "GNUTAR".  Default: [program "DUMP"].
 #   record     - record the backup in the time-stamp-database of the backup
 #                program (e.g. /etc/dumpdates for DUMP or
 #                @GNUTAR_LISTED_INCREMENTAL_DIRX@ for GNUTAR.).
@@ -507,6 +525,7 @@ define dumptype always-full {
     dumpcycle 0
 }
 
+# Dumptypes for gnutar
 define dumptype root-tar {
     global
     program "GNUTAR"
@@ -555,7 +574,7 @@ define dumptype comp-user-tar-span {
 define dumptype holding-disk {
     global
     comment "The master-host holding disk itself"
-    holdingdisk no # do not use the holding disk
+    holdingdisk never # do not use the holding disk
     priority medium
 }
 
@@ -629,21 +648,46 @@ define dumptype comp-test {
 define dumptype custom-compress {
    global
    program "GNUTAR"
-   comment "test dump with custom client compression"
+   comment "custom client compression dumped with tar"
    compress client custom
    client_custom_compress "/usr/bin/bzip2"
 }
 
-define dumptype encrypt-fast {
+define dumptype server-encrypt-fast {
    global
    program "GNUTAR"
-   comment "test dump with fast client compression and server symmetric encryption"
+   comment "fast client compression and server symmetric encryption"
    compress client fast
    encrypt server
-   server_encrypt "/usr/local/sbin/amcrypt"
+   server_encrypt "/usr/sbin/amcrypt"
    server_decrypt_option "-d"
 }
 
+define dumptype client-encrypt-nocomp {
+   global
+   program "GNUTAR"
+   comment "no compression and client symmetric encryption"
+   compress none
+   encrypt client
+   client_encrypt "/usr/sbin/amcrypt"
+   client_decrypt_option "-d"
+}
+
+
+# To use gpg public-key encryption, gpg does compress with zlib by default.
+# Thus, no need to specify compress
+
+#define dumptype gpg-encrypt {
+#    global
+#    program "GNUTAR"
+#    comment "server public-key encryption, dumped with tar"
+#    compress none
+#    encrypt server
+#    server_encrypt "/usr/sbin/amgpgcrypt"
+#    server_decrypt_option "-d"
+#}
+
+
 # network interfaces
 #
 # These are referred to by the disklist file.  They define the attributes
@@ -662,13 +706,54 @@ define dumptype encrypt-fast {
 
 define interface local {
     comment "a local disk"
-    use 1000 kbps
+    use 8000 kbps
+}
+
+#define interface le0 {
+#    comment "10 Mbps ethernet"
+#    use 400 kbps
+#}
+
+#define application-tool and dumptype for the amgtar application
+define application-tool app_amgtar {
+    comment "amgtar"
+    plugin  "amgtar"
+    #property "GNUTAR-PATH" "/path/to/gtar"
+    #property "GNUTAR-LISTDIR" "/path/to/gnutar_list_dir"
+                    #default from gnutar_list_dir setting in amanda-client.conf
+}
+
+define dumptype dt_amgtar {
+    program "APPLICATION"
+    application "app_amgtar"
+}
+
+#define application-tool and dumptype for the amstar application
+define application-tool app_amstar {
+    comment "amstar"
+    plugin  "amstar"
+    #property "STAR-PATH" "/path/to/star"
+    #property "STAR-TARDUMP" "/path/to/tardumps"  # default /etc/tardumps
+    #property "STAR-DLE-TARDUMP" "no"
+       # if 'yes' then create a different tardump file for each DLE,
+        # it is required if you do many dump in parallel (maxdump>1)
+}
+
+define dumptype dt_amstar {
+    program "APPLICATION"
+    application "app_amstar"
 }
 
-define interface le0 {
-    comment "10 Mbps ethernet"
-    use 400 kbps
+#define a script-tool to send an email
+define script-tool sc-email {
+  comment "script-email"
+  plugin  "script-email"
+  execute_on pre-dle-amcheck, pre-host-amcheck, post-dle-amcheck, post-host-amcheck, pre-dle-estimate, pre-host-estimate, post-dle-estimate, post-host-estimate, pre-dle-backup, pre-host-backup, post-dle-backup, post-host-backup
+  execute_where server                 # or client
+  property "mailto" "martinea"
 }
+#your dumptype must include: script "sc-email"
+#to use the script
 
 # You may include other amanda configuration files, so you can share
 # dumptypes, tapetypes and interface definitions among several