X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Fxml-source%2Famanda.conf.5.xml;h=ed84492ba48e1cadc59c1ec75fc01cee6b00e6e8;hb=d74dc4d908fcbc1a4ef474edaf51e61ec90eab6b;hp=027a4ab18c0ff4647e7e80391137906154b171e6;hpb=d3b2175e084f88c8736ad7073eacbf4670147aec;p=debian%2Famanda
diff --git a/man/xml-source/amanda.conf.5.xml b/man/xml-source/amanda.conf.5.xml
index 027a4ab..ed84492 100644
--- a/man/xml-source/amanda.conf.5.xml
+++ b/man/xml-source/amanda.conf.5.xml
@@ -12,11 +12,18 @@
amanda.conf
5
+&rmi.source;
+&rmi.version;
+&rmi.manual.5;
amanda.conf
Main configuration file for &A;, the Advanced Maryland Automatic Network Disk Archiver
+
+&author.jds;
+&author.sgw.xml;
+
DESCRIPTION
@@ -25,7 +32,7 @@ relevant sections and parameters of this file for quick reference.
The file <CONFIG_DIR>/<config>/amanda.conf is loaded.
-PARAMETERS
+SYNTAX
There are a number of configuration parameters that control the
behavior of the &A; programs.
@@ -34,22 +41,68 @@ so you need not specify the parameter in
amanda.conf
if the default is suitable.
+COMMENTS
+
Lines starting with # are ignored, as are blank lines.
Comments may be placed on a line with a directive by starting
the comment with a #.
The remainder of the line is ignored.
+
+
+KEYWORDS AND IDENTIFIERS
Keywords are case insensitive, i.e.
mailto
and
MailTo
-are treated the same.
+are treated the same. Also, the characters
+'-'
+and
+'_'
+are interchangeable in all predefined &A; keywords:
+device_property
+and
+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.
+
+Strings are always quoted with double quotes ("), and any double quotes
+or backslashes within the string are escaped with a backslash:
+
+tapelist "/path/to/tapelist"
+property "escaped-string" "escaping: \\ (backslash) and \" (double-quote)"
+
+
+
+To summarize, then:
+
+ # QUOTES CASE -/_
+logdir "logs" # required sensitive sensitive
+send-amreport-on strange # prohibited insensitive insensitive
+tapetype "EXABYTE" # optional insensitive sensitive
+
+define dumptype "dt" { # optional insensitive sensitive
+ "dumptype-common" # optional insensitive sensitive
+ strategy noincr # prohibited insensitive insensitive
+}
+
+
+
+
+
+VALUE SUFFIXES
Integer arguments may have one of the following (case insensitive) suffixes,
some of which have a multiplier effect:
-POSSIBLE SUFFIXES
-
b byte bytes
@@ -73,6 +126,7 @@ some of which have a multiplier effect:
kps kbps
Some number of kilobytes per second (bytes*1024).
+It is the default multiplier for all size options.
@@ -140,8 +194,46 @@ is assumed.
-
-PARAMETERS
+PARAMETER ORDER
+
+In general, the order in which parameters occur in the configuration file
+does not matter, with the exception of subsection inheritance. For example, if
+dumptype "normal-encrypt" which inherits from dumptype "normal", then "normal"
+must appear first in the configuration file.
+
+
+
+STRINGS
+Quoted strings in Amanda follow a common, C-like syntax. Printable
+characters and whitespace are kept as-is, except that the backslash character
+(\) is used as an escape character, and a double-quote ends the string. The allowed
+escape sequences are
+
+ ESCAPE SEQUENCE BECOMES
+ \\ \
+ \" "
+ \n (newline)
+ \t (tab)
+ \r (carriage return)
+ \f (form-feed)
+ \1 - \7
+ \01 - \77
+ \001 - \377 (character specified in octal)
+
+Illegally quoted strings are handled on a "best-effort" basis, which may lead to
+unexpected results.
+
+Examples:
+
+finserver "/data/finance/XYZ Corp's \"real\" finances" finance-high eth0 -1
+property "syspath" "C:\\WINDOWS\\SYSTEM"
+
+
+
+
+
+
+GLOBAL PARAMETERS
@@ -153,6 +245,12 @@ 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
mail reports distinct.
+
+
+
+ mailer string
+
+Default found by configure. A mail program that can send mail with 'MAILER -s "subject" user < message_file'.
@@ -164,6 +262,41 @@ A space separated list of recipients for mail reports.
+ send-amreport-on [all|strange|error|never]
+
+Default:
+all.
+Specify which types of messages will trigger an email from amreport. amreport is used by amdump and amflush.
+
+
+
+ all
+
+Send an email on any message.
+
+
+
+ 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;.
+
+
+
+ error
+
+Send an email only on error messages.
+
+
+
+ never
+
+Never send an email.
+
+
+
+
+
+
dumpcycle int
Default:
@@ -195,9 +328,7 @@ The number of amdump runs in
days.
A value of 0 means the same value as
dumpcycle.
-A value of -1 means guess the number of runs from the
-tapelist
-file,
+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
days /
@@ -232,15 +363,10 @@ with damaged or misplaced tapes or schedule adjustments that call for slight adj
usetimestamps
bool
- Default: No.
-By default, Amanda can only track at most one run per calendar day. When
-this 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.0
+ 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.
@@ -288,29 +414,23 @@ See the
option.
+
tapedev string
Default:
null:.
-The path name of the non-rewinding tape device.
-Non-rewinding tape device names often have an 'n' in the name,
-e.g.
-/dev/rmt/0mn,
-however this is operating system specific and you should consult
-that documentation for detailed naming information.
+The device name, referencing the name of a "device" section in the configuration file. See
+amanda-devices7
+for more information on device names.
If a tape changer is configured
(see the
tpchanger
option), this option might not be used.
-If the
-null
-output driver is selected
-(see the section OUTPUT DRIVERS in the
-amanda8
-manpage for more information),
+If tapedev is
+null:,
programs such as
&amdump;
will run normally but all images will be thrown away.
@@ -323,15 +443,33 @@ option set to
- rawtapedev string
+ device_property string string
-Default:
-null:.
-The path name of the raw tape device.
-This is only used if &A; is compiled for Linux machines with floppy tapes
-and is needed for QIC volume table operations.
+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
+a fixed block size of 128k, write:
+
+device_property "BLOCK_SIZE" "128k"
+
+
+
+
+ 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.
+
+
+
+
tpchanger string
@@ -392,6 +530,7 @@ the backup image &A; was processing starts over again on the next tape.
Default:
runtapes*tape_length.
Maximum number of bytes the planner will schedule for a run.
+The default unit is Kbytes if it is not specified.
@@ -459,10 +598,10 @@ to avoid overwriting each other's tapes.
- tapetype string
+ tapetype identifier
Default:
-EXABYTE.
+"EXABYTE".
The type of tape drive associated with
tapedev
or
@@ -475,8 +614,6 @@ like the
size, and
speed
of the tape media and device.
-First character of a tapetype string must
-be an alphabetic character
@@ -507,15 +644,14 @@ will wait before it fails with a data timeout error.
Default:
300 seconds.
-Amount of time per disk on a given client that the
-planner
-step of
-amdump
-will wait to get the dump size estimates.
-For instance, with the default of 300 seconds and four disks on client A,
-planner
-will wait up to 20 minutes for that machine.
-A negative value will be interpreted as a total amount of time to wait
+Amount of time per estimate on a given client that the
+planner step of
+amdump will wait to get the dump size estimates
+(note: Amanda runs up to 3 estimates for each DLE). For instance,
+with the default of 300 seconds and four DLE's, each estimating level
+0 and level 1 on client A, planner
+will wait up to 40 minutes for that machine. A negative value will
+be interpreted as a total amount of time to wait
per client instead of per disk.
@@ -542,7 +678,7 @@ How many times the server will resend a REQ packet if it doesn't get the ACK pac
netusage int
Default:
-300 Kbps.
+8000 Kbps.
The maximum network bandwidth allocated to &A;, in Kbytes per second.
See also the
interface
@@ -627,6 +763,7 @@ it will do the next level.
The value of this parameter is used only if the parameter
bumppercent is set to 0.
+The default unit is Kbytes if it is not specified.
The global setting of this parameter can be overwritten inside of a
dumptype-definition.
@@ -760,10 +897,20 @@ option enabled.
Default:
tapelist.
-The file name for the active
-tapelist
-file.
+The file name for the active &tapelist;.
&A; maintains this file with information about the active set of tapes.
+
+
+
+ device_output_buffer_size int
+
+Default:
+1280k.
+Controls the amount of memory used by &A;
+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.
+The default unit is bytes if it is not specified.
@@ -771,14 +918,11 @@ file.
Default:
20.
-The number of buffers used by the
-taper
-process run by
-amdump
-and
-amflush
-to hold data as it is read from the network or disk before it is written to tape.
-Each buffer is a little larger than 32 KBytes and is held in a shared memory region.
+This option is deprecated; use
+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.
@@ -840,7 +984,7 @@ These three parts specify:
the name of the column, which may be:
-
+
Compress (compression ratio)
Disk (client disk name)
DumpRate (dump rate in KBytes/sec)
@@ -851,7 +995,7 @@ These three parts specify:
OutKB (output image size in KBytes)
TapeRate (tape writing rate in KBytes/sec)
TapeTime (total tape time in hours:minutes)
-
+
@@ -883,7 +1027,9 @@ with one space before it.
Default:
none.
The name of an &A; configuration file to include within the current file.
-Useful for sharing dumptypes, tapetypes and interface definitions among several configurations.
+Useful for sharing dumptypes, tapetypes and interface definitions among several configurations.
+Relative pathnames are relative to the configuration directory.
+
@@ -968,12 +1114,95 @@ Debug level of the taper process
+
+ flush-threshold-dumped int
+
+Default: 0.
+ &A; 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
+ 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
+ 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
+ parameter.
+
+
+
+
+ flush-threshold-scheduled int
+
+Default: 0.
+ &A; 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
+ inequality h + s > t ×
+ d is satisfied,
+ where h is the amount of data on the
+ holding disk, s is the total amount of
+ data scheduled for this run but not dumped
+ yet, t is the capacity of a volume,
+ and d is this parameter, expressed as a
+ percentage. This parameter may be larger than 100%.
+ 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
+ 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.
+
+
+
+
+
+ taperflush int
+
+Default: 0.
+ At the end of a run, &A; 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
+ a new tape if the
+ inequality h > t ×
+ f is satisfied,
+ where h is the amount of data remaining on the
+ holding disk from this or previous runs, t
+ is the capacity of a volume,
+ 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.
+
+
+
reserved-udp-port int,int
Default: --with-udpportrange or
512,1023.
-Reserved udp port that will be used (bsd, bsdudp)
+Reserved udp port that will be used (bsd, bsdudp).
+Range is inclusive.
@@ -982,7 +1211,8 @@ Reserved udp port that will be used (bsd, bsdudp)
Default: --with-low-tcpportrange or
512,1023.
-Reserved tcp port that will be used (bsdtcp)
+Reserved tcp port that will be used (bsdtcp).
+Range is inclusive.
@@ -990,13 +1220,13 @@ Reserved tcp port that will be used (bsdtcp)
unreserved-tcp-port int,int
Default: --with-tcpportrange or
-1025,65536.
-Unreserved tcp port that will be used (bsd, bsdudp)
+1024,65535.
+Unreserved tcp port that will be used (bsd, bsdudp).
+Range is inclusive.
-
HOLDINGDISK SECTION
@@ -1057,6 +1287,7 @@ 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
they are written to tape, so each dump image still corresponds to a single continuous
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
((INT_MAX/1024)-64) Kbytes.
@@ -1088,7 +1319,7 @@ another set for file systems that should always get a full backup and so on.
-define dumptype name {
+define dumptype "name" {
dumptype-option dumptype-value
...
}
@@ -1122,22 +1353,7 @@ are defined.
Default:
bsd.
-Type of authorization to perform between tape server and backup client hosts.
-bsd, bsd authorization with udp initial
-connection and one tcp connection by data stream.
-bsdtcp, bsd authorization but use only
-one tcp connection.
-bsdudp, like bsd, but will use only one
-tcp connection for all data stream.
-krb4 to use Kerberos-IV
-authorization.
-krb5 to use Kerberos-V
-authorization.
-rsh to use rsh
-authorization.
-ssh to use OpenSSH
-authorization.
-
+Type of authorization to perform between tape server and backup client hosts. See amanda-auth7 for more detail.
@@ -1176,6 +1392,7 @@ it will do the next level.
The value of this parameter is used only if the parameter
bumppercent is set to 0.
+The default unit is Kbytes if it is not specified.
See also the options
bumppercent,
@@ -1350,7 +1567,7 @@ server host as it goes from the network into the holding disk or to tape.
PROG must not contain white space.
Specify client_decrypt_option "decryption-parameter" Default: "-d"
decryption-parameter must not contain white space.
- (See dumptype server-encrypt-fast in example/amanda.conf for reference)
+ (See dumptype client-encrypt-nocomp in example/amanda.conf for reference)
@@ -1360,7 +1577,7 @@ server host as it goes from the network into the holding disk or to tape.
PROG must not contain white space.
Specify server_decrypt_option "decryption-parameter" Default: "-d"
decryption-parameter must not contain white space.
- (See dumptype client-encrypt-nocomp in example/amanda.conf for reference)
+ (See dumptype server-encrypt-fast in example/amanda.conf for reference)
@@ -1598,17 +1815,58 @@ high (2), medium (1), low (0) or a number of your choice.
- program string
+ program [DUMP|GNUTAR|APPLICATION]
Default:
DUMP.
-The type of backup to perform. Valid values are
-DUMP
-for the native operating system backup program, and
-GNUTAR
-to use &gnutar; or to do PC backups using Samba.
+The type of backup to perform. Valid values are:
+
+
+
+ DUMP
+
+The native operating system backup program.
+
+
+
+ GNUTAR
+
+To use GNU-tar or to do PC backups using Samba.
+
+
+
+ APPLICATION
+
+To use an application-tool, see the application option.
+
+
+
+
+ application string
+
+No default. Must be the name of an application-tool if program is set to APPLICATION. See APPLICATION SECTION below.
+
+
+
+ script string
+
+No default. Must be the name of a script-tool. You can have many script. See SCRIPT SECTION below.
+
+
+
+ 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.
+
+
+
+
record boolean
@@ -1682,10 +1940,7 @@ The value should be hh*100+mm, e.g. 6:30PM (18:30) would be entered as
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.
- It is similar to skip-full, but with incronly full dumps may be scheduled manually.
- Unfortunately, it appears that &A; will perform full backups with this configuration,
- which is probably a bug.
+ &A; that a full dump has been performed off-line, so that it resets to level 1.
@@ -1705,6 +1960,7 @@ average dump being split), substantial tape space can be wasted.
If too small, large dumps will be split into innumerable tiny dumpfiles,
adding to restoration complexity.
A good rule of thumb, usually, is 1/10 of the size of your tape.
+The default unit is Kbytes if it is not specified.
@@ -1732,6 +1988,7 @@ The size of this buffer can be changed from its (very conservative) default
to a value reflecting the amount of memory that each taper process on
the dump server may reasonably consume.
+The default unit is Kbytes if it is not specified.
@@ -1739,31 +1996,31 @@ the dump server may reasonably consume.
The following dumptype entries are predefined by &A;:
-define dumptype no-compress {
+define dumptype "no-compress" {
compress none
}
-define dumptype compress-fast {
+define dumptype "compress-fast" {
compress client fast
}
-define dumptype compress-best {
+define dumptype "compress-best" {
compress client best
}
-define dumptype srvcompress {
+define dumptype "srvcompress" {
compress server fast
}
-define dumptype bsd-auth {
+define dumptype "bsd-auth" {
auth bsd
}
-define dumptype krb4-auth {
+define dumptype "krb4-auth" {
auth krb4
}
-define dumptype no-record {
+define dumptype "no-record" {
record no
}
-define dumptype no-hold {
+define dumptype "no-hold" {
holdingdisk no
}
-define dumptype no-full {
+define dumptype "no-full" {
skip-full yes
}
@@ -1772,7 +2029,7 @@ define dumptype no-full {
dumptype
section, one or more other
dumptype
-names may be entered, which make this
+names may be supplied as identifiers, which make this
dumptype
inherit options from other previously defined
dumptypes.
@@ -1780,15 +2037,15 @@ For instance, two sections might be the same except for the
record option:
-define dumptype normal {
+define dumptype "normal" {
comment "Normal backup, no compression, do indexing"
no-compress
index yes
maxdumps 2
}
-define dumptype testing {
+define dumptype "testing" {
comment "Test backup, no compression, do indexing, no recording"
- normal
+ "normal"
record no
}
@@ -1814,7 +2071,7 @@ The information is entered in a
section, which looks like this in the config file:
-define tapetype name {
+define tapetype "name" {
tapetype-option tapetype-value
...
}
@@ -1850,15 +2107,14 @@ convert it to kbytes using the device density.
length int
Default:
-2000 kbytes. How much data will fit on a tape.
+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 the section OUTPUT DRIVERS in the
-amanda8
-manpage for exceptions).
-
+(but see amanda-devices7 for exceptions).
+
+
@@ -1866,45 +2122,20 @@ manpage for exceptions).
Default:
32 kbytes.
-How much data will be written in each tape record expressed in KiloBytes.
-The tape record size (= blocksize) can not be reduced below the default 32 KBytes.
-The parameter blocksize can only be raised if &A; was compiled with the configure option
---with-maxtapeblocksize=N set with "N" greater than 32 during
-&configure;.
-
+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
-Default:
-(from configure --with-maxtapeblocksize).
-How much data will be read in each tape record expressed in KiloBytes.
-Some hardware require a value not too large, and some require it to be equal to the blocksize.
-It is useful if you configured amanda with a big --with-maxtapeblocksize and your
-hardware don't work with a value that big.
+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
+128k blocks. This unusual feature is not supported by all operating systems and
+tape devices.
-
-
-
- file-pad boolean
-
-Default:
-true.
-If true, every record, including the last one in the file, will have the same length.
-This matches the way &A; wrote tapes prior to the availability of this parameter.
-It may also be useful on devices that only support a fixed blocksize.
-
-Note that the last record on the tape probably includes trailing
-null byte padding, which will be passed back to
-gzip,
-compress
-or the restore program. Most programs just ignore this (although possibly with a warning).
-
-If this parameter is false, the last record in a file may be shorter
-than the block size. The file will contain the same amount of data the dump program generated,
-without trailing null byte padding. When read, the same amount of data that was written
-will be returned.
+The default unit is Kbytes if it is not specified.
@@ -1933,7 +2164,7 @@ man page for more information.
In addition to options, another
tapetype
-name may be entered, which makes this
+name may be supplie as an identifier, which makes this
tapetype
inherit options from another
tapetype.
@@ -1942,14 +2173,14 @@ Compact-III tapes and one using Compact-IV tapes is the length of the tape.
So they could be entered as:
-define tapetype DLT4000-III {
+define tapetype "DLT4000-III" {
comment "DLT4000 tape drives with Compact-III tapes"
length 12500 mbytes # 10 Gig tapes with some compression
filemark 2000 kbytes
speed 1536 kps
}
-define tapetype DLT4000-IV {
- DLT4000-III
+define tapetype "DLT4000-IV" {
+ "DLT4000-III"
comment "DLT4000 tape drives with Compact-IV tapes"
length 25000 mbytes # 20 Gig tapes with some compression
}
@@ -1970,7 +2201,7 @@ The information is entered in an interface
section, which looks like this:
-define interface name {
+define interface "name" {
interface-option interface-value
...
}
@@ -2003,7 +2234,7 @@ A comment string describing this set of network information.
use int
Default:
-300 Kbps.
+8000 Kbps.
The speed of the interface in Kbytes per second.
@@ -2011,16 +2242,286 @@ The speed of the interface in Kbytes per second.
In addition to options, another
interface
-name may be entered, which makes this
+name may be supplied as an identifier, which makes this
interface
inherit options from another
interface.
At the moment, this is of little use.
-AUTHOR
-James da Silva, &email.jds;: Original text
-&maintainer.sgw;: XML-conversion, major update, splitting
+APPLICATION SECTION
+The
+amanda.conf
+file may define multiple types of application.
+The information is entered in a application-tool
+section, which looks like this:
+
+
+define application-tool "name" {
+ application-option application-value
+ ...
+}
+
+
+name
+is the name of this type of application. It is referenced from the
+dumptype
+
+The application-tool options and values are:
+
+
+ comment string
+
+Default:
+none.
+A comment string describing this application.
+
+
+
+ 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+
+
+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.
+
+
+
+
+
+
+SCRIPT SECTION
+The
+amanda.conf
+file may define multiple types of script.
+The information is entered in a script-tool
+section, which looks like this:
+
+
+define script-tool "name" {
+ script-option script-value
+ ...
+}
+
+
+name
+is the name of this type of script. It is referenced from the
+dumptype
+
+The script-tool options and values are:
+
+
+ comment string
+
+Default:
+none.
+A comment string describing this script.
+
+
+
+ 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]
+
+Default: client. Where the script must be executed, on the client or server.
+
+
+
+ execute_on execute_on[,execute_on]*
+
+No default. When the script must be executed, you can specify many of them:
+
+
+
+ pre-dle-amcheck
+
+Execute before the amcheck command for the dle.
+
+
+
+ pre-host-amcheck
+
+Execute before the amcheck command for all dle for the client.
+
+
+
+ post-dle-amcheck
+
+Execute after the amcheck command for the dle.
+
+
+
+ post-host-amcheck
+
+Execute after the amcheck command for all dle for the client.
+
+
+
+ pre-dle-estimate
+
+Execute before the estimate command for the dle.
+
+
+
+ pre-host-estimate
+
+Execute before the estimate command for all dle for the client.
+
+
+
+ post-dle-estimate
+
+Execute after the estimate command for the dle.
+
+
+
+ post-host-estimate
+
+Execute after the estimate command for all dle for the client.
+
+
+
+ pre-dle-backup
+
+Execute before the backup command for the dle.
+
+
+
+ pre-host-backup
+
+Execute before the backup command for all dle for the client.
+
+
+
+ post-dle-backup
+
+Execute after the backup command for the dle.
+
+
+
+ post-host-backup
+
+Execute after the backup command for all dle for the client.
+
+
+
+ pre-recover
+
+Execute before any level is recovered.
+
+
+
+ post-recover
+
+Execute after all levels are recovered.
+
+
+
+ pre-level-recover
+
+Execute before each level recovery.
+
+
+
+ post-level-recover
+
+Execute after each level recovery.
+
+
+
+ inter-level-recover
+
+Execute between two levels of recovery.
+
+
+
+ If you recover level 0 and 2 of the disk /usr with amrecover, it will execute:
+
+script --pre-recover
+script --pre-level-recover --level 0
+#recovering level 0
+script --post-level-recover --level 0
+script --inter-level-recover --level 0 --level 2
+script --pre-level-recover --level 2
+#recovering level 2
+script --post-level-recover --level 2
+script --post-recover
+
+
+
+
+ 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.
+
+
+
+
+
+
+DEVICE SECTION
+Backend storage devices are specified in
+amanda.conf
+in the form of "device" sections, which look like this:
+
+
+define device name {
+ commend "comment (optional)"
+ tapedev "device-specifier"
+ device_property "prop-name" "prop-value"
+ ...
+}
+
+
+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.
+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.
+
+
+
+CHANGER SECTION
+Changers are described in
+amanda.conf
+in the form of "changer" sections, which look like this:
+
+
+define changer name {
+ comment "comment (optional)"
+ tapedev "tape-device"
+ tpchanger "changer-type"
+ changerdev "device-name"
+ changerfile "state-file"
+ ...
+}
+
+
+name is the user-specified name of this
+device. The remaining parameters are specific to the changer type selected.
+
+
SEE ALSO
@@ -2029,7 +2530,9 @@ At the moment, this is of little use.
amanda-client.conf5,
amcrypt8,
aespipe1,
+
+