1 \chapter{Community Bacula New Features in 5.1.x}
2 This chapter presents the new features that have been added to the
3 current Community version of Bacula that is under development. This version will be
4 released at some later date, probably near the end of April 2011.
6 There are additional features (plugins) available in the Enterprise version
7 that are described in another chapter. A subscription to Bacula Systems
8 is required for the Enterprise version.
10 \section{Restart Incomplete Job}
14 This project was funded by Bacula Systems and is available with Bacula
15 Enterprise Edition and Community Edition.
17 \section{New Tray Monitor}
19 Since the old integrated Windows tray monitor doesn't work anymore with
20 recent Windows versions, we have written a new Qt Tray Monitor that is available
21 for both Linux and Windows. This new version allows you to run Backup from
22 the tray monitor menu.
26 \includegraphics[width=10cm]{\idir tray-monitor}
27 \label{fig:traymonitor}
28 \caption{New tray monitor}
33 \includegraphics[width=10cm]{\idir tray-monitor1}
34 \label{fig:traymonitor1}
35 \caption{Run a Job through the new tray monitor}
39 This project was funded by Bacula Systems and is available with Bacula
40 the Enterprise Edition and the Community Edition.
42 \section{Purge Migration Job}
44 The new {\bf Purge Migration Job} directive may be added to the Migration
45 Job definition in the Director's configuration file. When it is enabled
46 the Job that was migrated during a migration will be purged at
47 the end of the migration job.
61 Selection Pattern = ".*Save"
63 Purge Migrated Job = yes
69 This project was submited by Dunlap Blake, testing and documentation was funded
72 \section{Job Bandwidth Limitation}
74 The new {\bf Job Bandwidth Limitation} directive may be added to the File
75 daemon's and/or Director's configuration to limit the bandwidth used by a Job
76 on a Client. It can be set in the File daemon's conf file for all Jobs run in
77 that File daemon, or it can be set for each Job in the Director's conf file.
83 Working Directory = /some/path
84 Pid Directory = /some/path
86 Maximum Bandwidth Per Job = 5Mb/s
90 The above example would cause any jobs running with the FileDaemon to not
91 exceed 5Mb/s of throughput when sending data to the Storage Daemon.
93 You can specify the speed parameter in k/s, Kb/s, m/s, Mb/s.
99 FileSet = FS_localhost
102 Maximum Bandwidth = 5Mb/s
107 The above example would cause Job \texttt{localhost-data} to not exceed 5MB/s
108 of throughput when sending data from the File daemon to the Storage daemon.
110 A new console command \texttt{setbandwidth} permits to set dynamically the
111 maximum throughput of a running Job or for future jobs of a Client.
114 * setbandwidth limit=1000000 jobid=10
117 The \texttt{limit} parameter is in Kb/s.
120 This project was funded by Bacula Systems and is available in
121 the Enterprise Edition and the Community Edition.
124 \section{SQL Catalog Enhancements}
126 % TODO: Marco can explain more things
127 Bacula uses a new catalog backend structure, it allows to build all SQL drivers
128 with the same \texttt{./configure ; make} session.
130 We also added cursor support for PostgreSQL backend, this improves memory usage
131 for large installation.
133 \section{Changes in Bvfs (Bacula Virtual FileSystem)}
135 Bat has now a bRestore panel that uses Bvfs to display files and
136 directories. It's still experimental.
140 \includegraphics[width=12cm]{\idir bat-brestore}
141 \label{fig:batbrestore}
142 \caption{Bat Brestore Panel}
145 \texttt{Important}, the Bvfs module is not currently compatible with BaseJobs,
146 Copy and Migration jobs.
149 This project was funded by Bacula Systems.
151 \subsection*{General notes}
154 \item All fields are separated by a tab
155 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
156 records in very big directories
157 \item All operations (except cache creation) are designed to run instantly
158 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
159 can contribute new faster SQL queries we will be happy, else don't complain
161 \item The cache creation is dependent of the number of directories. As Bvfs
162 shares information accross jobs, the first creation can be slow
163 \item All fields are separated by a tab
164 \item Due to potential encoding problem, it's advised to allways use pathid in
168 \subsection*{Get dependent jobs from a given JobId}
170 Bvfs allows you to query the catalog against any combination of jobs. You
171 can combine all Jobs and all FileSet for a Client in a single session.
173 To get all JobId needed to restore a particular job, you can use the
174 \texttt{.bvfs\_get\_jobids} command.
177 .bvfs_get_jobids jobid=num [all]
181 .bvfs_get_jobids jobid=10
183 .bvfs_get_jobids jobid=10 all
187 In this example, a normal restore will need to use JobIds 1,2,5,10 to
188 compute a complete restore of the system.
190 With the \texttt{all} option, the Director will use all defined FileSet for
193 \subsection*{Generating Bvfs cache}
195 The \texttt{.bvfs\_update} command computes the directory cache for jobs
196 specified in argument, or for all jobs if unspecified.
199 .bvfs_update [jobid=numlist]
204 .bvfs_update jobid=1,2,3
207 You can run the cache update process in a RunScript after the catalog backup.
209 \subsection*{Get all versions of a specific file}
211 Bvfs allows you to find all versions of a specific file for a given Client with
212 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
213 function uses only PathId and FilenameId. The jobid argument is mandatory but
217 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
218 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
219 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
226 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
227 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
230 \subsection*{List directories}
232 Bvfs allows you to list directories in a specific path.
234 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
235 PathId FilenameId FileId JobId LStat Path
236 PathId FilenameId FileId JobId LStat Path
237 PathId FilenameId FileId JobId LStat Path
241 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
242 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
243 listed is a directory.
246 .bvfs_lsdirs pathid=4 jobid=1,11,12
247 4 0 0 0 A A A A A A A A A A A A A A .
248 5 0 0 0 A A A A A A A A A A A A A A ..
249 3 0 0 0 A A A A A A A A A A A A A A regress/
252 In this example, to list directories present in \texttt{regress/}, you can use
254 .bvfs_lsdirs pathid=3 jobid=1,11,12
255 3 0 0 0 A A A A A A A A A A A A A A .
256 4 0 0 0 A A A A A A A A A A A A A A ..
257 2 0 0 0 A A A A A A A A A A A A A A tmp/
260 \subsection*{List files}
262 Bvfs allows you to list files in a specific path.
264 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
265 PathId FilenameId FileId JobId LStat Path
266 PathId FilenameId FileId JobId LStat Path
267 PathId FilenameId FileId JobId LStat Path
271 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
272 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
276 .bvfs_lsfiles pathid=4 jobid=1,11,12
277 4 0 0 0 A A A A A A A A A A A A A A .
278 5 0 0 0 A A A A A A A A A A A A A A ..
279 1 0 0 0 A A A A A A A A A A A A A A regress/
282 In this example, to list files present in \texttt{regress/}, you can use
284 .bvfs_lsfiles pathid=1 jobid=1,11,12
285 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
286 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
287 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
288 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
289 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
292 \subsection*{Restore set of files}
294 Bvfs allows you to create a SQL table that contains files that you want to
295 restore. This table can be provided to a restore command with the file option.
298 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
300 restore file=?b2num ...
303 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
304 select all files. This query could be time consuming.
306 \texttt{hardlink} list is always composed of a serie of two numbers (jobid,
307 fileindex). This information can be found in the LinkFI field of the LStat
310 The \texttt{path} argument represents the name of the table that Bvfs will
311 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
312 b2 and followed by digits).
317 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
321 \subsection*{Cleanup after restore}
323 To drop the table used by the restore command, you can use the
324 \texttt{.bvfs\_cleanup} command.
327 .bvfs_cleanup path=b20001
330 \section{Changes in the pruning algorithm}
332 We rewrote the job pruning algorithm in this version. Previously, in some users
333 reported that the pruning process at the end of jobs was very long. It should
334 not be longer the case. Now, Bacula won't prune automatically a Job if this
335 particular Job is needed to restore data. Example:
339 JobId: 2 Level: Incremental
340 JobId: 3 Level: Incremental
341 JobId: 4 Level: Differential
342 .. Other incrementals up to now
345 In this example, if the Job Retention defined in the Pool or in the Client
346 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
347 detect that JobId 1 and 4 are essential to restore data at the current state
348 and will prune only JobId 2 and 3.
350 \texttt{Important}, this change affect only the automatic pruning step after a
351 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
352 \texttt{VolumeRetention} period, important jobs can be pruned.
354 \section{Ability to Verify any specified Job}
355 You now have the ability to tell Bacula which Job should verify instead of
356 automatically verify just the last one.
358 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
360 To verify a given job, just specify the Job jobid in argument when starting the
363 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
365 JobName: VerifyVolume
366 Level: VolumeToCatalog
369 Pool: Default (From Job resource)
370 Storage: File (From Job resource)
371 Verify Job: VerifyVol.2010-09-08_14.17.17_03
372 Verify List: /tmp/regress/working/VerifyVol.bsr
373 When: 2010-09-08 14:17:31
375 OK to run? (yes/mod/no):
379 This project was funded by Bacula Systems and is available with Bacula
380 Enterprise Edition and Community Edition.
382 \section{Additions to RunScript variables}
383 You can have access to JobBytes and JobFiles using \%b and \%f in your runscript
384 command. The Client address is now available through \%h.
387 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%f ClientAddress=%h"
390 %\section{Changes in drivetype.exe}
392 %Now the \texttt{drivetype.exe} program allows you to list all local hard
393 %drives. It can help to build dynamic FileSet on Windows.
396 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
400 \section{ACL/Extended Attributes}
402 We added support for NFSv4 ACLs on FreeBSD 8.1 and IRIX extended attributes.
404 This project was funded by Marco van Wieringen.
406 \section{Additions to the Plugin API}
407 The bfuncs structure has been extended to include a number of
411 The bFuncs structure defines the callback entry points within Bacula
412 that the plugin can use register events, get Bacula values, set
413 Bacula values, and send messages to the Job output or debug output.
415 The exact definition as of this writing is:
417 typedef struct s_baculaFuncs {
420 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
421 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
422 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
423 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
424 int type, utime_t mtime, const char *fmt, ...);
425 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
426 int level, const char *fmt, ...);
427 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
429 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
431 /* New functions follow */
432 bRC (*AddExclude)(bpContext *ctx, const char *file);
433 bRC (*AddInclude)(bpContext *ctx, const char *file);
434 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
435 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
436 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
437 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
443 \item [AddExclude] can be called to exclude a file. The file
444 string passed may include wildcards that will be interpreted by
445 the {\bf fnmatch} subroutine. This function can be called
446 multiple times, and each time the file specified will be added
447 to the list of files to be excluded. Note, this function only
448 permits adding excludes of specific file or directory names,
449 or files matched by the rather simple fnmatch mechanism.
450 See below for information on doing wild-card and regex excludes.
452 \item [NewInclude] can be called to create a new Include block. This
453 block will be added before any user defined Include blocks. This
454 function can be called multiple times, but each time, it will create
455 a new Include section (not normally needed). This function should
456 be called only if you want to add an entirely new Include block.
458 \item [AddInclude] can be called to add new files/directories to
459 be included. They are added to the current Include block. If
460 NewInclude has not been included, the current Include block is
461 the last one that the user created. This function
462 should be used only if you want to add totally new files/directories
463 to be included in the backup.
465 \item [NewOptions] adds a new Options block to the current Include
466 in front of any other Options blocks. This permits the plugin to
467 add exclude directives (wild-cards and regexes) in front of the
468 user Options, and thus prevent certain files from being backed up.
469 This can be useful if the plugin backs up files, and they should
470 not be also backed up by the main Bacula code. This function
471 may be called multiple times, and each time, it creates a new
472 prepended Options block. Note: normally you want to call this
473 entry point prior to calling AddOptions, AddRegex, or AddWild.
475 \item [AddOptions] allows the plugin it set options in
476 the current Options block, which is normally created with the
477 NewOptions call just prior to adding Include Options.
478 The permitted options are passed as a character string, where
479 each character has a specific meaning as defined below:
482 \item [a] always replace files (default).
483 \item [e] exclude rather than include.
484 \item [h] no recursion into subdirectories.
485 \item [H] do not handle hard links.
486 \item [i] ignore case in wildcard and regex matches.
487 \item [M] compute an MD5 sum.
488 \item [p] use a portable data format on Windows (not recommended).
489 \item [R] backup resource forks and Findr Info.
490 \item [r] read from a fifo
491 \item [S1] compute an SHA1 sum.
492 \item [S2] compute an SHA256 sum.
493 \item [S3] comput an SHA512 sum.
494 \item [s] handle sparse files.
495 \item [m] use st\_mtime only for file differences.
496 \item [k] restore the st\_atime after accessing a file.
497 \item [A] enable ACL backup.
498 \item [Vxxx:] specify verify options. Must terminate with :
499 \item [Cxxx:] specify accurate options. Must terminate with :
500 \item [Jxxx:] specify base job Options. Must terminate with :
501 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
503 \item [Zn] specify gzip compression level n.
504 \item [K] do not use st\_atime in backup decision.
505 \item [c] check if file changed during backup.
506 \item [N] honor no dump flag.
507 \item [X] enable backup of extended attributes.
510 \item [AddRegex] adds a regex expression to the current Options block.
511 The fillowing options are permitted:
513 \item [ ] (a blank) regex applies to whole path and filename.
514 \item [F] regex applies only to the filename (directory or path stripped).
515 \item [D] regex applies only to the directory (path) part of the name.
518 \item [AddWild] adds a wildcard expression to the current Options block.
519 The fillowing options are permitted:
521 \item [ ] (a blank) regex applies to whole path and filename.
522 \item [F] regex applies only to the filename (directory or path stripped).
523 \item [D] regex applies only to the directory (path) part of the name.
526 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
527 that can use Accurate code to compare the file information in argument with
528 the previous file information. The \texttt{delta\_seq} attribute of the
529 \texttt{save\_pkt} will be updated, and the call will return
530 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
535 \subsection{Bacula events}
536 The list of events has been extended to include:
542 bEventStartBackupJob = 3,
543 bEventEndBackupJob = 4,
544 bEventStartRestoreJob = 5,
545 bEventEndRestoreJob = 6,
546 bEventStartVerifyJob = 7,
547 bEventEndVerifyJob = 8,
548 bEventBackupCommand = 9,
549 bEventRestoreCommand = 10,
554 bEventCancelCommand = 13,
555 bEventVssBackupAddComponents = 14,
556 bEventVssRestoreLoadComponentMetadata = 15,
557 bEventVssRestoreSetComponentsSelected = 16,
558 bEventRestoreObject = 17,
559 bEventEndFileSet = 18,
560 bEventPluginCommand = 19,
561 bEventVssBeforeCloseRestore = 20,
562 bEventVssPrepareSnapshot = 21
568 \item [bEventCancelCommand] is called whenever the currently
569 running Job is cancelled */
571 \item [bEventVssBackupAddComponents]
573 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
574 provides a char[27] table where the plugin can add Windows drives that will
575 be used during the Job. You need to add them without duplicates, and you can
576 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
580 \chapter{Release Version 5.0.3}
582 There are no new features in version 5.0.2. This version simply fixes a
583 number of bugs found in version 5.0.1 during the onging development
586 \chapter{Release Version 5.0.2}
588 There are no new features in version 5.0.2. This version simply fixes a
589 number of bugs found in version 5.0.1 during the onging development
595 \chapter{New Features in 5.0.1}
597 This chapter presents the new features that are in the released Bacula version
598 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
599 the onging development process.
601 \section{Truncate Volume after Purge}
602 \label{sec:actiononpurge}
604 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
605 the volume when it is purged with the new command \texttt{purge volume
606 action}. It is useful to prevent disk based volumes from consuming too much
612 Action On Purge = Truncate
617 As usual you can also set this property with the \texttt{update volume} command
619 *update volume=xxx ActionOnPurge=Truncate
620 *update volume=xxx actiononpurge=None
623 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
624 following command in interactive mode or in a RunScript as shown after:
626 *purge volume action=truncate storage=File allpools
627 # or by default, action=all
628 *purge volume action storage=File pool=Default
631 This is possible to specify the volume name, the media type, the pool, the
632 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
633 idle when you decide to run this command.
642 Console = "purge volume action=all allpools storage=File"
647 \textbf{Important note}: This feature doesn't work as
648 expected in version 5.0.0. Please do not use it before version 5.0.1.
650 \section{Allow Higher Duplicates}
651 This directive did not work correctly and has been depreciated
652 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
653 file as it will be removed in a future rlease.
655 \section{Cancel Lower Level Duplicates}
656 This directive was added in Bacula version 5.0.1. It compares the
657 level of a new backup job to old jobs of the same name, if any,
658 and will kill the job which has a lower level than the other one.
659 If the levels are the same (i.e. both are Full backups), then
660 nothing is done and the other Cancel XXX Duplicate directives
663 \chapter{New Features in 5.0.0}
665 \section{Maximum Concurent Jobs for Devices}
666 \label{sec:maximumconcurentjobdevice}
668 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
669 Daemon configuration permits setting the maximum number of Jobs that can
670 run concurrently on a specified Device. Using this directive, it is
671 possible to have different Jobs using multiple drives, because when the
672 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
673 Jobs on any other available compatible drive. This facilitates writing to
674 multiple drives with multiple Jobs that all use the same Pool.
676 This project was funded by Bacula Systems.
678 \section{Restore from Multiple Storage Daemons}
679 \index[general]{Restore}
681 Previously, you were able to restore from multiple devices in a single Storage
682 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
683 example, if your full backup runs on a Storage Daemon with an autochanger, and
684 your incremental jobs use another Storage Daemon with lots of disks, Bacula
685 will switch automatically from one Storage Daemon to an other within the same
688 You must upgrade your File Daemon to version 3.1.3 or greater to use this
691 This project was funded by Bacula Systems with the help of Equiinet.
693 \section{File Deduplication using Base Jobs}
694 A base job is sort of like a Full save except that you will want the FileSet to
695 contain only files that are unlikely to change in the future (i.e. a snapshot
696 of most of your system after installing it). After the base job has been run,
697 when you are doing a Full save, you specify one or more Base jobs to be used.
698 All files that have been backed up in the Base job/jobs but not modified will
699 then be excluded from the backup. During a restore, the Base jobs will be
700 automatically pulled in where necessary.
702 This is something none of the competition does, as far as we know (except
703 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
704 win for the user, it makes Bacula stand out as offering a unique optimization
705 that immediately saves time and money. Basically, imagine that you have 100
706 nearly identical Windows or Linux machine containing the OS and user files.
707 Now for the OS part, a Base job will be backed up once, and rather than making
708 100 copies of the OS, there will be only one. If one or more of the systems
709 have some files updated, no problem, they will be automatically restored.
711 See the \ilink{Base Job Chapter}{basejobs} for more information.
713 This project was funded by Bacula Systems.
715 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
716 \index[dir]{AllowCompression}
718 This new directive may be added to Storage resource within the Director's
719 configuration to allow users to selectively disable the client compression for
720 any job which writes to this storage resource.
726 Address = ultrium-tape
727 Password = storage_password # Password for Storage Daemon
730 AllowCompression = No # Tape drive has hardware compression
733 The above example would cause any jobs running with the UltriumTape storage
734 resource to run without compression from the client file daemons. This
735 effectively overrides any compression settings defined at the FileSet level.
737 This feature is probably most useful if you have a tape drive which supports
738 hardware compression. By setting the \texttt{AllowCompression = No} directive
739 for your tape drive storage resource, you can avoid additional load on the file
740 daemon and possibly speed up tape backups.
742 This project was funded by Collaborative Fusion, Inc.
744 \section{Accurate Fileset Options}
745 \label{sec:accuratefileset}
747 In previous versions, the accurate code used the file creation and modification
748 times to determine if a file was modified or not. Now you can specify which
749 attributes to use (time, size, checksum, permission, owner, group, \dots),
750 similar to the Verify options.
766 \item {\bf i} compare the inodes
767 \item {\bf p} compare the permission bits
768 \item {\bf n} compare the number of links
769 \item {\bf u} compare the user id
770 \item {\bf g} compare the group id
771 \item {\bf s} compare the size
772 \item {\bf a} compare the access time
773 \item {\bf m} compare the modification time (st\_mtime)
774 \item {\bf c} compare the change time (st\_ctime)
775 \item {\bf d} report file size decreases
776 \item {\bf 5} compare the MD5 signature
777 \item {\bf 1} compare the SHA1 signature
780 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
781 the File Daemon will have to read all files even if they normally would not
782 be saved. This increases the I/O load, but also the accuracy of the
783 deduplication. By default, Bacula will check modification/creation time
786 This project was funded by Bacula Systems.
788 \section{Tab-completion for Bconsole}
789 \label{sec:tabcompletion}
791 If you build \texttt{bconsole} with readline support, you will be able to use
792 the new auto-completion mode. This mode supports all commands, gives help
793 inside command, and lists resources when required. It works also in the restore
796 To use this feature, you should have readline development package loaded on
797 your system, and use the following option in configure.
799 ./configure --with-readline=/usr/include/readline --disable-conio ...
802 The new bconsole won't be able to tab-complete with older directors.
804 This project was funded by Bacula Systems.
806 \section{Pool File and Job Retention}
807 \label{sec:poolfilejobretention}
809 We added two new Pool directives, \texttt{FileRetention} and
810 \texttt{JobRetention}, that take precedence over Client directives of the same
811 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
812 example, you can decide to increase Retention times for Archive or OffSite Pool.
814 It seems obvious to us, but apparently not to some users, that given the
815 definition above that the Pool File and Job Retention periods is a global
816 override for the normal Client based prunning, which means that when the
817 Job is prunned, the prunning will apply globally to that particular Job.
819 Currently, there is a bug in the implementation that causes any Pool
820 retention periods specified to apply to {\bf all} Pools for that
821 particular Client. Thus we suggest that you avoid using these two
822 directives until this implementation problem is corrected.
824 \section{Read-only File Daemon using capabilities}
825 \label{sec:fdreadonly}
826 This feature implements support of keeping \textbf{ReadAll} capabilities after
827 UID/GID switch, this allows FD to keep root read but drop write permission.
829 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
830 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
833 root@localhost:~# bacula-fd -k -u nobody -g nobody
836 The code for this feature was contributed by our friends at AltLinux.
841 To help developers of restore GUI interfaces, we have added new \textsl{dot
842 commands} that permit browsing the catalog in a very simple way.
845 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
846 the Bvfs cache in the catalog. You need to run it before any access to the
849 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
850 will list all directories in the specified \texttt{path} or
851 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
852 encoding of path/filenames.
854 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
855 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
856 \texttt{pathid} avoids problems with character encoding.
859 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
860 data that will be displayed.
863 * .bvfs_update jobid=1,2
865 * .bvfs_lsdir path=/ jobid=1,2
868 This project was funded by Bacula Systems.
870 \section{Testing your Tape Drive}
871 \label{sec:btapespeed}
873 To determine the best configuration of your tape drive, you can run the new
874 \texttt{speed} command available in the \texttt{btape} program.
876 This command can have the following arguments:
878 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
879 (between 1 and 5GB). This counter is in GB.
880 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
881 of data should be greater than your memory ($file\_size*nb\_file$).
882 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
884 \item[\texttt{skip\_random}] This flag permits to skip tests with random
886 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
887 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
892 *speed file_size=3 skip_raw
893 btape.c:1078 Test with zero data and bacula block structure.
894 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
895 ++++++++++++++++++++++++++++++++++++++++++
896 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
897 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
899 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
901 btape.c:1090 Test with random data, should give the minimum throughput.
902 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
903 +++++++++++++++++++++++++++++++++++++++++++
904 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
905 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
906 +++++++++++++++++++++++++++++++++++++++++++
908 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
912 When using compression, the random test will give your the minimum throughput
913 of your drive . The test using constant string will give you the maximum speed
914 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
916 You can change the block size in the Storage Daemon configuration file.
918 \section{New {\bf Block Checksum} Device Directive}
919 You may now turn off the Block Checksum (CRC32) code
920 that Bacula uses when writing blocks to a Volume. This is
927 doing so can reduce the Storage daemon CPU usage slightly. It
928 will also permit Bacula to read a Volume that has corrupted data.
930 The default is {\bf yes} -- i.e. the checksum is computed on write
933 We do not recommend to turn this off particularly on older tape
934 drives or for disk Volumes where doing so may allow corrupted data
937 \section{New Bat Features}
939 Those new features were funded by Bacula Systems.
941 \subsection{Media List View}
943 By clicking on ``Media'', you can see the list of all your volumes. You will be
944 able to filter by Pool, Media Type, Location,\dots And sort the result directly
945 in the table. The old ``Media'' view is now known as ``Pool''.
948 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
949 \label{fig:mediaview}
953 \subsection{Media Information View}
955 By double-clicking on a volume (on the Media list, in the Autochanger content
956 or in the Job information panel), you can access a detailed overview of your
957 Volume. (cf \ref{fig:mediainfo}.)
960 \includegraphics[width=13cm]{\idir bat11.eps}
961 \caption{Media information}
962 \label{fig:mediainfo}
965 \subsection{Job Information View}
967 By double-clicking on a Job record (on the Job run list or in the Media
968 information panel), you can access a detailed overview of your Job. (cf
972 \includegraphics[width=13cm]{\idir bat12.eps}
973 \caption{Job information}
977 \subsection{Autochanger Content View}
979 By double-clicking on a Storage record (on the Storage list panel), you can
980 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
983 \includegraphics[width=13cm]{\idir bat13.eps}
984 \caption{Autochanger content}
985 \label{fig:achcontent}
988 To use this feature, you need to use the latest mtx-changer script
989 version. (With new \texttt{listall} and \texttt{transfer} commands)
991 \section{Bat on Windows}
992 We have ported {\bf bat} to Windows and it is now installed
993 by default when the installer is run. It works quite well
994 on Win32, but has not had a lot of testing there, so your
995 feedback would be welcome. Unfortunately, eventhough it is
996 installed by default, it does not yet work on 64 bit Windows
999 \section{New Win32 Installer}
1000 The Win32 installer has been modified in several very important
1003 \item You must deinstall any current version of the
1004 Win32 File daemon before upgrading to the new one.
1005 If you forget to do so, the new installation will fail.
1006 To correct this failure, you must manually shutdown
1007 and deinstall the old File daemon.
1008 \item All files (other than menu links) are installed
1009 in {\bf c:/Program Files/Bacula}.
1010 \item The installer no longer sets this
1011 file to require administrator privileges by default. If you want
1012 to do so, please do it manually using the {\bf cacls} program.
1015 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1017 \item The server daemons (Director and Storage daemon) are
1018 no longer included in the Windows installer. If you want the
1019 Windows servers, you will either need to build them yourself (note
1020 they have not been ported to 64 bits), or you can contact
1021 Bacula Systems about this.
1024 \section{Win64 Installer}
1025 We have corrected a number of problems that required manual
1026 editing of the conf files. In most cases, it should now
1027 install and work. {\bf bat} is by default installed in
1028 {\bf c:/Program Files/Bacula/bin32} rather than
1029 {\bf c:/Program Files/Bacula} as is the case with the 32
1030 bit Windows installer.
1032 \section{Linux Bare Metal Recovery USB Key}
1033 We have made a number of significant improvements in the
1034 Bare Metal Recovery USB key. Please see the README files
1035 it the {\bf rescue} release for more details.
1037 We are working on an equivalent USB key for Windows bare
1038 metal recovery, but it will take some time to develop it (best
1039 estimate 3Q2010 or 4Q2010)
1042 \section{bconsole Timeout Option}
1043 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1044 for commands. This is useful with GUI programs that use {\bf bconsole}
1045 to interface to the Director.
1047 \section{Important Changes}
1048 \label{sec:importantchanges}
1051 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1052 to the same Pool. The Storage daemon ensures that you do not read and
1053 write to the same Volume.
1054 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1056 \item Virtually all the features of {\bf mtx-changer} have
1057 now been parameterized, which allows you to configure
1058 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
1059 that contains variables that you can set to configure mtx-changer.
1060 This configuration file will not be overwritten during upgrades.
1061 We encourage you to submit any changes
1062 that are made to mtx-changer and to parameterize it all in
1063 mtx-changer.conf so that all configuration will be done by
1064 changing only mtx-changer.conf.
1065 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1066 and \texttt{transfer}. Please configure them as appropriate
1067 in mtx-changer.conf.
1068 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1069 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1070 password. If you want to use the new script, you will need to
1071 manually change the \texttt{BackupCatalog} Job definition.
1072 \item The \texttt{bconsole} \texttt{help} command now accepts
1073 an argument, which if provided produces information on that
1074 command (ex: \texttt{help run}).
1078 \subsubsection*{Truncate volume after purge}
1080 Note that the Truncate Volume after purge feature doesn't work as expected
1081 in 5.0.0 version. Please, don't use it before version 5.0.1.
1083 \subsection{Custom Catalog queries}
1085 If you wish to add specialized commands that list the contents of the catalog,
1086 you can do so by adding them to the \texttt{query.sql} file. This
1087 \texttt{query.sql} file is now empty by default. The file
1088 \texttt{examples/sample-query.sql} has an a number of sample commands
1089 you might find useful.
1091 \subsection{Deprecated parts}
1093 The following items have been \textbf{deprecated} for a long time, and are now
1094 removed from the code.
1097 \item Support for SQLite 2
1100 \section{Misc Changes}
1101 \label{sec:miscchanges}
1104 \item Updated Nagios check\_bacula
1105 \item Updated man files
1106 \item Added OSX package generation script in platforms/darwin
1107 \item Added Spanish and Ukrainian Bacula translations
1108 \item Enable/disable command shows only Jobs that can change
1109 \item Added \texttt{show disabled} command to show disabled Jobs
1110 \item Many ACL improvements
1111 \item Added Level to FD status Job output
1112 \item Begin Ingres DB driver (not yet working)
1113 \item Split RedHat spec files into bacula, bat, mtx, and docs
1114 \item Reorganized the manuals (fewer separate manuals)
1115 \item Added lock/unlock order protection in lock manager
1116 \item Allow 64 bit sizes for a number of variables
1117 \item Fixed several deadlocks or potential race conditions in the SD
1120 \chapter{Released Version 3.0.3 and 3.0.3a}
1122 There are no new features in version 3.0.3. This version simply fixes a
1123 number of bugs found in version 3.0.2 during the onging development
1126 \chapter{New Features in Released Version 3.0.2}
1128 This chapter presents the new features added to the
1129 Released Bacula Version 3.0.2.
1131 \section{Full Restore from a Given JobId}
1132 \index[general]{Restore menu}
1134 This feature allows selecting a single JobId and having Bacula
1135 automatically select all the other jobs that comprise a full backup up to
1136 and including the selected date (through JobId).
1138 Assume we start with the following jobs:
1140 +-------+--------------+---------------------+-------+----------+------------+
1141 | jobid | client | starttime | level | jobfiles | jobbytes |
1142 +-------+--------------+---------------------+-------+----------+------------
1143 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
1144 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
1145 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
1146 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
1147 +-------+--------------+---------------------+-------+----------+------------+
1150 Below is an example of this new feature (which is number 12 in the
1155 To select the JobIds, you have the following choices:
1156 1: List last 20 Jobs run
1157 2: List Jobs where a given File is saved
1159 12: Select full restore to a specified Job date
1162 Select item: (1-13): 12
1163 Enter JobId to get the state to restore: 5
1164 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1165 You have selected the following JobIds: 1,3,5
1167 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1168 1,444 files inserted into the tree.
1171 This project was funded by Bacula Systems.
1173 \section{Source Address}
1174 \index[general]{Source Address}
1176 A feature has been added which allows the administrator to specify the address
1177 from which the Director and File daemons will establish connections. This
1178 may be used to simplify system configuration overhead when working in complex
1179 networks utilizing multi-homing and policy-routing.
1181 To accomplish this, two new configuration directives have been implemented:
1184 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
1188 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
1192 Simply adding specific host routes on the OS
1193 would have an undesirable side-effect: any
1194 application trying to contact the destination host would be forced to use the
1195 more specific route possibly diverting management traffic onto a backup VLAN.
1196 Instead of adding host routes for each client connected to a multi-homed backup
1197 server (for example where there are management and backup VLANs), one can
1198 use the new directives to specify a specific source address at the application
1201 Additionally, this allows the simplification and abstraction of firewall rules
1202 when dealing with a Hot-Standby director or storage daemon configuration. The
1203 Hot-standby pair may share a CARP address, which connections must be sourced
1204 from, while system services listen and act from the unique interface addresses.
1206 This project was funded by Collaborative Fusion, Inc.
1208 \section{Show volume availability when doing restore}
1210 When doing a restore the selection dialog ends by displaying this
1214 The job will require the following
1215 Volume(s) Storage(s) SD Device(s)
1216 ===========================================================================
1217 *000741L3 LTO-4 LTO3
1218 *000866L3 LTO-4 LTO3
1219 *000765L3 LTO-4 LTO3
1220 *000764L3 LTO-4 LTO3
1221 *000756L3 LTO-4 LTO3
1222 *001759L3 LTO-4 LTO3
1223 *001763L3 LTO-4 LTO3
1227 Volumes marked with ``*'' are online (in the autochanger).
1230 This should help speed up large restores by minimizing the time spent
1231 waiting for the operator to discover that he must change tapes in the library.
1233 This project was funded by Bacula Systems.
1235 \section{Accurate estimate command}
1237 The \texttt{estimate} command can now use the accurate code to detect changes
1238 and give a better estimation.
1240 You can set the accurate behavior on the command line by using
1241 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1244 * estimate listing accurate=yes level=incremental job=BackupJob
1247 This project was funded by Bacula Systems.
1249 \chapter{New Features in 3.0.0}
1250 \label{NewFeaturesChapter}
1251 \index[general]{New Features}
1253 This chapter presents the new features added to the development 2.5.x
1254 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1256 \section{Accurate Backup}
1257 \index[general]{Accurate Backup}
1259 As with most other backup programs, by default Bacula decides what files to
1260 backup for Incremental and Differental backup by comparing the change
1261 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1262 backup completed. If one of those two times is later than the last backup
1263 time, then the file will be backed up. This does not, however, permit tracking
1264 what files have been deleted and will miss any file with an old time that may
1265 have been restored to or moved onto the client filesystem.
1267 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
1268 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1269 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1270 backup, there is no difference, but for {\bf Differential} and {\bf
1271 Incremental} backups, the Director will send a list of all previous files
1272 backed up, and the File daemon will use that list to determine if any new files
1273 have been added or or moved and if any files have been deleted. This allows
1274 Bacula to make an accurate backup of your system to that point in time so that
1275 if you do a restore, it will restore your system exactly.
1278 about using Accurate backup is that it requires more resources (CPU and memory)
1279 on both the Director and the Client machines to create the list of previous
1280 files backed up, to send that list to the File daemon, for the File daemon to
1281 keep the list (possibly very big) in memory, and for the File daemon to do
1282 comparisons between every file in the FileSet and the list. In particular,
1283 if your client has lots of files (more than a few million), you will need
1284 lots of memory on the client machine.
1286 Accurate must not be enabled when backing up with a plugin that is not
1287 specially designed to work with Accurate. If you enable it, your restores
1288 will probably not work correctly.
1290 This project was funded by Bacula Systems.
1295 \index[general]{Copy Jobs}
1297 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1298 existing Migration feature with the exception that the Job that is copied is
1299 left unchanged. This essentially creates two identical copies of the same
1300 backup. However, the copy is treated as a copy rather than a backup job, and
1301 hence is not directly available for restore. The {\bf restore} command lists
1302 copy jobs and allows selection of copies by using \texttt{jobid=}
1303 option. If the keyword {\bf copies} is present on the command line, Bacula will
1304 display the list of all copies for selected jobs.
1309 These JobIds have copies as follows:
1310 +-------+------------------------------------+-----------+------------------+
1311 | JobId | Job | CopyJobId | MediaType |
1312 +-------+------------------------------------+-----------+------------------+
1313 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
1314 +-------+------------------------------------+-----------+------------------+
1315 +-------+-------+----------+----------+---------------------+------------------+
1316 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
1317 +-------+-------+----------+----------+---------------------+------------------+
1318 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1319 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
1320 +-------+-------+----------+----------+---------------------+------------------+
1321 You have selected the following JobIds: 19,2
1323 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1324 5,611 files inserted into the tree.
1329 The Copy Job runs without using the File daemon by copying the data from the
1330 old backup Volume to a different Volume in a different Pool. See the Migration
1331 documentation for additional details. For copy Jobs there is a new selection
1332 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1333 not already copied to another Pool.
1335 As with Migration, the Client, Volume, Job, or SQL query, are
1336 other possible ways of selecting the Jobs to be copied. Selection
1337 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1338 work, but are probably more suited for Migration Jobs.
1340 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1341 it will promote the Copy to a \textsl{real} backup job and will make it available for
1342 automatic restore. If more than one Copy is available, it will promote the copy
1343 with the smallest JobId.
1345 A nice solution which can be built with the new Copy feature is often
1346 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1347 look something like the one below:
1351 Name = FullBackupsVirtualPool
1353 Purge Oldest Volume = Yes
1355 NextPool = FullBackupsTapePool
1359 Name = FullBackupsTapePool
1363 Volume Retention = 365 days
1364 Storage = superloader
1368 # Fake fileset for copy jobs
1380 # Fake client for copy jobs
1390 # Default template for a CopyDiskToTape Job
1393 Name = CopyDiskToTape
1395 Messages = StandardCopy
1398 Selection Type = PoolUncopiedJobs
1399 Maximum Concurrent Jobs = 10
1401 Allow Duplicate Jobs = Yes
1402 Cancel Queued Duplicates = No
1403 Cancel Running Duplicates = No
1408 Name = DaySchedule7:00
1409 Run = Level=Full daily at 7:00
1413 Name = CopyDiskToTapeFullBackups
1415 Schedule = DaySchedule7:00
1416 Pool = FullBackupsVirtualPool
1417 JobDefs = CopyDiskToTape
1421 The example above had 2 pool which are copied using the PoolUncopiedJobs
1422 selection criteria. Normal Full backups go to the Virtual pool and are copied
1423 to the Tape pool the next morning.
1425 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1430 +-------+------------------------------------+-----------+------------------+
1431 | JobId | Job | CopyJobId | MediaType |
1432 +-------+------------------------------------+-----------+------------------+
1433 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1434 +-------+------------------------------------+-----------+------------------+
1437 \section{ACL Updates}
1438 \index[general]{ACL Updates}
1439 The whole ACL code had been overhauled and in this version each platforms has
1440 different streams for each type of acl available on such an platform. As ACLs
1441 between platforms tend to be not that portable (most implement POSIX acls but
1442 some use an other draft or a completely different format) we currently only
1443 allow certain platform specific ACL streams to be decoded and restored on the
1444 same platform that they were created on. The old code allowed to restore ACL
1445 cross platform but the comments already mention that not being to wise. For
1446 backward compatability the new code will accept the two old ACL streams and
1447 handle those with the platform specific handler. But for all new backups it
1448 will save the ACLs using the new streams.
1450 Currently the following platforms support ACLs:
1454 \item {\bf Darwin/OSX}
1463 Currently we support the following ACL types (these ACL streams use a reserved
1464 part of the stream numbers):
1467 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1469 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1470 string representation from acl\_to\_text (POSIX acl)
1471 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1472 string representation from acl\_to\_text (POSIX acl) for default acls.
1473 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1474 string representation from acl\_to\_text (POSIX acl) for access acls.
1475 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1476 string representation from acltostr (POSIX acl)
1477 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1478 representation from acl\_to\_text (POSIX acl) for default acls.
1479 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1480 representation from acl\_to\_text (POSIX acl) for access acls.
1481 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1482 string representation from acl\_to\_text (POSIX acl) for default acls.
1483 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1484 representation from acl\_to\_text (POSIX acl) for access acls.
1485 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1486 string representation from acl\_to\_text (POSIX acl) for default acls.
1487 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1488 string representation from acl\_to\_text (POSIX acl) for default acls.
1489 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1490 representation from acl\_to\_text (POSIX acl) for access acls.
1491 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1492 string representation from acltotext or acl\_totext (POSIX acl)
1493 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1494 representation from from acl\_totext (NFSv4 or ZFS acl)
1497 In future versions we might support conversion functions from one type of acl
1498 into an other for types that are either the same or easily convertable. For now
1499 the streams are seperate and restoring them on a platform that doesn't
1500 recognize them will give you a warning.
1502 \section{Extended Attributes}
1503 \index[general]{Extended Attributes}
1504 Something that was on the project list for some time is now implemented for
1505 platforms that support a similar kind of interface. Its the support for backup
1506 and restore of so called extended attributes. As extended attributes are so
1507 platform specific these attributes are saved in seperate streams for each
1508 platform. Restores of the extended attributes can only be performed on the
1509 same platform the backup was done. There is support for all types of extended
1510 attributes, but restoring from one type of filesystem onto an other type of
1511 filesystem on the same platform may lead to supprises. As extended attributes
1512 can contain any type of data they are stored as a series of so called
1513 value-pairs. This data must be seen as mostly binary and is stored as such.
1514 As security labels from selinux are also extended attributes this option also
1515 stores those labels and no specific code is enabled for handling selinux
1518 Currently the following platforms support extended attributes:
1520 \item {\bf Darwin/OSX}
1526 On linux acls are also extended attributes, as such when you enable ACLs on a
1527 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1528 and not the same exteneded attribute.
1530 To enable the backup of extended attributes please add the following to your
1545 \section{Shared objects}
1546 \index[general]{Shared objects}
1547 A default build of Bacula will now create the libraries as shared objects
1548 (.so) rather than static libraries as was previously the case.
1549 The shared libraries are built using {\bf libtool} so it should be quite
1552 An important advantage of using shared objects is that on a machine with the
1553 Directory, File daemon, the Storage daemon, and a console, you will have only
1554 one copy of the code in memory rather than four copies. Also the total size of
1555 the binary release is smaller since the library code appears only once rather
1556 than once for every program that uses it; this results in significant reduction
1557 in the size of the binaries particularly for the utility tools.
1559 In order for the system loader to find the shared objects when loading the
1560 Bacula binaries, the Bacula shared objects must either be in a shared object
1561 directory known to the loader (typically /usr/lib) or they must be in the
1562 directory that may be specified on the {\bf ./configure} line using the {\bf
1563 {-}{-}libdir} option as:
1566 ./configure --libdir=/full-path/dir
1569 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1570 no need to modify your loader configuration provided that
1571 the shared objects are installed in that directory (Bacula
1572 does this with the make install command). The shared objects
1573 that Bacula references are:
1582 These files are symbolically linked to the real shared object file,
1583 which has a version number to permit running multiple versions of
1584 the libraries if desired (not normally the case).
1586 If you have problems with libtool or you wish to use the old
1587 way of building static libraries, or you want to build a static
1588 version of Bacula you may disable
1589 libtool on the configure command line with:
1592 ./configure --disable-libtool
1596 \section{Building Static versions of Bacula}
1597 \index[general]{Static linking}
1598 In order to build static versions of Bacula, in addition
1599 to configuration options that were needed you now must
1600 also add --disable-libtool. Example
1603 ./configure --enable-static-client-only --disable-libtool
1607 \section{Virtual Backup (Vbackup)}
1608 \index[general]{Virtual Backup}
1609 \index[general]{Vbackup}
1611 Bacula's virtual backup feature is often called Synthetic Backup or
1612 Consolidation in other backup products. It permits you to consolidate the
1613 previous Full backup plus the most recent Differential backup and any
1614 subsequent Incremental backups into a new Full backup. This new Full
1615 backup will then be considered as the most recent Full for any future
1616 Incremental or Differential backups. The VirtualFull backup is
1617 accomplished without contacting the client by reading the previous backup
1618 data and writing it to a volume in a different pool.
1620 In some respects the Vbackup feature works similar to a Migration job, in
1621 that Bacula normally reads the data from the pool specified in the
1622 Job resource, and writes it to the {\bf Next Pool} specified in the
1623 Job resource. Note, this means that usually the output from the Virtual
1624 Backup is written into a different pool from where your prior backups
1625 are saved. Doing it this way guarantees that you will not get a deadlock
1626 situation attempting to read and write to the same volume in the Storage
1627 daemon. If you then want to do subsequent backups, you may need to
1628 move the Virtual Full Volume back to your normal backup pool.
1629 Alternatively, you can set your {\bf Next Pool} to point to the current
1630 pool. This will cause Bacula to read and write to Volumes in the
1631 current pool. In general, this will work, because Bacula will
1632 not allow reading and writing on the same Volume. In any case, once
1633 a VirtualFull has been created, and a restore is done involving the
1634 most current Full, it will read the Volume or Volumes by the VirtualFull
1635 regardless of in which Pool the Volume is found.
1637 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1638 a level of {\bf VirtualFull}.
1640 A typical Job resource definition might look like the following:
1647 FileSet = "Full Set"
1654 # Default pool definition
1658 Recycle = yes # Automatically recycle Volumes
1659 AutoPrune = yes # Prune expired volumes
1660 Volume Retention = 365d # one year
1668 Recycle = yes # Automatically recycle Volumes
1669 AutoPrune = yes # Prune expired volumes
1670 Volume Retention = 365d # one year
1671 Storage = DiskChanger
1674 # Definition of file storage device
1679 Device = FileStorage
1681 Maximum Concurrent Jobs = 5
1684 # Definition of DDS Virtual tape disk storage device
1687 Address = localhost # N.B. Use a fully qualified name here
1689 Device = DiskChanger
1690 Media Type = DiskChangerMedia
1691 Maximum Concurrent Jobs = 4
1696 Then in bconsole or via a Run schedule, you would run the job as:
1699 run job=MyBackup level=Full
1700 run job=MyBackup level=Incremental
1701 run job=MyBackup level=Differential
1702 run job=MyBackup level=Incremental
1703 run job=MyBackup level=Incremental
1706 So providing there were changes between each of those jobs, you would end up
1707 with a Full backup, a Differential, which includes the first Incremental
1708 backup, then two Incremental backups. All the above jobs would be written to
1709 the {\bf Default} pool.
1711 To consolidate those backups into a new Full backup, you would run the
1715 run job=MyBackup level=VirtualFull
1718 And it would produce a new Full backup without using the client, and the output
1719 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1721 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1724 Note, the Start and End time of the Virtual Full backup is set to the
1725 values for the last job included in the Virtual Full (in the above example,
1726 it is an Increment). This is so that if another incremental is done, which
1727 will be based on the Virtual Full, it will backup all files from the
1728 last Job included in the Virtual Full rather than from the time the Virtual
1729 Full was actually run.
1733 \section{Catalog Format}
1734 \index[general]{Catalog Format}
1735 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1736 operation will convert the FileId field of the File table from 32 bits (max 4
1737 billion table entries) to 64 bits (very large number of items). The
1738 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1739 your catalog during the conversion. Also you won't be able to run jobs during
1740 this conversion period. For example, a 3 million file catalog will take 2
1741 minutes to upgrade on a normal machine. Please don't forget to make a valid
1742 backup of your database before executing the upgrade script. See the
1743 ReleaseNotes for additional details.
1745 \section{64 bit Windows Client}
1746 \index[general]{Win64 Client}
1747 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1748 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1749 As a consequence, we are also releasing a 64 bit version of the Bacula
1750 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1751 These binaries should only be installed on 64 bit Windows operating systems.
1752 What is important is not your hardware but whether or not you have
1753 a 64 bit version of the Windows OS.
1755 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1757 \item Before installing the Win64 Bacula Client, you must totally
1758 deinstall any prior 2.4.x Client installation using the
1759 Bacula deinstallation (see the menu item). You may want
1760 to save your .conf files first.
1761 \item Only the Client (File daemon) is ported to Win64, the Director
1762 and the Storage daemon are not in the 64 bit Windows installer.
1763 \item bwx-console is not yet ported.
1764 \item bconsole is ported but it has not been tested.
1765 \item The documentation is not included in the installer.
1766 \item Due to Vista security restrictions imposed on a default installation
1767 of Vista, before upgrading the Client, you must manually stop
1768 any prior version of Bacula from running, otherwise the install
1770 \item Due to Vista security restrictions imposed on a default installation
1771 of Vista, attempting to edit the conf files via the menu items
1772 will fail. You must directly edit the files with appropriate
1773 permissions. Generally double clicking on the appropriate .conf
1774 file will work providing you have sufficient permissions.
1775 \item All Bacula files are now installed in
1776 {\bf C:/Program Files/Bacula} except the main menu items,
1777 which are installed as before. This vastly simplifies the installation.
1778 \item If you are running on a foreign language version of Windows, most
1779 likely {\bf C:/Program Files} does not exist, so you should use the
1780 Custom installation and enter an appropriate location to install
1782 \item The 3.0.0 Win32 Client continues to install files in the locations used
1783 by prior versions. For the next version we will convert it to use
1784 the same installation conventions as the Win64 version.
1787 This project was funded by Bacula Systems.
1790 \section{Duplicate Job Control}
1791 \index[general]{Duplicate Jobs}
1792 The new version of Bacula provides four new directives that
1793 give additional control over what Bacula does if duplicate jobs
1794 are started. A duplicate job in the sense we use it here means
1795 a second or subsequent job with the same name starts. This
1796 happens most frequently when the first job runs longer than expected because no
1797 tapes are available.
1799 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1800 are specified in the Job resource.
1804 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1805 \index[general]{Allow Duplicate Jobs}
1806 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1807 the directive is set to {\bf no} (default) then only one job of a given name
1808 may run at one time, and the action that Bacula takes to ensure only
1809 one job runs is determined by the other directives (see below).
1811 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1812 are present and none of the three directives given below permit
1813 cancelling a job, then the current job (the second one started)
1816 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1817 \index[general]{Allow Higher Duplicates}
1818 This directive was in version 5.0.0, but does not work as
1819 expected. If used, it should always be set to no. In later versions
1820 of Bacula the directive is disabled (disregarded).
1822 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1823 \index[general]{Cancel Running Duplicates}
1824 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1825 if this directive is set to {\bf yes} any job that is already running
1826 will be canceled. The default is {\bf no}.
1828 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1829 \index[general]{Cancel Queued Duplicates}
1830 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1831 if this directive is set to {\bf yes} any job that is
1832 already queued to run but not yet running will be canceled.
1833 The default is {\bf no}.
1836 \section{TLS Authentication}
1837 \index[general]{TLS Authentication}
1838 In Bacula version 2.5.x and later, in addition to the normal Bacula
1839 CRAM-MD5 authentication that is used to authenticate each Bacula
1840 connection, you can specify that you want TLS Authentication as well,
1841 which will provide more secure authentication.
1843 This new feature uses Bacula's existing TLS code (normally used for
1844 communications encryption) to do authentication. To use it, you must
1845 specify all the TLS directives normally used to enable communications
1846 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1849 \subsection{TLS Authenticate = yes}
1851 TLS Authenticate = yes
1854 in the main daemon configuration resource (Director for the Director,
1855 Client for the File daemon, and Storage for the Storage daemon).
1857 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1858 authentication, Bacula will also do TLS authentication, then TLS
1859 encryption will be turned off, and the rest of the communication between
1860 the two Bacula daemons will be done without encryption.
1862 If you want to encrypt communications data, use the normal TLS directives
1863 but do not turn on {\bf TLS Authenticate}.
1865 \section{bextract non-portable Win32 data}
1866 \index[general]{bextract handles Win32 non-portable data}
1867 {\bf bextract} has been enhanced to be able to restore
1868 non-portable Win32 data to any OS. Previous versions were
1869 unable to restore non-portable Win32 data to machines that
1870 did not have the Win32 BackupRead and BackupWrite API calls.
1872 \section{State File updated at Job Termination}
1873 \index[general]{State File}
1874 In previous versions of Bacula, the state file, which provides a
1875 summary of previous jobs run in the {\bf status} command output was
1876 updated only when Bacula terminated, thus if the daemon crashed, the
1877 state file might not contain all the run data. This version of
1878 the Bacula daemons updates the state file on each job termination.
1880 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1881 \index[general]{MaxFullInterval}
1882 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1883 can be used to specify the maximum time interval between {\bf Full} backup
1884 jobs. When a job starts, if the time since the last Full backup is
1885 greater than the specified interval, and the job would normally be an
1886 {\bf Incremental} or {\bf Differential}, it will be automatically
1887 upgraded to a {\bf Full} backup.
1889 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1890 \index[general]{MaxDiffInterval}
1891 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1892 can be used to specify the maximum time interval between {\bf Differential} backup
1893 jobs. When a job starts, if the time since the last Differential backup is
1894 greater than the specified interval, and the job would normally be an
1895 {\bf Incremental}, it will be automatically
1896 upgraded to a {\bf Differential} backup.
1898 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1899 \index[general]{MaxDiffInterval}
1900 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1901 by the user, and when it is set it is an indication to backup programs
1902 to not backup that particular file. This version of Bacula contains a
1903 new Options directive within a FileSet resource, which instructs Bacula to
1904 obey this flag. The new directive is:
1907 Honor No Dump Flag = yes\vb{}no
1910 The default value is {\bf no}.
1913 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1914 \index[general]{IgnoreDir}
1915 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1916 can be added to the Include section of the FileSet resource. If the specified
1917 filename ({\bf filename-string}) is found on the Client in any directory to be
1918 backed up, the whole directory will be ignored (not backed up). For example:
1921 # List of files to be backed up
1929 Exclude Dir Containing = .excludeme
1934 But in /home, there may be hundreds of directories of users and some
1935 people want to indicate that they don't want to have certain
1936 directories backed up. For example, with the above FileSet, if
1937 the user or sysadmin creates a file named {\bf .excludeme} in
1938 specific directories, such as
1941 /home/user/www/cache/.excludeme
1942 /home/user/temp/.excludeme
1945 then Bacula will not backup the two directories named:
1948 /home/user/www/cache
1952 NOTE: subdirectories will not be backed up. That is, the directive
1953 applies to the two directories in question and any children (be they
1954 files, directories, etc).
1957 \section{Bacula Plugins}
1958 \index[general]{Plugin}
1959 Support for shared object plugins has been implemented in the Linux, Unix
1960 and Win32 File daemons. The API will be documented separately in
1961 the Developer's Guide or in a new document. For the moment, there is
1962 a single plugin named {\bf bpipe} that allows an external program to
1963 get control to backup and restore a file.
1965 Plugins are also planned (partially implemented) in the Director and the
1968 \subsection{Plugin Directory}
1969 \index[general]{Plugin Directory}
1970 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
1971 be added to the daemon definition resource. The directory takes a quoted
1972 string argument, which is the name of the directory in which the daemon can
1973 find the Bacula plugins. If this directive is not specified, Bacula will not
1974 load any plugins. Since each plugin has a distinctive name, all the daemons
1975 can share the same plugin directory.
1977 \subsection{Plugin Options}
1978 \index[general]{Plugin Options}
1979 The {\bf Plugin Options} directive takes a quoted string
1980 arguement (after the equal sign) and may be specified in the
1981 Job resource. The options specified will be passed to all plugins
1982 when they are run. This each plugin must know what it is looking
1983 for. The value defined in the Job resource can be modified
1984 by the user when he runs a Job via the {\bf bconsole} command line
1987 Note: this directive may be specified, and there is code to modify
1988 the string in the run command, but the plugin options are not yet passed to
1989 the plugin (i.e. not fully implemented).
1991 \subsection{Plugin Options ACL}
1992 \index[general]{Plugin Options ACL}
1993 The {\bf Plugin Options ACL} directive may be specified in the
1994 Director's Console resource. It functions as all the other ACL commands
1995 do by permitting users running restricted consoles to specify a
1996 {\bf Plugin Options} that overrides the one specified in the Job
1997 definition. Without this directive restricted consoles may not modify
2000 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
2001 \index[general]{Plugin}
2002 The {\bf Plugin} directive is specified in the Include section of
2003 a FileSet resource where you put your {\bf File = xxx} directives.
2014 Plugin = "bpipe:..."
2019 In the above example, when the File daemon is processing the directives
2020 in the Include section, it will first backup all the files in {\bf /home}
2021 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2022 the Plugin Directory. The syntax and semantics of the Plugin directive
2023 require the first part of the string up to the colon (:) to be the name
2024 of the plugin. Everything after the first colon is ignored by the File daemon but
2025 is passed to the plugin. Thus the plugin writer may define the meaning of the
2026 rest of the string as he wishes.
2028 Please see the next section for information about the {\bf bpipe} Bacula
2031 \section{The bpipe Plugin}
2032 \index[general]{The bpipe Plugin}
2033 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2034 the Bacula source distribution. When the plugin is compiled and linking into
2035 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2036 Please note that this is a very simple plugin that was written for
2037 demonstration and test purposes. It is and can be used in production, but
2038 that was never really intended.
2040 The purpose of the plugin is to provide an interface to any system program for
2041 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2042 the Include section of your Job's FileSet resource. The full syntax of the
2043 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2044 to specify the sytax as it wishes) is:
2047 Plugin = "<field1>:<field2>:<field3>:<field4>"
2052 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2053 stripped off, so in this case, we would put {\bf bpipe} in this field.
2055 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2056 pseudo path and filename under which the backup will be saved. This pseudo
2057 path and filename will be seen by the user in the restore file tree.
2058 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2059 backed up by the plugin will be put under that "pseudo" path and filename.
2060 You must be careful to choose a naming convention that is unique to avoid
2061 a conflict with a path and filename that actually exists on your system.
2063 \item {\bf field3} for the {\bf bpipe} plugin
2064 specifies the "reader" program that is called by the plugin during
2065 backup to read the data. {\bf bpipe} will call this program by doing a
2068 \item {\bf field4} for the {\bf bpipe} plugin
2069 specifies the "writer" program that is called by the plugin during
2070 restore to write the data back to the filesystem.
2073 Please note that for two items above describing the "reader" and "writer"
2074 fields, these programs are "executed" by Bacula, which
2075 means there is no shell interpretation of any command line arguments
2076 you might use. If you want to use shell characters (redirection of input
2077 or output, ...), then we recommend that you put your command or commands
2078 in a shell script and execute the script. In addition if you backup a
2079 file with the reader program, when running the writer program during
2080 the restore, Bacula will not automatically create the path to the file.
2081 Either the path must exist, or you must explicitly do so with your command
2082 or in a shell script.
2084 Putting it all together, the full plugin directive line might look
2088 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
2089 --opt --databases bacula:mysql"
2092 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2093 would be written on a single line.
2095 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2096 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
2097 program {\bf mysqldump -f --opt --database bacula} to read the data during
2098 backup. The mysqldump command outputs all the data for the database named
2099 {\bf bacula}, which will be read by the plugin and stored in the backup.
2100 During restore, the data that was backed up will be sent to the program
2101 specified in the last field, which in this case is {\bf mysql}. When
2102 {\bf mysql} is called, it will read the data sent to it by the plugn
2103 then write it back to the same database from which it came ({\bf bacula}
2106 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2107 the data from a specified program to Bacula for backup, and then from Bacula to
2108 a specified program for restore.
2110 By using different command lines to {\bf bpipe},
2111 you can backup any kind of data (ASCII or binary) depending
2112 on the program called.
2114 \section{Microsoft Exchange Server 2003/2007 Plugin}
2115 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
2116 \subsection{Background}
2117 The Exchange plugin was made possible by a funded development project
2118 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2119 The code for the plugin was written by James Harper, and the Bacula core
2120 code by Kern Sibbald. All the code for this funded development has become
2121 part of the Bacula project. Thanks to everyone who made it happen.
2123 \subsection{Concepts}
2124 Although it is possible to backup Exchange using Bacula VSS the Exchange
2125 plugin adds a good deal of functionality, because while Bacula VSS
2126 completes a full backup (snapshot) of Exchange, it does
2127 not support Incremental or Differential backups, restoring is more
2128 complicated, and a single database restore is not possible.
2130 Microsoft Exchange organises its storage into Storage Groups with
2131 Databases inside them. A default installation of Exchange will have a
2132 single Storage Group called 'First Storage Group', with two Databases
2133 inside it, "Mailbox Store (SERVER NAME)" and
2134 "Public Folder Store (SERVER NAME)",
2135 which hold user email and public folders respectively.
2137 In the default configuration, Exchange logs everything that happens to
2138 log files, such that if you have a backup, and all the log files since,
2139 you can restore to the present time. Each Storage Group has its own set
2140 of log files and operates independently of any other Storage Groups. At
2141 the Storage Group level, the logging can be turned off by enabling a
2142 function called "Enable circular logging". At this time the Exchange
2143 plugin will not function if this option is enabled.
2145 The plugin allows backing up of entire storage groups, and the restoring
2146 of entire storage groups or individual databases. Backing up and
2147 restoring at the individual mailbox or email item is not supported but
2148 can be simulated by use of the "Recovery" Storage Group (see below).
2150 \subsection{Installing}
2151 The Exchange plugin requires a DLL that is shipped with Microsoft
2152 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2153 correctly the Exchange plugin should find this automatically and run
2154 without any additional installation.
2156 If the DLL can not be found automatically it will need to be copied into
2157 the Bacula installation
2158 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
2159 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
2160 default Exchange installation.
2162 \subsection{Backing Up}
2163 To back up an Exchange server the Fileset definition must contain at
2164 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2165 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2166 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2167 up files are prefixed with something that isn't going to share a name
2168 with something outside the plugin, and the 'Microsoft Information Store'
2169 bit is required also. It is also possible to add the name of a storage
2170 group to the "Plugin =" line, eg \\
2171 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2172 if you want only a single storage group backed up.
2174 Additionally, you can suffix the 'Plugin =' directive with
2175 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2176 database at the end of a full backup.
2178 An Incremental or Differential backup will backup only the database logs
2179 for each Storage Group by inspecting the "modified date" on each
2180 physical log file. Because of the way the Exchange API works, the last
2181 logfile backed up on each backup will always be backed up by the next
2182 Incremental or Differential backup too. This adds 5MB to each
2183 Incremental or Differential backup size but otherwise does not cause any
2186 By default, a normal VSS fileset containing all the drive letters will
2187 also back up the Exchange databases using VSS. This will interfere with
2188 the plugin and Exchange's shared ideas of when the last full backup was
2189 done, and may also truncate log files incorrectly. It is important,
2190 therefore, that the Exchange database files be excluded from the backup,
2191 although the folders the files are in should be included, or they will
2192 have to be recreated manually if a baremetal restore is done.
2197 File = C:/Program Files/Exchsrvr/mdbdata
2198 Plugin = "exchange:..."
2201 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2202 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2203 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2204 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2205 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2206 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2207 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2212 The advantage of excluding the above files is that you can significantly
2213 reduce the size of your backup since all the important Exchange files
2214 will be properly saved by the Plugin.
2217 \subsection{Restoring}
2218 The restore operation is much the same as a normal Bacula restore, with
2219 the following provisos:
2222 \item The {\bf Where} restore option must not be specified
2223 \item Each Database directory must be marked as a whole. You cannot just
2224 select (say) the .edb file and not the others.
2225 \item If a Storage Group is restored, the directory of the Storage Group
2227 \item It is possible to restore only a subset of the available log files,
2228 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2229 if a log file is missing from the sequence of log files
2230 \item Each database to be restored must be dismounted and marked as "Can be
2231 overwritten by restore"
2232 \item If an entire Storage Group is to be restored (eg all databases and
2233 logs in the Storage Group), then it is best to manually delete the
2234 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
2235 as Exchange can get confused by stray log files lying around.
2238 \subsection{Restoring to the Recovery Storage Group}
2239 The concept of the Recovery Storage Group is well documented by
2241 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2242 but to briefly summarize...
2244 Microsoft Exchange allows the creation of an additional Storage Group
2245 called the Recovery Storage Group, which is used to restore an older
2246 copy of a database (e.g. before a mailbox was deleted) into without
2247 messing with the current live data. This is required as the Standard and
2248 Small Business Server versions of Exchange can not ordinarily have more
2249 than one Storage Group.
2251 To create the Recovery Storage Group, drill down to the Server in Exchange
2252 System Manager, right click, and select
2253 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
2254 locations and click OK. On the Recovery Storage Group, right click and
2255 select {\bf "Add Database to Recover..."} and select the database you will
2258 Restore only the single database nominated as the database in the
2259 Recovery Storage Group. Exchange will redirect the restore to the
2260 Recovery Storage Group automatically.
2261 Then run the restore.
2263 \subsection{Restoring on Microsoft Server 2007}
2264 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2265 2007, and henc you use a new proceedure for recovering a single mail box.
2266 This procedure is ducomented by Microsoft at:
2267 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2268 and involves using the {\bf Restore-Mailbox} and {\bf
2269 Get-MailboxStatistics} shell commands.
2271 \subsection{Caveats}
2272 This plugin is still being developed, so you should consider it
2273 currently in BETA test, and thus use in a production environment
2274 should be done only after very careful testing.
2276 When doing a full backup, the Exchange database logs are truncated by
2277 Exchange as soon as the plugin has completed the backup. If the data
2278 never makes it to the backup medium (eg because of spooling) then the
2279 logs will still be truncated, but they will also not have been backed
2280 up. A solution to this is being worked on. You will have to schedule a
2281 new Full backup to ensure that your next backups will be usable.
2283 The "Enable Circular Logging" option cannot be enabled or the plugin
2286 Exchange insists that a successful Full backup must have taken place if
2287 an Incremental or Differential backup is desired, and the plugin will
2288 fail if this is not the case. If a restore is done, Exchange will
2289 require that a Full backup be done before an Incremental or Differential
2292 The plugin will most likely not work well if another backup application
2293 (eg NTBACKUP) is backing up the Exchange database, especially if the
2294 other backup application is truncating the log files.
2296 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2297 we recommend either carefully testing or that you avoid this option for
2300 The Exchange plugin is not called during processing the bconsole {\bf
2301 estimate} command, and so anything that would be backed up by the plugin
2302 will not be added to the estimate total that is displayed.
2305 \section{libdbi Framework}
2306 \index[general]{libdbi Framework}
2307 As a general guideline, Bacula has support for a few catalog database drivers
2308 (MySQL, PostgreSQL, SQLite)
2309 coded natively by the Bacula team. With the libdbi implementation, which is a
2310 Bacula driver that uses libdbi to access the catalog, we have an open field to
2311 use many different kinds database engines following the needs of users.
2313 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
2314 implements a database-independent abstraction layer in C, similar to the
2315 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2316 leverage the power of multiple databases and multiple simultaneous database
2317 connections by using this framework.
2319 Currently the libdbi driver in Bacula project only supports the same drivers
2320 natively coded in Bacula. However the libdbi project has support for many
2321 others database engines. You can view the list at
2322 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2323 supported by Bacula, however, they must be tested properly by the Bacula team.
2325 Some of benefits of using libdbi are:
2327 \item The possibility to use proprietary databases engines in which your
2328 proprietary licenses prevent the Bacula team from developing the driver.
2329 \item The possibility to use the drivers written for the libdbi project.
2330 \item The possibility to use other database engines without recompiling Bacula
2331 to use them. Just change one line in bacula-dir.conf
2332 \item Abstract Database access, this is, unique point to code and profiling
2333 catalog database access.
2336 The following drivers have been tested:
2338 \item PostgreSQL, with and without batch insert
2339 \item Mysql, with and without batch insert
2344 In the future, we will test and approve to use others databases engines
2345 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2347 To compile Bacula to support libdbi we need to configure the code with the
2348 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2349 [database] is the database engine to be used with Bacula (of course we can
2350 change the driver in file bacula-dir.conf, see below). We must configure the
2351 access port of the database engine with the option --with-db-port, because the
2352 libdbi framework doesn't know the default access port of each database.
2354 The next phase is checking (or configuring) the bacula-dir.conf, example:
2358 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2359 dbname = regress; user = regress; password = ""
2363 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2364 mysql database. Currently the drivers supported by Bacula are: postgresql,
2365 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2367 The following limitations apply when Bacula is set to use the libdbi framework:
2368 - Not tested on the Win32 platform
2369 - A little performance is lost if comparing with native database driver.
2370 The reason is bound with the database driver provided by libdbi and the
2371 simple fact that one more layer of code was added.
2373 It is important to remember, when compiling Bacula with libdbi, the
2374 following packages are needed:
2376 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2377 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2380 You can download them and compile them on your system or install the packages
2381 from your OS distribution.
2383 \section{Console Command Additions and Enhancements}
2384 \index[general]{Console Additions}
2386 \subsection{Display Autochanger Content}
2387 \index[general]{StatusSlots}
2389 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2390 autochanger content.
2394 Slot | Volume Name | Status | Media Type | Pool |
2395 ------+---------------+----------+-------------------+------------|
2396 1 | 00001 | Append | DiskChangerMedia | Default |
2397 2 | 00002 | Append | DiskChangerMedia | Default |
2398 3*| 00003 | Append | DiskChangerMedia | Scratch |
2403 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2404 {\bf update slots} command to synchronize autochanger content with your
2407 \subsection{list joblog job=xxx or jobid=nnn}
2408 \index[general]{list joblog}
2409 A new list command has been added that allows you to list the contents
2410 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2411 or for a particular JobId. The {\bf llist} command will include a line with
2412 the time and date of the entry.
2414 Note for the catalog to have Job Log entries, you must have a directive
2421 In your Director's {\bf Messages} resource.
2423 \subsection{Use separator for multiple commands}
2424 \index[general]{Command Separator}
2425 When using bconsole with readline, you can set the command separator with
2426 \textbf{@separator} command to one
2427 of those characters to write commands who require multiple input in one line.
2429 !$%&'()*+,-/:;<>?[]^`{|}~
2432 \subsection{Deleting Volumes}
2433 The delete volume bconsole command has been modified to
2434 require an asterisk (*) in front of a MediaId otherwise the
2435 value you enter is a taken to be a Volume name. This is so that
2436 users may delete numeric Volume names. The previous Bacula versions
2437 assumed that all input that started with a number was a MediaId.
2439 This new behavior is indicated in the prompt if you read it
2442 \section{Bare Metal Recovery}
2443 The old bare metal recovery project is essentially dead. One
2444 of the main features of it was that it would build a recovery
2445 CD based on the kernel on your system. The problem was that
2446 every distribution has a different boot procedure and different
2447 scripts, and worse yet, the boot procedures and scripts change
2448 from one distribution to another. This meant that maintaining
2449 (keeping up with the changes) the rescue CD was too much work.
2451 To replace it, a new bare metal recovery USB boot stick has been developed
2452 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2453 boot from a USB key.
2457 \item Recovery can be done from within graphical environment.
2458 \item Recovery can be done in a shell.
2459 \item Ubuntu boots on a large number of Linux systems.
2460 \item The process of updating the system and adding new
2461 packages is not too difficult.
2462 \item The USB key can easily be upgraded to newer Ubuntu versions.
2463 \item The USB key has writable partitions for modifications to
2464 the OS and for modification to your home directory.
2465 \item You can add new files/directories to the USB key very easily.
2466 \item You can save the environment from multiple machines on
2468 \item Bacula Systems is funding its ongoing development.
2471 The disadvantages are:
2473 \item The USB key is usable but currently under development.
2474 \item Not everyone may be familiar with Ubuntu (no worse
2476 \item Some older OSes cannot be booted from USB. This can
2477 be resolved by first booting a Ubuntu LiveCD then plugging
2479 \item Currently the documentation is sketchy and not yet added
2480 to the main manual. See below ...
2483 The documentation and the code can be found in the {\bf rescue} package
2484 in the directory {\bf linux/usb}.
2486 \section{Miscellaneous}
2487 \index[general]{Misc New Features}
2489 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2490 \index[general]{Allow Mixed Priority}
2491 This directive is only implemented in version 2.5 and later. When
2492 set to {\bf yes} (default {\bf no}), this job may run even if lower
2493 priority jobs are already running. This means a high priority job
2494 will not have to wait for other jobs to finish before starting.
2495 The scheduler will only mix priorities when all running jobs have
2498 Note that only higher priority jobs will start early. Suppose the
2499 director will allow two concurrent jobs, and that two jobs with
2500 priority 10 are running, with two more in the queue. If a job with
2501 priority 5 is added to the queue, it will be run as soon as one of
2502 the running jobs finishes. However, new priority 10 jobs will not
2503 be run until the priority 5 job has finished.
2505 \subsection{Bootstrap File Directive -- FileRegex}
2506 \index[general]{Bootstrap File Directive}
2507 {\bf FileRegex} is a new command that can be added to the bootstrap
2508 (.bsr) file. The value is a regular expression. When specified, only
2509 matching filenames will be restored.
2511 During a restore, if all File records are pruned from the catalog
2512 for a Job, normally Bacula can restore only all files saved. That
2513 is there is no way using the catalog to select individual files.
2514 With this new feature, Bacula will ask if you want to specify a Regex
2515 expression for extracting only a part of the full backup.
2518 Building directory tree for JobId(s) 1,3 ...
2519 There were no files inserted into the tree, so file selection
2520 is not possible.Most likely your retention policy pruned the files
2522 Do you want to restore all the files? (yes\vb{}no): no
2524 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2525 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2528 \subsection{Bootstrap File Optimization Changes}
2529 In order to permit proper seeking on disk files, we have extended the bootstrap
2530 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2531 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2532 address range and end address range respectively. These two directives replace
2533 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2534 VolEndBlock} directives. Bootstrap files containing the old directives will
2535 still work, but will not properly take advantage of proper disk seeking, and
2536 may read completely to the end of a disk volume during a restore. With the new
2537 format (automatically generated by the new Director), restores will seek
2538 properly and stop reading the volume when all the files have been restored.
2540 \subsection{Solaris ZFS/NFSv4 ACLs}
2541 This is an upgrade of the previous Solaris ACL backup code
2542 to the new library format, which will backup both the old
2543 POSIX(UFS) ACLs as well as the ZFS ACLs.
2545 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2546 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2547 be used to transfer from UFS to ZFS filesystems.
2550 \subsection{Virtual Tape Emulation}
2551 \index[general]{Virtual Tape Emulation}
2552 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2553 the tape code but actually reading and writing to a disk file. Used with the
2554 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2555 and 700 slots. This feature is most useful in testing. It is enabled
2556 by using {\bf Device Type = vtape} in the Storage daemon's Device
2557 directive. This feature is only implemented on Linux machines and should not be
2558 used for production.
2560 \subsection{Bat Enhancements}
2561 \index[general]{Bat Enhancements}
2562 Bat (the Bacula Administration Tool) GUI program has been significantly
2563 enhanced and stabilized. In particular, there are new table based status
2564 commands; it can now be easily localized using Qt4 Linguist.
2566 The Bat communications protocol has been significantly enhanced to improve
2567 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2568 the Director you are using otherwise the communications protocol will not
2571 \subsection{RunScript Enhancements}
2572 \index[general]{RunScript Enhancements}
2573 The {\bf RunScript} resource has been enhanced to permit multiple
2574 commands per RunScript. Simply specify multiple {\bf Command} directives
2581 Command = "/bin/echo test"
2582 Command = "/bin/echo an other test"
2583 Command = "/bin/echo 3 commands in the same runscript"
2590 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2591 implemented, which runs the command after the Volume Shadow Copy has been made.
2593 Console commands can be specified within a RunScript by using:
2594 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2595 carefully tested and debugged and is known to easily crash the Director.
2596 We would appreciate feedback. Due to the recursive nature of this command, we
2597 may remove it before the final release.
2599 \subsection{Status Enhancements}
2600 \index[general]{Status Enhancements}
2601 The bconsole {\bf status dir} output has been enhanced to indicate
2602 Storage daemon job spooling and despooling activity.
2604 \subsection{Connect Timeout}
2605 \index[general]{Connect Timeout}
2606 The default connect timeout to the File
2607 daemon has been set to 3 minutes. Previously it was 30 minutes.
2609 \subsection{ftruncate for NFS Volumes}
2610 \index[general]{ftruncate for NFS Volumes}
2611 If you write to a Volume mounted by NFS (say on a local file server),
2612 in previous Bacula versions, when the Volume was recycled, it was not
2613 properly truncated because NFS does not implement ftruncate (file
2614 truncate). This is now corrected in the new version because we have
2615 written code (actually a kind user) that deletes and recreates the Volume,
2616 thus accomplishing the same thing as a truncate.
2618 \subsection{Support for Ubuntu}
2619 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2620 version of Linux, and thus now provides correct autostart routines.
2621 Since Ubuntu officially supports Bacula, you can also obtain any
2622 recent release of Bacula from the Ubuntu repositories.
2624 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2625 \index[general]{Recycle Pool}
2626 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2627 be placed (moved) when it is recycled. Without this directive, a Volume will
2628 remain in the same pool when it is recycled. With this directive, it can be
2629 moved automatically to any existing pool during a recycle. This directive is
2630 probably most useful when defined in the Scratch pool, so that volumes will
2631 be recycled back into the Scratch pool.
2633 \subsection{FD Version}
2634 \index[general]{FD Version}
2635 The File daemon to Director protocol now includes a version
2636 number, which although there is no visible change for users,
2637 will help us in future versions automatically determine
2638 if a File daemon is not compatible.
2640 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2641 \index[general]{Max Run Sched Time}
2642 The time specifies the maximum allowed time that a job may run, counted from
2643 when the job was scheduled. This can be useful to prevent jobs from running
2644 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2647 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2648 \index[general]{Max Wait Time}
2649 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2650 of checking the maximum allowed time that a job may block for a resource,
2651 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2652 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2653 their job depending on the level. Now, they have to use
2654 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2655 directives are now deprecated.
2657 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2658 \index[general]{Incremental Max Wait Time}
2659 \index[general]{Differential Max Wait Time}
2661 These directives have been deprecated in favor of
2662 \texttt{Incremental|Differential Max Run Time}.
2664 \subsection{Max Run Time directives}
2665 \index[general]{Max Run Time directives}
2666 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2667 maximum allowed time that a job can run depending on the level.
2669 \addcontentsline{lof}{figure}{Job time control directives}
2670 \includegraphics{\idir different_time.eps}
2672 \subsection{Statistics Enhancements}
2673 \index[general]{Statistics Enhancements}
2674 If you (or probably your boss) want to have statistics on your backups to
2675 provide some \textit{Service Level Agreement} indicators, you could use a few
2676 SQL queries on the Job table to report how many:
2680 \item jobs have been successful
2681 \item files have been backed up
2685 However, these statistics are accurate only if your job retention is greater
2686 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2687 be able to use them.
2689 Now, you can use the \textbf{update stats [days=num]} console command to fill
2690 the JobHistory table with new Job records. If you want to be sure to take in
2691 account only \textbf{good jobs}, ie if one of your important job has failed but
2692 you have fixed the problem and restarted it on time, you probably want to
2693 delete the first \textit{bad} job record and keep only the successful one. For
2694 that simply let your staff do the job, and update JobHistory table after two or
2695 three days depending on your organization using the \textbf{[days=num]} option.
2697 These statistics records aren't used for restoring, but mainly for
2698 capacity planning, billings, etc.
2700 The Bweb interface provides a statistics module that can use this feature. You
2701 can also use tools like Talend or extract information by yourself.
2703 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2704 the length of time that Bacula will keep statistics job records in the Catalog
2705 database after the Job End time. (In \texttt{JobHistory} table) When this time
2706 period expires, and if user runs \texttt{prune stats} command, Bacula will
2707 prune (remove) Job records that are older than the specified period.
2709 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2710 job to maintain statistics.
2713 Name = BackupCatalog
2716 Console = "update stats days=3"
2717 Console = "prune stats yes"
2724 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2725 \index[general]{ScratchPool}
2726 This directive permits to specify a specific \textsl{Scratch} pool for the
2727 current pool. This is useful when using multiple storage sharing the same
2728 mediatype or when you want to dedicate volumes to a particular set of pool.
2730 \subsection{Enhanced Attribute Despooling}
2731 \index[general]{Attribute Despooling}
2732 If the storage daemon and the Director are on the same machine, the spool file
2733 that contains attributes is read directly by the Director instead of being
2734 transmitted across the network. That should reduce load and speedup insertion.
2736 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2737 \index[general]{SpoolSize}
2738 A new Job directive permits to specify the spool size per job. This is used
2739 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2741 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2742 \index[general]{MaximumConsoleConnections}
2743 A new director directive permits to specify the maximum number of Console
2744 Connections that could run concurrently. The default is set to 20, but you may
2745 set it to a larger number.
2747 \subsection{VerId = \lt{}string\gt{}}
2748 \index[general]{VerId}
2749 A new director directive permits to specify a personnal identifier that will be
2750 displayed in the \texttt{version} command.
2752 \subsection{dbcheck enhancements}
2753 \index[general]{dbcheck enhancements}
2754 If you are using Mysql, dbcheck will now ask you if you want to create
2755 temporary indexes to speed up orphaned Path and Filename elimination.
2757 A new \texttt{-B} option allows you to print catalog information in a simple
2758 text based format. This is useful to backup it in a secure way.
2773 You can now specify the database connection port in the command line.
2775 \subsection{{-}{-}docdir configure option}
2776 \index[general]{{-}{-}docdir configure option}
2777 You can use {-}{-}docdir= on the ./configure command to
2778 specify the directory where you want Bacula to install the
2779 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2780 {\bf /usr/share/doc/bacula}.
2782 \subsection{{-}{-}htmldir configure option}
2783 \index[general]{{-}{-}htmldir configure option}
2784 You can use {-}{-}htmldir= on the ./configure command to
2785 specify the directory where you want Bacula to install the bat html help
2786 files. The default is {\bf /usr/share/doc/bacula/html}
2788 \subsection{{-}{-}with-plugindir configure option}
2789 \index[general]{{-}{-}plugindir configure option}
2790 You can use {-}{-}plugindir= on the ./configure command to
2791 specify the directory where you want Bacula to install
2792 the plugins (currently only bpipe-fd). The default is