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

   1 .\"     Title: amanda-client.conf
   2 .\"    Author:
   3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
   4 .\"      Date: 05/14/2008
   5 .\"    Manual:
   6 .\"    Source:
   7 .\"
   8 .TH "AMANDA\-CLIENT\.CONF" "5" "05/14/2008" "" ""
   9 .\" disable hyphenation
  10 .nh
  11 .\" disable justification (adjust text to left margin only)
  12 .ad l
  13 .SH "NAME"
  14 amanda-client.conf - Client configuration file for Amanda, the Advanced Maryland Automatic Network Disk Archiver
  15 .SH "DESCRIPTION"
  16 .PP
  17 \fIamanda\-client\.conf\fR
  18 is the client configuration file for
  19 \fIAmanda\fR\. This manpage lists the relevant sections and parameters of this file for quick reference\.
  20 .PP
  21 The files
  22 \fB<CONFIG_DIR>/amanda\-client\.conf\fR
  23 and
  24 \fB<CONFIG_DIR>/<config>/amanda\-client\.conf\fR
  25 are loaded\.
  26 .SH "PARAMETERS"
  27 .PP
  28 There are a number of configuration parameters that control the behavior of the
  29 \fIAmanda\fR
  30 programs\. All have default values, so you need not specify the parameter in
  31 \fBamanda\-client\.conf\fR
  32 if the default is suitable\.
  33 .PP
  34 Lines starting with # are ignored, as are blank lines\. Comments may be placed on a line with a directive by starting the comment with a #\. The remainder of the line is ignored\.
  35 .PP
  36 Keywords are case insensitive, i\.e\.
  37 \fBauth\fR
  38 and
  39 \fBAuth\fR
  40 are treated the same\.
  41 .PP
  42 Integer arguments may have one of the following (case insensitive) suffixes, some of which have a multiplier effect:
  43 .SS "POSSIBLE SUFFIXES"
  44 .PP
  45 \fBb byte bytes\fR
  46 .RS 4
  47 Some number of bytes\.
  48 .RE
  49 .PP
  50 \fBbps\fR
  51 .RS 4
  52 Some number of bytes per second\.
  53 .RE
  54 .PP
  55 \fBk kb kbyte kbytes kilobyte kilobytes\fR
  56 .RS 4
  57 Some number of kilobytes (bytes*1024)\.
  58 .RE
  59 .PP
  60 \fBkps kbps\fR
  61 .RS 4
  62 Some number of kilobytes per second (bytes*1024)\.
  63 .RE
  64 .PP
  65 \fBm mb meg mbyte mbytes megabyte megabytes\fR
  66 .RS 4
  67 Some number of megabytes (bytes*1024*1024)\.
  68 .RE
  69 .PP
  70 \fBmps mbps\fR
  71 .RS 4
  72 Some number of megabytes per second (bytes*1024*1024)\.
  73 .RE
  74 .PP
  75 \fBg gb gbyte gbytes gigabyte gigabytes\fR
  76 .RS 4
  77 Some number of gigabytes (bytes*1024*1024*1024)\.
  78 .RE
  79 .PP
  80 \fBtape tapes\fR
  81 .RS 4
  82 Some number of tapes\.
  83 .RE
  84 .PP
  85 \fBday days\fR
  86 .RS 4
  87 Some number of days\.
  88 .RE
  89 .PP
  90 \fBweek weeks\fR
  91 .RS 4
  92 Some number of weeks (days*7)\.
  93 .sp
  94 .it 1 an-trap
  95 .nr an-no-space-flag 1
  96 .nr an-break-flag 1
  97 .br
  98 Note
  99 The value
 100 \fBinf\fR
 101 may be used in most places where an integer is expected to mean an infinite amount\.
 102 .sp
 103 Boolean arguments may have any of the values
 104 \fBy\fR,
 105 \fByes\fR,
 106 \fBt\fR,
 107 \fBtrue\fR
 108 or
 109 \fBon\fR
 110 to indicate a true state, or
 111 \fBn\fR,
 112 \fBno\fR,
 113 \fBf\fR,
 114 \fBfalse\fR
 115 or
 116 \fBoff\fR
 117 to indicate a false state\. If no argument is given,
 118 \fBtrue\fR
 119 is assumed\.
 120 .RE
 121 .SS "PARAMETERS"
 122 .PP
 123 \fBconf\fR \fI string\fR
 124 .RS 4
 125 Default:
 126 \fISet by configure\fR\. The conf use by amrecover\.
 127 .RE
 128 .PP
 129 \fBindex_server\fR \fI string\fR
 130 .RS 4
 131 Default:
 132 \fISet by configure\fR\. The amindexd server amrecover will connect to\.
 133 .RE
 134 .PP
 135 \fBtape_server\fR \fI string\fR
 136 .RS 4
 137 Default:
 138 \fISet by configure\fR\. The amidxtaped server amrecover will connect to\.
 139 .RE
 140 .PP
 141 \fBtapedev\fR \fI string\fR
 142 .RS 4
 143 Default:
 144 \fISet by configure\fR\. The tapedev amrecover will use\.
 145 .RE
 146 .PP
 147 \fBauth\fR \fI string\fR
 148 .RS 4
 149 Default:
 150 \fIbsd\fR\. Type of authorization to perform between tape server and backup client hosts\.
 151 .sp
 152 \fBbsd\fR, bsd authorization with udp initial connection and one tcp connection by data stream\.
 153 .sp
 154 \fBbsdtcp\fR, bsd authorization but use only one tcp connection\.
 155 .sp
 156 \fBbsdudp\fR, like bsd, but will use only one tcp connection for all data stream\.
 157 .sp
 158 \fBkrb4\fR
 159 to use Kerberos\-IV authorization\.
 160 .sp
 161 \fBkrb5\fR
 162 to use Kerberos\-V authorization\.
 163 .sp
 164 \fBlocal\fR, if the client is the server, it doesn\'t require authencation setup\.
 165 .sp
 166 \fBrsh\fR
 167 to use rsh authorization\.
 168 .sp
 169 \fBssh\fR
 170 to use OpenSSH authorization\.
 171 .RE
 172 .PP
 173 \fBssh_keys\fR \fI string\fR
 174 .RS 4
 175 Default:
 176 \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 deafult ssh key will be used\.
 177 .RE
 178 .PP
 179 \fBgnutar_list_dir\fR \fI string\fR
 180 .RS 4
 181 Default from configure
 182 \fI\-\-with\-gnutar\-listdir=DIR\fR\. The directory where gnutar keep its state file\.
 183 .RE
 184 .PP
 185 \fBamandates\fR \fI string\fR
 186 .RS 4
 187 Default:
 188 \fI/etc/amandates\fR\. The file where amanda keep the last date of each dumplevel\.
 189 .RE
 190 .PP
 191 \fBconnect_tries\fR int
 192 .RS 4
 193 Default:
 194 \fI3\fR\. How many times the server will try a connection\.
 195 .RE
 196 .PP
 197 \fBrep_tries\fR int
 198 .RS 4
 199 Default:
 200 \fI5\fR\. How many times amandad will resend a REP packet if it doesn\'t get the ACK packet\.
 201 .RE
 202 .PP
 203 \fBdebug_amandad\fR int
 204 .RS 4
 205 Default:
 206 \fI0\fR\. Debug level of the amandad process
 207 .RE
 208 .PP
 209 \fBdebug_amidxtaped\fR int
 210 .RS 4
 211 Default:
 212 \fI0\fR\. Debug level of the amidxtaped process
 213 .RE
 214 .PP
 215 \fBdebug_amindexd\fR int
 216 .RS 4
 217 Default:
 218 \fI0\fR\. Debug level of the amindexd process
 219 .RE
 220 .PP
 221 \fBdebug_amrecover\fR int
 222 .RS 4
 223 Default:
 224 \fI0\fR\. Debug level of the amrecover process
 225 .RE
 226 .PP
 227 \fBdebug_auth\fR int
 228 .RS 4
 229 Default:
 230 \fI0\fR\. Debug level of the auth module
 231 .RE
 232 .PP
 233 \fBdebug_event\fR int
 234 .RS 4
 235 Default:
 236 \fI0\fR\. Debug level of the event module
 237 .RE
 238 .PP
 239 \fBdebug_holding\fR int
 240 .RS 4
 241 Default:
 242 \fI0\fR\. Debug level of the holdingdisk module
 243 .RE
 244 .PP
 245 \fBdebug_protocol\fR int
 246 .RS 4
 247 Default:
 248 \fI0\fR\. Debug level of the protocol module
 249 .RE
 250 .PP
 251 \fBdebug_selfcheck\fR int
 252 .RS 4
 253 Default:
 254 \fI0\fR\. Debug level of the selfcheck process
 255 .RE
 256 .PP
 257 \fBdebug_sendsize\fR int
 258 .RS 4
 259 Default:
 260 \fI0\fR\. Debug level of the sendsize process
 261 .RE
 262 .PP
 263 \fBdebug_sendbackup\fR int
 264 .RS 4
 265 Default:
 266 \fI0\fR\. Debug level of the sendbackup process
 267 .RE
 268 .PP
 269 \fBreserved\-udp\-port\fR int,int
 270 .RS 4
 271 Default: \-\-with\-udpportrange or
 272 \fI512,1023\fR\. Reserved udp port that will be used (amrecover with bsd or bsdudp)
 273 .RE
 274 .PP
 275 \fBreserved\-tcp\-port\fR int,int
 276 .RS 4
 277 Default: \-\-with\-low\-tcpportrange or
 278 \fI512,1023\fR\. Reserved tcp port that will be used (amrecover with bsdtcp)
 279 .RE
 280 .PP
 281 \fBunreserved\-tcp\-port\fR int,int
 282 .RS 4
 283 Default: \-\-with\-tcpportrange or
 284 \fI1025,65536\fR\. Unreserved tcp port that will be used (bsd, bsdudp)
 285 .RE
 286 .SH "AUTHOR"
 287 .PP
 288 James da Silva,
 289 <jds@amanda\.org>: Original text
 290 .PP
 291 Stefan G\. Weichinger,
 292 <sgw@amanda\.org>, maintainer of the
 293 \fIAmanda\fR\-documentation: XML\-conversion, major update, splitting
 294 .SH "SEE ALSO"
 295 .PP
 296
 297 \fBamanda\fR(8),
 298 \fBamanda.conf\fR(5),
 299 \fBamcrypt\fR(8),
 300 \fBaespipe\fR(1),
 301 \fI\%http://wiki.zmanda.com\fR