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 reserved-udp-port int,int
133 Default: --with-udpportrange or 512,1023. Reserved udp port that
134 will be used (amrecover with bsd or bsdudp)
135 reserved-tcp-port int,int
137 Default: --with-low-tcpportrange or 512,1023. Reserved tcp port
138 that will be used (amrecover with bsdtcp)
139 unreserved-tcp-port int,int
141 Default: --with-tcpportrange or 1025,65536. Unreserved tcp port
142 that will be used (bsd, bsdudp)
143 property string string+
145 Adds a global property for this client host, useful for e.g.,
146 Application API plugins. The first string is the property name, the
147 following strings are the property values
148
150 The amanda-client.conf file may define multiple types of application.
151 The information is entered in a application section, which looks like
152 this:
153 define application "name" {
154 application-option application-value
155 ...
156 }
157 name is the name of this type of application.
159 The setting from an application is merged with the dle setting if the
161 name is the same as the client-application-name from the dle or if the
162 client-application-name from the dle is not set and the name is the
163 same as the plugin from the dle.
164 The application options and values are:
166 client-application-name string
168 Default: none. Not use on the client.
169 comment string
171 Default: none. A comment string describing this application.
172 plugin string
174 No default. Must be set to the name of the program. This program
175 must be in the $libexecdir/amanda/application directory on the
176 client. If set, it must be the same as the dle plugin.
177 property [append] [priority] string string+
179 No default. You can set property for the application, each
180 application have a different set of property. Both strings are
181 quoted; the first string contains the name of the property to set,
182 and the others contains its values. append keyword append the
183 values to the list of values for that property. priority keyword
184 disallow the setting of that property on the server.
185
187 The amanda-client.conf file may define multiple types of script. The
188 information is entered in a script section, which looks like this:
189 define script "name" {
190 script-option script-value
191 ...
192 }
193 name is the name of this type of script.
195 The setting from a script is merged with the dle setting if the name is
197 the same as the client-script-name from the dle or if the
198 client-script-name from the dle is not set and the name is the same as
199 the plugin from the dle.
200 The script options and values are:
202 client-script-name string
204 Default: none. Not used on the client.
205 comment string
207 Default: none. A comment string describing this script.
208 plugin string
210 No default. Must be set to the name of the program. This program
211 must be in the $libdir/amanda/application directory on the client.
212 If set, it must be the same as the dle plugin.
213 execute-where client
215 Default: client. Value can't be changed.
216 execute-on execute_on[,execute_on]*
218 No default. When the script must be executed, you can specify many
219 of them:
220 pre-dle-amcheck
222 Execute before the amcheck command for the dle.
223 pre-host-amcheck
225 Execute before the amcheck command for all dle for the client.
226 post-dle-amcheck
228 Execute after the amcheck command for the dle.
229 post-host-amcheck
231 Execute after the amcheck command for all dle for the client.
232 pre-dle-estimate
234 Execute before the estimate command for the dle.
235 pre-host-estimate
237 Execute before the estimate command for all dle for the client.
238 post-dle-estimate
240 Execute after the estimate command for the dle.
241 post-host-estimate
243 Execute after the estimate command for all dle for the client.
244 pre-dle-backup
246 Execute before the backup command for the dle.
247 post-dle-backup
249 Execute after the backup command for the dle.
250 pre-recover
252 Execute before any level is recovered.
253 post-recover
255 Execute after all levels are recovered.
256 pre-level-recover
258 Execute before each level recovery.
259 post-level-recover
261 Execute after each level recovery.
262 inter-level-recover
264 Execute between two levels of recovery.
265 property [append] [priority] string string+
267 No default. You can set property for the script, each script have a
268 different set of property. Both strings are quoted; the first
269 string contains the name of the property to set, and the others
270 contains its values. append keyword append the values to the list
271 of values for that property. priority keyword disallow the setting
272 of that property on the server.
273
275 amanda(8), amanda.conf(5), amcrypt(8), aespipe(1)
276 The Amanda Wiki: : http://wiki.zmanda.com/
278
280 James da Silva <jds@amanda.org>
281 Stefan G. Weichinger <sgw@amanda.org>
283Amanda 3.3.3 01/10/2013 AMANDA-CLIENT.CON(5)