.\" Title: amanda.conf
.\" Author: James da Silva <jds@amanda.org>
.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
-.\" Date: 06/01/2010
+.\" Date: 10/18/2010
.\" Manual: File formats and conventions
-.\" Source: Amanda 3.1.0
+.\" Source: Amanda 3.2.0
.\" Language: English
.\"
-.TH "AMANDA\&.CONF" "5" "06/01/2010" "Amanda 3\&.1\&.0" "File formats and conventions"
+.TH "AMANDA\&.CONF" "5" "10/18/2010" "Amanda 3\&.2\&.0" "File formats and conventions"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
\fBdevice_property\fR
and
\fBdevice\-property\fR
-have the same meaning\&.
+have the same meaning\&. This manpage uses the dashed versions, but the underscored versions will be accepted for backward compatibility
.PP
Identifiers are names which are defined in the configuration itself, such as dumptypes or interfaces\&. Identifiers are are case\-insensitive, but sensitive to \'\fB\-\fR\' vs\&. \'\fB_\fR\'\&. Identifiers should be quoted in the configuration file, although For historical reasons, the quotes are optional\&.
.PP
define dumptype "dt" { # optional insensitive sensitive
"dumptype\-common" # optional insensitive sensitive
- strategy noincr # prohibited insensitive insensitive
+ strategy noinc # prohibited insensitive insensitive
}
.fi
.SS "VALUE SUFFIXES"
\fBtapecycle\fR \fIint\fR
.RS 4
Default:
-\fI15 tapes\fR\&. Typically tapes are used by Amanda in an ordered rotation\&. The
+\fI15 tapes\fR\&. Specifies the number of "active" volumes \- volumes that Amanda will not overwrite\&. While Amanda is always willing to write to a new volume, it refuses to overwrite a volume unless at least \'\fBtapecycle\fR
+\-1\' volumes have been written since\&.
+.sp
+It is considered good administrative practice to set the
+\fBtapecycle\fR
+parameter slightly lower than the actual number of tapes in use\&. 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\&.
+.sp
+Note: Amanda is commonly misconfigured with
+\fBtapecycle\fR
+equal to the number of tapes per
+\fBdumpcycle\fR\&. In this misconfiguration, amanda may erase a full dump before a new one is completed\&. Recovery is then impossible\&. The
\fBtapecycle\fR
-parameter defines the size of that rotation\&. This parameter must be be larger than the number of tapes used in a dumpcycle\&.
+must be at least one tape larger than the number of tapes per dumpcycle\&.
.sp
The number of tapes per dumpcycle is calculated by multiplying the number of
\fBamdump\fR
(the number of tapes used per run)\&. Typically
\fBtapecycle\fR
is set to two or four times the tapes per dumpcycle\&.
-.if n \{\
-.sp
-.\}
-.RS 4
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBNote\fR
-.ps -1
-.br
-Amanda is commonly misconfigured with \fBtapecycle\fR
-equal to the number of tapes per \fBdumpcycle\fR\&. 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\&.
-.sp .5v
-.RE
-While Amanda is always willing to use a new tape in its rotation, it refuses to reuse a tape until at least \'\fBtapecycle\fR
-\-1\' number of other tapes have been used\&.
-.sp
-It is considered good administrative practice to set the
-\fBtapecycle\fR
-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\&.
.RE
.PP
\fBusetimestamps\fR \fIbool\fR
\fBYes\fR\&. 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\&.
.RE
.PP
-\fBlabel_new_tapes\fR \fIstring\fR
+\fBlabel\-new\-tapes\fR \fIstring\fR
.RS 4
Deprecated, use
\fBautolabel\fR
-option\&.
+option with options
+\fBvolume\-error empty\fR
+to get equivalent behavior\&.
.sp
-Default: not set\&. 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, Amanda will ERASE any non\-Amanda tapes you may have, and may also ERASE any near\-failing tapes\&. Use with caution\&.
-.sp
-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:
-\fBlabel_new_tapes "DailySet1\-%%%"\fR
+Default: not set\&. When set, this directive will cause Amanda to automatically write an Amanda tape label to any blank tape she encounters\&.
.RE
.PP
-\fBautolabel\fR \fIstring\fR [\fBany\fR] [\fBother_config\fR] [\fBnon_amanda\fR] [\fBvolume_error\fR] [\fBempty\fR]
+\fBautolabel\fR \fIstring\fR [\fBany\fR] [\fBother\-config\fR] [\fBnon\-amanda\fR] [\fBvolume\-error\fR] [\fBempty\fR]
.RS 4
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\&.
.sp
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:
\fBautolabel "DailySet1\-%%%" empty\fR
+.sp
+Note that many devices cannot distinguish an empty tape from an error condition, so it may is often necessary to include
+\fBvolume\-error\fR
+as an autolabel condition\&.
.PP
\fBany\fR
.RS 4
-equivalent to \'\fBother_config non_amanda volume_error empty\fR\'
+equivalent to \'\fBother\-config non\-amanda volume\-error empty\fR\'
.RE
.PP
-\fBother_config\fR
+\fBother\-config\fR
.RS 4
Label volumes with a valid Amanda label that do not match our
\fBlabelstr\fR\&. Danger: this may erase volumes
from other Amanda configurations without warning!
.RE
.PP
-\fBnon_amanda\fR
+\fBnon\-amanda\fR
.RS 4
Label volumes which do not start with data that resembles an
Amanda header\&. Danger: this may erase volumes from other backup applications
without warning!
.RE
.PP
-\fBvolume_error\fR
+\fBvolume\-error\fR
.RS 4
Label volumes where an error occurs while trying to read the label\&.
Danger: this may erase arbitrary volumes due to transient errors\&.
\fBtapedev\fR \fIstring\fR
.RS 4
Default:
-\fI"null:"\fR\&. The device name, referencing the name of a "device" section in the configuration file\&. See
-\fBamanda-devices\fR(7)
-for more information on device names\&.
-.sp
-If a tape changer is configured (see the
-\fBtpchanger\fR
-option), this option might not be used\&.
-.sp
-If
-\fBtapedev\fR
-is
-\fBnull:\fR, programs such as
-\fBamdump\fR
-will run normally but all images will be thrown away\&. This should only be used for debugging and testing, and probably only with the
-\fBrecord\fR
-option set to
-\fIno\fR\&.
+\fI"null:"\fR\&. This parameter can either specify a device (explicitly or by referencing a device definition \- see
+\fBamanda-devices\fR(7)) or a tape changer (explicitly or by referencing a device definition \- see
+\fBamanda-changers\fR(7))\&.
.RE
.PP
-\fBdevice_property\fR \fIstring\fR \fIstring\fR
+\fBdevice\-property\fR \fIstring\fR \fIstring\fR
.RS 4
These options can set various device properties\&. See
\fBamanda-devices\fR(7)
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:
.nf
-device_property "BLOCK_SIZE" "128k"
+device\-property "BLOCK_SIZE" "128k"
.fi
.RE
.PP
.PP
\fBtpchanger\fR \fIstring\fR
.RS 4
-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\&.
-.sp
-If a tape changer is configured, choose one of the changer scripts (e\&.g\&.
-\fBchg\-scsi\fR) and enter that here\&.
+Default: not set\&. The tape changer to use\&. In most cases, only one of
+\fBtpchanger\fR
+or
+\fBtapedev\fR
+is specified, although for backward compatibility both may be specified if
+\fBtpchanger\fR
+gives the name of an old changer script\&. See
+\fBamanda-changers\fR(7)
+for more information on configuring changers\&.
.RE
.PP
\fBchangerdev\fR \fIstring\fR
\fBchangerfile\fR \fIstring\fR
.RS 4
Default:
-\fI"usr/adm/amanda/log/changer\-status"\fR\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the
+\fI"/usr/adm/amanda/log/changer\-status"\fR\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the
\fBtpchanger\fR
option\&.
.RE
If a tape changer is configured, this may be set larger than one to let Amanda write to more than one tape\&.
.sp
Note that this is an upper bound on the number of tapes, and Amanda may use less\&.
-.sp
-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 Amanda was processing starts over again on the next tape\&.
.RE
.PP
\fBmaxdumpsize\fR \fIint\fR
.RS 4
Default:
-\fI\fBruntapes\fR\fR\fI*\fR\fI\fBtape_length\fR\fR\&. Maximum number of bytes the planner will schedule for a run\&.
+\fI\fBruntapes\fR\fR\fI*\fR\fI\fBtape\-length\fR\fR\&. Maximum number of bytes the planner will schedule for a run\&.
.sp
The default unit is Kbytes if it is not specified\&.
.RE
.RE
.RE
.PP
+\fBtaper\-parallel\-write\fR \fIint\fR
+.RS 4
+.PP
+Default:
+\fI1\fR\&. Amanda can write simultaneously up to that number of volume at any given time\&. The changer must have as many drives\&.
+.RE
+.PP
\fBlabelstr\fR \fIstring\fR
.RS 4
Default:
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\&.
.RE
.PP
-\fBconnect_tries\fR \fIint\fR
+\fBconnect\-tries\fR \fIint\fR
.RS 4
Default:
\fI3\fR\&. How many times the server will try a connection\&.
.RE
.PP
-\fBreq_tries\fR \fIint\fR
+\fBreq\-tries\fR \fIint\fR
.RS 4
Default:
\fI3\fR\&. How many times the server will resend a REQ packet if it doesn\'t get the ACK packet\&.
\fBtapelist\fR(5)\&. Amanda maintains this file with information about the active set of tapes\&.
.RE
.PP
-\fBdevice_output_buffer_size\fR \fIint\fR
+\fBdevice\-output\-buffer\-size\fR \fIint\fR
.RS 4
Default:
\fI1280k\fR\&. 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\&.
.RS 4
Default:
\fI20\fR\&. This option is deprecated; use the
-\fBdevice_output_buffer_size\fR
+\fBdevice\-output\-buffer\-size\fR
directive instead\&.
\fBtapebufs\fR
works the same way, but the number specified is multiplied by the device blocksize prior to use\&.
\fBoff\fR\&. Whether an amdump run will flush the dumps from holding disk to tape\&.
.RE
.PP
-\fBamrecover_do_fsf\fR \fIbool\fR
+\fBamrecover\-do\-fsf\fR \fIbool\fR
.RS 4
+Deprecated; amrecover always uses fsf, and does not invoke amrestore\&.
+.sp
Default:
\fBon\fR\&. Amrecover will call amrestore with the \-f flag for faster positioning of the tape\&.
.RE
.PP
-\fBamrecover_check_label\fR \fIbool\fR
+\fBamrecover\-check\-label\fR \fIbool\fR
.RS 4
+Deprecated; amrecover always checks the label, and does not invoke amrestore\&.
+.sp
Default:
\fBon\fR\&. Amrecover will call amrestore with the \-l flag to check the label\&.
.RE
.PP
-\fBamrecover_changer\fR \fIstring\fR
+\fBamrecover\-changer\fR \fIstring\fR
.RS 4
-Default: not set\&. Amrecover will use the changer if you use \'settape <string>\' and that string is the same as the amrecover_changer setting\&.
+Default: not set\&. Amrecover will use the changer if you use \'settape <string>\' and that string is the same as the
+\fBamrecover\-changer\fR
+setting\&.
.RE
.PP
\fBcolumnspec\fR \fIstring\fR
\fIno default\fR\&. 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\&.
.RE
.PP
-\fBdebug_days\fR \fIint\fR
+\fBdebug\-days\fR \fIint\fR
.RS 4
Default:
\fI3\fR\&. The number of days the debug files are kept\&.
.RE
.PP
-\fBdebug_auth\fR \fIint\fR
+\fBdebug\-auth\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the auth module
.RE
.PP
-\fBdebug_event\fR \fIint\fR
+\fBdebug\-event\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the event module
.RE
.PP
-\fBdebug_holding\fR \fIint\fR
+\fBdebug\-holding\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the holdingdisk module
.RE
.PP
-\fBdebug_protocol\fR \fIint\fR
+\fBdebug\-protocol\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the protocol module
.RE
.PP
-\fBdebug_planner\fR \fIint\fR
+\fBdebug\-planner\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the planner process
.RE
.PP
-\fBdebug_driver\fR \fIint\fR
+\fBdebug\-driver\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the driver process
.RE
.PP
-\fBdebug_dumper\fR \fIint\fR
+\fBdebug\-dumper\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the dumper process
.RE
.PP
-\fBdebug_chunker\fR \fIint\fR
+\fBdebug\-chunker\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the chunker process
.RE
.PP
-\fBdebug_taper\fR \fIint\fR
+\fBdebug\-taper\fR \fIint\fR
.RS 4
Default:
\fI0\fR\&. Debug level of the taper process
Default: \-\-with\-tcpportrange or
\fI1024,65535\fR\&. Unreserved tcp port that will be used (bsd, bsdudp)\&. Range is inclusive\&.
.RE
+.PP
+\fBrecovery\-limit\fR [ \fIstring\fR | \fBsame\-host\fR ]
+.RS 4
+Default: none (no limitations)\&. This parameter limits the hosts that may do remote recoveries\&. Hosts are identified by their authenticated peer name, as described in
+\fBamanda-auth\fR(7); if this is not available and the recovery\-limit parameter is present, recovery will be denied\&. The arguments to the parameter are strings giving host match expressions (see
+\fBamanda-match\fR(7)) or the special keyword same\-host, which requires an exact match to the hostname of the DLE being recovered\&. Specifying no arguments at all will disable all recoveries from any host\&.
+.sp
+Note that match expressions can be constructed to be forgiving of e\&.g\&., fully\-qualified vs\&. unqualified hostnames, but
+\fBsame\-host\fR
+requires an exact match\&.
+.sp
+The error messages that appear in amrecover are intentionally vague to avoid information leakage\&. Consult the amindexd debug log for more details on the reasons a recovery was rejected\&.
+.sp
+Recovery limits can be refined on a per\-DLE basis using the dumptype parameter of the same name\&. Note that the default value will apply to any dumpfiles for disks which no longer appear in the disklist; thus leaving the global parameter at its default value but setting it for all DLEs is not sufficient to maintain secure backups\&.
+.RE
.SH "HOLDINGDISK SECTION"
.PP
The
for more detail\&.
.RE
.PP
-\fBamandad_path\fR \fIstring\fR
+\fBamandad\-path\fR \fIstring\fR
.RS 4
Default:
\fI"$libexec/amandad"\fR\&. Specify the amandad path of the client, only use with rsh/ssh authentification\&.
.RE
.PP
-\fBclient_username\fR \fIstring\fR
+\fBclient\-username\fR \fIstring\fR
.RS 4
Default:
\fICLIENT_LOGIN\fR\&. Specify the username to connect on the client, only use with rsh/ssh authentification\&.
.RE
.PP
-\fBclient_port\fR [ \fIint\fR | \fIstring\fR ]
+\fBclient\-port\fR [ \fIint\fR | \fIstring\fR ]
.RS 4
Default:
\fI"amanda"\fR\&. Specifies the port to connect to on the client\&. It can be a service name or a numeric port number\&.
compress client custom
.RS 4
Specify
-\fIclient_custom_compress\fR
+\fBclient\-custom\-compress\fR
"PROG"
.sp
PROG must not contain white space and it must accept \-d for uncompress\&.
compress server custom
.RS 4
Specify
-\fBserver_custom_compress\fR
+\fBserver\-custom\-compress\fR
"PROG"
.sp
PROG must not contain white space and it must accept \-d for uncompress\&.
option), Amanda (software) compression should be disabled\&.
.RE
.PP
-\fBclient_custom_compress\fR \fIstring\fR
+\fBclient\-custom\-compress\fR \fIstring\fR
.RS 4
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\&.
.RE
.PP
-\fBserver_custom_compress\fR \fIstring\fR
+\fBserver\-custom\-compress\fR \fIstring\fR
.RS 4
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\&.
.RE
.PP
encrypt client
.RS 4
-Specify client_encrypt "PROG"
+Specify client\-encrypt "PROG"
.sp
PROG must not contain white space\&.
.sp
-Specify client_decrypt_option "decryption\-parameter" Default: "\-d"
+Specify client\-decrypt\-option "decryption\-parameter" Default: "\-d"
.sp
decryption\-parameter must not contain white space\&.
.sp
.PP
encrypt server
.RS 4
-Specify server_encrypt "PROG"
+Specify server\-encrypt "PROG"
.sp
PROG must not contain white space\&.
.sp
-Specify server_decrypt_option "decryption\-parameter" Default: "\-d"
+Specify server\-decrypt\-option "decryption\-parameter" Default: "\-d"
.sp
decryption\-parameter must not contain white space\&.
.sp
is provided as a reference symmetric encryption program\&.
.RE
.PP
-\fBclient_encrypt\fR \fIstring\fR
+\fBclient\-encrypt\fR \fIstring\fR
.RS 4
Default: none\&. The program to use to perform encryption/decryption on the client; used with "encrypt client"\&. Must not contain whitespace\&.
.RE
.PP
-\fBclient_decrypt_option\fR \fIstring\fR
+\fBclient\-decrypt\-option\fR \fIstring\fR
.RS 4
-Default: \-d\&. The option that can be passed to client_encrypt to make it decrypt instead\&. Must not contain whitespace\&.
+Default: \-d\&. The option that can be passed to client\-encrypt to make it decrypt instead\&. Must not contain whitespace\&.
.RE
.PP
-\fBserver_encrypt\fR \fIstring\fR
+\fBserver\-encrypt\fR \fIstring\fR
.RS 4
Default: none\&. The program to use to perform encryption/decryption on the server; used with "encrypt server"\&. Must not contain whitespace\&.
.RE
.PP
-\fBserver_decrypt_option\fR \fIstring\fR
+\fBserver\-decrypt\-option\fR \fIstring\fR
.RS 4
-Default: \-d\&. The option that can be passed to server_encrypt to make it decrypt instead\&. Must not contain whitespace\&.
+Default: \-d\&. The option that can be passed to server\-encrypt to make it decrypt instead\&. Must not contain whitespace\&.
.RE
.PP
\fBestimate\fR [ \fBclient\fR | \fBcalcsize\fR | \fBserver\fR ]+
has scheduled an incremental backup, these disks will be skipped\&.
.RE
.PP
-\fBssh_keys\fR \fIstring\fR
+\fBssh\-keys\fR \fIstring\fR
.RS 4
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\&.
.RE
.RE
.RE
.PP
-\fBtape_splitsize\fR \fIint\fR
+\fBallow\-split\fR \fIbool\fR
.RS 4
-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\&. Note that if this value is too large (more than half the size of the 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\&.
+Default: true\&. If true, then dumps with this dumptype can be split on the storage media\&. If false, then the dump will be written in a single file on the media\&. See "Dump Splitting Configuration" below\&.
+.RE
+.PP
+\fBtape\-splitsize\fR \fIint\fR
+.RS 4
+Deprecated\&. See "Dump Splitting Configuration" below\&.
.sp
-The default unit is Kbytes if it is not specified\&.
+Default: not set\&. Split dump file on tape into pieces of a specified size\&. The default unit is Kbytes if it is not specified\&.
.RE
.PP
-\fBsplit_diskbuffer\fR \fIstring\fR
+\fBsplit\-diskbuffer\fR \fIstring\fR
.RS 4
+.PP
+Deprecated\&. See "Dump Splitting Configuration" below\&.
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\&.
.RE
.PP
-\fBfallback_splitsize\fR \fIint\fR
+\fBfallback\-splitsize\fR \fIint\fR
.RS 4
-Default:
-\fI10M\fR\&. 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\&. This specifies the maximum size split chunks can be in this scenario, and thus the maximum amount of memory consumed for in\-memory splitting\&. 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\&.
+Deprecated\&. See "Dump Splitting Configuration" below\&.
.sp
-The default unit is Kbytes if it is not specified\&.
+Default:
+\fI10M\fR\&. This specifies the part size used when no
+\fBsplit\-diskbuffer\fR
+is specified, or when it is too small or does not exist, and thus the maximum amount of memory consumed for in\-memory splitting\&. The default unit is Kbytes if it is not specified\&.
+.RE
+.PP
+\fBrecovery\-limit\fR [ \fBsame\-host\fR | \fIstring\fR ]*
+.RS 4
+Default: global value\&. This parameter overrides the global
+\fBrecovery\-limit\fR
+parameter for DLEs of this dumptype\&.
.RE
.PP
The following
The default unit is Kbytes if it is not specified\&.
.RE
.PP
+\fBpart\-size\fR \fIint\fR
+.RS 4
+Default: none\&. This is the size (in KB if no units are specified) of each split part written to the volume\&. It is reduced to
+\fBpart\-cache\-max\-size\fR
+when part caching is required\&. If this is set to zero, then no splitting will take place; in this case, some devices can span dumps from volume to volume, while others will cause the entire dump to fail if they encounter end\-of\-medium before the dump is complete\&. See "Dump Splitting Configuration" below\&.
+.RE
+.PP
+\fBpart\-cache\-type\fR [ \fBnone\fR | \fBdisk\fR | \fBmemory\fR ]
+.RS 4
+Default: none\&. When part caching is required, this parameter specifies the type of caching that will be used\&. The options include no caching (\fBnone\fR), in which case a failed part will cause the entire dump to fail; on\-disk caching (\fBdisk\fR), for which
+\fBpart\-cache\-dir\fR
+must be set properly; and in\-memory caching (\fBmemory\fR), which on most systems severely restrains the size of the part that can be written\&. See "Dump Splitting Configuration" below\&.
+.RE
+.PP
+\fBpart\-cache\-dir\fR \fIstring\fR
+.RS 4
+Default: none\&. The directory in which part\-cache files can be written when caching on disk\&. See "Dump Splitting Configuration" below\&.
+.RE
+.PP
+\fBpart\-cache\-max\-size\fR \fIint\fR
+.RS 4
+Default: none\&. The maximum part size to use when caching is in effect\&. This is used to limit the part size when disk or memory space for caching is constrained\&. This value must be greater than zero\&.
+.RE
+.PP
\fBspeed\fR \fIint\fR
.RS 4
Default:
.PP
In addition to options, another
\fBtapetype\fR
-name may be supplie as an identifier, which makes this
+name may be supplied as an identifier, which makes this
\fBtapetype\fR
inherit options from another
\fBtapetype\fR\&. 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:
\fI5000\fR\&. Scripts are executed in that order, it is useful if you have many scripts and they must be executed in a spefific order\&.
.RE
.PP
-\fBexecute_where\fR [ \fBclient\fR | \fBserver\fR ]
+\fBexecute\-where\fR [ \fBclient\fR | \fBserver\fR ]
.RS 4
Default:
\fBclient\fR\&. Where the script must be executed, on the client or server\&.
.RE
.PP
-\fB>execute_on\fR \fIexecute_on\fR [,\fIexecute_on\fR]*
+\fBexecute\-on\fR \fIexecute_on\fR [,\fIexecute_on\fR]*
.RS 4
No default\&. When the script must be executed, you can specify many of them:
.PP
.fi
.RE
.PP
-\fBproperty\fR> [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
+\fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
.RS 4
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\&.
\fBappend\fR
define device \fIname\fR {
commend "\fIcomment (optional)\fR"
tapedev "\fIdevice\-specifier\fR"
- device_property "\fIprop\-name\fR" "\fIprop\-value\fR"
+ device\-property "\fIprop\-name\fR" "\fIprop\-value\fR"
\&.\&.\&.
}
.fi
parmeter is optional and only for the user\'s convenience\&.
.PP
An arbitrary number of
-\fIdevice_property\fR
+\fIdevice\-property\fR
parameters can be specified\&. Again, see
\fBamanda-devices\fR(7)
for information on device properties\&.
See
\fBamanda-changers\fR(7)
for more information on configuring changers\&.
+.SH "DUMP SPLITTING CONFIGURATION"
+.PP
+Amanda can "split" dumps into parts while writing them to storage media\&. This allows Amanda to recover gracefully from a failure while writing a part to a volume, by simply selecting a new volume and re\-writing the dump from the beginning of the failed part\&. Parts also allow Amanda to seek directly to the required data, although this functionality is not yet used\&.
+.PP
+In order to support re\-writing from the beginning of a failed part, Amanda must have access to the contents of the part after it has been partially written\&. If the dump is being read from holding disk, then the part contents are availble there\&. Otherwise, the part must be cached, and this can be done memory or on disk\&. In either of the latter cases, the cache must have enough space to hold an entire part\&.
+.PP
+Because it is common for a single Amanda configuration to use both holding\-disk (FILE\-WRITE) and direct (known as PORT\-WRITE) dumps, Amanda allows the configuration of different split sizes for the two cases\&. This allows, for example, for a part size appropriate to large tapes when performing FILE\-WRITE dumps, with a part size limited by available disk or memory when performing PORT\-WRITE dumps\&.
+.PP
+Selecting a proper split size is a delicate matter\&. If the parts are too large, substantial storage space may be wasted in failed parts\&. If too small, large dumps will be split into innumerable tiny dumpfiles, adding to restoration complexity; furthermore, an excess of filemarks will cause slower tape drive operation and reduce the usable space on tape\&. A good rule of thumb is 1/10 of the size of a volume of storage media\&.
+.PP
+In versions of Amanda through 3\&.1\&.*, splitting was controlled by the dumptype parameters
+\fBtape\-splitsize\fR,
+\fBsplit\-diskbuffer\fR, and
+\fBfallback\-splitsize\fR\&. These keywords had confusing and non\-intuitive interactions, and have since been deprecated\&.
+.PP
+If the deprecated keywords are not present, subsequent versions of Amanda use the dumptype parameter
+\fBallow\-split\fR
+to control whether a DLE can be split, and the
+\fItapetype\fR
+parameters
+\fBpart\-size\fR,
+\fBpart\-cache\-type\fR,
+\fBpart\-cache\-dir\fR, and
+\fBpart\-cache\-max\-size\fR\&. The
+\fBpart\-size\fR
+specifies the "normal" part size, while the
+\fBpart\-cache\-*\fR
+parameters describe how to behave when caching is required (on PORT\-WRITE)\&. Full details on these parameters are given above\&.
.SH "SEE ALSO"
.PP
\fBamanda\fR(8),
projects / debian / amanda / blobdiff