1AMANDA-CLIENT.CON(5)     File formats and conventions     AMANDA-CLIENT.CON(5)
2
3
4

NAME

6       amanda-client.conf - Client configuration file for Amanda, the Advanced
7       Maryland Automatic Network Disk Archiver
8

DESCRIPTION

10       amanda-client.conf(5) is the client configuration file for Amanda. This
11       manpage lists the relevant sections and parameters of this file for
12       quick reference.
13
14       The files <CONFIG_DIR>/amanda-client.conf and
15       <CONFIG_DIR>/<config>/amanda-client.conf are loaded.
16

SYNTAX

18       The syntax of amanda-client.conf(5) is identical to that for
19       amanda.conf(5).
20

GLOBAL PARAMETERS

22       conf string
23           Default: Set by configure. The conf use by amrecover.
24
25       client_username string
26           Default: CLIENT_LOGIN. Similar to the parameter of the same name in
27           amanda.conf(5), this specifies the username that amrecover should
28           send when connecting to the server. It should match the username
29           specified in .amandahosts on the server.
30
31       client_port [ int | string ]
32           Default: "amanda". Similar to the parameter of the same name in
33           amanda.conf(5), this specifies the port to connect on the server.
34           It can be a service name or a numeric port number.
35
36       index_server string
37           Default: Set by configure. The amindexd server amrecover will
38           connect to.
39
40       tape_server string
41           Default: Set by configure. The amidxtaped server amrecover will
42           connect to.
43
44       tapedev string
45           Default: Set by configure. The tapedev amrecover will use.
46
47       auth string
48           Default: "bsd". Type of authorization to perform between tape
49           server and backup client hosts.
50
51           "bsd", bsd authorization with udp initial connection and one tcp
52           connection by data stream.
53
54           "bsdtcp", bsd authorization but use only one tcp connection.
55
56           "bsdudp", like bsd, but will use only one tcp connection for all
57           data stream.
58
59           "krb5" to use Kerberos-V authorization.
60
61           "local", if the client is the server, it doesn´t require
62           authencation setup.
63
64           "rsh" to use rsh authorization.
65
66           "ssh" to use OpenSSH authorization.
67
68       ssh_keys string
69           Default: No default. The key file the ssh auth will use, it must be
70           the private key. If this parameter is not specified, then the
71           default ssh key will be used.
72
73       gnutar_list_dir string
74           Default from configure --with-gnutar-listdir=DIR. The directory
75           where gnutar keep its state file.
76
77       mailer string
78           Default found by configure. A mail program that can send mail with
79           ´MAILER -s "subject" user < message_file´.
80
81       amandates string
82           Default: /etc/amandates. The file where amanda keep the last date
83           of each dumplevel.
84
85       connect_tries int
86           Default: 3. How many times the server will try a connection.
87
88       rep_tries int
89           Default: 5. How many times amandad will resend a REP packet if it
90           doesn´t get the ACK packet.
91
92       debug_days int
93           Default: 3. The number of days the debug files are kept.
94
95       debug_amandad int
96           Default: 0. Debug level of the amandad process
97
98       debug_amidxtaped int
99           Default: 0. Debug level of the amidxtaped process
100
101       debug_amindexd int
102           Default: 0. Debug level of the amindexd process
103
104       debug_amrecover int
105           Default: 0. Debug level of the amrecover process
106
107       debug_auth int
108           Default: 0. Debug level of the auth module
109
110       debug_event int
111           Default: 0. Debug level of the event module
112
113       debug_holding int
114           Default: 0. Debug level of the holdingdisk module
115
116       debug_protocol int
117           Default: 0. Debug level of the protocol module
118
119       debug_selfcheck int
120           Default: 0. Debug level of the selfcheck process
121
122       debug_sendsize int
123           Default: 0. Debug level of the sendsize process
124
125       debug_sendbackup int
126           Default: 0. Debug level of the sendbackup process
127
128       reserved-udp-port int,int
129           Default: --with-udpportrange or 512,1023. Reserved udp port that
130           will be used (amrecover with bsd or bsdudp)
131
132       reserved-tcp-port int,int
133           Default: --with-low-tcpportrange or 512,1023. Reserved tcp port
134           that will be used (amrecover with bsdtcp)
135
136       unreserved-tcp-port int,int
137           Default: --with-tcpportrange or 1025,65536. Unreserved tcp port
138           that will be used (bsd, bsdudp)
139
140       property string string+
141           Adds a global property for this client host, useful for e.g.,
142           Application API plugins. The first string is the property name, the
143           following strings are the property values
144

APPLICATION SECTION

146       The amanda.conf file may define multiple types of application. The
147       information is entered in a application section, which looks like this:
148       define application "name" {
149           application-option application-value
150           ...
151       }
152
153       name is the name of this type of application. It is referenced from the
154       dumptype
155
156       The application options and values are:
157
158       comment string
159           Default: none. A comment string describing this application.
160
161       plugin string
162           No default. Must be set to the name of the program. This program
163           must be in the $libexecdir/amanda/application directory on the
164           client.
165
166       property [append] [priority] string string+
167           No default. You can set property for the application, each
168           application have a different set of property. Both strings are
169           quoted; the first string contains the name of the property to set,
170           and the others contains its values.  append keyword append the
171           values to the list of values for that property.  priority keyword
172           disallow the setting of that property on the server.
173

SCRIPT SECTION

175       The amanda.conf file may define multiple types of script. The
176       information is entered in a script section, which looks like this:
177       define script "name" {
178           script-option script-value
179           ...
180       }
181
182       name is the name of this type of script. It is referenced from the
183       dumptype
184
185       The script options and values are:
186
187       comment string
188           Default: none. A comment string describing this script.
189
190       plugin string
191           No default. Must be set to the name of the program. This program
192           must be in the $libdir/amanda/application directory on the client
193           and/or server.
194
195       execute_where [ client | server ]
196           Default: client. Where the script must be executed, on the client
197           or server. Only client is valid.
198
199       execute_on execute_on[,execute_on]*
200           No default. When the script must be executed, you can specify many
201           of them:
202
203           pre-dle-amcheck
204               Execute before the amcheck command for the dle.
205
206           pre-host-amcheck
207               Execute before the amcheck command for all dle for the client.
208
209           post-dle-amcheck
210               Execute after the amcheck command for the dle.
211
212           post-host-amcheck
213               Execute after the amcheck command for all dle for the client.
214
215           pre-dle-estimate
216               Execute before the estimate command for the dle.
217
218           pre-host-estimate
219               Execute before the estimate command for all dle for the client.
220
221           post-dle-estimate
222               Execute after the estimate command for the dle.
223
224           post-host-estimate
225               Execute after the estimate command for all dle for the client.
226
227           pre-dle-backup
228               Execute before the backup command for the dle.
229
230           pre-host-backup
231               Execute before the backup command for all dle for the client.
232
233           post-dle-backup
234               Execute after the backup command for the dle.
235
236           post-host-backup
237               Execute after the backup command for all dle for the client.
238
239           pre-recover
240               Execute before any level is recovered.
241
242           post-recover
243               Execute after all levels are recovered.
244
245           pre-level-recover
246               Execute before each level recovery.
247
248           post-level-recover
249               Execute after each level recovery.
250
251           inter-level-recover
252               Execute between two levels of recovery.
253
254       property [append] [priority] string string+
255           No default. You can set property for the script, each script have a
256           different set of property. Both strings are quoted; the first
257           string contains the name of the property to set, and the others
258           contains its values.  append keyword append the values to the list
259           of values for that property.  priority keyword disallow the setting
260           of that property on the server.
261

SEE ALSO

263       amanda(8), amanda.conf(5), amcrypt(8), aespipe(1)
264
265       The Amanda Wiki: : http://wiki.zmanda.com/
266

AUTHORS

268       James da Silva <jds@amanda.org>
269
270       Stefan G. Weichinger <sgw@amanda.org>
271
272
273
274Amanda 3.1.3                      10/04/2010              AMANDA-CLIENT.CON(5)
Impressum