X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Fxml-source%2Famanda.conf.5.xml;h=7d4fda62455205c5dceefa33dd1ce644c359b48f;hb=d5853102f67d85d8e169f9dbe973ad573306c215;hp=f082edacd66c442c7d4fcbf0e61ecb635f1a5694;hpb=b93e5b5a13be7e970bc333acbe885f5b518300e1;p=debian%2Famanda diff --git a/man/xml-source/amanda.conf.5.xml b/man/xml-source/amanda.conf.5.xml index f082eda..7d4fda6 100644 --- a/man/xml-source/amanda.conf.5.xml +++ b/man/xml-source/amanda.conf.5.xml @@ -3,7 +3,7 @@ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ - + %global_entities; ]> @@ -18,7 +18,7 @@ amanda.conf -Main configuration file for &A;, the Advanced Maryland Automatic Network Disk Archiver +Main configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver &author.jds; @@ -27,7 +27,7 @@ DESCRIPTION -&amconf; is the main configuration file for &A;. This manpage lists the +&amconf; is the main configuration file for Amanda. This manpage lists the relevant sections and parameters of this file for quick reference. The file <CONFIG_DIR>/<config>/amanda.conf is loaded. @@ -35,7 +35,7 @@ relevant sections and parameters of this file for quick reference. SYNTAX There are a number of configuration parameters that control the -behavior of the &A; programs. +behavior of the Amanda programs. All have default values, so you need not specify the parameter in amanda.conf @@ -52,25 +52,25 @@ The remainder of the line is ignored. KEYWORDS AND IDENTIFIERS Keywords are case insensitive, i.e. -mailto +mailto and -MailTo +MailTo are treated the same. Also, the characters -'-' +'-' and -'_' -are interchangeable in all predefined &A; keywords: -device_property +'_' +are interchangeable in all predefined Amanda keywords: +device_property and -device-property +device-property have the same meaning. Identifiers are names which are defined in the configuration itself, such as dumptypes or interfaces. Identifiers are are case-insensitive, but sensitive to -'-' +'-' vs. -'_'. +'_'. Identifiers should be quoted in the configuration file, although For historical reasons, the quotes are optional. @@ -105,87 +105,95 @@ some of which have a multiplier effect: - b byte bytes + b byte bytes Some number of bytes. - bps + bps Some number of bytes per second. - k kb kbyte kbytes kilobyte kilobytes + k kb kbyte kbytes kilobyte kilobytes Some number of kilobytes (bytes*1024). - kps kbps + kps kbps Some number of kilobytes per second (bytes*1024). It is the default multiplier for all size options. - m mb meg mbyte mbytes megabyte megabytes + m mb meg mbyte mbytes megabyte megabytes Some number of megabytes (bytes*1024*1024). - mps mbps + mps mbps Some number of megabytes per second (bytes*1024*1024). - g gb gbyte gbytes gigabyte gigabytes + g gb gbyte gbytes gigabyte gigabytes Some number of gigabytes (bytes*1024*1024*1024). - tape tapes + t tb tbyte tbytes terabyte terabytes + +Some number of terabytes (bytes*1024*1024*1024*1024). + + + + tape tapes Some number of tapes. - day days + day days Some number of days. - week weeks + week weeks Some number of weeks (days*7). The value -inf +inf may be used in most places where an integer is expected to mean an infinite amount. Boolean arguments may have any of the values -y, -yes, -t, -true +1, +y, +yes, +t, +true or -on +on to indicate a true state, or -n, -no, -f, -false +0, +n, +no, +f, +false or -off +off to indicate a false state. If no argument is given, -true +true is assumed. @@ -230,6 +238,54 @@ property "syspath" "C:\\WINDOWS\\SYSTEM" + +SUBSECTIONS AND INHERITANCE + +Amanda configuration files may include various +subsections, each defining a set of configuration +directives. Each type of subsection is described below. Note that all types +of subsections can inherit from other subsections of the +same type by naming the "parent" section in the "child" subsection. For +example: + + +define dumptype global { + record yes + index yes +} + +define dumptype nocomp { + global # inherit the parameters in dumptype 'global' + compress none +} + + +Note that multiple inheritance is also supported by simply naming +multiple parent sections in a child. Parents are implicitly expanded in place +in a child, and the last occurrence of each parameter takes precedence. For +example, + +define tapetype par1 { + comment "Parent 1" + filemark 8k + speed 300bps + length 200M +} +define tapetype par2 { + comment "Parent 2" + filemark 16k + speed 400bps +} +define tapetype child { + par1 + par2 + filemark 32k +} + +In this example, 'child' will have a filemark of 32k, a speed of 400bps, and a +length of 200M. + + @@ -237,58 +293,57 @@ property "syspath" "C:\\WINDOWS\\SYSTEM" - org string + org string Default: -daily. +"daily". A descriptive name for the configuration. This string appears in the Subject line of mail reports. -Each &A; configuration should have a different string to keep +Each Amanda configuration should have a different string to keep mail reports distinct. - mailer string + mailer string Default found by configure. A mail program that can send mail with 'MAILER -s "subject" user < message_file'. - mailto string + mailto string -Default: -operators. -A space separated list of recipients for mail reports. +Default: none. +A space separated list of recipients for mail reports. If not specified, amdump will not send any mail. - send-amreport-on [all|strange|error|never] + send-amreport-on [ all | strange | error | never ] Default: -all. +all. Specify which types of messages will trigger an email from amreport. amreport is used by amdump and amflush. - all + all Send an email on any message. - strange + strange -Send an email on strange or error message. A strange message occurs when the dump succeeded, but returned one or more errors unknown to &A;. +Send an email on strange or error message. A strange message occurs when the dump succeeded, but returned one or more errors unknown to Amanda. - error + error Send an email only on error messages. - never + never Never send an email. @@ -297,62 +352,72 @@ Specify which types of messages will trigger an email from amreport. amreport is - dumpcycle int + dumpcycle int Default: -10 days. +10 days. The number of days in the backup cycle. Each disk will get a full backup at least this often. Setting this to zero tries to do a full backup each run. This parameter may also be set in a specific -dumptype +dumptype (see below). This value sets the default for all -dumptypes +dumptypes so must appear in amanda.conf before any -dumptypes +dumptypes are defined. - runspercycle int + runspercycle int Default: -same as dumpcycle. +same as dumpcycle. The number of amdump runs in -dumpcycle +dumpcycle days. A value of 0 means the same value as -dumpcycle. +dumpcycle. A value of -1 means guess the number of runs from the &tapelist; file, which is the number of tapes used in the last -dumpcycle +dumpcycle days / -runtapes. +runtapes. - tapecycle int + tapecycle int Default: -15 tapes. -Typically tapes are used by &A; in an ordered rotation. The tapecycle parameter -defines the size of that rotation. The number of tapes in rotation must be larger than the number of tapes -required for a complete dump cycle (see the dumpcycle parameter). - +15 tapes. +Typically tapes are used by Amanda in an ordered rotation. The tapecycle parameter +defines the size of that rotation. This parameter must be be larger than the number of tapes +used in a dumpcycle. -This is calculated by multiplying the number of &amdump; runs per dump cycle -(runspercycle parameter) times the number of tapes used per run -(runtapes parameter). Typically two to four times this calculated number of tapes are in rotation. -While &A; is always willing to use a new tape in its rotation, it refuses to reuse a tape until at -least 'tapecycle -1' number of other tapes have been used. +The number of tapes per dumpcycle is calculated by multiplying the number of +&amdump; runs per dump cycle runspercycle (the +number of &amdump; runs per dump cycle) and runtapes (the number of tapes used per run). Typically +tapecycle is set to two or four times the tapes +per dumpcycle. + +Amanda is commonly misconfigured with tapecycle +equal to the number of tapes per dumpcycle. In this +misconfiguration, amanda may erase a full dump before a new one is completed, +the recovery is then impossible. tapecycle must be at least one tape larger +than the number of tapes per dumpcycle. + + +While Amanda is always willing to use a new tape in its rotation, it refuses to reuse a tape until at +least 'tapecycle -1' number of other tapes have been used. -It is considered good administrative practice to set the tapecycle parameter +It is considered good administrative practice to set the tapecycle parameter slightly lower than the actual number of tapes in rotation. This allows the administrator to more easily cope with damaged or misplaced tapes or schedule adjustments that call for slight adjustments in the rotation order. @@ -360,10 +425,10 @@ with damaged or misplaced tapes or schedule adjustments that call for slight adj - usetimestamps - bool + usetimestamps + bool - Default: Yes. + Default: Yes. This option allows Amanda to track multiple runs per calendar day. The only reason one might disable it is that Amanda versions before 2.5.1 can't read logfiles written when this option was enabled. @@ -372,13 +437,14 @@ can't read logfiles written when this option was enabled. - label_new_tapes - string + label_new_tapes + string + Deprecated, use autolabel option. Default: not set. -When set, this directive will cause &A; to automatically write an &A; +When set, this directive will cause Amanda to automatically write an Amanda tape label to any blank tape she encounters. This option is DANGEROUS -because when set, &A; will ERASE any non-&A; tapes you may have, and may +because when set, Amanda will ERASE any non-Amanda tapes you may have, and may also ERASE any near-failing tapes. Use with caution. When using this directive, specify the template for new tape labels. The template should contain some number of contiguous '%' @@ -391,62 +457,118 @@ Example: - dumpuser string + autolabel + string + [any] + [other_config] + [non_amanda] + [volume_error] + [empty] + + Default: not set. +When set, this directive will cause Amanda to automatically write an Amanda +tape label to most volume she encounters. This option is DANGEROUS +because when set, Amanda may erase near-failing tapes or tapes accidentally +loaded in the wrong slot. +When using this directive, specify the template for new tape +labels. The template should contain some number of contiguous '%' +characters, which will be replaced with a generated number. Be sure to +specify enough '%' characters that you do not run out of tape labels. +Example: +autolabel "DailySet1-%%%" empty + + + +any +equivalent to 'other_config non_amanda volume_error empty' + + + +other_config +Label volumes with a valid Amanda label that do not match our +labelstr. Danger: this may erase volumes +from other Amanda configurations without warning! + + + +non_amanda +Label volumes which do not start with data that resembles an +Amanda header. Danger: this may erase volumes from other backup applications +without warning! + + + +volume_error +Label volumes where an error occurs while trying to read the label. +Danger: this may erase arbitrary volumes due to transient errors. + + + +empty +Label volumes where a read returns 0 bytes. + + + + + + + + dumpuser string Default: -amanda. -The login name &A; uses to run the backups. +"amanda". +The login name Amanda uses to run the backups. The backup client hosts must allow access from the tape server host as this user via .rhosts or .amandahosts, -depending on how the &A; software was built. +depending on how the Amanda software was built. - printer string + printer string Printer to use when doing tape labels. See the -lbl-templ -tapetype +lbl-templ +tapetype option. - tapedev string + tapedev string Default: -null:. -The device name, referencing the name of a "device" section in the configuration file. See -amanda-devices7 +"null:". +The device name, referencing the name of a "device" section in the configuration file. See + for more information on device names. If a tape changer is configured (see the -tpchanger +tpchanger option), this option might not be used. -If tapedev is +If tapedev is null:, programs such as &amdump; will run normally but all images will be thrown away. This should only be used for debugging and testing, and probably only with the -record +record option set to -no. +no. - device_property string string + device_property string string These options can set various device properties. See -amanda-devices7 + for more information on device properties and their syntax. Both strings are always quoted; the first string contains the name of the property to set, and the second contains its value. For example, to set @@ -459,22 +581,21 @@ device_property "BLOCK_SIZE" "128k" - property [append] string string+ + property [append] string string+ These options can set various properties, they can be used by third party software to store information in the configuration file. Both strings are quoted; the first string contains the name of the property to set, and the others contains its values. -append keyword append the values to the list of values for that property. +append keyword append the values to the list of values for that property. - tpchanger string + tpchanger string -Default: -none. +Default: not set. The name of the tape changer. If a tape changer is not configured, this option is not used and should be commented out of the configuration file. @@ -485,94 +606,94 @@ and enter that here. - changerdev string + changerdev string Default: -/dev/null. +"dev/null". A tape changer configuration parameter. Usage depends on the particular changer defined with the -tpchanger +tpchanger option. - changerfile string + changerfile string Default: -/usr/adm/amanda/log/changer-status. +"usr/adm/amanda/log/changer-status". A tape changer configuration parameter. Usage depends on the particular changer defined with the -tpchanger +tpchanger option. - runtapes int + runtapes int Default: -1. +1. The maximum number of tapes used in a single run. If a tape changer is not configured, this option is not used and should be commented out of the configuration file. If a tape changer is configured, this may be set larger than one to -let &A; write to more than one tape. +let Amanda write to more than one tape. Note that this is an upper bound on the number of tapes, -and &A; may use less. -Also note that as of this release, &A; does not support true tape overflow. +and Amanda may use less. +Also note that as of this release, Amanda does not support true tape overflow. When it reaches the end of one tape, -the backup image &A; was processing starts over again on the next tape. +the backup image Amanda was processing starts over again on the next tape. - maxdumpsize int + maxdumpsize int Default: -runtapes*tape_length. +runtapes*tape_length. Maximum number of bytes the planner will schedule for a run. The default unit is Kbytes if it is not specified. - taperalgo [first|firstfit|largest|largestfit|smallest|last] + taperalgo [ first | firstfit | largest | largestfit | smallest | last ] Default: -first. +first. The algorithm used to choose which dump image to send to the taper. - first + first First in, first out. - firstfit + firstfit The first dump image that will fit on the current tape. - largest + largest The largest dump image. - largestfit + largestfit The largest dump image that will fit on the current tape. - smallest + smallest The smallest dump image. - last + last Last in, first out. @@ -582,13 +703,13 @@ The algorithm used to choose which dump image to send to the taper. -labelstr string +labelstr string Default: -.*. +".*". The tape label constraint regular expression. All tape labels generated (see -amlabel8) +) and used by this configuration must match the regular expression. If multiple configurations are run from the same tape server host, it is helpful to set their labels to different strings @@ -598,39 +719,39 @@ to avoid overwriting each other's tapes. - tapetype identifier + tapetype string Default: -"EXABYTE". +no default. The type of tape drive associated with -tapedev +tapedev or -tpchanger. -This refers to one of the defined tapetypes +tpchanger. +This refers to one of the defined tapetypes in the config file (see below), which specify various tape parameters, like the -length, -filemark +length, +filemark size, and -speed +speed of the tape media and device. - ctimeout int + ctimeout int Default: -30 seconds. +30 seconds. Maximum amount of time that amcheck will wait for each client host. - dtimeout int + dtimeout int Default: -1800 seconds. +1800 seconds. Amount of idle time per disk on a given client that a dumper running from within @@ -640,10 +761,10 @@ will wait before it fails with a data timeout error. - etimeout int + etimeout int Default: -300 seconds. +300 seconds. Amount of time per estimate on a given client that the planner step of amdump will wait to get the dump size estimates @@ -657,41 +778,41 @@ per client instead of per disk. - connect_tries int + connect_tries int Default: -3. +3. How many times the server will try a connection. - req_tries int + req_tries int Default: -3. +3. How many times the server will resend a REQ packet if it doesn't get the ACK packet. - netusage int + netusage int Default: -8000 Kbps. -The maximum network bandwidth allocated to &A;, in Kbytes per second. +8000 Kbps. +The maximum network bandwidth allocated to Amanda, in Kbytes per second. See also the interface section. - inparallel int + inparallel int Default: -10. -The maximum number of backups that &A; will attempt to run in parallel. -&A; will stay within the constraints of network bandwidth and +10. +The maximum number of backups that Amanda will attempt to run in parallel. +Amanda will stay within the constraints of network bandwidth and holding disk space available, so it doesn't hurt to set this number a bit high. Some contention can occur with larger numbers of backups, but this effect is relatively small on most systems. @@ -699,20 +820,20 @@ of backups, but this effect is relatively small on most systems. - displayunit "k|m|g|t" + displayunit "k|m|g|t" Default: -"k". +"k". The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera. - dumporder string + dumporder string Default: -tttTTTTTTT. +"tttTTTTTTT". The priority order of each dumper: @@ -728,36 +849,36 @@ B: largest bandwidth - maxdumps int + maxdumps int Default: -1. -The maximum number of backups from a single host that &A; will +1. +The maximum number of backups from a single host that Amanda will attempt to run in parallel. See also the inparallel option. Note that this parameter may also be set in a specific -dumptype +dumptype (see below). This value sets the default for all -dumptypes +dumptypes so must appear in amanda.conf before any -dumptypes +dumptypes are defined. - bumpsize int + bumpsize int Default: -10 Mbytes. +10 Mbytes. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size. -If &A; determines that the next higher backup level +If Amanda determines that the next higher backup level will be this much smaller than the current level, it will do the next level. The value of this parameter is used only if the parameter @@ -770,21 +891,21 @@ dumptype-definition. See also the options -bumppercent, -bumpmult and -bumpdays. +bumppercent, +bumpmult and +bumpdays. - bumppercent int + bumppercent int Default: -0 percent. +0. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as percentage of the current size of the DLE (size of current level 0). -If &A; determines that the next higher backup level +If Amanda determines that the next higher backup level will be this much smaller than the current level, it will do the next level. @@ -798,27 +919,27 @@ dumptype-definition. See also the options -bumpsize, -bumpmult and -bumpdays. +bumpsize, +bumpmult and +bumpdays. - bumpmult float + bumpmult float Default: -1.5. +1.5. The bump size multiplier. -&A; multiplies -bumpsize +Amanda multiplies +bumpsize by this factor for each level. This prevents active filesystems from bumping too much by making it harder to bump to the next level. For example, with the default -bumpsize +bumpsize and -bumpmult +bumpmult set to 2.0, the bump threshold will be 10 Mbytes for level one, 20 Mbytes for level two, 40 Mbytes for level three, and so on. @@ -828,13 +949,13 @@ dumptype-definition. - bumpdays int + bumpdays int Default: -2 days. -To insure redundancy in the dumps, &A; keeps filesystems at the +2 days. +To insure redundancy in the dumps, Amanda keeps filesystems at the same incremental level for at least -bumpdays +bumpdays days, even if the other bump threshold criteria are met. The global setting of this parameter can be overwritten inside of a @@ -844,22 +965,22 @@ dumptype-definition. - diskfile string + diskfile string Default: -disklist. +"disklist". The file name for the disklist file holding client hosts, disks and other client dumping information. - infofile string + infofile string Default: -/usr/adm/amanda/curinfo. +"/usr/adm/amanda/curinfo". The file or directory name for the historical information database. -If &A; was configured to use DBM databases, this is the base file +If Amanda was configured to use DBM databases, this is the base file name for them. If it was configured to use text formated databases (the default), this is the base directory and within here will be a directory per @@ -867,10 +988,10 @@ client, then a directory per disk, then a text file of data. - logdir string + logdir string Default: -/usr/adm/amanda. +"/usr/adm/amanda". The directory for the amdump and @@ -879,34 +1000,34 @@ files. - indexdir string + indexdir string Default -/usr/adm/amanda/index. +"/usr/adm/amanda/index". The directory where index files (backup image catalogues) are stored. Index files are only generated for filesystems whose -dumptype +dumptype has the -index +index option enabled. - tapelist string + tapelist string Default: -tapelist. +"tapelist". The file name for the active &tapelist;. -&A; maintains this file with information about the active set of tapes. +Amanda maintains this file with information about the active set of tapes. - device_output_buffer_size int + device_output_buffer_size int Default: -1280k. -Controls the amount of memory used by &A; +1280k. +Controls the amount of memory used by Amanda to hold data as it is read from the network or disk before it is written to the output device. Higher values may be useful on fast tape drives and optical media. @@ -914,22 +1035,22 @@ useful on fast tape drives and optical media. - tapebufs int + tapebufs int Default: -20. +20. This option is deprecated; use -the device_output_buffer_size directive -instead. tapebufs works the same way, +the device_output_buffer_size directive +instead. tapebufs works the same way, but the number specified is multiplied by the device blocksize prior to use. - reserve number + reserve int Default: -100. +100. The part of holding-disk space that should be reserved for incremental backups if no tape is available, expressed as a percentage of the available holding-disk space (0-100). @@ -939,50 +1060,51 @@ the amount of holding disk space reserved for incrementals should be lowered.

 - autoflush bool + autoflush bool Default: -off. +off. Whether an amdump run will flush the dumps from holding disk to tape. - amrecover_do_fsf bool + amrecover_do_fsf bool Default: -on. +on. Amrecover will call amrestore with the -f flag for faster positioning of the tape. - amrecover_check_label bool + amrecover_check_label bool Default: -on. +on. Amrecover will call amrestore with the -l flag to check the label. - amrecover_changer string + amrecover_changer string -Default: ''. +Default: not set. Amrecover will use the changer if you use 'settape <string>' and that string is the same as the amrecover_changer setting. - columnspec string + columnspec string + default: "HostName=0:12:12,Disk=1:11:11,Level=1:1:1,OrigKB=1:-7:0,OutKB=1:-7:0,Compress=1:-6:1,DumpTime=1:-7:7,Dumprate=1:-6:1,TapeTime=1:-6:6,TapeRate=1:-6:1" Defines the width of columns amreport should use. String is a comma (',') separated list of triples. Each triple consists of three parts which are separated by a equal sign ('=') and a colon (':') (see the example). -These three parts specify: - +These four parts specify: + - the name of the column, which may be: + the name of the column, which may be: Compress (compression ratio) @@ -995,38 +1117,41 @@ These three parts specify: OutKB (output image size in KBytes) TapeRate (tape writing rate in KBytes/sec) TapeTime (total tape time in hours:minutes) - + -the amount of space to display before the column (used to get whitespace between columns). +the amount of space to display before the column (used to get whitespace between columns). the width of the column itself. If set to a negative value, the width will be calculated on demand to fit the largest entry in this column. - + +the precision of the column, number of digit after the decimal point for number. + + Here is an example: -columnspec "Disk=1:18,HostName=0:10,OutKB=1:7" +columnspec "Disk=1:18,HostName=0:10,OrigKB=::2,OutKB=1:7" The above will display the disk information in 18 characters and put one space before it. The hostname column will be 10 characters wide with -no space to the left. The output KBytes column is seven characters wide +no space to the left. The Original KBytes print 2 decimal digit. The output KBytes column is seven characters wide with one space before it. - includefile string + includefile string Default: -none. -The name of an &A; configuration file to include within the current file. +no default. +The name of an Amanda configuration file to include within the current file. Useful for sharing dumptypes, tapetypes and interface definitions among several configurations. Relative pathnames are relative to the configuration directory. @@ -1034,121 +1159,127 @@ Relative pathnames are relative to the configuration directory. - debug_auth int + debug_days int Default: -0. +3. +The number of days the debug files are kept. + + + + + debug_auth int + +Default: +0. Debug level of the auth module - debug_event int + debug_event int Default: -0. +0. Debug level of the event module - debug_holding int + debug_holding int Default: -0. +0. Debug level of the holdingdisk module - debug_protocol int + debug_protocol int Default: -0. +0. Debug level of the protocol module - debug_planner int + debug_planner int Default: -0. +0. Debug level of the planner process - debug_driver int + debug_driver int Default: -0. +0. Debug level of the driver process - debug_dumper int + debug_dumper int Default: -0. +0. Debug level of the dumper process - debug_chunker int + debug_chunker int Default: -0. +0. Debug level of the chunker process - debug_taper int + debug_taper int Default: -0. +0. Debug level of the taper process - flush-threshold-dumped int + flush-threshold-dumped int -Default: 0. - &A; will not begin writing data to a new volume until the amount of +Default: 0. + Amanda will not begin writing data to a new volume until the amount of data on the holding disk is at least this percentage of the volume - size. In other words, &A; will not begin until the - inequality h > t × - d is satisfied, - where h is the amount of data on the - holding disk, t is the capacity of a - volume, and d is this parameter, expressed as a - percentage. This parameter may be larger than 100%, for example to keep + size. In other words, Amanda will not begin until the + amount of data on the holding disk is greater than the tape + length times this parameter. + This parameter may be larger than 100%, for example to keep more recent dumps on the holding disk for faster recovery. Needless to say, your holding disk must be big enough that this criterion could be satisfied. If the holding disk cannot be used for a particular dump (because, for example, there is no - remaining holding space) then &A; will disregard the constraint + remaining holding space) then Amanda will disregard the constraint specified by this setting and start a new volume anyway. Once writing to a volume has begun, this constraint is not applied unless and until a new volume is needed. The value of this parameter may not exceed than that of - the flush-threshold-scheduled + the flush-threshold-scheduled parameter. - flush-threshold-scheduled int + flush-threshold-scheduled int -Default: 0. - &A; will not begin writing data to a new volume until the sum of the +Default: 0. + Amanda will not begin writing data to a new volume until the sum of the amount of data on the holding disk and the estimated amount of data remaining to be dumped during this run is at least this percentage - of the volume size. In other words, &A; will not begin until the + of the volume size. In other words, Amanda will not begin until the inequality h + s > t × d is satisfied, where h is the amount of data on the @@ -1160,27 +1291,27 @@ Debug level of the taper process Needless to say, your holding disk must be big enough that this criterion could be satisfied. If the holding disk cannot be used for a particular dump (because, for example, there is no - remaining holding space) then &A; will disregard the constraint + remaining holding space) then Amanda will disregard the constraint specified by this setting and start a new volume anyway. Once writing to a volume has begun, this constraint is not applied unless and until a new volume is needed. The value of this parameter may not be less than that of - the flush-threshold-dumped - or taperflush parameters. + the flush-threshold-dumped + or taperflush parameters. - taperflush int + taperflush int -Default: 0. - At the end of a run, &A; will start a new tape to flush remaining +Default: 0. + At the end of a run, Amanda will start a new tape to flush remaining data if there is more data on the holding disk at the end of a run than this setting allows; the amount is specified as a percentage of the capacity of a single - volume. In other words, at the end of a run, &A; will begin + volume. In other words, at the end of a run, Amanda will begin a new tape if the inequality h > t × f is satisfied, @@ -1190,37 +1321,37 @@ Debug level of the taper process and f is this parameter, expressed as a percentage. This parameter may be greater than 100%. The value of this parameter may not exceed that of - the flush-threshold-scheduled - parameter.; autoflush must be set to 'yes' if - taperflush is greater than 0. + the flush-threshold-scheduled + parameter.; autoflush must be set to 'yes' if + taperflush is greater than 0. - reserved-udp-port int,int + reserved-udp-port int,int Default: --with-udpportrange or -512,1023. +512,1023. Reserved udp port that will be used (bsd, bsdudp). Range is inclusive. - reserved-tcp-port int,int + reserved-tcp-port int,int Default: --with-low-tcpportrange or -512,1023. +512,1023. Reserved tcp port that will be used (bsdtcp). Range is inclusive. - unreserved-tcp-port int,int + unreserved-tcp-port int,int Default: --with-tcpportrange or -1024,65535. +1024,65535. Unreserved tcp port that will be used (bsd, bsdudp). Range is inclusive. @@ -1236,12 +1367,13 @@ backup images before they are written to tape. The syntax is: -holdingdisk name { +define holdingdisk name { holdingdisk-option holdingdisk-value ... } +The { must appear at the end of a line, and the } on its own line. Name is a logical name for this holding disk. @@ -1249,39 +1381,38 @@ is a logical name for this holding disk. - comment string + comment string -Default: -none. +Default: not set. A comment string describing this holding disk. - directory disk + directory string Default: -/dumps/amanda. +"/dumps/amanda". The path to this holding area. - use int + use int Default: -0 Gb. +0 Gb. Amount of space that can be used in this holding disk area. If the value is zero, all available space on the file system is used. -If the value is negative, &A; will use all available space minus that value. +If the value is negative, Amanda will use all available space minus that value. - chunksize int + chunksize int Default: -1 Gb. +1 Gb. Holding disk chunk size. Dumps larger than the specified size will be stored in multiple holding disk files. The size of each chunk will not exceed the specified value. However, even though dump images are split in the holding disk, they are concatenated as @@ -1289,7 +1420,7 @@ they are written to tape, so each dump image still corresponds to a single conti tape section. The default unit is Kbytes if it is not specified. -If 0 is specified, &A; will create holding disk chunks as large as +If 0 is specified, Amanda will create holding disk chunks as large as ((INT_MAX/1024)-64) Kbytes. Each holding disk chunk includes a 32 Kbyte header, so the minimum @@ -1298,7 +1429,7 @@ chunk size is 64 Kbytes (but that would be really silly). Operating systems that are limited to a maximum file size of 2 Gbytes actually cannot handle files that large. They must be at least one byte less than 2 Gbytes. -Since &A; works with 32 Kbyte blocks, and +Since Amanda works with 32 Kbyte blocks, and to handle the final read at the end of the chunk, the chunk size should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum file size, e.g. 2047 Mbytes. @@ -1315,7 +1446,7 @@ that can benefit from high compression, another set that does not compress well, another set for file systems that should always get a full backup and so on. A set of backup options are entered in a -dumptype +dumptype section, which looks like this: @@ -1325,54 +1456,65 @@ define dumptype "name" { } +The { must appear at the end of a line, and the } on its own line. Name is the name of this set of backup options. It is referenced from the &disklist; file. Some of the options in a -dumptype +dumptype section are the same as those in the main part of &amconf;. The main option value is used to set the default for all -dumptype +dumptype sections. For instance, setting -dumpcycle +dumpcycle to 50 in the main part of the config file causes all following -dumptype +dumptype sections to start with that value, but the value may be changed on a section by section basis. Changes to variables in the main part of the config file must be done before (earlier in the file) any -dumptypes +dumptypes are defined. The dumptype options and values are: - auth string + auth string Default: -bsd. -Type of authorization to perform between tape server and backup client hosts. See amanda-auth7 for more detail. +"bsd". +Type of authorization to perform between tape server and backup client hosts. See for more detail. - amandad_path string + amandad_path string Default: -$libexec/amandad. +"$libexec/amandad". Specify the amandad path of the client, only use with rsh/ssh authentification. - client_username string + client_username string Default: -CLIENT_LOGIN. +CLIENT_LOGIN. Specify the username to connect on the client, only use with rsh/ssh authentification. + + + + + + client_port [ int | string ] + +Default: +"amanda". +Specifies the port to connect to on the client. It can be a service name or a numeric port number. @@ -1380,13 +1522,13 @@ Specify the username to connect on the client, only use with rsh/ssh authentific - bumpsize int + bumpsize int Default: -10 Mbytes. +10 Mbytes. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as size. -If &A; determines that the next higher backup level +If Amanda determines that the next higher backup level will be this much smaller than the current level, it will do the next level. The value of this parameter is used only if the parameter @@ -1395,21 +1537,21 @@ The value of this parameter is used only if the parameter The default unit is Kbytes if it is not specified. See also the options -bumppercent, -bumpmult and -bumpdays. +bumppercent, +bumpmult and +bumpdays. - bumppercent int + bumppercent int Default: -0 percent. +0. The minimum savings required to trigger an automatic bump from one incremental level to the next, expressed as percentage of the current size of the DLE (size of current level 0). -If &A; determines that the next higher backup level +If Amanda determines that the next higher backup level will be this much smaller than the current level, it will do the next level. @@ -1419,86 +1561,84 @@ parameter bumpsize is used to trigger bumping. See also the options -bumpsize, -bumpmult and -bumpdays. +bumpsize, +bumpmult and +bumpdays. - bumpmult float + bumpmult float Default: -1.5. +1.5. The bump size multiplier. -&A; multiplies -bumpsize +Amanda multiplies +bumpsize by this factor for each level. This prevents active filesystems from bumping too much by making it harder to bump to the next level. For example, with the default -bumpsize +bumpsize and -bumpmult +bumpmult set to 2.0, the bump threshold will be 10 Mbytes for level one, 20 Mbytes for level two, 40 Mbytes for level three, and so on. - bumpdays int + bumpdays int Default: -2 days. -To insure redundancy in the dumps, &A; keeps filesystems at the +2 days. +To insure redundancy in the dumps, Amanda keeps filesystems at the same incremental level for at least -bumpdays +bumpdays days, even if the other bump threshold criteria are met. - comment string + comment string -Default: -none. +Default: not set. A comment string describing this set of backup options. - comprate float [, float ] + comprate float [, float ] Default: -0.50, -0.50. +0.50, 0.50. The expected full and incremental compression factor for dumps. -It is only used if &A; does not have any history information on +It is only used if Amanda does not have any history information on compression rates for a filesystem, so should not usually need to be set. However, it may be useful for the first time a very large filesystem that compresses very little is backed up. - compress [client|server] string + compress [ none | client | server ] [ best | fast | custom ] Default: -client fast. -If &A; does compression of the backup images, it can do so either on the backup client +client fast. +If Amanda does compression of the backup images, it can do so either on the backup client host before it crosses the network or on the tape server host as it goes from the network into the holding disk or to tape. Which place to do compression (if at all) depends on how well the dump image usually compresses, the speed and load on the client or server, network capacity, holding disk capacity, availability of tape hardware compression, etc. -For either type of compression, &A; also allows the selection +For either type of compression, Amanda also allows the selection of three styles of compression. -Best +best is the best compression available, often at the expense of CPU overhead. -Fast +fast is often not as good a compression as -best, -but usually less CPU overhead. Or to specify Custom +best, +but usually less CPU overhead. Or to specify custom to use your own compression method. (See dumptype custom-compress in example/amanda.conf for reference) -So the compress options line may be one of: +So the compress options line may be one of: @@ -1526,20 +1666,39 @@ to use your own compression method. (See dumptype custom-compress in example/ama compress server custom - Specify server_custom_compress "PROG" + Specify server_custom_compress "PROG" PROG must not contain white space and it must accept -d for uncompress. Note that some tape devices do compression and this option has nothing to do with whether that is used. If hardware compression is used (usually via a particular tape device name -or mt option), &A; (software) compression should be disabled. +or mt option), Amanda (software) compression should be disabled. + + + + + client_custom_compress string + +Default: none. + The program to use to perform compression/decompression on the client; used with +"compress client custom". Must not contain whitespace. Must accept -d to uncompress. + + + + + server_custom_compress string + +Default: none. + The program to use to perform compression/decompression on the server; used with +"compress server custom". Must not contain whitespace. Must accept -d to uncompress. + - dumpcycle int + dumpcycle int -Default: 10 days. +Default: 10 days. The number of days in the backup cycle. Each disk using this set of options will get a full backup at least this of ten. Setting this to zero tries to do a full backup each run. @@ -1547,13 +1706,13 @@ ten. Setting this to zero tries to do a full backup each run. - encrypt [none|client|server] + encrypt [ none | client | server ] -Default: none. +Default: not set. To encrypt backup images, it can do so either on the backup client host before it crosses the network or on the tape server host as it goes from the network into the holding disk or to tape. -So the encrypt options line may be one +So the encrypt options line may be one of: @@ -1590,32 +1749,71 @@ client-encryption AND server-compression is not supported. + + client_encrypt string + +Default: none. +The program to use to perform encryption/decryption on the client; used with +"encrypt client". Must not contain whitespace. + + + + + client_decrypt_option string + +Default: -d. +The option that can be passed to client_encrypt to make it decrypt instead. +Must not contain whitespace. + + + + + server_encrypt string + +Default: none. +The program to use to perform encryption/decryption on the server; used with +"encrypt server". Must not contain whitespace. + + + + + server_decrypt_option string + +Default: -d. +The option that can be passed to server_encrypt to make it decrypt instead. +Must not contain whitespace. + + - estimate client|calcsize|server + estimate [ client | calcsize | server ]+ -Default: client. -Determine the way &A; does it's estimate. +Default: client. +Determine the way Amanda estimates the size of each DLE before beginning a backup. This is a list of acceptable estimate methods, and Amanda applies the first method supported by the application. The methods are: client - Use the same program as the dumping program, this is the most - accurate way to do estimates, but it can take a long time. + Use the same program as the dumping program. This is the most + accurate method to do estimates, but it can take a long time. calcsize - Use a faster program to do estimates, but the result is less accurate. + Use a faster program to do estimates, but the result is less + accurate. server - Use only statistics from the previous run to give an estimate, - it takes only a few seconds but the result is not accurate if your disk - usage changes from day to day. + Use only statistics from the previous few runs to give an estimate. + This very quick, but the result is not accurate if your disk + usage changes from day to day. If this method is specified, but the + server does not have enough data to make an estimate, then the option + is internally moved to the end of the list, thereby preferring 'client' + or 'calcsize' in this case. @@ -1624,42 +1822,46 @@ Determine the way &A; does it's estimate. - exclude [ list|file ][[optional][ append ][ string ]+] + exclude [ list | file ][[optional][append][ string ]+] Default: -file. -There are two exclude lists, -exclude file +file. Exclude is the opposite of +include and specifies files that will be excluded from +the backup. The format of the exclude expressions depends on the application, +and some applications do not support excluding files at all. + +There are two exclude parameters, +exclude file and -exclude list. +exclude list. With -exclude file -, the -string -is a &gnutar; exclude expression. With -exclude list +exclude file, the +string +is an exclude expression. With +exclude list , the -string +string is a file name on the client containing &gnutar; exclude expressions. The path to the specified exclude list file, if present (see description of -'optional' below), must be readable by the &A; user. +'optional' below), must be readable by the Amanda user. -All exclude expressions are concatenated in one file and passed to &gnutar; -as an argument. +All exclude expressions are concatenated in one file and passed to the +application as an argument. -Exclude expressions must always be specified as relative to the -head directory of the DLE. +For &gnutar;, exclude expressions must always be specified as relative to the +top-level directory of the DLE, and must start with "./". See the manpages for individual +applications for more information on supported exclude expressions. With the -append keyword, the -string is appended to the current list, without it, the -string overwrites the list. +append keyword, the +string is appended to the current list, without it, the +string overwrites the list. -If optional -is specified for exclude list, +If optional +is specified for exclude list, then amcheck will not complain if the file doesn't exist or is not readable. -For exclude list, +For exclude list, if the file name is relative, the disk name being backed up is prepended. So if this is entered: @@ -1676,33 +1878,33 @@ for a backup of /var, - holdingdisk [ never|auto|required ] + holdingdisk [ never | auto | required ] Default: -auto. +auto. Whether a holding disk should be used for these backups or whether they should go directly to tape. -If the holding disk is a portion of another file system that &A; +If the holding disk is a portion of another file system that Amanda is backing up, that file system should refer to a dumptype with -holdingdisk +holdingdisk set to never to avoid backing up the holding disk into itself. - never|no|false|off + never|no|false|off Never use a holdingdisk, the dump will always go directly to tape. There will be no dump if you have a tape error. - auto|yes|true|on + auto|yes|true|on 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) - required + required Always dump to holdingdisk, never directly to tape. There will be no dump if it doesn't fit on holdingdisk @@ -1713,10 +1915,10 @@ to avoid backing up the holding disk into itself. - ignore boolean + ignore boolean Default: -no. +no. Whether disks associated with this backup type should be backed up or not. This option is useful when the disklist @@ -1725,150 +1927,150 @@ some of which should not back up all the listed file systems. - include [ list|file ][[optional][ append ][ string ]+] + include [ list | file ][[optional][append][ string ]+] Default: -file +file ".". There are two include lists, -include file +include file and -include list. +include list. With -include file +include file , the -string +string is a glob expression. With -include list +include list , the -string +string is a file name on the client containing glob expressions. -All include expressions are expanded by &A;, concatenated in one file and passed to &gnutar; as a +All include expressions are expanded by Amanda, concatenated in one file and passed to &gnutar; as a argument. They must start with "./" and contain no other "/". Include expressions must always be specified as relative to the head directory of the DLE. For globbing to work at all, even the limited single level, -the top level directory of the DLE must be readable by the &A; user. +the top level directory of the DLE must be readable by the Amanda user. -With the append keyword, the -string is appended to the current list, without it, the -string overwrites the list. +With the append keyword, the +string is appended to the current list, without it, the +string overwrites the list. If -optional is specified for -include list, then amcheck will not complain if the file +optional is specified for +include list, then amcheck will not complain if the file doesn't exist or is not readable. -For include list, +For include list, If the file name is relative, the disk name being backed up is prepended. - index boolean + index boolean -Default: no. +Default: no. Whether an index (catalogue) of the backup should be generated and saved in -indexdir. +indexdir. These catalogues are used by the amrecover utility. - kencrypt boolean + kencrypt boolean Default: -no. +no. Whether the backup image should be encrypted by Kerberos as it is sent across the network from the backup client host to the tape server host. - maxdumps int + maxdumps int Default: -1. -The maximum number of backups from a single host that &A; will attempt to run in parallel. -See also the main section parameter inparallel. +1. +The maximum number of backups from a single host that Amanda will attempt to run in parallel. +See also the main section parameter inparallel. - maxpromoteday int + maxpromoteday int Default: -10000. +10000. The maximum number of day for a promotion, set it 0 if you don't want promotion, set it to 1 or 2 if your disks get overpromoted. - priority string + priority [ low | medium | high ] -Default: medium. -When there is no tape to write to, &A; will do incremental backups +Default: medium. +When there is no tape to write to, Amanda will do incremental backups in priority order to the holding disk. The priority may be high (2), medium (1), low (0) or a number of your choice. - program [DUMP|GNUTAR|APPLICATION] + program [ "DUMP" | "GNUTAR" | "APPLICATION" ] Default: -DUMP. +"DUMP". The type of backup to perform. Valid values are: - DUMP + "DUMP" The native operating system backup program. - GNUTAR + "GNUTAR" To use GNU-tar or to do PC backups using Samba. - APPLICATION + "APPLICATION" -To use an application-tool, see the application option. +To use an application, see the application option. - application string + application string -No default. Must be the name of an application-tool if program is set to APPLICATION. See APPLICATION SECTION below. +No default. Must be the name of an application if program is set to APPLICATION. See APPLICATION SECTION below. - script string + script string -No default. Must be the name of a script-tool. You can have many script. See SCRIPT SECTION below. +No default. Must be the name of a script. You can have many script. See SCRIPT SECTION below. - property [append] string string+ + property [append] string string+ These options can set various properties, they can be used by third party software to store information in the configuration file. Both strings are quoted; the first string contains the name of the property to set, and the others contains its values. -append keyword append the values to the list of values for that property. +append keyword append the values to the list of values for that property. - record boolean + record boolean Default: yes. @@ -1878,77 +2080,78 @@ This is normally enabled for daily backups and turned off for periodic archival - skip-full boolean + skip-full boolean Default: -no. If true and +no. If true and planner has scheduled a full backup, these disks will be skipped, and -full backups should be run off-line on these days. It was reported that &A; only schedules +full backups should be run off-line on these days. It was reported that Amanda only schedules level 1 incrementals in this configuration; this is probably a bug. - skip-incr boolean + skip-incr boolean Default: -no. If true and +no. If true and planner has scheduled an incremental backup, these disks will be skipped. - ssh_keys string + ssh_keys string -Default: -No default. +Default: not set. The key file the ssh auth will use, it must be the private key. If this parameter is not specified, then the default ssh key will be used. - starttime int + starttime int -Default: -none. -Backups will not start until after this time of day. +Default: not set. +Backup of these disks will not start until after this time of day. The value should be hh*100+mm, e.g. 6:30PM (18:30) would be entered as 1830. - strategy string + strategy [ standard | nofull | noinc | skip | incronly ] - Default: standard. + Default: standard. Strategy to use when planning what level of backup to run next. Values are: - standard + standard - The standard &A; schedule. + The standard Amanda schedule. - nofull + nofull Never do full backups, only level 1 incrementals. - noinc + noinc Never do incremental backups, only full dumps. - skip + skip - Never do backups (useful when sharing the disklist file). + Treat this DLE as if it doesn't exist (useful to disable DLEs + when sharing the disklist file between + multiple configurations). Skipped DLEs will not be checked or + dumped, and will not be matched by disklist expressions. - incronly + incronly Only do incremental dumps. amadmin force should be used to tell - &A; that a full dump has been performed off-line, so that it resets to level 1. + Amanda that a full dump has been performed off-line, so that it resets to level 1. @@ -1956,10 +2159,9 @@ The value should be hh*100+mm, e.g. 6:30PM (18:30) would be entered as - tape_splitsize int + tape_splitsize int -Default: -none. +Default: not set. Split dump file on tape into pieces of a specified size. This allows dumps to be spread across multiple tapes, and can potentially make more efficient use of tape space. @@ -1973,20 +2175,19 @@ A good rule of thumb, usually, is 1/10 of the size of your tape. - split_diskbuffer string + split_diskbuffer string -Default: -none. +Default: not set. 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. - fallback_splitsize int + fallback_splitsize int Default: -10M. +10M. When dumping a split dump in PORT-WRITE mode, if no split_diskbuffer is specified (or if we somehow fail to use our split_diskbuffer), we must buffer split chunks in memory. @@ -2001,7 +2202,7 @@ the dump server may reasonably consume. -The following dumptype entries are predefined by &A;: +The following dumptype entries are predefined by Amanda: define dumptype "no-compress" { @@ -2019,9 +2220,6 @@ define dumptype "srvcompress" { define dumptype "bsd-auth" { auth bsd } -define dumptype "krb4-auth" { - auth krb4 -} define dumptype "no-record" { record no } @@ -2034,15 +2232,15 @@ define dumptype "no-full" { In addition to options in a -dumptype +dumptype section, one or more other -dumptype +dumptype names may be supplied as identifiers, which make this -dumptype +dumptype inherit options from other previously defined -dumptypes. +dumptypes. For instance, two sections might be the same except for the -record option: +record option: define dumptype "normal" { @@ -2058,85 +2256,88 @@ define dumptype "testing" { } -&A; provides a -dumptype +Amanda provides a +dumptype named global in the sample amanda.conf file that all -dumptypes +dumptypes should reference. This provides an easy place to make changes that will affect every -dumptype. +dumptype, although you must be careful +that every dumptype explicitly inherits from the +global +dumptype - Amanda does not do so automatically. TAPETYPE SECTION The amanda.conf file may define multiple types of tape media and devices. The information is entered in a -tapetype +tapetype section, which looks like this in the config file: -define tapetype "name" { +define tapetype "name" { tapetype-option tapetype-value ... } +The { must appear at the end of a line, and the } on its own line. Name is the name of this type of tape medium/device. It is referenced from the -tapetype +tapetype option in the main part of the config file. The tapetype options and values are: - comment string + comment string -Default: -none. +Default: not set. A comment string describing this set of tape information. - filemark int + filemark int Default: -1 kbytes. +1 kbytes. How large a file mark (tape mark) is, measured in kbytes. If the size is only known in some linear measurement (e.g. inches), convert it to kbytes using the device density. - length int + length int Default: -2000 kbytes. How much data will fit on a tape, expressed in kbytes. +2000 kbytes. How much data will fit on a tape, expressed in kbytes. -Note that this value is only used by &A; to schedule which backups will be run. -Once the backups start, &A; will continue to write to a tape until it gets an error, -regardless of what value is entered for length -(but see amanda-devices7 for exceptions). +Note that this value is only used by Amanda to schedule which backups will be run. +Once the backups start, Amanda will continue to write to a tape until it gets an error, +regardless of what value is entered for length +(but see for exceptions). -blocksize int +blocksize int Default: -32 kbytes. +32 kbytes. How much data will be written in each tape record, expressed in kbytes. This is similar to the BLOCK_SIZE device property, but if the blocksize is not a multiple of 1024 bytes, then this parameter cannot be used to specify it, and the property must be used instead. -readblocksize int +readblocksize int -Default: 32 kytes +Default: 32 kytes How much data will be read in each tape record. This can be used to override a device's block size for reads only. This may be useful, for example, in reading a tape written with a 256k block size when Amanda is configured to use @@ -2148,34 +2349,35 @@ tape devices. - speed int + speed int Default: -200 bps. +200 bps. How fast the drive will accept data, in bytes per second. -This parameter is NOT currently used by &A;. +This parameter is NOT currently used by Amanda. - lbl-templ string + lbl-templ string -A PostScript template file used by +Default: not set. +A PostScript template file used by amreport -to generate labels. Several sample files are provided with the &A; sources in the +to generate labels. Several sample files are provided with the Amanda sources in the example directory. See the -amreport8 + man page for more information. In addition to options, another -tapetype +tapetype name may be supplie as an identifier, which makes this -tapetype +tapetype inherit options from another -tapetype. +tapetype. For instance, the only difference between a DLT4000 tape drive using Compact-III tapes and one using Compact-IV tapes is the length of the tape. So they could be entered as: @@ -2205,7 +2407,7 @@ define tapetype "DLT4000-IV" { The amanda.conf file may define multiple types of network interfaces. -The information is entered in an interface +The information is entered in an interface section, which looks like this: @@ -2215,45 +2417,45 @@ define interface "name" { } +The { must appear at the end of a line, and the } on its own line. name is the name of this type of network interface. It is referenced from the disklist file. Note that these sections define network interface characteristics, not the actual interface that will be used. Nor do they impose limits on the bandwidth that will -actually be taken up by &A;. -&A; computes the estimated bandwidth each file system backup will take +actually be taken up by Amanda. +Amanda computes the estimated bandwidth each file system backup will take based on the estimated size and time, then compares that plus any other running backups with the limit as another of the criteria when deciding whether -to start the backup. Once a backup starts, &A; will use as much of the network as it can +to start the backup. Once a backup starts, Amanda will use as much of the network as it can leaving throttling up to the operating system and network hardware. The interface options and values are: - comment string + comment string -Default: -none. +Default: not set. A comment string describing this set of network information. - use int + use int Default: -8000 Kbps. +8000 Kbps. The speed of the interface in Kbytes per second. In addition to options, another -interface +interface name may be supplied as an identifier, which makes this -interface +interface inherit options from another -interface. +interface. At the moment, this is of little use. @@ -2261,43 +2463,43 @@ At the moment, this is of little use. The amanda.conf file may define multiple types of application. -The information is entered in a application-tool +The information is entered in a application section, which looks like this: -define application-tool "name" { +define application "name" { application-option application-value ... } +The { must appear at the end of a line, and the } on its own line. name is the name of this type of application. It is referenced from the dumptype -The application-tool options and values are: +The application options and values are: - comment string + comment string -Default: -none. +Default: not set. A comment string describing this application. - plugin string + plugin string No default. Must be set to the name of the program. This program must be in the $libexecdir/amanda/application directory on the client. - property [append] [priority] string string+ + property [append] [priority] string string+ No default. You can set property for the application, each application have a different set of property. Both strings are quoted; the first string contains the name of the property to set, and the others contains its values. -append keyword append the values to the list of values for that property. -priority keyword disallow the setting of that property on the client. +append keyword append the values to the list of values for that property. +priority keyword disallow the setting of that property on the client. @@ -2308,146 +2510,152 @@ the property to set, and the others contains its values. The amanda.conf file may define multiple types of script. -The information is entered in a script-tool +The information is entered in a script section, which looks like this: -define script-tool "name" { +define script "name" { script-option script-value ... } +The { must appear at the end of a line, and the } on its own line. name is the name of this type of script. It is referenced from the dumptype -The script-tool options and values are: +The script options and values are: - comment string + comment string -Default: -none. +Default: not set. A comment string describing this script. - plugin string + plugin string No default. Must be set to the name of the program. This program must be in the $libexecdir/amanda/application directory on the client and/or server. - execute_where [client|server] + order int + +Default: 5000. Scripts are executed in that order, it is useful if you have many scripts and they must be executed in a spefific order. + + + + execute_where [ client | server ] -Default: client. Where the script must be executed, on the client or server. +Default: client. Where the script must be executed, on the client or server. - execute_on execute_on[,execute_on]* + >execute_on execute_on [,execute_on]* No default. When the script must be executed, you can specify many of them: - pre-dle-amcheck + pre-dle-amcheck Execute before the amcheck command for the dle. - pre-host-amcheck + pre-host-amcheck Execute before the amcheck command for all dle for the client. - post-dle-amcheck + post-dle-amcheck Execute after the amcheck command for the dle. - post-host-amcheck + post-host-amcheck Execute after the amcheck command for all dle for the client. - pre-dle-estimate + pre-dle-estimate Execute before the estimate command for the dle. - pre-host-estimate + pre-host-estimate Execute before the estimate command for all dle for the client. - post-dle-estimate + post-dle-estimate Execute after the estimate command for the dle. - post-host-estimate + post-host-estimate Execute after the estimate command for all dle for the client. - pre-dle-backup + pre-dle-backup Execute before the backup command for the dle. - pre-host-backup + pre-host-backup -Execute before the backup command for all dle for the client. +Execute before the backup command for all dle for the client. It can't be run on client, it must be run on server - post-dle-backup + post-dle-backup Execute after the backup command for the dle. - post-host-backup + post-host-backup -Execute after the backup command for all dle for the client. +Execute after the backup command for all dle for the client. It can't be run on client, it must be run on server - pre-recover + pre-recover Execute before any level is recovered. - post-recover + post-recover Execute after all levels are recovered. - pre-level-recover + pre-level-recover Execute before each level recovery. - post-level-recover + post-level-recover Execute after each level recovery. - inter-level-recover + inter-level-recover Execute between two levels of recovery. @@ -2468,12 +2676,12 @@ script --post-recover - property [append] [priority] string string+ + property> [append] [priority] string string+ No default. You can set property for the script, each script have a different set of property. Both strings are quoted; the first string contains the name of the property to set, and the others contains its values. -append keyword append the values to the list of values for that property. -priority keyword disallow the setting of that property on the client. +append keyword append the values to the list of values for that property. +priority keyword disallow the setting of that property on the client. @@ -2494,18 +2702,19 @@ define device name { } +The { must appear at the end of a line, and the } on its own line. name is the user-specified name of this device. It is referenced from the global tapedev parameter. The device-specifier specifies the device name to use; -see amanda-devices7. +see . As with most sections, the comment parmeter is optional and only for the user's convenience. An arbitrary number of device_property parameters can be specified. Again, see -amanda-devices7 + for information on device properties. @@ -2518,29 +2727,31 @@ in the form of "changer" sections, which look like this: define changer name { comment "comment (optional)" - tapedev "tape-device" - tpchanger "changer-type" + tpchanger "changer-spec" changerdev "device-name" changerfile "state-file" ... } +The { must appear at the end of a line, and the } on its own line. name is the user-specified name of this device. The remaining parameters are specific to the changer type selected. +See for more information on configuring changers. + -SEE ALSO - -amanda8, -amanda-client.conf5, -amcrypt8, -aespipe1, - - + +, +, +, +, +, + + + -