X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Fxml-source%2Famanda.conf.5.xml;h=f322c1ff3b3bfa604b45a1957632ec5e3bcec823;hb=94a044f90357edefa6f4ae9f0b1d5885b0e34aee;hp=a608c3aad8e9bea1cee87b790a6e9aaa30595636;hpb=1194fb66aa28d9929c3f2bef3cc6c1c3f40a60a4;p=debian%2Famanda
diff --git a/man/xml-source/amanda.conf.5.xml b/man/xml-source/amanda.conf.5.xml
index a608c3a..f322c1f 100644
--- a/man/xml-source/amanda.conf.5.xml
+++ b/man/xml-source/amanda.conf.5.xml
@@ -22,6 +22,7 @@
DESCRIPTION
&amconf; is the main configuration file for &A;. This manpage lists the
relevant sections and parameters of this file for quick reference.
+ The file <CONFIG_DIR>/<config>/amanda.conf is loaded.
PARAMETERS
@@ -109,10 +110,10 @@ some of which have a multiplier effect:
Some number of weeks (days*7).
-The value
+The value
inf
may be used in most places where an integer is expected
-to mean an infinite amount.
+to mean an infinite amount.
Boolean arguments may have any of the values
y,
@@ -170,7 +171,7 @@ A space separated list of recipients for mail reports.
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
+This parameter may also be set in a specific
dumptype
(see below).
This value sets the default for all
@@ -179,10 +180,11 @@ so must appear in
amanda.conf
before any
dumptypes
-are defined.
+are defined.
+
-
+
runspercycle int
@@ -227,32 +229,24 @@ with damaged or misplaced tapes or schedule adjustments that call for slight adj
- label_new_tapes
- string
-
- Default: not set.
-When set, this directive will cause &A; to automatically write an &A;
-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
-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 '%'
-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:
-label_new_tapes "DailySet1-%%%"
-
-
-
+ usetimestamps
+ bool
+
+ 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.
+
+
+
-=======
label_new_tapes
string
Default: not set.
-When set, this directive will cause &A; to automatically write an Amanda
-tape label to any black tape she encounters. This option is DANGEROUS
+When set, this directive will cause &A; to automatically write an &A;
+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
also ERASE any near-failing tapes. Use with caution.
When using this directive, specify the template for new tape
@@ -289,6 +283,7 @@ See the
option.
+
tapedev string
@@ -324,15 +319,27 @@ 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, including block size,
+maximum volume usage, authentication information, hardware feature support,
+and more.Specifics of how properties are used are device-dependent, though
+some common properties are supported across multiple device drivers.
+
+ Both strings are 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, do:device_property "BLOCK_SIZE" "131072"
+
+The order in which device properties are set is as follows:
+Tapetype parameters, including length, blocksize,
+readblocksize, file-pad, are translated into device properties and set
+accordingly.
+Device properties from any device_property configuration directives
+are set, in the order they appear in the configuration file.
+
+
tpchanger string
@@ -502,28 +509,47 @@ running from within
will wait before it fails with a data timeout error.
+
etimeout int
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.
+
+
+ connect_tries int
+
+Default:
+3.
+How many times the server will try a connection.
+
+
+
+
+ req_tries int
+
+Default:
+3.
+How many times the server will resend a REQ packet if it doesn't get the ACK packet.
+
+
+
netusage int
Default:
-300 Kbps.
+8000 Kbps.
The maximum network bandwidth allocated to &A;, in Kbytes per second.
See also the
interface
@@ -558,16 +584,16 @@ The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera.
Default:
tttTTTTTTT.
-The priority order of each dumper:
+The priority order of each dumper:
-
-s: smallest size
-S: largest size
-t: smallest time
-T: largest time
-b: smallest bandwidth
-B: largest bandwidth
-
+
+s: smallest size
+S: largest size
+t: smallest time
+T: largest time
+b: smallest bandwidth
+B: largest bandwidth
+
@@ -745,6 +771,17 @@ The file name for the active
tapelist
file.
&A; maintains this file with information about the active set of tapes.
+
+
+
+ device_output_buffer_size int
+
+Default:
+640k.
+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.
@@ -752,14 +789,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.
@@ -787,7 +821,7 @@ Whether an amdump run will flush the dumps from holding disk to tape.
amrecover_do_fsf bool
Default:
-off.
+on.
Amrecover will call amrestore with the -f flag for faster positioning of the tape.
@@ -795,7 +829,7 @@ Amrecover will call amrestore with the -f flag for faster positioning of the tap
amrecover_check_label bool
Default:
-off.
+on.
Amrecover will call amrestore with the -l flag to check the label.
@@ -817,44 +851,44 @@ 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:
-
+
the name of the column, which may be:
-
- Compress (compression ratio)
- Disk (client disk name)
- DumpRate (dump rate in KBytes/sec)
- DumpTime (total dump time in hours:minutes)
- HostName (client host name)
- Level (dump level)
- OrigKB (original image size in KBytes)
- OutKB (output image size in KBytes)
- TapeRate (tape writing rate in KBytes/sec)
- TapeTime (total tape time in hours:minutes)
-
+
+ Compress (compression ratio)
+ Disk (client disk name)
+ DumpRate (dump rate in KBytes/sec)
+ DumpTime (total dump time in hours:minutes)
+ HostName (client host name)
+ Level (dump level)
+ OrigKB (original image size in KBytes)
+ 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.
-
-
-Here is an example:
+
+Here is an example:
-columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"
-
+columnspec "Disk=1:18,HostName=0:10,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
-with one space before it.
+with one space before it.
@@ -864,9 +898,204 @@ 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.
+
+
+
+
+
+ debug_auth int
+
+Default:
+0.
+Debug level of the auth module
+
+
+
+
+ debug_event int
+
+Default:
+0.
+Debug level of the event module
+
+
+
+
+ debug_holding int
+
+Default:
+0.
+Debug level of the holdingdisk module
+
+
+
+
+ debug_protocol int
+
+Default:
+0.
+Debug level of the protocol module
+
+
+
+
+ debug_planner int
+
+Default:
+0.
+Debug level of the planner process
+
+
+
+
+ debug_driver int
+
+Default:
+0.
+Debug level of the driver process
+
+
+
+
+ debug_dumper int
+
+Default:
+0.
+Debug level of the dumper process
+
+
+
+
+ debug_chunker int
+
+Default:
+0.
+Debug level of the chunker process
+
+
+
+
+ debug_taper int
+
+Default:
+0.
+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.
+ 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.
+ 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.
+ 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).
+Range is inclusive.
+
+
+
+
+ reserved-tcp-port int,int
+
+Default: --with-low-tcpportrange or
+512,1023.
+Reserved tcp port that will be used (bsdtcp).
+Range is inclusive.
+
+
+ unreserved-tcp-port int,int
+
+Default: --with-tcpportrange or
+1024,65535.
+Unreserved tcp port that will be used (bsd, bsdudp).
+Range is inclusive.
+
+
+
@@ -881,7 +1110,8 @@ The syntax is:
holdingdisk name {
holdingdisk-option holdingdisk-value
...
-}
+}
+
Name
is a logical name for this holding disk.
@@ -897,6 +1127,7 @@ is a logical name for this holding disk.
A comment string describing this holding disk.
+
directory disk
@@ -905,40 +1136,42 @@ A comment string describing this holding disk.
The path to this holding area.
+
use int
-Default:
+Default:
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, &A; will use all available space minus that value.
+
chunksize int
-Default:
+Default:
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
they are written to tape, so each dump image still corresponds to a single continuous
-tape section.
+tape section.
-If 0 is specified, &A; will create holding disk chunks as large as
-((INT_MAX/1024)-64) Kbytes.
+If 0 is specified, &A; 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
-chunk size is 64 Kbytes (but that would be really silly).
+Each holding disk chunk includes a 32 Kbyte header, so the minimum
+chunk size is 64 Kbytes (but that would be really silly).
-Operating systems that are limited to a maximum file size of 2 Gbytes
+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
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.
+file size, e.g. 2047 Mbytes.
@@ -991,16 +1224,46 @@ 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.
+local, if the client is the server, it
+doesn't require authencation setup.
+rsh to use rsh
+authorization.
ssh to use OpenSSH
authorization.
+
+ amandad_path string
+
+Default:
+$libexec/amandad.
+Specify the amandad path of the client, only use with rsh/ssh authentification.
+
+
+
+
+
+ client_username string
+
+Default:
+CLIENT_LOGIN.
+Specify the username to connect on the client, only use with rsh/ssh authentification.
+
+
+
+
@@ -1121,24 +1384,39 @@ is often not as good a compression as
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:
-
-compress none
-compress [client] fast
-compress [client] best
-compress client custom
-Specify client_custom_compress "PROG"
-PROG must not contain white space and it must accept -d for uncompress.
-compress server fast
-compress server best
-compress server custom
-Specify server_custom_compress "PROG"
-PROG must not contain white space and it must accept -d for uncompress.
-
-
+
+
+ compress none
+
+
+ compress client fast
+
+
+ compress client best
+
+
+ compress client custom
+
+ Specify client_custom_compress "PROG"
+ PROG must not contain white space and it must accept -d for uncompress.
+
+
+
+ compress server fast
+
+
+ compress server best
+
+
+ compress server custom
+
+ 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.
@@ -1164,29 +1442,38 @@ server host as it goes from the network into the holding disk or to tape.
So the encrypt options line may be one
of:
-
-encrypt none
-encrypt client
-Specify client_encrypt "PROG"
-PROG must not contain white space.
-Specify client_decrypt_option "decryption-parameter" Default: "-d"
-decryption-parameter must not contain white space.
-(See dumptype encrypt-fast in example/amanda.conf for reference)
-
-encrypt server
-Specify server_encrypt "PROG"
-PROG must not contain white space.
-Specify server_decrypt_option "decryption-parameter" Default: "-d"
-decryption-parameter must not contain white space.
-
-
-
+
+
+ encrypt none
+
+
+ encrypt client
+
+ Specify client_encrypt "PROG"
+ 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)
+
+
+
+ encrypt server
+
+ Specify server_encrypt "PROG"
+ 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)
+
+
+
Note that current logic assumes compression then encryption during
backup(thus decrypt then uncompress during restore). So specifying
client-encryption AND server-compression is not supported.
amcrypt which is a wrapper of
aespipe is provided as a reference
- encryption program.
+ symmetric encryption program.
+
@@ -1195,31 +1482,35 @@ client-encryption AND server-compression is not supported.
Default: client.
Determine the way &A; does it's estimate.
-
-
-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.
-
-
-
-calcsize:
-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.
-
-
-
-
+
+
+ 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.
+
+
+
+ calcsize
+
+ 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.
+
+
+
+
- exclude [ list|file ][[optional][ append ][ string ]+]
+ exclude [ list|file ][[optional][ append ][ string ]+]
Default:
file.
@@ -1271,17 +1562,39 @@ for a backup of /var,
- holdingdisk boolean
+ holdingdisk [ never|auto|required ]
Default:
-yes.
+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;
is backing up, that file system should refer to a dumptype with
holdingdisk
set to
-no
+never
to avoid backing up the holding disk into itself.
+
+
+
+ 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
+
+ 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
+
+ Always dump to holdingdisk, never directly to tape. There will be no dump if it doesn't fit on holdingdisk
+
+
+
+
@@ -1298,7 +1611,7 @@ 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
@@ -1323,8 +1636,9 @@ is a file name on the client containing glob expressions.
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.
+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.
+
With the append keyword, the
string is appended to the current list, without it, the
@@ -1629,10 +1943,10 @@ A comment string describing this set of tape information.
filemark int
Default:
-1000 bytes.
-How large a file mark (tape mark) is, measured in bytes.
+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 bytes using the device density.
+convert it to kbytes using the device density.
@@ -1654,12 +1968,24 @@ manpage for exceptions).
blocksize int
Default:
-32.
+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;.
+
+
+
+
+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.
@@ -1780,7 +2106,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.
@@ -1803,8 +2129,14 @@ At the moment, this is of little use.
SEE ALSO
amanda8,
+amanda-client.conf5,
amcrypt8,
aespipe1,
+http://wiki.zmanda.com
+
+
+
+An updated version of this man page may be available at http://wiki.zmanda.com/index.php/Amanda.conf.