NAME¶
amanda-client.conf - Client configuration file for Amanda, the
Advanced Maryland Automatic Network Disk Archiver
DESCRIPTION¶
amanda-client.conf(5) is the client configuration file for
Amanda. This manpage lists the relevant sections and parameters of this file
for quick reference.
The files <CONFIG_DIR>/amanda-client.conf and
<CONFIG_DIR>/<config>/amanda-client.conf are loaded.
GLOBAL PARAMETERS¶
conf string
Default: Set by configure. The conf use by
amrecover.
client-username string
Default:
CLIENT_LOGIN. Similar to the parameter of
the same name in
amanda.conf(5), this specifies the username that
amrecover should send when connecting to the server. It should match
the username specified in .amandahosts on the server.
client-port [ int | string ]
Default:
"amanda". Similar to the
parameter of the same name in
amanda.conf(5), this specifies the port
to connect on the server. It can be a service name or a numeric port
number.
amdump-server string
No default: Set by configure. The amanda server to
connect with the amdump_client program.
index-server string
Default: Set by configure. The amindexd server
amrecover will connect to.
tape-server string
Default: Set by configure. The amidxtaped server
amrecover will connect to.
tapedev string
Default: Set by configure. The tapedev amrecover
will use.
auth string
Default:
"bsdtcp". 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.
"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.
ssh-keys string
Default: No default. 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.
gnutar-list-dir string
Default from configure --with-gnutar-listdir=DIR.
The directory where gnutar keep its state file.
mailer string
Default found by configure. A mail program that can send
mail with 'MAILER -s "subject" user < message_file'.
amandates string
Default: /etc/amandates. The file where amanda
keep the last date of each dumplevel.
connect-tries int
Default: 3. How many times the server will try a
connection.
rep-tries int
Default: 5. How many times amandad will resend a
REP packet if it doesn't get the ACK packet.
debug-days int
Default: 3. The number of days the debug files are
kept.
debug-amandad int
Default: 0. Debug level of the amandad
process
debug-amidxtaped int
Default: 0. Debug level of the amidxtaped
process
debug-amindexd int
Default: 0. Debug level of the amindexd
process
debug-amrecover int
Default: 0. Debug level of the amrecover
process
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-selfcheck int
Default: 0. Debug level of the selfcheck
process
debug-sendsize int
Default: 0. Debug level of the sendsize
process
debug-sendbackup int
Default: 0. Debug level of the sendbackup
process
hostname string
Default: `hostname`. The hostname (in the DLE) of
the client machine
reserved-udp-port int,int
Default: --with-udpportrange or 512,1023. Reserved
udp port that will be used (amrecover with bsd or bsdudp)
reserved-tcp-port int,int
Default: --with-low-tcpportrange or 512,1023.
Reserved tcp port that will be used (amrecover with bsdtcp)
unreserved-tcp-port int,int
Default: --with-tcpportrange or 1025,65536.
Unreserved tcp port that will be used (bsd, bsdudp)
property string string+
Adds a global property for this client host, useful for
e.g., Application API plugins. The first string is the property name, the
following strings are the property values
APPLICATION SECTION¶
The amanda-client.conf file may define multiple types of
application. The information is entered in a application section,
which looks like this:
define application "name" {
application-option application-value
...
}
name is the name of this type of application.
The setting from an application is merged with the dle setting if
the name is the same as the client-application-name from the
dle or if the client-application-name from the dle is not set and the
name is the same as the plugin from the dle.
The application options and values are:
client-application-name string
Default: none. Not use on the client.
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. If set, it must be the same as the dle plugin.
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 server.
SCRIPT SECTION¶
The amanda-client.conf file may define multiple types of
script. The information is entered in a script section, which looks
like this:
define script "name" {
script-option script-value
...
}
name is the name of this type of script.
The setting from a script is merged with the dle setting if the
name is the same as the client-script-name from the dle or if
the client-script-name from the dle is not set and the name is
the same as the plugin from the dle.
The script options and values are:
client-script-name string
Default: none. Not used on the client.
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 $libdir/amanda/application directory on the
client. If set, it must be the same as the dle plugin.
execute-where client
Default: client. Value can't be changed.
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.
post-dle-backup
Execute after the backup command for the dle.
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.
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
server.
AUTHORS¶
James da Silva <jds@amanda.org>
Stefan G. Weichinger <sgw@amanda.org>