1AMANDA-CLIENT.CON(5) File formats and conventions AMANDA-CLIENT.CON(5)
2
6 amanda-client.conf - Client configuration file for Amanda, the Advanced
7 Maryland Automatic Network Disk Archiver
8
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 The files <CONFIG_DIR>/amanda-client.conf and
15 <CONFIG_DIR>/<config>/amanda-client.conf are loaded.
16
18 The syntax of amanda-client.conf(5) is identical to that for
19 amanda.conf(5).
20
22 conf string
23 Default: Set by configure. The conf use by amrecover.
24 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 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 amdump-server string
37 No default: Set by configure. The amanda server to connect with the
38 amdump_client program.
39 index-server string
41 Default: Set by configure. The amindexd server amrecover will
42 connect to.
43 tape-server string
45 Default: Set by configure. The amidxtaped server amrecover will
46 connect to.
47 tapedev string
49 Default: Set by configure. The tapedev amrecover will use.
50 auth string
52 Default: "bsdtcp". Type of authorization to perform between tape
53 server and backup client hosts.
54 "bsd", bsd authorization with udp initial connection and one tcp
56 connection by data stream.
57 "bsdtcp", bsd authorization but use only one tcp connection.
59 "bsdudp", like bsd, but will use only one tcp connection for all
61 data stream.
62 "krb5" to use Kerberos-V authorization.
64 "local", if the client is the server, it doesn't require
66 authencation setup.
67 "rsh" to use rsh authorization.
69 "ssh" to use OpenSSH authorization.
71 ssh-keys string
73 Default: No default. The key file the ssh auth will use, it must be
74 the private key. If this parameter is not specified, then the
75 default ssh key will be used.
76 gnutar-list-dir string
78 Default from configure --with-gnutar-listdir=DIR. The directory
79 where gnutar keep its state file.
80 mailer string
82 Default found by configure. A mail program that can send mail with
83 'MAILER -s "subject" user < message_file'.
84 amandates string
86 Default: /etc/amandates. The file where amanda keep the last date
87 of each dumplevel.
88 connect-tries int
90 Default: 3. How many times the server will try a connection.
91 rep-tries int
93 Default: 5. How many times amandad will resend a REP packet if it
94 doesn't get the ACK packet.
95 debug-days int
97 Default: 3. The number of days the debug files are kept.
98 debug-amandad int
100 Default: 0. Debug level of the amandad process
101 debug-amidxtaped int
103 Default: 0. Debug level of the amidxtaped process
104 debug-amindexd int
106 Default: 0. Debug level of the amindexd process
107 debug-amrecover int
109 Default: 0. Debug level of the amrecover process
110 debug-auth int
112 Default: 0. Debug level of the auth module
113 debug-event int
115 Default: 0. Debug level of the event module
116 debug-holding int
118 Default: 0. Debug level of the holdingdisk module
119 debug-protocol int
121 Default: 0. Debug level of the protocol module
122 debug-selfcheck int
124 Default: 0. Debug level of the selfcheck process
125 debug-sendsize int
127 Default: 0. Debug level of the sendsize process
128 debug-sendbackup int
130 Default: 0. Debug level of the sendbackup process
131 hostname string
133 Default: `hostname`. The hostname (in the DLE) of the client
134 machine
135 reserved-udp-port int,int
137 Default: --with-udpportrange or 512,1023. Reserved udp port that
138 will be used (amrecover with bsd or bsdudp)
139 reserved-tcp-port int,int
141 Default: --with-low-tcpportrange or 512,1023. Reserved tcp port
142 that will be used (amrecover with bsdtcp)
143 unreserved-tcp-port int,int
145 Default: --with-tcpportrange or 1025,65536. Unreserved tcp port
146 that will be used (bsd, bsdudp)
147 property string string+
149 Adds a global property for this client host, useful for e.g.,
150 Application API plugins. The first string is the property name, the
151 following strings are the property values
152
154 The amanda-client.conf file may define multiple types of application.
155 The information is entered in a application section, which looks like
156 this:
157 define application "name" {
158 application-option application-value
159 ...
160 }
161 name is the name of this type of application.
163 The setting from an application is merged with the dle setting if the
165 name is the same as the client-application-name from the dle or if the
166 client-application-name from the dle is not set and the name is the
167 same as the plugin from the dle.
168 The application options and values are:
170 client-application-name string
172 Default: none. Not use on the client.
173 comment string
175 Default: none. A comment string describing this application.
176 plugin string
178 No default. Must be set to the name of the program. This program
179 must be in the $libexecdir/amanda/application directory on the
180 client. If set, it must be the same as the dle plugin.
181 property [append] [priority] string string+
183 No default. You can set property for the application, each
184 application have a different set of property. Both strings are
185 quoted; the first string contains the name of the property to set,
186 and the others contains its values. append keyword append the
187 values to the list of values for that property. priority keyword
188 disallow the setting of that property on the server.
189
191 The amanda-client.conf file may define multiple types of script. The
192 information is entered in a script section, which looks like this:
193 define script "name" {
194 script-option script-value
195 ...
196 }
197 name is the name of this type of script.
199 The setting from a script is merged with the dle setting if the name is
201 the same as the client-script-name from the dle or if the
202 client-script-name from the dle is not set and the name is the same as
203 the plugin from the dle.
204 The script options and values are:
206 client-script-name string
208 Default: none. Not used on the client.
209 comment string
211 Default: none. A comment string describing this script.
212 plugin string
214 No default. Must be set to the name of the program. This program
215 must be in the $libdir/amanda/application directory on the client.
216 If set, it must be the same as the dle plugin.
217 execute-where client
219 Default: client. Value can't be changed.
220 execute-on execute_on[,execute_on]*
222 No default. When the script must be executed, you can specify many
223 of them:
224 pre-dle-amcheck
226 Execute before the amcheck command for the dle.
227 pre-host-amcheck
229 Execute before the amcheck command for all dle for the client.
230 post-dle-amcheck
232 Execute after the amcheck command for the dle.
233 post-host-amcheck
235 Execute after the amcheck command for all dle for the client.
236 pre-dle-estimate
238 Execute before the estimate command for the dle.
239 pre-host-estimate
241 Execute before the estimate command for all dle for the client.
242 post-dle-estimate
244 Execute after the estimate command for the dle.
245 post-host-estimate
247 Execute after the estimate command for all dle for the client.
248 pre-dle-backup
250 Execute before the backup command for the dle.
251 post-dle-backup
253 Execute after the backup command for the dle.
254 pre-recover
256 Execute before any level is recovered.
257 post-recover
259 Execute after all levels are recovered.
260 pre-level-recover
262 Execute before each level recovery.
263 post-level-recover
265 Execute after each level recovery.
266 inter-level-recover
268 Execute between two levels of recovery.
269 property [append] [priority] string string+
271 No default. You can set property for the script, each script have a
272 different set of property. Both strings are quoted; the first
273 string contains the name of the property to set, and the others
274 contains its values. append keyword append the values to the list
275 of values for that property. priority keyword disallow the setting
276 of that property on the server.
277
279 amanda(8), amanda.conf(5), amcrypt(8), aespipe(1)
280 The Amanda Wiki: : http://wiki.zmanda.com/
282
284 James da Silva <jds@amanda.org>
285 Stefan G. Weichinger <sgw@amanda.org>
287Amanda 3.5.1 12/01/2017 AMANDA-CLIENT.CON(5)