git.gag.com Git - debian/amanda/blob - man/amanda-client.conf.5

   1 '\" t
   2 .\"     Title: amanda-client.conf
   3 .\"    Author: James da Silva <jds@amanda.org>
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
   5 .\"      Date: 10/18/2010
   6 .\"    Manual: File formats and conventions
   7 .\"    Source: Amanda 3.2.0
   8 .\"  Language: English
   9 .\"
  10 .TH "AMANDA\-CLIENT\&.CON" "5" "10/18/2010" "Amanda 3\&.2\&.0" "File formats and conventions"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 amanda-client.conf \- Client configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver
  23 .SH "DESCRIPTION"
  24 .PP
  25 \fBamanda-client.conf\fR(5)
  26 is the client configuration file for Amanda\&. This manpage lists the relevant sections and parameters of this file for quick reference\&.
  27 .PP
  28 The files
  29 \fB<CONFIG_DIR>/amanda\-client\&.conf\fR
  30 and
  31 \fB<CONFIG_DIR>/<config>/amanda\-client\&.conf\fR
  32 are loaded\&.
  33 .SH "SYNTAX"
  34
  35
  36 The syntax of \fBamanda-client.conf\fR(5) is identical to that for
  37 \fBamanda.conf\fR(5)\&.
  38 .SH "GLOBAL PARAMETERS"
  39 .PP
  40 \fBconf\fR \fIstring\fR
  41 .RS 4
  42 Default:
  43 \fISet by configure\fR\&. The conf use by amrecover\&.
  44 .RE
  45 .PP
  46 \fBclient\-username\fR \fIstring\fR
  47 .RS 4
  48 Default:
  49 \fICLIENT_LOGIN\fR\&. Similar to the parameter of the same name in
  50 \fBamanda.conf\fR(5), this specifies the username that
  51 \fBamrecover\fR
  52 should send when connecting to the server\&. It should match the username specified in
  53 \&.amandahosts
  54 on the server\&.
  55 .RE
  56 .PP
  57 \fBclient\-port\fR [ \fIint\fR | \fIstring\fR ]
  58 .RS 4
  59 Default:
  60 \fI"amanda"\fR\&. Similar to the parameter of the same name in
  61 \fBamanda.conf\fR(5), this specifies the port to connect on the server\&. It can be a service name or a numeric port number\&.
  62 .RE
  63 .PP
  64 \fBindex\-server\fR \fIstring\fR
  65 .RS 4
  66 Default:
  67 \fISet by configure\fR\&. The amindexd server amrecover will connect to\&.
  68 .RE
  69 .PP
  70 \fBtape\-server\fR \fIstring\fR
  71 .RS 4
  72 Default:
  73 \fISet by configure\fR\&. The amidxtaped server amrecover will connect to\&.
  74 .RE
  75 .PP
  76 \fBtapedev\fR \fIstring\fR
  77 .RS 4
  78 Default:
  79 \fISet by configure\fR\&. The tapedev amrecover will use\&.
  80 .RE
  81 .PP
  82 \fBauth\fR \fIstring\fR
  83 .RS 4
  84 Default:
  85 \fB"bsd"\fR\&. Type of authorization to perform between tape server and backup client hosts\&.
  86 .sp
  87 \fB"bsd"\fR, bsd authorization with udp initial connection and one tcp connection by data stream\&.
  88 .sp
  89 \fB"bsdtcp"\fR, bsd authorization but use only one tcp connection\&.
  90 .sp
  91 \fB"bsdudp"\fR, like bsd, but will use only one tcp connection for all data stream\&.
  92 .sp
  93 \fB"krb5"\fR
  94 to use Kerberos\-V authorization\&.
  95 .sp
  96 \fB"local"\fR, if the client is the server, it doesn\'t require authencation setup\&.
  97 .sp
  98 \fB"rsh"\fR
  99 to use rsh authorization\&.
 100 .sp
 101 \fB"ssh"\fR
 102 to use OpenSSH authorization\&.
 103 .RE
 104 .PP
 105 \fBssh\-keys\fR \fIstring\fR
 106 .RS 4
 107 Default:
 108 \fINo default\fR\&. 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\&.
 109 .RE
 110 .PP
 111 \fBgnutar\-list\-dir\fR \fIstring\fR
 112 .RS 4
 113 Default from configure
 114 \fI\-\-with\-gnutar\-listdir=DIR\fR\&. The directory where gnutar keep its state file\&.
 115 .RE
 116 .PP
 117 \fBmailer\fR \fIstring\fR
 118 .RS 4
 119 Default found by configure\&. A mail program that can send mail with \'\fIMAILER \-s "subject" user < message_file\fR\'\&.
 120 .RE
 121 .PP
 122 \fBamandates\fR \fIstring\fR
 123 .RS 4
 124 Default:
 125 \fI/etc/amandates\fR\&. The file where amanda keep the last date of each dumplevel\&.
 126 .RE
 127 .PP
 128 \fBconnect\-tries\fR \fIint\fR
 129 .RS 4
 130 Default:
 131 \fI3\fR\&. How many times the server will try a connection\&.
 132 .RE
 133 .PP
 134 \fBrep\-tries\fR \fIint\fR
 135 .RS 4
 136 Default:
 137 \fI5\fR\&. How many times amandad will resend a REP packet if it doesn\'t get the ACK packet\&.
 138 .RE
 139 .PP
 140 \fBdebug\-days\fR \fIint\fR
 141 .RS 4
 142 Default:
 143 \fI3\fR\&. The number of days the debug files are kept\&.
 144 .RE
 145 .PP
 146 \fBdebug\-amandad\fR \fIint\fR
 147 .RS 4
 148 Default:
 149 \fI0\fR\&. Debug level of the amandad process
 150 .RE
 151 .PP
 152 \fBdebug\-amidxtaped\fR \fIint\fR
 153 .RS 4
 154 Default:
 155 \fI0\fR\&. Debug level of the amidxtaped process
 156 .RE
 157 .PP
 158 \fBdebug\-amindexd\fR \fIint\fR
 159 .RS 4
 160 Default:
 161 \fI0\fR\&. Debug level of the amindexd process
 162 .RE
 163 .PP
 164 \fBdebug\-amrecover\fR \fIint\fR
 165 .RS 4
 166 Default:
 167 \fI0\fR\&. Debug level of the amrecover process
 168 .RE
 169 .PP
 170 \fBdebug\-auth\fR \fIint\fR
 171 .RS 4
 172 Default:
 173 \fI0\fR\&. Debug level of the auth module
 174 .RE
 175 .PP
 176 \fBdebug\-event\fR \fIint\fR
 177 .RS 4
 178 Default:
 179 \fI0\fR\&. Debug level of the event module
 180 .RE
 181 .PP
 182 \fBdebug\-holding\fR \fIint\fR
 183 .RS 4
 184 Default:
 185 \fI0\fR\&. Debug level of the holdingdisk module
 186 .RE
 187 .PP
 188 \fBdebug\-protocol\fR \fIint\fR
 189 .RS 4
 190 Default:
 191 \fI0\fR\&. Debug level of the protocol module
 192 .RE
 193 .PP
 194 \fBdebug\-selfcheck\fR \fIint\fR
 195 .RS 4
 196 Default:
 197 \fI0\fR\&. Debug level of the selfcheck process
 198 .RE
 199 .PP
 200 \fBdebug\-sendsize\fR \fIint\fR
 201 .RS 4
 202 Default:
 203 \fI0\fR\&. Debug level of the sendsize process
 204 .RE
 205 .PP
 206 \fBdebug\-sendbackup\fR \fIint\fR
 207 .RS 4
 208 Default:
 209 \fI0\fR\&. Debug level of the sendbackup process
 210 .RE
 211 .PP
 212 \fBreserved\-udp\-port\fR \fIint\fR,\fIint\fR
 213 .RS 4
 214 Default: \-\-with\-udpportrange or
 215 \fI512,1023\fR\&. Reserved udp port that will be used (amrecover with bsd or bsdudp)
 216 .RE
 217 .PP
 218 \fBreserved\-tcp\-port\fR \fIint\fR,\fIint\fR
 219 .RS 4
 220 Default: \-\-with\-low\-tcpportrange or
 221 \fI512,1023\fR\&. Reserved tcp port that will be used (amrecover with bsdtcp)
 222 .RE
 223 .PP
 224 \fBunreserved\-tcp\-port\fR \fIint\fR,\fIint\fR
 225 .RS 4
 226 Default: \-\-with\-tcpportrange or
 227 \fI1025,65536\fR\&. Unreserved tcp port that will be used (bsd, bsdudp)
 228 .RE
 229 .PP
 230 \fBproperty\fR \fIstring\fR \fIstring\fR+
 231 .RS 4
 232 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
 233 .RE
 234 .SH "APPLICATION SECTION"
 235 .PP
 236 The
 237 \fBamanda\&.conf\fR
 238 file may define multiple types of application\&. The information is entered in a
 239 \fBapplication\fR
 240 section, which looks like this:
 241 .nf
 242 define application "\fIname\fR" {
 243     \fIapplication\-option\fR \fIapplication\-value\fR
 244     \&.\&.\&.
 245 }
 246 .fi
 247 .PP
 248 \fIname\fR
 249 is the name of this type of application\&. It is referenced from the
 250 \fBdumptype\fR
 251 .PP
 252 The application options and values are:
 253 .PP
 254 \fBcomment\fR \fIstring\fR
 255 .RS 4
 256 Default:
 257 \fInone\fR\&. A comment string describing this application\&.
 258 .RE
 259 .PP
 260 \fBplugin\fR \fIstring\fR
 261 .RS 4
 262 No default\&. Must be set to the name of the program\&. This program must be in the
 263 \fI$libexecdir/amanda/application\fR
 264 directory on the client\&.
 265 .RE
 266 .PP
 267 \fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
 268 .RS 4
 269 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\&.
 270 \fBappend\fR
 271 keyword append the values to the list of values for that property\&.
 272 \fBpriority\fR
 273 keyword disallow the setting of that property on the server\&.
 274 .RE
 275 .SH "SCRIPT SECTION"
 276 .PP
 277 The
 278 \fBamanda\&.conf\fR
 279 file may define multiple types of script\&. The information is entered in a
 280 \fBscript\fR
 281 section, which looks like this:
 282 .nf
 283 define script "\fIname\fR" {
 284     \fIscript\-option\fR \fIscript\-value\fR
 285     \&.\&.\&.
 286 }
 287 .fi
 288 .PP
 289 \fIname\fR
 290 is the name of this type of script\&. It is referenced from the
 291 \fBdumptype\fR
 292 .PP
 293 The script options and values are:
 294 .PP
 295 \fBcomment\fR \fIstring\fR
 296 .RS 4
 297 Default:
 298 \fInone\fR\&. A comment string describing this script\&.
 299 .RE
 300 .PP
 301 \fBplugin\fR \fIstring\fR
 302 .RS 4
 303 No default\&. Must be set to the name of the program\&. This program must be in the
 304 \fI$libdir/amanda/application\fR
 305 directory on the client and/or server\&.
 306 .RE
 307 .PP
 308 \fBexecute\-where\fR [ \fBclient\fR | \fBserver\fR ]
 309 .RS 4
 310 Default:
 311 \fBclient\fR\&. Where the script must be executed, on the client or server\&. Only
 312 \fBclient\fR
 313 is valid\&.
 314 .RE
 315 .PP
 316 \fBexecute\-on\fR \fIexecute_on\fR[,\fIexecute_on\fR]*
 317 .RS 4
 318 No default\&. When the script must be executed, you can specify many of them:
 319 .PP
 320 \fBpre\-dle\-amcheck\fR
 321 .RS 4
 322 Execute before the amcheck command for the dle\&.
 323 .RE
 324 .PP
 325 \fBpre\-host\-amcheck\fR
 326 .RS 4
 327 Execute before the amcheck command for all dle for the client\&.
 328 .RE
 329 .PP
 330 \fBpost\-dle\-amcheck\fR
 331 .RS 4
 332 Execute after the amcheck command for the dle\&.
 333 .RE
 334 .PP
 335 \fBpost\-host\-amcheck\fR
 336 .RS 4
 337 Execute after the amcheck command for all dle for the client\&.
 338 .RE
 339 .PP
 340 \fBpre\-dle\-estimate\fR
 341 .RS 4
 342 Execute before the estimate command for the dle\&.
 343 .RE
 344 .PP
 345 \fBpre\-host\-estimate\fR
 346 .RS 4
 347 Execute before the estimate command for all dle for the client\&.
 348 .RE
 349 .PP
 350 \fBpost\-dle\-estimate\fR
 351 .RS 4
 352 Execute after the estimate command for the dle\&.
 353 .RE
 354 .PP
 355 \fBpost\-host\-estimate\fR
 356 .RS 4
 357 Execute after the estimate command for all dle for the client\&.
 358 .RE
 359 .PP
 360 \fBpre\-dle\-backup\fR
 361 .RS 4
 362 Execute before the backup command for the dle\&.
 363 .RE
 364 .PP
 365 \fBpre\-host\-backup\fR
 366 .RS 4
 367 Execute before the backup command for all dle for the client\&.
 368 .RE
 369 .PP
 370 \fBpost\-dle\-backup\fR
 371 .RS 4
 372 Execute after the backup command for the dle\&.
 373 .RE
 374 .PP
 375 \fBpost\-host\-backup\fR
 376 .RS 4
 377 Execute after the backup command for all dle for the client\&.
 378 .RE
 379 .PP
 380 \fBpre\-recover\fR
 381 .RS 4
 382 Execute before any level is recovered\&.
 383 .RE
 384 .PP
 385 \fBpost\-recover\fR
 386 .RS 4
 387 Execute after all levels are recovered\&.
 388 .RE
 389 .PP
 390 \fBpre\-level\-recover\fR
 391 .RS 4
 392 Execute before each level recovery\&.
 393 .RE
 394 .PP
 395 \fBpost\-level\-recover\fR
 396 .RS 4
 397 Execute after each level recovery\&.
 398 .RE
 399 .PP
 400 \fBinter\-level\-recover\fR
 401 .RS 4
 402 Execute between two levels of recovery\&.
 403 .RE
 404 .RE
 405 .PP
 406 \fBproperty\fR [\fBappend\fR] [\fBpriority\fR] \fIstring\fR \fIstring\fR+
 407 .RS 4
 408 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\&.
 409 \fBappend\fR
 410 keyword append the values to the list of values for that property\&.
 411 \fBpriority\fR
 412 keyword disallow the setting of that property on the server\&.
 413 .RE
 414 .SH "SEE ALSO"
 415 .PP
 416 \fBamanda\fR(8),
 417 \fBamanda.conf\fR(5),
 418 \fBamcrypt\fR(8),
 419 \fBaespipe\fR(1)
 420 .PP
 421 The Amanda Wiki:
 422 : http://wiki.zmanda.com/
 423 .SH "AUTHORS"
 424 .PP
 425 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
 426 .PP
 427 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>