4 \section*{Volume Utility Tools}
5 \label{_UtilityChapter}
6 \index[general]{Volume Utility Tools}
7 \index[general]{Tools!Volume Utility}
8 \addcontentsline{toc}{section}{Volume Utility Tools}
10 This document describes the utility programs written to aid Bacula users and
11 developers in dealing with Volumes external to Bacula.
13 \subsection*{Specifying the Configuration File}
14 \index[general]{Specifying the Configuration File}
15 \addcontentsline{toc}{subsection}{Specifying the Configuration File}
17 Starting with version 1.27, each of the following programs requires a valid
18 Storage daemon configuration file (actually, the only part of the
19 configuration file that these programs need is the {\bf Device} resource
20 definitions). This permits the programs to find the configuration parameters
21 for your archive device (generally a tape drive). By default, they read {\bf
22 bacula-sd.conf} in the current directory, but you may specify a different
23 configuration file using the {\bf -c} option.
26 \subsection*{Specifying a Device Name For a Tape}
27 \index[general]{Tape!Specifying a Device Name For a}
28 \index[general]{Specifying a Device Name For a Tape}
29 \addcontentsline{toc}{subsection}{Specifying a Device Name For a Tape}
31 Each of these programs require a {\bf device-name} where the Volume can be
32 found. In the case of a tape, this is the physical device name such as {\bf
33 /dev/nst0} or {\bf /dev/rmt/0ubn} depending on your system. For the program to
34 work, it must find the identical name in the Device resource of the
35 configuration file. See below for specifying Volume names.
37 Please note that if you have Bacula running and you ant to use
38 one of these programs, you will either need to stop the Storage daemon, or
39 {\bf unmount} any tape drive you want to use, otherwise the drive
40 will {\bf busy} because Bacula is using it.
43 \subsection*{Specifying a Device Name For a File}
44 \index[general]{File!Specifying a Device Name For a}
45 \index[general]{Specifying a Device Name For a File}
46 \addcontentsline{toc}{subsection}{Specifying a Device Name For a File}
48 If you are attempting to read or write an archive file rather than a tape, the
49 {\bf device-name} should be the full path to the archive location including
50 the filename. The filename (last part of the specification) will be stripped
51 and used as the Volume name, and the path (first part before the filename)
52 must have the same entry in the configuration file. So, the path is equivalent
53 to the archive device name, and the filename is equivalent to the volume name.
56 \subsection*{Specifying Volumes}
57 \index[general]{Volumes!Specifying}
58 \index[general]{Specifying Volumes}
59 \addcontentsline{toc}{subsection}{Specifying Volumes}
61 In general, you must specify the Volume name to each of the programs below
62 (with the exception of {\bf btape}). The best method to do so is to specify a
63 {\bf bootstrap} file on the command line with the {\bf -b} option. As part of
64 the bootstrap file, you will then specify the Volume name or Volume names if
65 more than one volume is needed. For example, suppose you want to read tapes
66 {\bf tape1} and {\bf tape2}. First construct a {\bf bootstrap} file named say,
67 {\bf list.bsr} which contains:
75 where each Volume is separated by a vertical bar. Then simply use:
79 ./bls -b list.bsr /dev/nst0
83 In the case of Bacula Volumes that are on files, you may simply append volumes
88 ./bls /tmp/test1\|test2
92 where the backslash (\textbackslash{}) was necessary as a shell escape to
93 permit entering the vertical bar (|).
95 And finally, if you feel that specifying a Volume name is a bit complicated
96 with a bootstrap file, you can use the {\bf -V} option (on all programs except
97 {\bf bcopy}) to specify one or more Volume names separated by the vertical bar
102 ./bls -V Vol001 /dev/nst0
106 You may also specify an asterisk (*) to indicate that the program should
107 accept any volume. For example:
118 \index[general]{program!bls}
119 \addcontentsline{toc}{subsection}{bls}
121 {\bf bls} can be used to do an {\bf ls} type listing of a {\bf Bacula} tape or
126 Usage: bls [options] <device-name>
127 -b <file> specify a bootstrap file
128 -c <file> specify a config file
129 -d <level> specify debug level
130 -e <file> exclude list
131 -i <file> include list
134 (no j or k option) list saved files
136 -p proceed inspite of errors
138 -V specify Volume names (separated by |)
139 -? print this message
143 For example, to list the contents of a tape:
147 ./bls -V Volume-name /dev/nst0
151 Or to list the contents of a file:
155 ./bls /tmp/Volume-name
157 ./bls -V Volume-name /tmp
161 Note that, in the case of a file, the Volume name becomes the filename, so in
162 the above example, you will replace the {\bf xxx} with the name of the volume
165 Normally if no options are specified, {\bf bls} will produce the equivalent
166 output to the {\bf ls -l} command for each file on the tape. Using other
167 options listed above, it is possible to display only the Job records, only the
168 tape blocks, etc. For example:
174 bls: butil.c:148 Using device: /tmp
175 drwxrwxr-x 3 k k 4096 02-10-19 21:08 /home/kern/bacula/k/src/dird/
176 drwxrwxr-x 2 k k 4096 02-10-10 18:59 /home/kern/bacula/k/src/dird/CVS/
177 -rw-rw-r-- 1 k k 54 02-07-06 18:02 /home/kern/bacula/k/src/dird/CVS/Root
178 -rw-rw-r-- 1 k k 16 02-07-06 18:02 /home/kern/bacula/k/src/dird/CVS/Repository
179 -rw-rw-r-- 1 k k 1783 02-10-10 18:59 /home/kern/bacula/k/src/dird/CVS/Entries
180 -rw-rw-r-- 1 k k 97506 02-10-18 21:07 /home/kern/bacula/k/src/dird/Makefile
181 -rw-r--r-- 1 k k 3513 02-10-18 21:02 /home/kern/bacula/k/src/dird/Makefile.in
182 -rw-rw-r-- 1 k k 4669 02-07-06 18:02 /home/kern/bacula/k/src/dird/README-config
183 -rw-r--r-- 1 k k 4391 02-09-14 16:51 /home/kern/bacula/k/src/dird/authenticate.c
184 -rw-r--r-- 1 k k 3609 02-07-07 16:41 /home/kern/bacula/k/src/dird/autoprune.c
185 -rw-rw-r-- 1 k k 4418 02-10-18 21:03 /home/kern/bacula/k/src/dird/bacula-dir.conf
187 -rw-rw-r-- 1 k k 83 02-08-31 19:19 /home/kern/bacula/k/src/dird/.cvsignore
188 bls: Got EOF on device /tmp
193 \subsubsection*{Listing Jobs}
194 \index[general]{Listing Jobs with bls}
195 \index[general]{bls!Listing Jobs}
196 \addcontentsline{toc}{subsubsection}{bls Listing Jobs}
198 If you are listing a Volume to determine what Jobs to restore, normally the
199 {\bf -j} option provides you with most of what you will need as long as you
200 don't have multiple clients. For example,
204 ./bls -j -V Test1 -c stored.conf DDS-4
205 bls: butil.c:258 Using device: "DDS-4" for reading.
206 11-Jul 11:54 bls: Ready to read from volume "Test1" on device "DDS-4" (/dev/nst0).
207 Volume Record: File:blk=0:1 SessId=4 SessTime=1121074625 JobId=0 DataLen=165
208 Begin Job Session Record: File:blk=0:2 SessId=4 SessTime=1121074625 JobId=1 Level=F Type=B
209 Begin Job Session Record: File:blk=0:3 SessId=5 SessTime=1121074625 JobId=5 Level=F Type=B
210 Begin Job Session Record: File:blk=0:6 SessId=3 SessTime=1121074625 JobId=2 Level=F Type=B
211 Begin Job Session Record: File:blk=0:13 SessId=2 SessTime=1121074625 JobId=4 Level=F Type=B
212 End Job Session Record: File:blk=0:99 SessId=3 SessTime=1121074625 JobId=2 Level=F Type=B
213 Files=168 Bytes=1,732,978 Errors=0 Status=T
214 End Job Session Record: File:blk=0:101 SessId=2 SessTime=1121074625 JobId=4 Level=F Type=B
215 Files=168 Bytes=1,732,978 Errors=0 Status=T
216 End Job Session Record: File:blk=0:108 SessId=5 SessTime=1121074625 JobId=5 Level=F Type=B
217 Files=168 Bytes=1,732,978 Errors=0 Status=T
218 End Job Session Record: File:blk=0:109 SessId=4 SessTime=1121074625 JobId=1 Level=F Type=B
219 Files=168 Bytes=1,732,978 Errors=0 Status=T
220 11-Jul 11:54 bls: End of Volume at file 1 on device "DDS-4" (/dev/nst0), Volume "Test1"
221 11-Jul 11:54 bls: End of all volumes.
225 shows a full save followed by two incremental saves.
227 Adding the {\bf -v} option will display virtually all information that is
228 available for each record:
230 \subsubsection*{Listing Blocks}
231 \index[general]{Listing Blocks with bls}
232 \index[general]{bls!Listing Blocks}
233 \addcontentsline{toc}{subsubsection}{bls Listing Blocks}
235 Normally, except for debugging purposes, you will not need to list Bacula
236 blocks (the "primitive" unit of Bacula data on the Volume). However, you can
241 ./bls -k /tmp/File002
242 bls: butil.c:148 Using device: /tmp
248 bls: Got EOF on device /tmp
249 End of File on device
253 By adding the {\bf -v} option, you can get more information, which can be
254 useful in knowing what sessions were written to the volume:
258 ./bls -k -v /tmp/File002
260 Id : Bacula 0.9 mortal
265 LabelType : VOL_LABEL
271 Date label written: 2002-10-19 at 21:16
272 Block: 1 blen=64512 First rec FI=VOL_LABEL SessId=1 SessTim=1035062102 Strm=0 rlen=147
273 Block: 2 blen=64512 First rec FI=6 SessId=1 SessTim=1035062102 Strm=DATA rlen=4087
274 Block: 3 blen=64512 First rec FI=12 SessId=1 SessTim=1035062102 Strm=DATA rlen=5902
275 Block: 4 blen=64512 First rec FI=19 SessId=1 SessTim=1035062102 Strm=DATA rlen=28382
277 Block: 65 blen=64512 First rec FI=83 SessId=1 SessTim=1035062102 Strm=DATA rlen=1873
278 Block: 66 blen=19195 First rec FI=83 SessId=1 SessTim=1035062102 Strm=DATA rlen=2973
279 bls: Got EOF on device /tmp
280 End of File on device
284 Armed with the SessionId and the SessionTime, you can extract just about
287 If you want to know even more, add a second {\bf -v} to the command line to
288 get a dump of every record in every block.
292 ./bls -k -v -v /tmp/File002
293 bls: block.c:79 Dump block 80f8ad0: size=64512 BlkNum=1
294 Hdrcksum=b1bdfd6d cksum=b1bdfd6d
295 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=VOL_LABEL Strm=0 len=147 p=80f8b40
296 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=SOS_LABEL Strm=-7 len=122 p=80f8be7
297 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=1 Strm=UATTR len=86 p=80f8c75
298 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=2 Strm=UATTR len=90 p=80f8cdf
299 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=3 Strm=UATTR len=92 p=80f8d4d
300 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=3 Strm=DATA len=54 p=80f8dbd
301 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=3 Strm=MD5 len=16 p=80f8e07
302 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=4 Strm=UATTR len=98 p=80f8e2b
303 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=4 Strm=DATA len=16 p=80f8ea1
304 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=4 Strm=MD5 len=16 p=80f8ec5
305 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=5 Strm=UATTR len=96 p=80f8ee9
306 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=5 Strm=DATA len=1783 p=80f8f5d
307 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=5 Strm=MD5 len=16 p=80f9668
308 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=UATTR len=95 p=80f968c
309 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=DATA len=32768 p=80f96ff
310 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=DATA len=32768 p=8101713
311 bls: block.c:79 Dump block 80f8ad0: size=64512 BlkNum=2
312 Hdrcksum=9acc1e7f cksum=9acc1e7f
313 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=contDATA len=4087 p=80f8b40
314 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=DATA len=31970 p=80f9b4b
315 bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=MD5 len=16 p=8101841
320 \subsection*{bextract}
322 \index[general]{Bextract}
323 \index[general]{program!bextract}
324 \addcontentsline{toc}{subsection}{bextract}
326 Normally, you will restore files by running a {\bf Restore} Job from the {\bf
327 Console} program. However, {\bf bextract} can be used to extract a single file
328 or a list of files from a Bacula tape or file. In fact, {\bf bextract} can be
329 a useful tool to restore files to an empty system assuming you are able to
330 boot, you have statically linked {\bf bextract} and you have an appropriate
331 {\bf bootstrap} file.
338 Usage: bextract [-d debug_level] <device-name> <directory-to-store-files>
339 -b <file> specify a bootstrap file
340 -dnn set debug level to nn
341 -e <file> exclude list
342 -i <file> include list
343 -p proceed inspite of I/O errors
344 -V specify Volume names (separated by |)
345 -? print this message
349 where {\bf device-name} is the Archive Device (raw device name or full
350 filename) of the device to be read, and {\bf directory-to-store-files} is a
351 path prefix to prepend to all the files restored.
353 NOTE: On Windows systems, if you specify a prefix of say d:/tmp, any file that
354 would have been restored to {\bf c:/My Documents} will be restored to {\bf
355 d:/tmp/My Documents}. That is, the original drive specification will be
356 stripped. If no prefix is specified, the file will be restored to the original
359 \subsubsection*{Extracting with Include or Exclude Lists}
360 \index[general]{Lists!Extracting with Include or Exclude}
361 \index[general]{Extracting with Include or Exclude Lists}
362 \addcontentsline{toc}{subsubsection}{Extracting with Include or Exclude Lists}
364 Using the {\bf -e} option, you can specify a file containing a list of files
365 to be excluded. Wildcards can be used in the exclusion list. This option will
366 normally be used in conjunction with the {\bf -i} option (see below). Both the
367 {\bf -e} and the {\bf -i} options may be specified at the same time as the
368 {\bf -b} option. The bootstrap filters will be applied first, then the include
369 list, then the exclude list.
371 Likewise, and probably more importantly, with the {\bf -i} option, you can
372 specify a file that contains a list (one file per line) of files and
373 directories to include to be restored. The list must contain the full filename
374 with the path. If you specify a path name only, all files and subdirectories
375 of that path will be restored. If you specify a line containing only the
376 filename (e.g. {\bf my-file.txt}) it probably will not be extracted because
377 you have not specified the full path.
379 For example, if the file {\bf include-list} contains:
392 ./bextract -i include-list -V Volume /dev/nst0 /tmp
396 will restore from the Bacula archive {\bf /dev/nst0} all files and directories
397 in the backup from {\bf /home/kern/bacula} and from {\bf /usr/local/bin}. The
398 restored files will be placed in a file of the original name under the
399 directory {\bf /tmp} (i.e. /tmp/home/kern/bacula/... and
400 /tmp/usr/local/bin/...).
402 \subsubsection*{Extracting With a Bootstrap File}
403 \index[general]{File!Extracting With a Bootstrap}
404 \index[general]{Extracting With a Bootstrap File}
405 \addcontentsline{toc}{subsubsection}{Extracting With a Bootstrap File}
407 The {\bf -b} option is used to specify a {\bf bootstrap} file containing the
408 information needed to restore precisely the files you want. Specifying a {\bf
409 bootstrap} file is optional but recommended because it gives you the most
410 control over which files will be restored. For more details on the {\bf
411 bootstrap} file, please see
412 \ilink{Restoring Files with the Bootstrap File}{_ChapterStart43}
413 chapter of this document. Note, you may also use a bootstrap file produced by
414 the {\bf restore} command. For example:
418 ./bextract -b bootstrap-file /dev/nst0 /tmp
422 The bootstrap file allows detailed specification of what files you want
423 restored (extracted). You may specify a bootstrap file and include and/or
424 exclude files at the same time. The bootstrap conditions will first be
425 applied, and then each file record seen will be compared to the include and
428 \subsubsection*{Extracting From Multiple Volumes}
429 \index[general]{Volumes!Extracting From Multiple}
430 \index[general]{Extracting From Multiple Volumes}
431 \addcontentsline{toc}{subsubsection}{Extracting From Multiple Volumes}
433 If you wish to extract files that span several Volumes, you can specify the
434 Volume names in the bootstrap file or you may specify the Volume names on the
435 command line by separating them with a vertical bar. See the section above
436 under the {\bf bls} program entitled {\bf Listing Multiple Volumes} for more
437 information. The same techniques apply equally well to the {\bf bextract}
442 \index[general]{bscan}
443 \index[general]{program!bscan}
444 \addcontentsline{toc}{subsection}{bscan}
446 The {\bf bscan} program can be used to re-create a database (catalog) from the
447 backup information written to one or more Volumes. This is normally needed
448 only if one or more Volumes have been pruned or purged from your catalog so
449 that the records on the Volume are no longer in the catalog.
451 With some care, it can also be used to synchronize your existing catalog with
452 a Volume. Although we have never seen a case of bscan damaging a
453 catalog, since bscan modifies your catalog, we recommend that
454 you do a simple ASCII backup of your database before running {\bf bscan} just
456 \ilink{Compacting Your Database}{CompactingMySQL}.
458 {\bf bscan} can also be useful in a disaster recovery situation, after the
459 loss of a hard disk, if you do not have a valid {\bf bootstrap} file for
460 reloading your system, or if a Volume has been recycled but not overwritten,
461 you can use {\bf bscan} to re-create your database, which can then be used to
462 {\bf restore} your system or a file to its previous state.
469 Usage: bscan [options] <bacula-archive>
470 -b bootstrap specify a bootstrap file
471 -c <file> specify configuration file
472 -d <nn> set debug level to nn
473 -m update media info in database
474 -n <name> specify the database name (default bacula)
475 -u <user> specify database user name (default bacula)
476 -P <password> specify database password (default none)
477 -h <host> specify database host (default NULL)
478 -p proceed inspite of I/O errors
480 -s synchronize or store in database
482 -V <Volumes> specify Volume names (separated by |)
483 -w <dir> specify working directory (default from conf file)
484 -? print this message
488 If you are using MySQL or PostgreSQL, there is no need to supply a working
489 directory since in that case, bscan knows where the databases are. However, if
490 you have provided security on your database, you may need to supply either the
491 database name ({\bf -b} option), the user name ({\bf -u} option), and/or the
492 password ({\bf -p}) options.
494 As an example, let's suppose that you did a backup to Volumes "Vol001"
495 and "Vol002", then sometime later all records of one or both those
497 were pruned or purged from the
498 database. By using {\bf bscan} you can recreate the catalog entries for
499 those Volumes and then use the {\bf restore} command in the Console to restore
500 whatever you want. A command something like:
504 bscan -c bacula-sd.conf -v -V Vol001\|Vol002 /dev/nst0
508 will give you an idea of what is going to happen without changing
509 your catalog. Of course, you may need to change the path to the Storage
510 daemon's conf file, the Volume name, and your tape (or disk) device name. This
511 command must read the entire tape, so if it has a lot of data, it may take a
512 long time, and thus you might want to immediately use the command listed
513 below. Note, if you are writing to a disk file, replace the device name with
514 the path to the directory that contains the Volumes. This must correspond to
515 the Archive Device in the conf file.
517 Then to actually write or store the records in the catalog, add the {\bf -s}
522 bscan -s -m -c bacula-sd.conf -v -V Vol001\|Vol002 /dev/nst0
526 When writing to the database, if bscan finds existing records, it will
527 generally either update them if something is wrong or leave them alone. Thus
528 if the Volumes you are scanning are all or partially in the catalog already, no
529 harm will be done to that existing data. Any missing data will simply be
532 If you have multiple tapes, you should scan them with:
536 bscan -s -m -c bacula-sd.conf -v -V Vol001\|Vol002\|Vol003 /dev/nst0
540 You should, always try to specify the tapes in the order they are written.
541 However, bscan can handle scanning tapes that are not sequential. Any
542 incomplete records at the end of the tape will simply be ignored in that
543 case. If you are simply reparing an existing catalog, this may be OK, but
544 if you are creating a new catalog from scratch, it will leave your database
545 in an incorrect state. If you do not specify all necessary Volumes on a
546 single bscan command, bscan will not be able to correctly restore the
547 records that span two volumes. In other words, it is much better to
548 specify two or three volumes on a single bscan command rather than run
549 bscan two or three times, each with a single volume.
552 Note, the restoration process using bscan is not identical to the original
553 creation of the catalog data. This is because certain non-essential data such
554 as volume reads, volume mounts, etc is not stored on the Volume, and thus is
555 not restored by bscan. The results of bscanning are, however, perfectly valid,
556 and will permit restoration of any or all the files in the catalog using the
557 normal Bacula console commands.
559 \subsubsection*{Using bscan to Compare a Volume to an existing Catalog}
560 \index[general]{Catalog!Using bscan to Compare a Volume to an existing}
561 \index[general]{Using bscan to Compare a Volume to an existing Catalog}
562 \addcontentsline{toc}{subsubsection}{Using bscan to Compare a Volume to an
565 If you wish to compare the contents of a Volume to an existing catalog without
566 changing the catalog, you can safely do so if and only if you do {\bf not}
567 specify either the {\bf -m} or the {\bf -s} options. However, at this time
568 (Bacula version 1.26), the comparison routines are not as good or as thorough
569 as they should be, so we don't particularly recommend this mode other than for
572 \subsubsection*{Using bscan to Recreate a Catalog from a Volume}
573 \index[general]{Volume!Using bscan to Recreate a Catalog from a}
574 \index[general]{Using bscan to Recreate a Catalog from a Volume}
575 \addcontentsline{toc}{subsubsection}{Using bscan to Recreate a Catalog from a
578 This is the mode for which {\bf bscan} is most useful. You can either {\bf
579 bscan} into a freshly created catalog, or directly into your existing catalog
580 (after having made an ASCII copy as described above). Normally, you should
581 start with a freshly created catalog that contains no data.
583 Starting with a single Volume named {\bf TestVolume1}, you run a command such
588 ./bscan -V TestVolume1 -v -s -m -c bacula-sd.conf /dev/nst0
592 If there is more than one volume, simply append it to the first one separating
593 it with a vertical bar. You may need to precede the vertical bar with a
594 forward slash escape the shell -- e.g. {\bf
595 TestVolume1\textbackslash{}|TestVolume2}. The {\bf -v} option was added for
596 verbose output (this can be omitted if desired). The {\bf -s} option that
597 tells {\bf bscan} to store information in the database. The physical device
598 name {\bf /dev/nst0} is specified after all the options.
600 {\bf} For example, after having done a full backup of a directory, then two
601 incrementals, I reinitialized the SQLite database as described above, and
602 using the bootstrap.bsr file noted above, I entered the following command:
606 ./bscan -b bootstrap.bsr -v -s -c bacula-sd.conf /dev/nst0
610 which produced the following output:
614 bscan: bscan.c:182 Using Database: bacula, User: bacula
615 bscan: bscan.c:673 Created Pool record for Pool: Default
616 bscan: bscan.c:271 Pool type "Backup" is OK.
617 bscan: bscan.c:632 Created Media record for Volume: TestVolume1
618 bscan: bscan.c:298 Media type "DDS-4" is OK.
619 bscan: bscan.c:307 VOL_LABEL: OK for Volume: TestVolume1
620 bscan: bscan.c:693 Created Client record for Client: Rufus
621 bscan: bscan.c:769 Created new JobId=1 record for original JobId=2
622 bscan: bscan.c:717 Created FileSet record "Kerns Files"
623 bscan: bscan.c:819 Updated Job termination record for new JobId=1
624 bscan: bscan.c:905 Created JobMedia record JobId 1, MediaId 1
625 bscan: Got EOF on device /dev/nst0
626 bscan: bscan.c:693 Created Client record for Client: Rufus
627 bscan: bscan.c:769 Created new JobId=2 record for original JobId=3
628 bscan: bscan.c:708 Fileset "Kerns Files" already exists.
629 bscan: bscan.c:819 Updated Job termination record for new JobId=2
630 bscan: bscan.c:905 Created JobMedia record JobId 2, MediaId 1
631 bscan: Got EOF on device /dev/nst0
632 bscan: bscan.c:693 Created Client record for Client: Rufus
633 bscan: bscan.c:769 Created new JobId=3 record for original JobId=4
634 bscan: bscan.c:708 Fileset "Kerns Files" already exists.
635 bscan: bscan.c:819 Updated Job termination record for new JobId=3
636 bscan: bscan.c:905 Created JobMedia record JobId 3, MediaId 1
637 bscan: Got EOF on device /dev/nst0
638 bscan: bscan.c:652 Updated Media record at end of Volume: TestVolume1
639 bscan: bscan.c:428 End of Volume. VolFiles=3 VolBlocks=57 VolBytes=10,027,437
643 The key points to note are that {\bf bscan} prints a line when each major
644 record is created. Due to the volume of output, it does not print a line for
645 each file record unless you supply the {\bf -v} option twice or more on the
648 In the case of a Job record, the new JobId will not normally be the same as
649 the original Jobid. For example, for the first JobId above, the new JobId is
650 1, but the original JobId is 2. This is nothing to be concerned about as it is
651 the normal nature of databases. {\bf bscan} will keep everything straight.
653 Although {\bf bscan} claims that it created a Client record for Client: Rufus
654 three times, it was actually only created the first time. This is normal.
656 You will also notice that it read an end of file after each Job (Got EOF on
657 device ...). Finally the last line gives the total statistics for the bscan.
659 If you had added a second {\bf -v} option to the command line, Bacula would
660 have been even more verbose, dumping virtually all the details of each Job
661 record it encountered.
663 Now if you start Bacula and enter a {\bf list jobs} command to the console
664 program, you will get:
668 +-------+----------+------------------+------+-----+----------+----------+---------+
669 | JobId | Name | StartTime | Type | Lvl | JobFiles | JobBytes | JobStat |
670 +-------+----------+------------------+------+-----+----------+----------+---------+
671 | 1 | kernsave | 2002-10-07 14:59 | B | F | 84 | 4180207 | T |
672 | 2 | kernsave | 2002-10-07 15:00 | B | I | 15 | 2170314 | T |
673 | 3 | kernsave | 2002-10-07 15:01 | B | I | 33 | 3662184 | T |
674 +-------+----------+------------------+------+-----+----------+----------+---------+
678 which corresponds virtually identically with what the database contained
679 before it was re-initialized and restored with bscan. All the Jobs and Files
680 found on the tape are restored including most of the Media record. The Volume
681 (Media) records restored will be marked as {\bf Full} so that they cannot be
682 rewritten without operator intervention.
684 It should be noted that {\bf bscan} cannot restore a database to the exact
685 condition it was in previously because a lot of the less important information
686 contained in the database is not saved to the tape. Nevertheless, the
687 reconstruction is sufficiently complete, that you can run {\bf restore}
688 against it and get valid results.
690 \subsubsection*{Using bscan to Correct the Volume File Count}
691 \index[general]{Using bscan to Correct the Volume File Count}
692 \index[general]{Count!Using bscan to Correct the Volume File}
693 \addcontentsline{toc}{subsubsection}{Using bscan to Correct the Volume File
696 If the Storage daemon crashes during a backup Job, the catalog will not be
697 properly updated for the Volume being used at the time of the crash. This
698 means that the Storage daemon will have written say 20 files on the tape, but
699 the catalog record for the Volume indicates only 19 files.
701 Bacula refuses to write on a tape that contains a different number of files
702 from what is in the catalog. To correct this situation, you may run a {\bf
703 bscan} with the {\bf -m} option (but {\bf without} the {\bf -s} option) to
704 update only the final Media record for the Volumes read.
706 \subsubsection*{After bscan}
707 \index[general]{After bscan}
708 \index[general]{Bscan!After}
709 \addcontentsline{toc}{subsubsection}{After bscan}
711 If you use {\bf bscan} to enter the contents of the Volume into an existing
712 catalog, you should be aware that the records you entered may be immediately
713 pruned during the next job, particularly if the Volume is very old or had been
714 previously purged. To avoid this, after running {\bf bscan}, you can manually
715 set the volume status (VolStatus) to {\bf Read-Only} by using the {\bf update}
716 command in the catalog. This will allow you to restore from the volume without
717 having it immediately purged. When you have restored and backed up the data,
718 you can reset the VolStatus to {\bf Used} and the Volume will be purged from
723 \index[general]{Bcopy}
724 \index[general]{program!bcopy}
725 \addcontentsline{toc}{subsection}{bcopy}
727 The {\bf bcopy} program can be used to copy one {\bf Bacula} archive file to
728 another. For example, you may copy a tape to a file, a file to a tape, a file
729 to a file, or a tape to a tape. For tape to tape, you will need two tape
730 drives. (a later version is planned that will buffer it to disk). In the
731 process of making the copy, no record of the information written to the new
732 Volume is stored in the catalog. This means that the new Volume, though it
733 contains valid backup data, cannot be accessed directly from existing catalog
734 entries. If you wish to be able to use the Volume with the Console restore
735 command, for example, you must first bscan the new Volume into the catalog.
737 \subsubsection*{bcopy Command Options}
738 \index[general]{Options!bcopy Command}
739 \index[general]{Bcopy Command Options}
740 \addcontentsline{toc}{subsubsection}{bcopy Command Options}
744 Usage: bcopy [-d debug_level] <input-archive> <output-archive>
745 -b bootstrap specify a bootstrap file
746 -c <file> specify configuration file
747 -dnn set debug level to nn
748 -i specify input Volume names (separated by |)
749 -o specify output Volume names (separated by |)
750 -p proceed inspite of I/O errors
752 -w dir specify working directory (default /tmp)
753 -? print this message
757 By using a {\bf bootstrap} file, you can copy parts of a Bacula archive file
760 One of the objectives of this program is to be able to recover as much data as
761 possible from a damaged tape. However, the current version does not yet have
764 As this is a new program, any feedback on its use would be appreciated. In
765 addition, I only have a single tape drive, so I have never been able to test
766 this program with two tape drives.
770 \index[general]{Btape}
771 \index[general]{program!btape}
772 \addcontentsline{toc}{subsection}{btape}
774 This program permits a number of elementary tape operations via a tty command
775 interface. The {\bf test} command, described below, can be very useful for
776 testing older tape drive compatibility problems. Aside from initial testing of
777 tape drive compatibility with {\bf Bacula}, {\bf btape} will be mostly used by
778 developers writing new tape drivers.
780 {\bf btape} can be dangerous to use with existing {\bf Bacula} tapes because
781 it will relabel a tape or write on the tape if so requested regardless that
782 the tape may contain valuable data, so please be careful and use it only on
785 To work properly, {\bf btape} needs to read the Storage daemon's configuration
786 file. As a default, it will look for {\bf bacula-sd.conf} in the current
787 directory. If your configuration file is elsewhere, please use the {\bf -c}
788 option to specify where.
790 The physical device name must be specified on the command line, and this
791 same device name must be present in the Storage daemon's configuration file
796 Usage: btape <options> <device_name>
797 -b <file> specify bootstrap file
798 -c <file> set configuration file to file
799 -d <nn> set debug level to nn
800 -p proceed inspite of I/O errors
803 -? print this message.
807 \subsubsection*{Using btape to Verify your Tape Drive}
808 \index[general]{Using btape to Verify your Tape Drive}
809 \index[general]{Drive!Using btape to Verify your Tape}
810 \addcontentsline{toc}{subsubsection}{Using btape to Verify your Tape Drive}
812 An important reason for this program is to ensure that a Storage daemon
813 configuration file is defined so that Bacula will correctly read and write
816 It is highly recommended that you run the {\bf test} command before running
817 your first Bacula job to ensure that the parameters you have defined for your
818 storage device (tape drive) will permit {\bf Bacula} to function properly. You
819 only need to mount a blank tape, enter the command, and the output should be
820 reasonably self explanatory. Please see the
821 \ilink{Tape Testing}{_ChapterStart27} Chapter of this manual for
824 \subsubsection*{btape Commands}
825 \index[general]{Btape Commands}
826 \index[general]{Commands!btape}
827 \addcontentsline{toc}{subsubsection}{btape Commands}
829 The full list of commands are:
835 autochanger test autochanger
838 bfill fill tape using Bacula writes
839 cap list device capabilities
840 clear clear tape errors
841 eod go to end of Bacula data for append
842 eom go to the physical end of medium
843 fill fill tape, write onto second volume
844 unfill read filled tape
845 fsf forward space a file
846 fsr forward space a record
847 help print this command
848 label write a Bacula label to the tape
851 rawfill use write() to fill tape
852 readlabel read and print the Bacula tape label
853 rectest test record handling functions
854 rewind rewind the tape
855 scan read() tape block by block to EOT and report
856 scanblocks Bacula read block by block to EOT and report
857 status print tape status
858 test General test Bacula tape functions
859 weof write an EOF on the tape
860 wr write a single Bacula block
861 rr read a single record
862 qfill quick fill command
866 The most useful commands are:
869 \item test -- test writing records and EOF marks and reading them back.
870 \item fill -- completely fill a volume with records, then write a few records
871 on a second volume, and finally, both volumes will be read back.
872 This command writes blocks containing random data, so your drive will
873 not be able to compress the data, and thus it is a good test of
874 the real physical capacity of your tapes.
875 \item readlabel -- read and dump the label on a Bacula tape.
876 \item cap -- list the device capabilities as defined in the configuration
877 file and as perceived by the Storage daemon.
880 The {\bf readlabel} command can be used to display the details of a Bacula
881 tape label. This can be useful if the physical tape label was lost or damaged.
884 In the event that you want to relabel a {\bf Bacula}, you can simply use the
885 {\bf label} command which will write over any existing label. However, please
886 note for labeling tapes, we recommend that you use the {\bf label} command in
887 the {\bf Console} program since it will never overwrite a valid Bacula tape.
889 \subsection*{Other Programs}
890 \index[general]{Programs!Other}
891 \index[general]{Other Programs}
892 \addcontentsline{toc}{subsection}{Other Programs}
894 The following programs are general utility programs and in general do not need
895 a configuration file nor a device name.
899 \index[general]{Bsmtp}
900 \index[general]{program!bsmtp}
901 \addcontentsline{toc}{subsection}{bsmtp}
903 {\bf bsmtp} is a simple mail transport program that permits more flexibility
904 than the standard mail programs typically found on Unix systems. It can even
905 be used on Windows machines.
911 Usage: bsmtp [-f from] [-h mailhost] [-s subject] [-c copy] [recipient ...]
913 -dnn set debug level to nn
914 -f set the From: field
915 -h use mailhost:port as the bsmtp server
916 -s set the Subject: field
917 -? print this message.
921 If the {\bf -f} option is not specified, {\bf bsmtp} will use your userid. If
922 the option is not specified {\bf bsmtp} will use the value in the environment
923 variable {\bf bsmtpSERVER} or if there is none {\bf localhost}. By default
926 {\bf recipients} is a space separated list of email recipients.
928 The body of the email message is read from standard input.
930 An example of the use of {\bf bsmtp} would be to put the following statement
931 in the {\bf Messages} resource of your {\bf bacula-dir.conf} file. Note, these
932 commands should appear on a single line each.
936 mailcommand = "/home/bacula/bin/bsmtp -h mail.domain.com -f \"\(Bacula\) %r\"
937 -s \"Bacula: %t %e of %c %l\" %r"
938 operatorcommand = "/home/bacula/bin/bsmtp -h mail.domain.com -f \"\(Bacula\) %r\"
939 -s \"Bacula: Intervention needed for %j\" %r"
943 Where you replace {\bf /home/bacula/bin} with the path to your {\bf Bacula}
944 binary directory, and you replace {\bf mail.domain.com} with the fully
945 qualified name of your bsmtp (email) server, which normally listens on port
946 25. For more details on the substitution characters (e.g. \%r) used in the
947 above line, please see the documentation of the
948 \ilink{ MailCommand in the Messages Resource}{mailcommand}
949 chapter of this manual.
951 It is HIGHLY recommended that you test one or two cases by hand to make sure
952 that the {\bf mailhost} that you specified is correct and that it will accept
953 your email requests. Since {\bf bsmtp} always uses a TCP connection rather
954 than writing in the spool file, you may find that your {\bf from} address is
955 being rejected because it does not contain a valid domain, or because your
956 message is caught in your spam filtering rules. Generally, you should specify
957 a fully qualified domain name in the {\bf from} field, and depending on
958 whether your bsmtp gateway is Exim or Sendmail, you may need to modify the
959 syntax of the from part of the message. Please test.
961 When running {\bf bsmtp} by hand, you will need to terminate the message by
962 entering a ctl-d in column 1 of the last line.
964 If you are getting incorrect dates (e.g. 1970) and you are
965 running with a non-English language setting, you might try adding
966 a LANG="en_US" immediately before the bsmtp call.
968 \subsection*{dbcheck}
970 \index[general]{Dbcheck}
971 \index[general]{program!dbcheck}
972 \addcontentsline{toc}{subsection}{dbcheck}
974 {\bf dbcheck} is a simple program that will search for logical
975 inconsistencies in the Bacula tables in your database, and optionally fix them.
976 It is a database maintenance routine, in the sense that it can
977 detect and remove unused rows, but it is not a database repair
978 routine. To repair a database, see the tools furnished by the
979 database vendor. Normally dbcheck should never need to be run,
980 but if Bacula has crashed or you have a lot of Clients, Pools, or
981 Jobs that you have removed, it could be useful.
983 The {\bf dbcheck} program can be found in
984 the {\bf \lt{}bacula-source\gt{}/src/tools} directory of the source
985 distribution. Though it is built with the make process, it is not normally
992 Usage: dbcheck [-c config] [-C catalog name] [-d debug_level] []
994 -C catalog name in the director conf file
995 -c director conf filename
996 -dnn set debug level to nn
997 -f fix inconsistencies
999 -? print this message
1003 If the {\bf -c} option is given with the Director's conf file, there is no
1004 need to enter any of the command line arguments, in particular the working
1005 directory as dbcheck will read them from the file.
1007 If the {\bf -f} option is specified, {\bf dbcheck} will repair ({\bf fix}) the
1008 inconsistencies it finds. Otherwise, it will report only.
1010 If the {\bf -b} option is specified, {\bf dbcheck} will run in batch mode, and
1011 it will proceed to examine and fix (if -f is set) all programmed inconsistency
1012 checks. If the {\bf -b} option is not specified, {\bf dbcheck} will enter
1013 interactive mode and prompt with the following:
1017 Hello, this is the database check/correct program.
1018 Please select the function you want to perform.
1019 1) Toggle modify database flag
1020 2) Toggle verbose flag
1021 3) Repair bad Filename records
1022 4) Repair bad Path records
1023 5) Eliminate duplicate Filename records
1024 6) Eliminate duplicate Path records
1025 7) Eliminate orphaned Jobmedia records
1026 8) Eliminate orphaned File records
1027 9) Eliminate orphaned Path records
1028 10) Eliminate orphaned Filename records
1029 11) Eliminate orphaned FileSet records
1030 12) Eliminate orphaned Client records
1031 13) Eliminate orphaned Job records
1032 14) Eliminate all Admin records
1033 15) Eliminate all Restore records
1036 Select function number:
1040 By entering 1 or 2, you can toggle the modify database flag (-f option) and
1041 the verbose flag (-v). It can be helpful and reassuring to turn off the modify
1042 database flag, then select one or more of the consistency checks (items 3
1043 through 9) to see what will be done, then toggle the modify flag on and re-run
1046 The inconsistencies examined are the following:
1049 \item Duplicate filename records. This can happen if you accidentally run two
1050 copies of Bacula at the same time, and they are both adding filenames
1051 simultaneously. It is a rare occurrence, but will create an inconsistent
1052 database. If this is the case, you will receive error messages during Jobs
1053 warning of duplicate database records. If you are not getting these error
1054 messages, there is no reason to run this check.
1055 \item Repair bad Filename records. This checks and corrects filenames that
1056 have a trailing slash. They should not.
1057 \item Repair bad Path records. This checks and corrects path names that do
1058 not have a trailing slash. They should.
1059 \item Duplicate path records. This can happen if you accidentally run two
1060 copies of Bacula at the same time, and they are both adding filenames
1061 simultaneously. It is a rare occurrence, but will create an inconsistent
1062 database. See the item above for why this occurs and how you know it is
1064 \item Orphaned JobMedia records. This happens when a Job record is deleted
1065 (perhaps by a user issued SQL statement), but the corresponding JobMedia
1066 record (one for each Volume used in the Job) was not deleted. Normally, this
1067 should not happen, and even if it does, these records generally do not take
1068 much space in your database. However, by running this check, you can
1069 eliminate any such orphans.
1070 \item Orphaned File records. This happens when a Job record is deleted
1071 (perhaps by a user issued SQL statement), but the corresponding File record
1072 (one for each Volume used in the Job) was not deleted. Note, searching for
1073 these records can be {\bf very} time consuming (i.e. it may take hours) for a
1074 large database. Normally this should not happen as Bacula takes care to
1075 prevent it. Just the same, this check can remove any orphaned File records.
1076 It is recommended that you run this once a year since orphaned File records
1077 can take a large amount of space in your database. You might
1078 want to ensure that you have indexes on JobId, FilenameId, and
1079 PathId for the File table in your catalog before running this
1081 \item Orphaned Path records. This condition happens any time a directory is
1082 deleted from your system and all associated Job records have been purged.
1083 During standard purging (or pruning) of Job records, Bacula does not check
1084 for orphaned Path records. As a consequence, over a period of time, old
1085 unused Path records will tend to accumulate and use space in your database.
1086 This check will eliminate them. It is recommended that you run this
1087 check at least once a year.
1088 \item Orphaned Filename records. This condition happens any time a file is
1089 deleted from your system and all associated Job records have been purged.
1090 This can happen quite frequently as there are quite a large number of files
1091 that are created and then deleted. In addition, if you do a system update or
1092 delete an entire directory, there can be a very large number of Filename
1093 records that remain in the catalog but are no longer used.
1095 During standard purging (or pruning) of Job records, Bacula does not check
1096 for orphaned Filename records. As a consequence, over a period of time, old
1097 unused Filename records will accumulate and use space in your database. This
1098 check will eliminate them. It is strongly recommended that you run this check
1099 at least once a year, and for large database (more than 200 Megabytes), it is
1100 probably better to run this once every 6 months.
1101 \item Orphaned Client records. These records can remain in the database long
1102 after you have removed a client.
1103 \item Orphaned Job records. If no client is defined for a job or you do not
1104 run a job for a long time, you can accumulate old job records. This option
1105 allow you to remove jobs that are not attached to any client (and thus
1107 \item All Admin records. This command will remove all Admin records,
1108 regardless of their age.
1109 \item All Restore records. This command will remove all Restore records,
1110 regardless of their age.
1113 By the way, I personally run dbcheck only where I have messed up
1114 my database due to a bug in developing Bacula code, so normally
1115 you should never need to run dbcheck inspite of the
1116 recommendations given above, which are given so that users don't
1117 waste their time running dbcheck too often.
1119 \subsection*{bregex}
1121 \index[general]{bregex}
1122 \index[general]{program!bregex}
1123 \addcontentsline{toc}{subsection}{bregex}
1125 {\bf bregex} is a simple program that will allow you to test
1126 regular expressions against a file of data. This can be useful
1127 because the regex libraries on most systems differ, and in
1128 addition, regex expressions can be complicated.
1130 {\bf bregex} is found in the src/tools directory and it is
1131 normally installed with your system binaries. To run it, use:
1134 Usage: bregex [-d debug_level] -f <data-file>
1135 -f specify file of data to be matched
1136 -l suppress line numbers
1137 -n print lines that do not match
1138 -? print this message.
1141 The \lt{}data-file\gt{} is a filename that contains lines
1142 of data to be matched (or not) against one or more patterns.
1143 When the program is run, it will prompt you for a regular
1144 expression pattern, then apply it one line at a time against
1145 the data in the file. Each line that matches will be printed
1146 preceded by its line number. You will then be prompted again
1147 for another pattern.
1149 Enter an empty line for a pattern to terminate the program. You
1150 can print only lines that do not match by using the -n option,
1151 and you can suppress printing of line numbers with the -l option.
1153 This program can be useful for testing regex expressions to be
1154 applied against a list of filenames.
1158 \index[general]{bwild}
1159 \index[general]{program!bwild}
1160 \addcontentsline{toc}{subsection}{bwild}
1162 {\bf bwild} is a simple program that will allow you to test
1163 wild-card expressions against a file of data.
1165 {\bf bwild} is found in the src/tools directory and it is
1166 normally installed with your system binaries. To run it, use:
1169 Usage: bwild [-d debug_level] -f <data-file>
1170 -f specify file of data to be matched
1171 -l suppress line numbers
1172 -n print lines that do not match
1173 -? print this message.
1176 The \lt{}data-file\gt{} is a filename that contains lines
1177 of data to be matched (or not) against one or more patterns.
1178 When the program is run, it will prompt you for a wild-card
1179 pattern, then apply it one line at a time against
1180 the data in the file. Each line that matches will be printed
1181 preceded by its line number. You will then be prompted again
1182 for another pattern.
1184 Enter an empty line for a pattern to terminate the program. You
1185 can print only lines that do not match by using the -n option,
1186 and you can suppress printing of line numbers with the -l option.
1188 This program can be useful for testing wild expressions to be
1189 applied against a list of filenames.
1191 \subsection*{testfind}
1193 \index[general]{Testfind}
1194 \index[general]{program!testfind}
1195 \addcontentsline{toc}{subsection}{testfind}
1197 {\bf testfind} permits listing of files using the same search engine that is
1198 used for the {\bf Include} resource in Job resources. Note, much of the
1199 functionality of this program (listing of files to be included) is present in
1201 \ilink{estimate command}{estimate} in the Console program.
1203 The original use of testfind was to ensure that Bacula's file search engine
1204 was correct and to print some statistics on file name and path length.
1205 However, you may find it useful to see what bacula would do with a given {\bf
1206 Include} resource. The {\bf testfind} program can be found in the {\bf
1207 \lt{}bacula-source\gt{}/src/tools} directory of the source distribution.
1208 Though it is built with the make process, it is not normally "installed".
1214 Usage: testfind [-d debug_level] [-] [pattern1 ...]
1215 -a print extended attributes (Win32 debug)
1216 -dnn set debug level to nn
1217 - read pattern(s) from stdin
1218 -? print this message.
1219 Patterns are used for file inclusion -- normally directories.
1220 Debug level>= 1 prints each file found.
1221 Debug level>= 10 prints path/file for catalog.
1222 Errors are always printed.
1223 Files/paths truncated is a number with len> 255.
1224 Truncation is only in the catalog.
1228 Where a pattern is any filename specification that is valid within an {\bf
1229 Include} resource definition. If none is specified, {\bf /} (the root
1230 directory) is assumed. For example:
1238 Would print the following:
1244 Lnk: /bin/bash2 -> bash
1245 Lnk: /bin/sh -> bash
1253 Reg: /bin/aumix-minimal
1255 Lnka: /bin/gawk-3.1.0 -> /bin/gawk
1265 Even though {\bf testfind} uses the same search engine as {\bf Bacula}, each
1266 directory to be listed, must be entered as a separate command line entry or
1267 entered one line at a time to standard input if the {\bf -} option was
1270 Specifying a debug level of one (i.e. {\bf -d1}) on the command line will
1271 cause {\bf testfind} to print the raw filenames without showing the Bacula
1272 internal file type, or the link (if any). Debug levels of 10 or greater cause
1273 the filename and the path to be separated using the same algorithm that is
1274 used when putting filenames into the Catalog database.