Imported Upstream version 2.4.5
[debian/amanda] / man / amanda.8
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "AMANDA" 8 "" "" ""
21 .SH NAME
22 amanda \- Advanced Maryland Automatic Network Disk Archiver
23 .SH "SYNOPSIS"
24 .ad l
25 .hy 0
26 .HP 7
27 \fBamdump\fR \fIconfig\fR
28 .ad
29 .hy
30 .ad l
31 .hy 0
32 .HP 8
33 \fBamflush\fR [\-f] \fIconfig\fR
34 .ad
35 .hy
36 .ad l
37 .hy 0
38 .HP 10
39 \fBamcleanup\fR \fIconfig\fR
40 .ad
41 .hy
42 .ad l
43 .hy 0
44 .HP 10
45 \fBamrecover\fR [\fIconfig\fR] [\fIoptions\fR]
46 .ad
47 .hy
48 .ad l
49 .hy 0
50 .HP 10
51 \fBamrestore\fR [\fIoptions\fR] \fItapedevice\fR [\fIhostname\fR\ [\fIdiskname\fR]]
52 .ad
53 .hy
54 .ad l
55 .hy 0
56 .HP 8
57 \fBamlabel\fR \fIconfig\fR \fIlabel\fR [\fIslot\fR\ \fIslot\fR]
58 .ad
59 .hy
60 .ad l
61 .hy 0
62 .HP 8
63 \fBamcheck\fR [\fIoptions\fR] \fIconfig\fR
64 .ad
65 .hy
66 .ad l
67 .hy 0
68 .HP 8
69 \fBamadmin\fR \fIconfig\fR \fIcommand\fR [\fIoptions\fR]
70 .ad
71 .hy
72 .ad l
73 .hy 0
74 .HP 7
75 \fBamtape\fR \fIconfig\fR \fIcommand\fR [\fIoptions\fR]
76 .ad
77 .hy
78 .ad l
79 .hy 0
80 .HP 9
81 \fBamverify\fR \fIconfig\fR
82 .ad
83 .hy
84 .ad l
85 .hy 0
86 .HP 9
87 \fBamrmtape\fR [\fIoptions\fR] \fIconfig\fR \fIlabel\fR
88 .ad
89 .hy
90 .ad l
91 .hy 0
92 .HP 9
93 \fBamstatus\fR \fIconfig\fR [\fIoptions\fR]
94 .ad
95 .hy
96 .ad l
97 .hy 0
98 .HP 11
99 \fBamoverview\fR \fIconfig\fR [\fIoptions\fR]
100 .ad
101 .hy
102 .ad l
103 .hy 0
104 .HP 7
105 \fBamplot\fR [\fIoptions\fR] \fIamdump\-files\fR
106 .ad
107 .hy
108 .ad l
109 .hy 0
110 .HP 9
111 \fBamreport\fR [\fIconfig\fR] [\fIoptions\fR]
112 .ad
113 .hy
114 .ad l
115 .hy 0
116 .HP 6
117 \fBamtoc\fR [\fIoptions\fR] \fIlogfile\fR
118 .ad
119 .hy
120 .ad l
121 .hy 0
122 .HP 10
123 \fBamcheckdb\fR \fIconfig\fR
124 .ad
125 .hy
126 .ad l
127 .hy 0
128 .HP 10
129 \fBamgetconf\fR [\fIconfig\fR] \fIparameter\fR
130 .ad
131 .hy
132
133 .SH "DESCRIPTION"
134
135 .PP
136 \fBAMANDA\fR is the ``\fBAdvanced Maryland Automatic Network Disk Archiver\fR''\&. This manual page gives an overview of the \fBAMANDA\fR commands and configuration files for quick reference\&.
137
138 .PP
139 Here are all the \fBAMANDA\fR commands\&. Each one has its own manual page\&. See them for all the gory details\&.
140
141 .TP
142 \fBamdump\fR
143 Take care of automatic \fBAMANDA\fR backups\&. This is normally executed by \fBcron\fR on a computer called the \fBtape server host\fR and requests backups of file systems located on \fBbackup\fR  \fBclients\fR\&. \fBAmdump\fR backs up all disks in the \fBdisklist\fR file (discussed below) to tape or, if there is a problem, to a special \fBholding\fR  \fBdisk\fR\&. After all backups are done, \fBamdump\fR sends mail reporting failures and successes\&.
144
145 .TP
146 \fBamflush\fR
147 Flush backups from the holding disk to tape\&. \fBAmflush\fR is used after \fBamdump\fR has reported it could not write backups to tape for some reason\&. When this happens, backups stay in the holding disk\&. Run \fBamflush\fR after the tape problem is corrected to write backups from the holding disk to tape\&.
148
149 .TP
150 \fBamcleanup\fR
151 Clean up after an interrupted \fBamdump\fR\&. This command is only needed if \fBamdump\fR was unable to complete for some reason, usually because the tape server host crashed while \fBamdump\fR was running\&.
152
153 .TP
154 \fBamrecover\fR
155 Provides an interactive interface to browse the \fBAMANDA\fR index files (backup image catalogues) and select which tapes to recover files from\&. It can also run \fBamrestore\fR and a restore program (e\&.g\&. \fBtar\fR) to actually recover the files\&.
156
157 .TP
158 \fBamrestore\fR
159 Read an \fBAMANDA\fR tape, searching for requested backups\&. \fBAmrestore\fR is suitable for everything from interactive restores of single files to a full restore of all partitions on a failed disk\&.
160
161 .TP
162 \fBamlabel\fR
163 Write an \fBAMANDA\fR format label onto a tape\&. All \fBAMANDA\fR tapes must be labeled with \fBamlabel\fR\&. \fBAmdump\fR and \fBamflush\fR will not write to an unlabeled tape (see TAPE MANAGEMENT below)\&.
164
165 .TP
166 \fBamcheck\fR
167 Verify the correct tape is mounted and all file systems on all backup client systems are ready to be backed up\&. Often run by \fBcron\fR before \fBamdump\fR to generate a mail warning that backups might fail unless corrective action is taken\&.
168
169 .TP
170 \fBamadmin\fR
171 Take care of administrative tasks like finding out which tapes are needed to restore a filesystem, forcing hosts to do full backups of selected disks and looking at schedule balance information\&.
172
173 .TP
174 \fBamtape\fR
175 Take care of tape changer control operations like loading particular tapes, ejecting tapes and scanning the tape storage slots\&.
176
177 .TP
178 \fBamverify\fR
179 Check \fBAMANDA\fR backup tapes for errors\&.
180
181 .TP
182 \fBamrmtape\fR
183 Delete a tape from the \fBAMANDA\fR databases\&.
184
185 .TP
186 \fBamstatus\fR
187 Report the status of a running or completed \fBamdump\fR\&.
188
189 .TP
190 \fBamoverview\fR
191 Display a chart of hosts and file systems backed up every run\&.
192
193 .TP
194 \fBamplot\fR
195 Generate utilization plots of \fBAMANDA\fR runs for performance tuning\&.
196
197 .TP
198 \fBamreport\fR
199 Generate an \fBAMANDA\fR summary E\-mail report\&.
200
201 .TP
202 \fBamtoc\fR
203 Generate table of content files for \fBAMANDA\fR tapes\&.
204
205 .TP
206 \fBamcheckdb\fR
207 Verify every tape \fBAMANDA\fR knows about is consistent in the database\&.
208
209 .TP
210 \fBamgetconf\fR
211 Look up parameters in the \fBAMANDA\fR configuration file\&.
212
213 .SH "CONFIGURATION"
214
215 .PP
216 There are three user\-editable files that control the behavior of \fBAMANDA\fR\&. The first is \fBamanda\&.conf\fR, the main configuration file\&. It contains parameters to customize \fBAMANDA\fR for the site\&. Second is the \fBdisklist\fR file, which lists hosts and disk partitions to back up\&. Third is the \fBtapelist\fR file, which lists tapes that are currently active\&. These files are described in more detail in the following sections\&.
217
218 .PP
219 All files are stored in individual configuration directories under \fI/usr/local/etc/amanda/\fR\&. A site will often have more than one configuration\&. For example, it might have a \fBnormal\fR configuration for everyday backups and an \fBarchive\fR configuration for infrequent full archival backups\&. The configuration files would be stored under directories \fI/usr/local/etc/amanda/normal/\fR and \fI/usr/local/etc/amanda/archive/\fR, respectively\&. Part of the job of an \fBAMANDA\fR administrator is to create, populate and maintain these directories\&.
220
221 .PP
222 All log and database files generated by \fBAMANDA\fR go in corresponding directories somewhere\&. The exact location is controlled by entries in \fBamanda\&.conf\fR\&. A typical location would be under \fI/var/adm/amanda\fR\&. For the above example, the files might go in \fI/var/adm/amanda/normal/\fR and \fI/var/adm/amanda/archive/\fR\&.
223
224 .PP
225 As log files are no longer needed (no longer contain relevant information), \fBAMANDA\fR cycles them out in various ways, depending on the type of file\&.
226
227 .PP
228 Detailed information about \fBamdump\fR runs are stored in files named \fBamdump\&.\fR\fBNN\fR where \fBNN\fR is a sequence number, with 1 being the most recent file\&. \fBAmdump\fR rotates these files each run, keeping roughly the last \fBtapecycle\fR (see below) worth of them\&.
229
230 .PP
231 The file used by \fBamreport\fR to generate the mail summary is named \fBlog\&.\fR\fBYYYYMMDD\&.NN\fR where \fBYYYYMMDD\fR is the datestamp of the start of the \fBamdump\fR run and \fBNN\fR is a sequence number started at 0\&. At the end of each \fBamdump\fR run, log files for runs whose tapes have been reused are renamed into a subdirectory of the main log directory (see the \fBlogdir\fR parameter below) named \fBoldlog\fR\&. It is up to the \fBAMANDA\fR administrator to remove them from this directory when desired\&.
232
233 .PP
234 Index (backup image catalogue) files older than the full dump matching the oldest backup image for a given client and disk are removed by \fBamdump\fR at the end of each run\&.
235
236 .SH "CONFIG FILE PARAMETERS"
237
238 .PP
239 There are a number of configuration parameters that control the behavior of the \fBAMANDA\fR programs\&. All have default values, so you need not specify the parameter in \fBamanda\&.conf\fR if the default is suitable\&.
240
241 .PP
242 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\&.
243
244 .PP
245 Keywords are case insensitive, i\&.e\&. \fBmailto\fR and \fBMailTo\fR are treated the same\&.
246
247 .PP
248 Integer arguments may have one of the following (case insensitive) suffixes, some of which have a multiplier effect:
249
250 .TP
251 \fBb byte bytes\fR
252 Some number of bytes\&.
253
254 .TP
255 \fBbps\fR
256 Some number of bytes per second\&.
257
258 .TP
259 \fBk kb kbyte kbytes kilobyte kilobytes\fR
260 Some number of kilobytes (bytes*1024)\&.
261
262 .TP
263 \fBkps kbps\fR
264 Some number of kilobytes per second (bytes*1024)\&.
265
266 .TP
267 \fBm mb meg mbyte mbytes megabyte megabytes\fR
268 Some number of megabytes (bytes*1024*1024)\&.
269
270 .TP
271 \fBmps mbps\fR
272 Some number of megabytes per second (bytes*1024*1024)\&.
273
274 .TP
275 \fBg gb gbyte gbytes gigabyte gigabytes\fR
276 Some number of gigabytes (bytes*1024*1024*1024)\&.
277
278 .TP
279 \fBtape tapes\fR
280 Some number of tapes\&.
281
282 .TP
283 \fBday days\fR
284 Some number of days\&.
285
286 .TP
287 \fBweek weeks\fR
288 Some number of weeks (days*7)\&.
289
290  .RS .Sh "Note" The value \fBinf\fR may be used in most places where an integer is expected to mean an infinite amount\&. Boolean arguments may have any of the values \fBy\fR, \fByes\fR, \fBt\fR, \fBtrue\fR or \fBon\fR to indicate a true state, or \fBn\fR, \fBno\fR, \fBf\fR, \fBfalse\fR or \fBoff\fR to indicate a false state\&. If no argument is given, \fBtrue\fR is assumed\&. .RE 
291
292 .TP
293 \fBorg\fR \fB string\fR
294 Default: \fBdaily\fR\&. A descriptive name for the configuration\&. This string appears in the Subject line of mail reports\&. Each \fBAMANDA\fR configuration should have a different string to keep mail reports distinct\&.
295
296 .TP
297 \fBmailto\fR \fB string\fR
298 Default: \fBoperators\fR\&. A space separated list of recipients for mail reports\&.
299
300 .TP
301 \fBdumpcycle\fR \fB int\fR
302 Default: \fB10 days\fR\&. The number of days in the backup cycle\&. Each disk will get a full backup at least this often\&. Setting this to zero tries to do a full backup each run\&.
303
304  .RS .Sh "Note" This parameter may also be set in a specific \fBdumptype\fR (see below)\&. This value sets the default for all \fBdumptype\fRs so must appear in \fBamanda\&.conf\fR before any \fBdumptype\fRs are defined\&. .RE 
305
306 .TP
307 \fBrunspercycle\fR \fB int\fR
308 Default: \fBsame as dumpcycle\fR\&. The number of amdump runs in \fBdumpcycle\fR days\&. A value of 0 means the same value as \fBdumpcycle\fR\&. A value of \-1 means guess the number of runs from the \fBtapelist\fR file, which is the number of tapes used in the last \fBdumpcycle\fR days / \fBruntapes\fR\&.
309
310 .TP
311 \fBtapecycle\fR \fB int\fR
312 Default: \fB15 tapes\fR\&. Typically tapes are used by \fBAMANDA\fR in an ordered rotation\&. The \fBtapecycle\fR parameter defines the size of that rotation\&. The number of tapes in rotation must be larger than the number of tapes required for a complete dump cycle (see the \fBdumpcycle\fR parameter)\&.
313
314 This is calculated by multiplying the number of \fBamdump\fR runs per dump cycle (\fBrunspercycle\fR parameter) times the number of tapes used per run (\fBruntapes\fR parameter)\&. Typically two to four times this calculated number of tapes are in rotation\&. While \fBAMANDA\fR is always willing to use a new tape in its rotation, it refuses to reuse a tape until at least '\fBtapecycle\fR \-1' number of other tapes have been used\&.
315
316 It is considered good administrative practice to set the \fBtapecycle\fR parameter slightly lower than the actual number of tapes in rotation\&. This allows the administrator to more easily cope with damaged or misplaced tapes or schedule adjustments that call for slight adjustments in the rotation order\&.
317
318 .TP
319 \fBdumpuser\fR \fB string\fR
320 Default: \fBamanda\fR\&. The login name \fBAMANDA\fR uses to run the backups\&. The backup client hosts must allow access from the tape server host as this user via \&.rhosts or \&.amandahosts, depending on how the \fBAMANDA\fR software was built\&.
321
322 .TP
323 \fBprinter\fR string
324 Printer to use when doing tape labels\&. See the \fBlbl\-templ\fR  \fBtapetype\fR option\&.
325
326 .TP
327 \fBtapedev\fR string
328 Default: \fI/dev/nst0\fR\&. The path name of the non\-rewinding tape device\&. Non\-rewinding tape device names often have an 'n' in the name, e\&.g\&. \fI/dev/rmt/0mn\fR, however this is operating system specific and you should consult that documentation for detailed naming information\&.
329
330 If a tape changer is configured (see the \fBtpchanger\fR option), this option might not be used\&.
331
332 If the \fBnull\fR output driver is selected (see the OUTPUT DRIVERS section later for more information), programs such as \fBamdump\fR will run normally but all images will be thrown away\&. This should only be used for debugging and testing, and probably only with the \fBrecord\fR option set to \fBno\fR\&.
333
334 .TP
335 \fBrawtapedev\fR string
336 Default: \fI/dev/null\fR\&. The path name of the raw tape device\&. This is only used if \fBAMANDA\fR is compiled for Linux machines with floppy tapes and is needed for QIC volume table operations\&.
337
338 .TP
339 \fBtpchanger\fR string
340 Default: \fBnone\fR\&. The name of the tape changer\&. If a tape changer is not configured, this option is not used and should be commented out of the configuration file\&.
341
342 If a tape changer is configured, choose one of the changer scripts (e\&.g\&. \fBchg\-scsi\fR) and enter that here\&.
343
344 .TP
345 \fBchangerdev\fR string
346 Default: \fI/dev/null\fR\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the \fBtpchanger\fR option\&.
347
348 .TP
349 \fBchangerfile\fR string
350 Default: \fI/usr/adm/amanda/log/changer\-status\fR\&. A tape changer configuration parameter\&. Usage depends on the particular changer defined with the \fBtpchanger\fR option\&.
351
352 .TP
353 \fBruntapes\fR int
354 Default: 1\&. The maximum number of tapes used in a single run\&. If a tape changer is not configured, this option is not used and should be commented out of the configuration file\&.
355
356 If a tape changer is configured, this may be set larger than one to let \fBAMANDA\fR write to more than one tape\&.
357
358 Note that this is an upper bound on the number of tapes, and \fBAMANDA\fR may use less\&.
359
360 Also note that as of this release, \fBAMANDA\fR does not support true tape overflow\&. When it reaches the end of one tape, the backup image \fBAMANDA\fR was processing starts over again on the next tape\&.
361
362 .TP
363 \fBmaxdumpsize\fR int
364 Default: \fBruntapes\fR*\fBtape_length\fR\&. Maximum number of bytes the planner will schedule for a run\&.
365
366 .TP
367 \fBtaperalgo\fR [first|firstfit|largest|largestfit|smallest|last]
368 Default: \fBfirst\fR\&. The algorithm used to choose which dump image to send to the taper\&.
369
370 .RS
371
372 .TP
373 \fBfirst\fR
374 First in, first out\&.
375
376 .TP
377 \fBfirstfit\fR
378 The first dump image that will fit on the current tape\&.
379
380 .TP
381 \fBlargest\fR
382 The largest dump image\&.
383
384 .TP
385 \fBlargestfit\fR
386 The largest dump image that will fit on the current tape\&.
387
388 .TP
389 \fBsmallest\fR
390 The smallest dump image\&.
391
392 .TP
393 \fBlast\fR
394 Last in, first out\&.
395
396 .RE
397 .IP
398
399 .TP
400 \fBlabelstr\fR \fB string\fR
401 Default: \fB\&.*\fR\&. The tape label constraint regular expression\&. All tape labels generated (see \fBamlabel(8)\fR) and used by this configuration must match the regular expression\&. If multiple configurations are run from the same tape server host, it is helpful to set their labels to different strings (for example, ``\fBDAILY[0\-9][0\-9]*\fR'' vs\&. ``\fBARCHIVE[0\-9][0\-9]*\fR'') to avoid overwriting each other's tapes\&.
402
403 .TP
404 \fBtapetype\fR \fB string\fR
405 Default: \fBEXABYTE\fR\&. The type of tape drive associated with \fBtapedev\fR or \fBtpchanger\fR\&. This refers to one of the defined \fBtapetype\fRs in the config file (see below), which specify various tape parameters, like the \fBlength\fR, \fBfilemark\fR size, and \fBspeed\fR of the tape media and device\&.
406
407 .TP
408 \fBctimeout\fR int
409 Default: \fB30 seconds\fR\&. Maximum amount of time that \fBamcheck\fR will wait for each client host\&.
410
411 .TP
412 \fBdtimeout\fR int
413 Default: \fB1800 seconds\fR\&. Amount of idle time per disk on a given client that a \fBdumper\fR running from within \fBamdump\fR will wait before it fails with a data timeout error\&.
414
415 .TP
416 \fBetimeout\fR int
417 Default: \fB300 seconds\fR\&. Amount of time per disk on a given client that the \fBplanner\fR step of \fBamdump\fR will wait to get the dump size estimates\&. For instance, with the default of 300 seconds and four disks on client A, \fBplanner\fR will wait up to 20 minutes for that machine\&. A negative value will be interpreted as a total amount of time to wait per client instead of per disk\&.
418
419 .TP
420 \fBnetusage\fR int
421 Default: \fB300 Kbps\fR\&. The maximum network bandwidth allocated to \fBAMANDA\fR, in Kbytes per second\&. See also the \fBinterface\fR section\&.
422
423 .TP
424 \fBinparallel\fR int
425 Default: 10\&. The maximum number of backups that \fBAMANDA\fR will attempt to run in parallel\&. \fBAMANDA\fR will stay within the constraints of network bandwidth and holding disk space available, so it doesn't hurt to set this number a bit high\&. Some contention can occur with larger numbers of backups, but this effect is relatively small on most systems\&.
426
427 .TP
428 \fBdisplayunit\fR "k|m|g|t"
429 Default: "k"\&. The unit used to print many numbers, k=kilo, m=mega, g=giga, t=tera\&.
430
431 .TP
432 \fBdumporder\fR string
433 Default: \fBtttTTTTTTT\fR\&. The priority order of each dumper:
434
435 .RS
436 .TP 3
437 \(bu
438 s: smallest size
439 .TP
440 \(bu
441 S: largest size
442 .TP
443 \(bu
444 t: smallest time
445 .TP
446 \(bu
447 T: largest time
448 .TP
449 \(bu
450 b: smallest bandwidth
451 .TP
452 \(bu
453 B: largest bandwidth
454 .LP
455 .RE
456 .IP
457
458 .TP
459 \fBmaxdumps\fR int
460 Default: 1\&. The maximum number of backups from a single host that \fBAMANDA\fR will attempt to run in parallel\&. See also the \fBinparallel\fR option\&.
461
462 Note that this parameter may also be set in a specific \fBdumptype\fR (see below)\&. This value sets the default for all \fBdumptype\fRs so must appear in \fBamanda\&.conf\fR before any \fBdumptype\fRs are defined\&.
463
464 .TP
465 \fBbumpsize\fR int
466 Default: \fB10 Mbytes\fR\&. The minimum savings required to trigger an automatic bump from one incremental level to the next\&. If \fBAMANDA\fR determines that the next higher backup level will be this much smaller than the current level, it will do the next level\&. See also the \fBbumpmult\fR option\&.
467
468 .TP
469 \fBbumpmult\fR \fB float\fR
470 Default: 1\&.5\&. The bump size multiplier\&. \fBAMANDA\fR multiplies \fBbumpsize\fR by this factor for each level\&. This prevents active filesystems from bumping too much by making it harder to bump to the next level\&. For example, with the default \fBbumpsize\fR and \fBbumpmult\fR set to 2\&.0, the bump threshold will be 10 Mbytes for level one, 20 Mbytes for level two, 40 Mbytes for level three, and so on\&.
471
472 .TP
473 \fBbumpdays\fR \fB int\fR
474 Default: \fB2 days\fR\&. To insure redundancy in the dumps, \fBAMANDA\fR keeps filesystems at the same incremental level for at least \fBbumpdays\fR days, even if the other bump threshold criteria are met\&.
475
476 .TP
477 \fBdiskfile\fR \fB string\fR
478 Default: \fBdisklist\fR\&. The file name for the \fBdisklist\fR file holding client hosts, disks and other client dumping information\&.
479
480 .TP
481 \fBinfofile\fR \fB string\fR
482 Default: \fI/usr/adm/amanda/curinfo\fR\&. The file or directory name for the historical information database\&. If \fBAMANDA\fR was configured to use DBM databases, this is the base file name for them\&. If it was configured to use text formated databases (the default), this is the base directory and within here will be a directory per client, then a directory per disk, then a text file of data\&.
483
484 .TP
485 \fBlogdir\fR \fB string\fR
486 Default: \fI/usr/adm/amanda\fR\&. The directory for the \fBamdump\fR and \fBlog\fR files\&.
487
488 .TP
489 \fBindexdir\fR \fB string\fR
490 Default \fI/usr/adm/amanda/index\fR\&. The directory where index files (backup image catalogues) are stored\&. Index files are only generated for filesystems whose \fBdumptype\fR has the \fBindex\fR option enabled\&.
491
492 .TP
493 \fBtapelist\fR \fB string\fR
494 Default: \fBtapelist\fR\&. The file name for the active \fBtapelist\fR file\&. \fBAMANDA\fR maintains this file with information about the active set of tapes\&.
495
496 .TP
497 \fBtapebufs\fR \fB int\fR
498 Default: 20\&. The number of buffers used by the \fBtaper\fR process run by \fBamdump\fR and \fBamflush\fR to hold data as it is read from the network or disk before it is written to tape\&. Each buffer is a little larger than 32 KBytes and is held in a shared memory region\&.
499
500 .TP
501 \fBreserve\fR \fB number\fR
502 Default: 100\&. The part of holding\-disk space that should be reserved for incremental backups if no tape is available, expressed as a percentage of the available holding\-disk space (0\-100)\&. By default, when there is no tape to write to, degraded mode (incremental) backups will be performed to the holding disk\&. If full backups should also be allowed in this case, the amount of holding disk space reserved for incrementals should be lowered\&.
503
504 .TP
505 \fBautoflush\fR \fB bool\fR
506 Default: \fBoff\fR\&. Whether an amdump run will flush the dump already on holding disk to tape\&.
507
508 .TP
509 \fBamrecover_do_fsf\fR \fB bool\fR
510 Default: \fBoff\fR\&. Amrecover will call amrestore with the \-f flag for faster positioning of the tape\&.
511
512 .TP
513 \fBamrecover_check_label\fR \fB bool\fR
514 Default: \fBoff\fR\&. Amrecover will call amrestore with the \-l flag to check the label\&.
515
516 .TP
517 \fBamrecover_changer\fR \fB string\fR
518 Default: ''\&. Amrecover will use the changer if you use 'settape <string>' and that string is the same as the amrecover_changer setting\&.
519
520 .TP
521 \fBcolumnspec\fR \fB string\fR
522 Defines the width of columns \fBamreport\fR should use\&. \fBString\fR is a comma (',') separated list of triples\&. Each triple consists of three parts which are separated by a equal sign ('=') and a colon (':') (see the example)\&. These three parts specify:
523
524
525 .RS
526 .TP 3
527 \(bu
528 the name of the column, which may be:
529
530 .RS
531 .TP 3
532 \(bu
533 Compress (compression ratio)
534 .TP
535 \(bu
536 Disk (client disk name)
537 .TP
538 \(bu
539 DumpRate (dump rate in KBytes/sec)
540 .TP
541 \(bu
542 DumpTime (total dump time in hours:minutes)
543 .TP
544 \(bu
545 HostName (client host name)
546 .TP
547 \(bu
548 Level (dump level)
549 .TP
550 \(bu
551 OrigKB (original image size in KBytes)
552 .TP
553 \(bu
554 OutKB (output image size in KBytes)
555 .TP
556 \(bu
557 TapeRate (tape writing rate in KBytes/sec)
558 .TP
559 \(bu
560 TapeTime (total tape time in hours:minutes)
561 .LP
562 .RE
563 .IP
564 .TP
565 \(bu
566 the amount of space to display before the column (used to get whitespace between columns)\&.
567 .TP
568 \(bu
569 the width of the column itself\&. If set to a negative value, the width will be calculated on demand to fit the largest entry in this column\&.
570 .LP
571 .RE
572 .IP
573 Here is an example:
574
575 .nf
576
577 columnspec "Disk=1:18,HostName=0:10,OutKB=1:7"
578 .fi
579 The above will display the disk information in 18 characters and put one space before it\&. The hostname column will be 10 characters wide with no space to the left\&. The output KBytes column is seven characters wide with one space before it\&.
580
581 .TP
582 \fBincludefile\fR \fB string\fR
583 Default: \fBnone\fR\&. The name of an \fBAMANDA\fR configuration file to include within the current file\&. Useful for sharing dumptypes, tapetypes and interface definitions among several configurations\&.
584
585 .SH "HOLDINGDISK SECTION"
586
587 .PP
588 The \fBamanda\&.conf\fR file may define one or more holding disks used as buffers to hold backup images before they are written to tape\&. The syntax is:
589 .nf
590
591 holdingdisk \fBname\fR {
592     \fBholdingdisk\-option\fR \fBholdingdisk\-value\fR
593     \&.\&.\&.
594 }
595 .fi
596
597 .PP
598 \fBName\fR is a logical name for this holding disk\&.
599
600 .PP
601 The options and values are:
602
603 .TP
604 \fBcomment\fR \fB string\fR
605 Default: \fBnone\fR\&. A comment string describing this holding disk\&.
606
607 .TP
608 \fBdirectory\fR \fB disk\fR
609 Default: \fI/dumps/amanda\fR\&. The path to this holding area\&.
610
611 .TP
612 \fBuse\fR \fB int\fR
613 Default: \fB0 Gb\fR\&. Amount of space that can be used in this holding disk area\&. If the value is zero, all available space on the file system is used\&. If the value is negative, \fBAMANDA\fR will use all available space minus that value\&.
614
615 .TP
616 \fBchunksize\fR \fB int\fR
617 Default: \fB1 Gb\fR\&. Holding disk chunk size\&. Dumps larger than the specified size will be stored in multiple holding disk files\&. The size of each chunk will not exceed the specified value\&. However, even though dump images are split in the holding disk, they are concatenated as they are written to tape, so each dump image still corresponds to a single continuous tape section\&.
618
619 If 0 is specified, \fBAMANDA\fR will create holding disk chunks as large as ((INT_MAX/1024)\-64) Kbytes\&.
620
621 Each holding disk chunk includes a 32 Kbyte header, so the minimum chunk size is 64 Kbytes (but that would be really silly)\&.
622
623 Operating systems that are limited to a maximum file size of 2 Gbytes actually cannot handle files that large\&. They must be at least one byte less than 2 Gbytes\&. Since \fBAMANDA\fR works with 32 Kbyte blocks, and to handle the final read at the end of the chunk, the chunk size should be at least 64 Kbytes (2 * 32 Kbytes) smaller than the maximum file size, e\&.g\&. 2047 Mbytes\&.
624
625 .SH "DUMPTYPE SECTION"
626
627 .PP
628 The \fBamanda\&.conf\fR file may define multiple sets of backup options and refer to them by name from the \fBdisklist\fR file\&. For instance, one set of options might be defined for file systems that can benefit from high compression, another set that does not compress well, another set for file systems that should always get a full backup and so on\&.
629
630 .PP
631 A set of backup options are entered in a \fBdumptype\fR section, which looks like this:
632 .nf
633
634 define dumptype \fBname\fR {
635     \fBdumptype\-option\fR \fBdumptype\-value\fR
636     \&.\&.\&.
637 }
638 .fi
639
640 .PP
641 \fBName\fR is the name of this set of backup options\&. It is referenced from the \fBdisklist\fR file\&.
642
643 .PP
644 Some of the options in a \fBdumptype\fR section are the same as those in the main part of \fBamanda\&.conf\fR\&. The main option value is used to set the default for all \fBdumptype\fR sections\&. For instance, setting \fBdumpcycle\fR to 50 in the main part of the config file causes all following \fBdumptype\fR sections to start with that value, but the value may be changed on a section by section basis\&. Changes to variables in the main part of the config file must be done before (earlier in the file) any \fBdumptype\fRs are defined\&.
645
646 .PP
647 The dumptype options and values are:
648
649 .TP
650 \fBauth\fR \fB string\fR
651 Default: \fBbsd\fR\&. Type of authorization to perform between tape server and backup client hosts\&. May be \fBkrb4\fR to use Kerberos\-IV authorization\&.
652
653 .TP
654 \fBcomment\fR \fB string\fR
655 Default: \fBnone\fR\&. A comment string describing this set of backup options\&.
656
657 .TP
658 \fBcomprate\fR \fBfloat\fR [, \fBfloat\fR ]
659 Default: 0\&.50, 0\&.50\&. The expected full and incremental compression factor for dumps\&. It is only used if \fBAMANDA\fR does not have any history information on compression rates for a filesystem, so should not usually need to be set\&. However, it may be useful for the first time a very large filesystem that compresses very little is backed up\&.
660
661 .TP
662 \fBcompress [client|server]\fR \fB string\fR
663 Default: \fBclient fast\fR\&. If \fBAMANDA\fR does compression of the backup images, it can do so either on the backup client host before it crosses the network or on the tape server host as it goes from the network into the holding disk or to tape\&. Which place to do compression (if at all) depends on how well the dump image usually compresses, the speed and load on the client or server, network capacity, holding disk capacity, availability of tape hardware compression, etc\&.
664
665 For either type of compression, \fBAMANDA\fR also allows the selection of two styles of compression\&. \fBBest\fR is the best compression available, often at the expense of CPU overhead\&. \fBFast\fR is often not as good a compression as \fBbest\fR, but usually less CPU overhead\&.
666
667 So the \fBcompress\fR options line may be one of:
668
669
670 .RS
671 .TP 3
672 \(bu
673 compress none
674 .TP
675 \(bu
676 compress [client] fast
677 .TP
678 \(bu
679 compress [client] best
680 .TP
681 \(bu
682 compress server fast
683 .TP
684 \(bu
685 compress server best
686 .LP
687 .RE
688 .IP
689 Note that some tape devices do compression and this option has nothing to do with whether that is used\&. If hardware compression is used (usually via a particular tape device name or \fBmt\fR option), \fBAMANDA\fR (software) compression should be disabled\&.
690
691 .TP
692 \fBdumpcycle\fR \fB int\fR
693 Default: \fB10 days\fR\&. The number of days in the backup cycle\&. Each disk using this set of options will get a full backup at least this often\&. Setting this to zero tries to do a full backup each run\&.
694
695 .TP
696 \fBexclude\fR [ \fBlist|file\fR ][[optional][ \fBappend\fR ][ \fB string\fR ]+]
697 Default: \fBfile\fR\&. There are two exclude lists, \fBexclude file\fR and \fBexclude list\&.\fR With \fBexclude file\fR , the \fBstring\fR is a \fBGNU\-tar\fR exclude expression\&. With \fBexclude list\fR , the \fBstring\fR is a file name on the client containing \fBGNU\-tar\fR exclude expressions\&.
698
699 All exclude expressions are concatenated in one file and passed to \fBGNU\-tar\fR as an \fB\-\-exclude\-from\fR argument\&.
700
701 With the \fBappend\fR keyword, the \fBstring\fR is appended to the current list, without it, the \fBstring\fR overwrites the list\&.
702
703 If \fBoptional\fR is specified for \fBexclude list\fR, then amcheck will not complain if the file doesn't exist or is not readable\&.
704
705 For \fBexclude list\fR, if the file name is relative, the disk name being backed up is prepended\&. So if this is entered:
706
707 .nf
708
709     exclude list ``\fB\&.amanda\&.excludes\fR''
710 .fi
711 the actual file used would be \fI/var/\&.amanda\&.excludes\fR for a backup of \fI/var\fR, \fI/usr/local/\&.amanda\&.excludes\fR for a backup of \fI/usr/local\fR, and so on\&.
712
713 .TP
714 \fBholdingdisk\fR \fB boolean\fR
715 Default: \fByes\fR\&. Whether a holding disk should be used for these backups or whether they should go directly to tape\&. If the holding disk is a portion of another file system that \fBAMANDA\fR is backing up, that file system should refer to a dumptype with \fBholdingdisk\fR set to \fBno\fR to avoid backing up the holding disk into itself\&.
716
717 .TP
718 \fBignore\fR \fB boolean\fR
719 Default: \fBno\fR\&. Whether disks associated with this backup type should be backed up or not\&. This option is useful when the \fBdisklist\fR file is shared among several configurations, some of which should not back up all the listed file systems\&.
720
721 .TP
722 \fBinclude\fR [ \fBlist|file\fR ][[optional][ \fBappend\fR ][ \fB string\fR ]+]
723 Default: \fBfile\fR "\&."\&. There are two include lists, \fBinclude file\fR and \fBinclude list\&.\fR With \fBinclude file\fR , the \fBstring\fR is a glob expression\&. With \fBinclude list\fR , the \fBstring\fR is a file name on the client containing glob expressions\&.
724
725 All include expressions are expanded by \fBAMANDA\fR, concatenated in one file and passed to \fBGNU\-tar\fR as a \fB\-\-files\-from\fR argument\&. They must start with "\&./" and contain no other "/"\&.
726
727 With the \fBappend\fR keyword, the \fBstring\fR is appended to the current list, without it, the \fBstring\fR overwrites the list\&.
728
729 If \fBoptional\fR is specified for \fBinclude list,\fR then amcheck will not complain if the file doesn't exist or is not readable\&.
730
731 For \fBinclude list\fR, If the file name is relative, the disk name being backed up is prepended\&.
732
733 .TP
734 \fBindex\fR \fB boolean\fR
735 Default: \fBno\fR\&. Whether an index (catalogue) of the backup should be generated and saved in \fBindexdir\fR\&. These catalogues are used by the \fBamrecover\fR utility\&.
736
737 .TP
738 \fBkencrypt\fR \fB boolean\fR
739 Default: \fBno\fR\&. Whether the backup image should be encrypted by Kerberos as it is sent across the network from the backup client host to the tape server host\&.
740
741 .TP
742 \fBmaxdumps\fR \fB int\fR
743 Default: 1\&. The maximum number of backups from a single host that \fBAMANDA\fR will attempt to run in parallel\&. See also the main section parameter \fBinparallel\fR\&.
744
745 .TP
746 \fBmaxpromoteday\fR \fB int\fR
747 Default: 10000\&. The maximum number of day for a promotion, set it 0 if you don't want promotion, set it to 1 or 2 if your disks get overpromoted\&.
748
749 .TP
750 \fBpriority\fR \fB string\fR
751 Default: \fBmedium\fR\&. When there is no tape to write to, \fBAMANDA\fR will do incremental backups in priority order to the holding disk\&. The priority may be high (2)\&. medium (1), low (0) or a number of your choice\&.
752
753 .TP
754 \fBprogram\fR \fB string\fR
755 Default: \fBDUMP\fR\&. The type of backup to perform\&. Valid values are \fBDUMP\fR for the native operating system backup program, and \fBGNUTAR\fR to use \fBGNU\-tar\fR or to do PC backups using Samba\&.
756
757 .TP
758 \fBrecord\fR \fB boolean\fR
759 Default: \fByes\fR\&. Whether to ask the backup program to update its database (e\&.g\&. \fI/etc/dumpdates\fR for DUMP or \fI/usr/local/var/amanda/gnutar\-lists\fR for GNUTAR) of time stamps\&. This is normally enabled for daily backups and turned off for periodic archival runs\&.
760
761 .TP
762 \fBskip\-full\fR \fB boolean\fR
763 Default: \fBno\fR\&. If \fBtrue\fR and \fBplanner\fR has scheduled a full backup, these disks will be skipped, and full backups should be run off\-line on these days\&. It was reported that \fBAMANDA\fR only schedules level 1 incrementals in this configuration; this is probably a bug\&.
764
765 .TP
766 \fBskip\-incr\fR \fB boolean\fR
767 Default: \fBno\fR\&. If \fBtrue\fR and \fBplanner\fR has scheduled an incremental backup, these disks will be skipped\&.
768
769 .TP
770 \fBstarttime\fR \fB int\fR
771 Default: \fBnone\fR\&. Backups will not start until after this time of day\&. The value should be hh*100+mm, e\&.g\&. 6:30PM (18:30) would be entered as 1830\&.
772
773 .TP
774 \fBstrategy\fR \fB string\fR
775 Default: \fBstandard\fR\&. Strategy to use when planning what level of backup to run next\&. Values are:
776
777 .TP
778 \fBstandard\fR
779 The standard \fBAMANDA\fR schedule\&.
780
781 .TP
782 \fBnofull\fR
783 Never do full backups, only level 1 incrementals\&.
784
785 .TP
786 \fBnoinc\fR
787 Never do incremental backups, only full dumps\&.
788
789 .TP
790 \fBskip\fR
791 Never do backups (useful when sharing the \fBdisklist\fR file)\&.
792
793 .TP
794 \fBincronly\fR
795 Only do incremental dumps\&. \fBamadmin force\fR should be used to tell \fBAMANDA\fR that a full dump has been performed off\-line, so that it resets to level 1\&. It is similar to skip\-full, but with incronly full dumps may be scheduled manually\&. Unfortunately, it appears that \fBAMANDA\fR will perform full backups with this configuration, which is probably a bug\&.
796
797 .PP
798 The following \fBdumptype\fR entries are predefined by \fBAMANDA\fR:
799 .nf
800
801 define dumptype no\-compress {
802     compress none
803 }
804 define dumptype compress\-fast {
805     compress client fast
806 }
807 define dumptype compress\-best {
808     compress client best
809 }
810 define dumptype srvcompress {
811     compress server fast
812 }
813 define dumptype bsd\-auth {
814     auth bsd
815 }
816 define dumptype krb4\-auth {
817     auth krb4
818 }
819 define dumptype no\-record {
820     record no
821 }
822 define dumptype no\-hold {
823     holdingdisk no
824 }
825 define dumptype no\-full {
826     skip\-full yes
827
828 .fi
829
830 .PP
831 In addition to options in a \fBdumptype\fR section, one or more other \fBdumptype\fR names may be entered, which make this \fBdumptype\fR inherit options from other previously defined \fBdumptype\fRs\&. For instance, two sections might be the same except for the \fBrecord\fR option:
832 .nf
833
834 define dumptype normal {
835     comment "Normal backup, no compression, do indexing"
836     no\-compress
837     index yes
838     maxdumps 2
839 }
840 define dumptype testing {
841     comment "Test backup, no compression, do indexing, no recording"
842     normal
843     record no
844 }
845 .fi
846
847 .PP
848 \fBAMANDA\fR provides a \fBdumptype\fR named \fBglobal\fR in the sample \fBamanda\&.conf\fR file that all \fBdumptype\fRs should reference\&. This provides an easy place to make changes that will affect every \fBdumptype\fR\&.
849
850 .SH "TAPETYPE SECTION"
851
852 .PP
853 The \fBamanda\&.conf\fR file may define multiple types of tape media and devices\&. The information is entered in a \fBtapetype\fR section, which looks like this in the config file:
854 .nf
855
856 define tapetype \fBname\fR {
857     \fBtapetype\-option\fR \fBtapetype\-value\fR
858     \&.\&.\&.
859 }
860 .fi
861
862 .PP
863 \fBName\fR is the name of this type of tape medium/device\&. It is referenced from the \fBtapetype\fR option in the main part of the config file\&.
864
865 .PP
866 The tapetype options and values are:
867
868 .TP
869 \fBcomment\fR \fB string\fR
870 Default: \fBnone\fR\&. A comment string describing this set of tape information\&.
871
872 .TP
873 \fBfilemark\fR \fB int\fR
874 Default: \fB1000 bytes\fR\&. How large a file mark (tape mark) is, measured in bytes\&. If the size is only known in some linear measurement (e\&.g\&. inches), convert it to bytes using the device density\&.
875
876 .TP
877 \fBlength\fR \fB int\fR
878 Default: \fB2000 kbytes\fR\&. How much data will fit on a tape\&.
879
880 Note that this value is only used by \fBAMANDA\fR to schedule which backups will be run\&. Once the backups start, \fBAMANDA\fR will continue to write to a tape until it gets an error, regardless of what value is entered for \fBlength\fR (but see the OUTPUT DRIVERS section later for exceptions)\&.
881
882 .TP
883 \fBblocksize\fR \fB int\fR
884 Default: \fB32\fR\&. How much data will be written in each tape record expressed in KiloBytes\&. The tape record size (= blocksize) can not be reduced below the default 32 KBytes\&. The parameter blocksize can only be raised if \fBAMANDA\fR was compiled with the configure option \-\-with\-maxtapeblocksize=N set with "N" greater than 32 during \fBconfigure\fR\&.
885
886 .TP
887 \fBfile\-pad\fR \fB boolean\fR
888 Default: \fBtrue\fR\&. If true, every record, including the last one in the file, will have the same length\&. This matches the way \fBAMANDA\fR wrote tapes prior to the availability of this parameter\&. It may also be useful on devices that only support a fixed blocksize\&.
889
890 Note that the last record on the tape probably includes trailing null byte padding, which will be passed back to \fBgzip\fR, \fBcompress\fR or the restore program\&. Most programs just ignore this (although possibly with a warning)\&.
891
892 If this parameter is false, the last record in a file may be shorter than the block size\&. The file will contain the same amount of data the dump program generated, without trailing null byte padding\&. When read, the same amount of data that was written will be returned\&.
893
894 .TP
895 \fBspeed\fR \fB int\fR
896 Default: \fB200 bps\fR\&. How fast the drive will accept data, in bytes per second\&. This parameter is NOT currently used by \fBAMANDA\fR\&.
897
898 .TP
899 \fBlbl\-templ\fR \fB string\fR
900 A PostScript template file used by \fBamreport\fR to generate labels\&. Several sample files are provided with the \fBAMANDA\fR sources in the \fBexample\fR directory\&. See the \fBamreport\fR(8) man page for more information\&.
901
902 .PP
903 In addition to options, another \fBtapetype\fR name may be entered, which makes this \fBtapetype\fR inherit options from another \fBtapetype\fR\&. For instance, the only difference between a DLT4000 tape drive using Compact\-III tapes and one using Compact\-IV tapes is the length of the tape\&. So they could be entered as:
904 .nf
905
906 define tapetype DLT4000\-III {
907     comment "DLT4000 tape drives with Compact\-III tapes"
908     length 12500 mbytes         # 10 Gig tapes with some compression
909     filemark 2000 kbytes
910     speed 1536 kps
911 }
912 define tapetype DLT4000\-IV {
913     DLT4000\-III
914     comment "DLT4000 tape drives with Compact\-IV tapes"
915     length 25000 mbytes         # 20 Gig tapes with some compression
916 }
917 .fi
918
919 .SH "INTERFACE SECTION"
920
921 .PP
922 The \fBamanda\&.conf\fR file may define multiple types of network interfaces\&. The information is entered in an \fBinterface\fR section, which looks like this:
923 .nf
924
925 define interface \fBname\fR {
926     \fBinterface\-option\fR \fBinterface\-value\fR
927     \&.\&.\&.
928 }
929 .fi
930
931 .PP
932 \fBname\fR is the name of this type of network interface\&. It is referenced from the \fBdisklist\fR file\&.
933
934 .PP
935 Note that these sections define network interface characteristics, not the actual interface that will be used\&. Nor do they impose limits on the bandwidth that will actually be taken up by \fBAMANDA\fR\&. \fBAMANDA\fR computes the estimated bandwidth each file system backup will take based on the estimated size and time, then compares that plus any other running backups with the limit as another of the criteria when deciding whether to start the backup\&. Once a backup starts, \fBAMANDA\fR will use as much of the network as it can leaving throttling up to the operating system and network hardware\&.
936
937 .PP
938 The interface options and values are:
939
940 .TP
941 \fBcomment\fR \fB string\fR
942 Default: \fBnone\fR\&. A comment string describing this set of network information\&.
943
944 .TP
945 \fBuse\fR \fB int\fR
946 Default: \fB300 Kbps\fR\&. The speed of the interface in Kbytes per second\&.
947
948 .PP
949 In addition to options, another \fBinterface\fR name may be entered, which makes this \fBinterface\fR inherit options from another \fBinterface\fR\&. At the moment, this is of little use\&.
950
951 .SH "DISKLIST FILE"
952
953 .PP
954 The \fBdisklist\fR file determines which disks will be backed up by \fBAMANDA\fR\&. The file usually contains one line per disk:
955 .nf
956
957 \fBhostname diskname\fR [\fBdiskdevice\fR] \fBdumptype\fR [\fBspindle\fR [\fBinterface\fR] ]
958 .fi
959
960 .PP
961 All pairs [ \fBhostname diskname\fR ] must be unique\&.
962
963 .PP
964 Lines starting with # are ignored, as are blank lines\&. The fields have the following meanings:
965
966 .TP
967 \fBhostname\fR
968 The name of the host to be backed up\&. If \fBdiskdevice\fR refers to a PC share, this is the host \fBAMANDA\fR will run the Samba \fBsmbclient\fR program on to back up the share\&.
969
970 .TP
971 \fBdiskname\fR
972 The name of the disk (a label)\&. In most case, you set your \fBdiskname\fR to the \fBdiskdevice\fR and you don't set the \fBdiskdevice\&.\fR If you want multiple entries with the same \fBdiskdevice\fR, you must set a different \fBdiskname\fR for each entry\&. It's the \fBdiskname\fR that you use on the commandline for any \fBAMANDA\fR command\&. Look at the example/disklist file for example\&.
973
974 .TP
975 \fBdiskdevice\fR
976 Default: same as diskname\&. The name of the disk device to be backed up\&. It may be a full device name, a device name without the \fI/dev/\fR prefix, e\&.g\&. \fBsd0a\fR, or a mount point such as \fI/usr\fR\&.
977
978 It may also refer to a PC share by starting the name with two (forward) slashes, e\&.g\&. \fI//some\-pc/home\fR\&. In this case, the \fBprogram\fR option in the associated \fBdumptype\fR must be entered as \fBGNUTAR\fR\&. It is the combination of the double slash disk name and \fBprogram GNUTAR\fR in the \fBdumptype\fR that triggers the use of Samba\&.
979
980 .TP
981 \fBdumptype\fR
982 Refers to a \fBdumptype\fR defined in the \fBamanda\&.conf\fR file\&. \fBDumptype\fRs specify backup related parameters, such as whether to compress the backups, whether to record backup results in \fI/etc/dumpdates\fR, the disk's relative priority, etc\&.
983
984 .TP
985 \fBspindle\fR
986 Default: \fB\-1\fR\&. A number used to balance backup load on a host\&. \fBAMANDA\fR will not run multiple backups at the same time on the same spindle, unless the spindle number is \-1, which means there is no spindle restriction\&.
987
988 .TP
989 \fBinterface\fR
990 Default: \fBlocal\fR\&. The name of a network interface definition in the \fBamanda\&.conf\fR file, used to balance network load\&.
991
992 .PP
993 Instead of naming a \fBdumptype\fR, it is possible to define one in\-line, enclosing \fBdumptype\fR options within curly braces, one per line, just like a \fBdumptype\fR definition in \fBamanda\&.conf\fR\&. Since pre\-existing \fBdumptype\fRs are valid option names, this syntax may be used to customize \fBdumptype\fRs for particular disks\&.
994
995 .PP
996 A line break \fBmust\fR follow the left curly bracket\&.
997
998 .PP
999 For instance, if a \fBdumptype\fR named \fBnormal\fR is used for most disks, but use of the holding disk needs to be disabled for the file system that holds it, this would work instead of defining a new dumptype:
1000 .nf
1001
1002 \fBhostname diskname\fR [ \fBdiskdevice\fR ] {
1003   normal
1004   holdingdisk no
1005 } [ \fBspindle\fR [ \fBinterface\fR ] ]
1006 .fi
1007
1008 .SH "TAPE MANAGEMENT"
1009
1010 .PP
1011 The \fBtapelist\fR file contains the list of tapes in active use\&. This file is maintained entirely by \fBAMANDA\fR and should not be created or edited during normal operation\&. It contains lines of the form:
1012
1013 .PP
1014
1015 .nf
1016 YYYYMMDD label flags
1017 .fi
1018
1019
1020 .PP
1021 Where \fBYYYYMMDD\fR is the date the tape was written, \fBlabel\fR is a label for the tape as written by \fBamlabel\fR and \fBflags\fR tell \fBAMANDA\fR whether the tape may be reused, etc (see the \fBreuse\fR options of \fBamadmin\fR)\&.
1022
1023 .PP
1024 \fBAmdump\fR and \fBamflush\fR will refuse to write to an unlabeled tape, or to a labeled tape that is considered active\&. There must be more tapes in active rotation (see the \fBtapecycle\fR option) than there are runs in the backup cycle (see the \fBdumpcycle\fR option) to prevent overwriting a backup image that would be needed to do a full recovery\&.
1025
1026 .SH "OUTPUT DRIVERS"
1027
1028 .PP
1029 The normal value for the \fBtapedev\fR parameter, or for what a tape changer returns, is a full path name to a non\-rewinding tape device, such as \fI/dev/nst0\fR or \fI/dev/rmt/0mn\fR or \fI/dev/nst0\&.1\fR or whatever conventions the operating system uses\&. \fBAMANDA\fR provides additional application level drivers that support non\-traditional tape\-simulations or features\&. To access a specific output driver, set \fBtapedev\fR (or configure your changer to return) a string of the form \fBdriver\fR:\fBdriver\-info\fR where \fBdriver\fR is one of the supported drivers and \fBdriver\-info\fR is optional additional information needed by the driver\&.
1030
1031 .PP
1032 The supported drivers are:
1033
1034 .TP
1035 \fBtape\fR
1036 This is the default driver\&. The \fBdriver\-info\fR is the tape device name\&. Entering 
1037 .nf
1038 tapedev /dev/rmt/0mn
1039 .fi
1040  is really a short hand for 
1041 .nf
1042 tapedev tape:/dev/rmt/0mn
1043 .fi
1044 \&.
1045
1046 .TP
1047 \fBnull\fR
1048 This driver throws away anything written to it and returns EOF for any reads except a special case is made for reading a label, in which case a ``\fBfake\fR'' value is returned that \fBAMANDA\fR checks for and allows through regardless of what you have set in \fBlabelstr\fR\&. The \fBdriver\-info\fR field is not used and may be left blank:
1049
1050
1051 .nf
1052 tapedev null:
1053 .fi
1054
1055
1056 The \fBlength\fR value from the associated \fBtapetype\fR is used to limit the amount of data written\&. When the limit is reached, the driver will simulate end of tape\&.
1057
1058 .RS
1059 .Sh "Note"
1060 This driver should only be used for debugging and testing,
1061 and probably only with the
1062 \fBrecord\fR
1063 option set to
1064 \fBno\fR\&.
1065 .RE
1066
1067 .TP
1068 \fBrait\fR
1069 \fBR\fRedundant \fBA\fRrray of \fBI\fRnexpensive (?) \fBT\fRapes\&. Reads and writes tapes mounted on multiple drives by spreading the data across N\-1 drives and using the last drive for a checksum\&. See docs/RAIT for more information\&.
1070
1071 The \fBdriver\-info\fR field describes the devices to use\&. Curly braces indicate multiple replacements in the string\&. For instance:
1072
1073
1074 .nf
1075 tapedev rait:/dev/rmt/tps0d{4,5,6}n
1076 .fi
1077
1078
1079 would use the following devices:
1080
1081 \fI/dev/rmt/tps0d4n\fR  \fI/dev/rmt/tps0d5n\fR  \fI/dev/rmt/tps0d6n\fR 
1082
1083 .TP
1084 \fBfile\fR
1085 This driver emulates a tape device with a set of files in a directory\&. The \fBdriver\-info\fR field must be the name of an existing directory\&. The driver will test for a subdirectory of that named \fBdata\fR and return \fBoffline\fR until it is present\&. When present, the driver uses two files in the \fBdata\fR subdirectory for each tape file\&. One contains the actual data\&. The other contains record length information\&.
1086
1087 The driver uses a file named \fBstatus\fR in the \fBfile\fR device directory to hold driver status information, such as tape position\&. If not present, the driver will create it as though the device is rewound\&.
1088
1089 The \fBlength\fR value from the associated \fBtapetype\fR is used to limit the amount of data written\&. When the limit is reached, the driver will simulate end of tape\&.
1090
1091 One way to use this driver with a real device such as a CD\-writer is to create a directory for the \fBfile\fR device and one or more other directories for the actual data\&. Create a symlink named \fBdata\fR in the \fBfile\fR directory to one of the data directories\&. Set the \fBtapetype\fR length to whatever the medium will hold\&.
1092
1093 When \fBAMANDA\fR fills the \fBfile\fR device, remove the symlink and (optionally) create a new symlink to another data area\&. Use a CD writer software package to burn the image from the first data area\&.
1094
1095 To read the CD, mount it and create the \fBdata\fR symlink in the \fBfile\fR device directory\&.
1096
1097 .SH "AUTHORIZATION"
1098
1099 .PP
1100 \fBAMANDA\fR processes on the tape server host run as the \fBdumpuser\fR user listed in \fBamanda\&.conf\fR\&. When they connect to a backup client, they do so with an \fBAMANDA\fR\-specific protocol\&. They do not, for instance, use \fBrsh\fR or \fBssh\fR directly\&.
1101
1102 .PP
1103 On the client side, the \fBamandad\fR daemon validates the connection using one of several methods, depending on how it was compiled and on options it is passed:
1104
1105 .TP
1106 \&.rhosts
1107 Even though \fBAMANDA\fR does not use \fBrsh\fR, it can use \&.rhosts\-style authentication and a \&.rhosts file\&.
1108
1109 .TP
1110 \&.amandahosts
1111 This is essentially the same as \&.rhosts authentication except a different file, with almost the same format, is used\&. This is the default mechanism built into \fBAMANDA\fR\&.
1112
1113 The format of the \fI\&.amandahosts\fR file is:
1114
1115 \fBhostname\fR [ \fBusername\fR ]
1116
1117 If \fBusername\fR is ommitted, it defaults to the user running \fBamandad\fR, i\&.e\&. the user listed in the \fBinetd\fR or \fBxinetd\fR configuration file\&.
1118
1119 .TP
1120 Kerberos
1121 \fBAMANDA\fR may use the Kerberos authentication system\&. Further information is in the \fBdocs/KERBEROS\fR   file that comes with an \fBAMANDA\fR distribution\&.
1122
1123 For Samba access, \fBAMANDA\fR needs a file on the Samba server (which may or may not also be the tape server) named \fI/etc/amandapass\fR with share names, (clear text) passwords and (optional) domain names, in that order, one per line, whitespace separated\&. By default, the user used to connect to the PC is the same for all PC's and is compiled into \fBAMANDA\fR\&. It may be changed on a host by host basis by listing it first in the password field followed by a percent sign and then the password\&. For instance:
1124
1125 .nf
1126
1127   //some\-pc/home normalpw
1128   //another\-pc/disk otheruser%otherpw
1129   .fi
1130 With clear text passwords, this file should obviously be tightly protected\&. It only needs to be readable by the \fBAMANDA\fR\-user on the Samba server\&.
1131
1132 You can find further information in the \fBdocs/SAMBA\fR   file that comes with an \fBAMANDA\fR distribution\&.
1133
1134 .SH "HOST & DISK EXPRESSION"
1135
1136 .PP
1137 All host and disk arguments to programs are special expressions\&. The command applies to all disks that match your arguments\&. This section describes the matcher\&.
1138
1139 .PP
1140 The matcher matches by word, each word is a glob expression, words are separated by the separator '\&.' for host and '/' for disk\&. You can anchor the expression at left with a '^'\&. You can anchor the expression at right with a '$'\&. The matcher is case insensitive for host but is case sensitive for disk\&. A match succeeds if all words in your expression match contiguous words in the host or disk\&.
1141 .nf
1142
1143  \&.   word separator for a host
1144  /   word separator for a disk
1145  ^   anchor at left
1146  $   anchor at right
1147  ?   match exactly one character except the separator
1148  *   match zero or more characters except the separator
1149  **  match zero or more characters including the separator
1150 .fi
1151
1152 .PP
1153 Some examples:
1154 .nf
1155
1156   EXPRESSION      WILL MATCH              WILL NOT MATCH
1157   hosta           hosta                   hostb
1158                   hoSTA\&.dOMAIna\&.ORG
1159                   foo\&.hosta\&.org
1160   host            host                    hosta
1161   host?           hosta                   host
1162                   hostb
1163   ho*na           hoina                   ho\&.aina\&.org
1164   ho**na          hoina
1165                   ho\&.aina\&.org
1166   ^hosta          hosta                   foo\&.hosta\&.org
1167   sda*            /dev/sda1
1168                   /dev/sda12
1169   /opt/           opt (disk)              opt (host)
1170   \&.opt\&.           opt (host)              opt (disk)
1171   /               /                       any other disk
1172   /usr            /usr
1173                   /usr/opt
1174   /usr$           /usr                    /usr/opt 
1175 .fi
1176
1177 .SH "DATESTAMP EXPRESSION"
1178
1179 .PP
1180 A \fBdatestamp\fR expression is a range expression where we only match the prefix\&. Leading ^ is removed\&. Trailing $ forces an exact match\&.
1181 .nf
1182
1183   20001212\-14  match all dates beginning with 20001212, 20001213 or 20001214
1184   20001212\-4   same as previous
1185   20001212\-24  match all dates between 20001212 and 20001224
1186   2000121      match all dates that start with 2000121 (20001210\-20001219)
1187   2            match all dates that start with 2 (20000101\-29991231)
1188   2000\-10      match all dates between 20000101\-20101231
1189   200010$      match only 200010 
1190 .fi
1191
1192 .SH "AUTHOR"
1193
1194 .PP
1195 James da Silva, <jds@amanda\&.org> : Original text
1196
1197 .PP
1198 Stefan G\&. Weichinger, <sgw@amanda\&.org>, maintainer of the \fBAMANDA\fR\-documentation: XML\-conversion,major update
1199
1200 .SH "SEE ALSO"
1201
1202 .PP
1203 \fBamadmin\fR(8), \fBamcheck\fR(8), \fBamcheckdb\fR(8), \fBamcleanup\fR(8), \fBamdd\fR(8), \fBamdump\fR(8), \fBamflush\fR(8), \fBamgetconf\fR(8), \fBamlabel\fR(8), \fBammt\fR(8), \fBamoverview\fR(8), \fBamplot\fR(8), \fBamrecover\fR(8), \fBamreport\fR(8), \fBamrestore\fR(8), \fBamrmtape\fR(8), \fBamstatus\fR(8), \fBamtape\fR(8), \fBamtoc\fR(8), \fBamverify\fR(8), \fBamverifyrun\fR(8)
1204