1 \chapter{New Features in 5.1.x}
2 This chapter presents the new features that have been added to the
3 current version of Bacula that is under development. This version will be
4 released at some later date, probably near the end of 2010.
6 \section{Restart Incomplete Job}
10 This project was funded by Bacula Systems and is available with Bacula
11 Enterprise Edition and Community Edition.
13 \section{New Tray Monitor}
15 As the default Windows tray monitor doesn't work anymore with recent windows
16 version, we added a new QT Tray Monitor that is available for both Linux and
17 Windows. This new version allows you to run Backup from the menu.
21 \includegraphics[width=10cm]{\idir tray-monitor}
22 \label{fig:traymonitor}
23 \caption{New tray monitor}
28 \includegraphics[width=10cm]{\idir tray-monitor1}
29 \label{fig:traymonitor1}
30 \caption{Run a Job through the new tray monitor}
34 This project was funded by Bacula Systems and is available with Bacula
35 Enterprise Edition and Community Edition.
37 \section{Purge Migration Job when Completed}
39 A new directive may be added to the Migration Job definition in the Director
40 configuration file to purge the job migrated at the end of a migration.
54 Selection Pattern = ".*Save"
56 Purge Migrated Job = yes
62 This project was submited by Dunlap Blake, testing and documentation was funded
65 \section{Job Bandwidth Limitation}
67 A new directive may be added to FileDaemon or Director to allow users to limit
68 the bandwidth used by a Job on a Client. It can be set for all Jobs globally,
69 per Directors in the File Daemon configuration, or per Job in the Director
76 Working Directory = /some/path
77 Pid Directory = /some/path
79 Maximum Bandwidth Per Job = 5MB/s
83 The above example would cause any jobs running with the FileDaemon to not
84 exceed 5MB/s of throughput when sending data to the Storage Daemon.
86 You can specify the speed parameter in k/s, KB/s, m/s, MB/s.
92 FileSet = FS_localhost
95 Maximum Bandwidth = 5MB/s
100 The above example would cause job \texttt{localhost-data} to not exceed 5MB/s
101 of throughput when sending data to the Storage Daemon.
103 A new console command \texttt{setbandwidth} permits to set dynamically the
104 maximum throughput of a running Job or for future jobs of a Client.
107 * setbandwidth limit=1000000 jobid=10
110 The \texttt{limit} parameter is in KB/s.
113 This project was funded by Bacula Systems and is available with Bacula
114 Enterprise Edition and Community Edition.
116 \section{Support for MSSQL Block Level Backup}
118 This project was funded by Bacula Systems and is available with Bacula
121 \section{Support for NDMP protocol}
123 The new \texttt{ndmp} Plugin is able to backup a NAS through NDMP protocol
124 using \textbf{Filer to server} approach, where the Filer is backing up across
125 the LAN to your Bacula server.
127 Accurate option should be turned on in the Job resource.
139 Plugin = "ndmp:host=nasbox user=root pass=root file=/vol/vol1"
144 This project was funded by Bacula Systems and is available with Bacula
147 \section{Incremental/Differential Block Level Difference Backup}
149 The new \texttt{delta} Plugin is able to compute and apply signature-based file
150 differences. It can be used to backup only changes in a big binary file like
151 Outlook PST, VirtualBox/VmWare images or database files.
153 It supports both Incremental and Differential backups and stores signatures
154 database in the File Daemon working directory. This plugin is available on all
155 plateform including Windows 32 and 64bit.
157 Accurate option should be turned on in the Job resource.
169 Plugin = "delta:/home/eric/.VirtualBox/HardDisks/lenny-i386.vdi"
174 This project was funded by Bacula Systems and is available with Bacula
177 \section{Include All Windows Drives in FileSet}
179 The \texttt{alldrives} Windows Plugin allows you to include all local drives
180 with a simple directive. This plugin is available for Windows 64 and 32 bit.
192 You exclude some specific drives with the \texttt{exclude} option.
199 Plugin = "alldrives: exclude=D,E"
205 This project was funded by Bacula Systems and is available with Bacula
208 \section{Changes in Bvfs (Bacula Virtual FileSystem)}
210 Bat has now a bRestore panel that uses Bvfs to display files and
211 directories. It's still experimental.
215 \includegraphics[width=12cm]{\idir bat-brestore}
216 \label{fig:batbrestore}
217 \caption{Bat Brestore Panel}
220 \texttt{Important}, the Bvfs module is not currently compatible with BaseJobs,
221 Copy and Migration jobs.
224 This project was funded by Bacula Systems.
226 \subsection*{General notes}
229 \item All fields are separated by a tab
230 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
231 records in very big directories
232 \item All operations (except cache creation) are designed to run instantly
233 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
234 can contribute new faster SQL queries we will be happy, else don't complain
236 \item The cache creation is dependent of the number of directories. As Bvfs
237 shares information accross jobs, the first creation can be slow
238 \item All fields are separated by a tab
239 \item Due to potential encoding problem, it's advised to allways use pathid in
243 \subsection*{Get dependent jobs from a given JobId}
245 Bvfs allows you to query the catalog against any combination of jobs. You
246 can combine all Jobs and all FileSet for a Client in a single session.
248 To get all JobId needed to restore a particular job, you can use the
249 \texttt{.bvfs\_get\_jobids} command.
252 .bvfs_get_jobids jobid=num [all]
256 .bvfs_get_jobids jobid=10
258 .bvfs_get_jobids jobid=10 all
262 In this example, a normal restore will need to use JobIds 1,2,5,10 to
263 compute a complete restore of the system.
265 With the \texttt{all} option, the Director will use all defined FileSet for
268 \subsection*{Generating Bvfs cache}
270 The \texttt{.bvfs\_update} command computes the directory cache for jobs
271 specified in argument, or for all jobs if unspecified.
274 .bvfs_update [jobid=numlist]
279 .bvfs_update jobid=1,2,3
282 You can run the cache update process in a RunScript after the catalog backup.
284 \subsection*{Get all versions of a specific file}
286 Bvfs allows you to find all versions of a specific file for a given Client with
287 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
288 function uses only PathId and FilenameId. The jobid argument is mandatory but
292 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
293 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
294 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
301 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
302 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
305 \subsection*{List directories}
307 Bvfs allows you to list directories in a specific path.
309 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
310 PathId FilenameId FileId JobId LStat Path
311 PathId FilenameId FileId JobId LStat Path
312 PathId FilenameId FileId JobId LStat Path
316 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
317 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
318 listed is a directory.
321 .bvfs_lsdirs pathid=4 jobid=1,11,12
322 4 0 0 0 A A A A A A A A A A A A A A .
323 5 0 0 0 A A A A A A A A A A A A A A ..
324 3 0 0 0 A A A A A A A A A A A A A A regress/
327 In this example, to list directories present in \texttt{regress/}, you can use
329 .bvfs_lsdirs pathid=3 jobid=1,11,12
330 3 0 0 0 A A A A A A A A A A A A A A .
331 4 0 0 0 A A A A A A A A A A A A A A ..
332 2 0 0 0 A A A A A A A A A A A A A A tmp/
335 \subsection*{List files}
337 Bvfs allows you to list files in a specific path.
339 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
340 PathId FilenameId FileId JobId LStat Path
341 PathId FilenameId FileId JobId LStat Path
342 PathId FilenameId FileId JobId LStat Path
346 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
347 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
351 .bvfs_lsfiles pathid=4 jobid=1,11,12
352 4 0 0 0 A A A A A A A A A A A A A A .
353 5 0 0 0 A A A A A A A A A A A A A A ..
354 1 0 0 0 A A A A A A A A A A A A A A regress/
357 In this example, to list files present in \texttt{regress/}, you can use
359 .bvfs_lsfiles pathid=1 jobid=1,11,12
360 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
361 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
362 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
363 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
364 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
367 \subsection*{Restore set of files}
369 Bvfs allows you to create a SQL table that contains files that you want to
370 restore. This table can be provided to a restore command with the file option.
373 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
375 restore file=?b2num ...
378 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
379 select all files. This query could be time consuming.
381 \texttt{hardlink} list is always composed of a serie of two numbers (jobid,
382 fileindex). This information can be found in the LinkFI field of the LStat
385 The \texttt{path} argument represents the name of the table that Bvfs will
386 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
387 b2 and followed by digits).
392 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
396 \subsection*{Cleanup after restore}
398 To drop the table used by the restore command, you can use the
399 \texttt{.bvfs\_cleanup} command.
402 .bvfs_cleanup path=b20001
405 \section{Changes in the pruning algorithm}
407 We rewrote the job pruning algorithm in this version. Previously, in some users
408 reported that the pruning process at the end of jobs was very long. It should
409 not be longer the case. Now, Bacula won't prune automatically a Job if this
410 particular Job is needed to restore data. Example:
414 JobId: 2 Level: Incremental
415 JobId: 3 Level: Incremental
416 JobId: 4 Level: Differential
417 .. Other incrementals up to now
420 In this example, if the Job Retention defined in the Pool or in the Client
421 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
422 detect that JobId 1 and 4 are essential to restore data at the current state
423 and will prune only JobId 2 and 3.
425 \texttt{Important}, this change affect only the automatic pruning step after a
426 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
427 \texttt{VolumeRetention} period, important jobs can be pruned.
429 \section{Ability to Verify any specified Job}
430 You now have the ability to tell Bacula which Job should verify instead of
431 automatically verify just the last one.
433 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
435 To verify a given job, just specify the Job jobid in argument when starting the
438 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
440 JobName: VerifyVolume
441 Level: VolumeToCatalog
444 Pool: Default (From Job resource)
445 Storage: File (From Job resource)
446 Verify Job: VerifyVol.2010-09-08_14.17.17_03
447 Verify List: /tmp/regress/working/VerifyVol.bsr
448 When: 2010-09-08 14:17:31
450 OK to run? (yes/mod/no):
454 This project was funded by Bacula Systems and is available with Bacula
455 Enterprise Edition and Community Edition.
457 \section{Additions to RunScript variables}
458 You can have access to JobBytes and JobFiles using \%b and \%f in your runscript
459 command. The Client address is now available through \%h.
462 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%f ClientAddress=%h"
465 %\section{Changes in drivetype.exe}
467 %Now the \texttt{drivetype.exe} program allows you to list all local hard
468 %drives. It can help to build dynamic FileSet on Windows.
471 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
475 \section{ACL/Extended Attributes}
477 We added support for NFSv4 ACLs on FreeBSD 8.1 and IRIX extended attributes.
479 This project was funded by Marco van Wieringen.
481 \section{Additions to the Plugin API}
482 The bfuncs structure has been extended to include a number of
486 The bFuncs structure defines the callback entry points within Bacula
487 that the plugin can use register events, get Bacula values, set
488 Bacula values, and send messages to the Job output or debug output.
490 The exact definition as of this writing is:
492 typedef struct s_baculaFuncs {
495 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
496 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
497 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
498 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
499 int type, utime_t mtime, const char *fmt, ...);
500 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
501 int level, const char *fmt, ...);
502 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
504 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
506 /* New functions follow */
507 bRC (*AddExclude)(bpContext *ctx, const char *file);
508 bRC (*AddInclude)(bpContext *ctx, const char *file);
509 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
510 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
511 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
512 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
518 \item [AddExclude] can be called to exclude a file. The file
519 string passed may include wildcards that will be interpreted by
520 the {\bf fnmatch} subroutine. This function can be called
521 multiple times, and each time the file specified will be added
522 to the list of files to be excluded. Note, this function only
523 permits adding excludes of specific file or directory names,
524 or files matched by the rather simple fnmatch mechanism.
525 See below for information on doing wild-card and regex excludes.
527 \item [NewInclude] can be called to create a new Include block. This
528 block will be added before any user defined Include blocks. This
529 function can be called multiple times, but each time, it will create
530 a new Include section (not normally needed). This function should
531 be called only if you want to add an entirely new Include block.
533 \item [AddInclude] can be called to add new files/directories to
534 be included. They are added to the current Include block. If
535 NewInclude has not been included, the current Include block is
536 the last one that the user created. This function
537 should be used only if you want to add totally new files/directories
538 to be included in the backup.
540 \item [NewOptions] adds a new Options block to the current Include
541 in front of any other Options blocks. This permits the plugin to
542 add exclude directives (wild-cards and regexes) in front of the
543 user Options, and thus prevent certain files from being backed up.
544 This can be useful if the plugin backs up files, and they should
545 not be also backed up by the main Bacula code. This function
546 may be called multiple times, and each time, it creates a new
547 prepended Options block. Note: normally you want to call this
548 entry point prior to calling AddOptions, AddRegex, or AddWild.
550 \item [AddOptions] allows the plugin it set options in
551 the current Options block, which is normally created with the
552 NewOptions call just prior to adding Include Options.
553 The permitted options are passed as a character string, where
554 each character has a specific meaning as defined below:
557 \item [a] always replace files (default).
558 \item [e] exclude rather than include.
559 \item [h] no recursion into subdirectories.
560 \item [H] do not handle hard links.
561 \item [i] ignore case in wildcard and regex matches.
562 \item [M] compute an MD5 sum.
563 \item [p] use a portable data format on Windows (not recommended).
564 \item [R] backup resource forks and Findr Info.
565 \item [r] read from a fifo
566 \item [S1] compute an SHA1 sum.
567 \item [S2] compute an SHA256 sum.
568 \item [S3] comput an SHA512 sum.
569 \item [s] handle sparse files.
570 \item [m] use st\_mtime only for file differences.
571 \item [k] restore the st\_atime after accessing a file.
572 \item [A] enable ACL backup.
573 \item [Vxxx:] specify verify options. Must terminate with :
574 \item [Cxxx:] specify accurate options. Must terminate with :
575 \item [Jxxx:] specify base job Options. Must terminate with :
576 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
578 \item [Zn] specify gzip compression level n.
579 \item [K] do not use st\_atime in backup decision.
580 \item [c] check if file changed during backup.
581 \item [N] honor no dump flag.
582 \item [X] enable backup of extended attributes.
585 \item [AddRegex] adds a regex expression to the current Options block.
586 The fillowing options are permitted:
588 \item [ ] (a blank) regex applies to whole path and filename.
589 \item [F] regex applies only to the filename (directory or path stripped).
590 \item [D] regex applies only to the directory (path) part of the name.
593 \item [AddWild] adds a wildcard expression to the current Options block.
594 The fillowing options are permitted:
596 \item [ ] (a blank) regex applies to whole path and filename.
597 \item [F] regex applies only to the filename (directory or path stripped).
598 \item [D] regex applies only to the directory (path) part of the name.
601 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
602 that can use Accurate code to compare the file information in argument with
603 the previous file information. The \texttt{delta\_seq} attribute of the
604 \texttt{save\_pkt} will be updated, and the call will return
605 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
610 \subsection{Bacula events}
611 The list of events has been extended to include:
617 bEventStartBackupJob = 3,
618 bEventEndBackupJob = 4,
619 bEventStartRestoreJob = 5,
620 bEventEndRestoreJob = 6,
621 bEventStartVerifyJob = 7,
622 bEventEndVerifyJob = 8,
623 bEventBackupCommand = 9,
624 bEventRestoreCommand = 10,
629 bEventCancelCommand = 13,
630 bEventVssBackupAddComponents = 14,
631 bEventVssRestoreLoadComponentMetadata = 15,
632 bEventVssRestoreSetComponentsSelected = 16,
633 bEventRestoreObject = 17,
634 bEventEndFileSet = 18,
635 bEventPluginCommand = 19,
636 bEventVssBeforeCloseRestore = 20,
637 bEventVssPrepareSnapshot = 21
643 \item [bEventCancelCommand] is called whenever the currently
644 running Job is cancelled */
646 \item [bEventVssBackupAddComponents]
648 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
649 provides a char[27] table where the plugin can add Windows drives that will
650 be used during the Job. You need to add them without duplicates, and you can
651 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
655 \chapter{Release Version 5.0.3}
657 There are no new features in version 5.0.2. This version simply fixes a
658 number of bugs found in version 5.0.1 during the onging development
661 \chapter{Release Version 5.0.2}
663 There are no new features in version 5.0.2. This version simply fixes a
664 number of bugs found in version 5.0.1 during the onging development
670 \chapter{New Features in 5.0.1}
672 This chapter presents the new features that are in the released Bacula version
673 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
674 the onging development process.
676 \section{Truncate Volume after Purge}
677 \label{sec:actiononpurge}
679 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
680 the volume when it is purged with the new command \texttt{purge volume
681 action}. It is useful to prevent disk based volumes from consuming too much
687 Action On Purge = Truncate
692 As usual you can also set this property with the \texttt{update volume} command
694 *update volume=xxx ActionOnPurge=Truncate
695 *update volume=xxx actiononpurge=None
698 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
699 following command in interactive mode or in a RunScript as shown after:
701 *purge volume action=truncate storage=File allpools
702 # or by default, action=all
703 *purge volume action storage=File pool=Default
706 This is possible to specify the volume name, the media type, the pool, the
707 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
708 idle when you decide to run this command.
717 Console = "purge volume action=all allpools storage=File"
722 \textbf{Important note}: This feature doesn't work as
723 expected in version 5.0.0. Please do not use it before version 5.0.1.
725 \section{Allow Higher Duplicates}
726 This directive did not work correctly and has been depreciated
727 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
728 file as it will be removed in a future rlease.
730 \section{Cancel Lower Level Duplicates}
731 This directive was added in Bacula version 5.0.1. It compares the
732 level of a new backup job to old jobs of the same name, if any,
733 and will kill the job which has a lower level than the other one.
734 If the levels are the same (i.e. both are Full backups), then
735 nothing is done and the other Cancel XXX Duplicate directives
738 \chapter{New Features in 5.0.0}
740 \section{Maximum Concurent Jobs for Devices}
741 \label{sec:maximumconcurentjobdevice}
743 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
744 Daemon configuration permits setting the maximum number of Jobs that can
745 run concurrently on a specified Device. Using this directive, it is
746 possible to have different Jobs using multiple drives, because when the
747 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
748 Jobs on any other available compatible drive. This facilitates writing to
749 multiple drives with multiple Jobs that all use the same Pool.
751 This project was funded by Bacula Systems.
753 \section{Restore from Multiple Storage Daemons}
754 \index[general]{Restore}
756 Previously, you were able to restore from multiple devices in a single Storage
757 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
758 example, if your full backup runs on a Storage Daemon with an autochanger, and
759 your incremental jobs use another Storage Daemon with lots of disks, Bacula
760 will switch automatically from one Storage Daemon to an other within the same
763 You must upgrade your File Daemon to version 3.1.3 or greater to use this
766 This project was funded by Bacula Systems with the help of Equiinet.
768 \section{File Deduplication using Base Jobs}
769 A base job is sort of like a Full save except that you will want the FileSet to
770 contain only files that are unlikely to change in the future (i.e. a snapshot
771 of most of your system after installing it). After the base job has been run,
772 when you are doing a Full save, you specify one or more Base jobs to be used.
773 All files that have been backed up in the Base job/jobs but not modified will
774 then be excluded from the backup. During a restore, the Base jobs will be
775 automatically pulled in where necessary.
777 This is something none of the competition does, as far as we know (except
778 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
779 win for the user, it makes Bacula stand out as offering a unique optimization
780 that immediately saves time and money. Basically, imagine that you have 100
781 nearly identical Windows or Linux machine containing the OS and user files.
782 Now for the OS part, a Base job will be backed up once, and rather than making
783 100 copies of the OS, there will be only one. If one or more of the systems
784 have some files updated, no problem, they will be automatically restored.
786 See the \ilink{Base Job Chapter}{basejobs} for more information.
788 This project was funded by Bacula Systems.
790 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
791 \index[dir]{AllowCompression}
793 This new directive may be added to Storage resource within the Director's
794 configuration to allow users to selectively disable the client compression for
795 any job which writes to this storage resource.
801 Address = ultrium-tape
802 Password = storage_password # Password for Storage Daemon
805 AllowCompression = No # Tape drive has hardware compression
808 The above example would cause any jobs running with the UltriumTape storage
809 resource to run without compression from the client file daemons. This
810 effectively overrides any compression settings defined at the FileSet level.
812 This feature is probably most useful if you have a tape drive which supports
813 hardware compression. By setting the \texttt{AllowCompression = No} directive
814 for your tape drive storage resource, you can avoid additional load on the file
815 daemon and possibly speed up tape backups.
817 This project was funded by Collaborative Fusion, Inc.
819 \section{Accurate Fileset Options}
820 \label{sec:accuratefileset}
822 In previous versions, the accurate code used the file creation and modification
823 times to determine if a file was modified or not. Now you can specify which
824 attributes to use (time, size, checksum, permission, owner, group, \dots),
825 similar to the Verify options.
841 \item {\bf i} compare the inodes
842 \item {\bf p} compare the permission bits
843 \item {\bf n} compare the number of links
844 \item {\bf u} compare the user id
845 \item {\bf g} compare the group id
846 \item {\bf s} compare the size
847 \item {\bf a} compare the access time
848 \item {\bf m} compare the modification time (st\_mtime)
849 \item {\bf c} compare the change time (st\_ctime)
850 \item {\bf d} report file size decreases
851 \item {\bf 5} compare the MD5 signature
852 \item {\bf 1} compare the SHA1 signature
855 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
856 the File Daemon will have to read all files even if they normally would not
857 be saved. This increases the I/O load, but also the accuracy of the
858 deduplication. By default, Bacula will check modification/creation time
861 This project was funded by Bacula Systems.
863 \section{Tab-completion for Bconsole}
864 \label{sec:tabcompletion}
866 If you build \texttt{bconsole} with readline support, you will be able to use
867 the new auto-completion mode. This mode supports all commands, gives help
868 inside command, and lists resources when required. It works also in the restore
871 To use this feature, you should have readline development package loaded on
872 your system, and use the following option in configure.
874 ./configure --with-readline=/usr/include/readline --disable-conio ...
877 The new bconsole won't be able to tab-complete with older directors.
879 This project was funded by Bacula Systems.
881 \section{Pool File and Job Retention}
882 \label{sec:poolfilejobretention}
884 We added two new Pool directives, \texttt{FileRetention} and
885 \texttt{JobRetention}, that take precedence over Client directives of the same
886 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
887 example, you can decide to increase Retention times for Archive or OffSite Pool.
889 It seems obvious to us, but apparently not to some users, that given the
890 definition above that the Pool File and Job Retention periods is a global
891 override for the normal Client based prunning, which means that when the
892 Job is prunned, the prunning will apply globally to that particular Job.
894 Currently, there is a bug in the implementation that causes any Pool
895 retention periods specified to apply to {\bf all} Pools for that
896 particular Client. Thus we suggest that you avoid using these two
897 directives until this implementation problem is corrected.
899 \section{Read-only File Daemon using capabilities}
900 \label{sec:fdreadonly}
901 This feature implements support of keeping \textbf{ReadAll} capabilities after
902 UID/GID switch, this allows FD to keep root read but drop write permission.
904 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
905 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
908 root@localhost:~# bacula-fd -k -u nobody -g nobody
911 The code for this feature was contributed by our friends at AltLinux.
916 To help developers of restore GUI interfaces, we have added new \textsl{dot
917 commands} that permit browsing the catalog in a very simple way.
920 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
921 the Bvfs cache in the catalog. You need to run it before any access to the
924 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
925 will list all directories in the specified \texttt{path} or
926 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
927 encoding of path/filenames.
929 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
930 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
931 \texttt{pathid} avoids problems with character encoding.
934 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
935 data that will be displayed.
938 * .bvfs_update jobid=1,2
940 * .bvfs_lsdir path=/ jobid=1,2
943 This project was funded by Bacula Systems.
945 \section{Testing your Tape Drive}
946 \label{sec:btapespeed}
948 To determine the best configuration of your tape drive, you can run the new
949 \texttt{speed} command available in the \texttt{btape} program.
951 This command can have the following arguments:
953 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
954 (between 1 and 5GB). This counter is in GB.
955 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
956 of data should be greater than your memory ($file\_size*nb\_file$).
957 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
959 \item[\texttt{skip\_random}] This flag permits to skip tests with random
961 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
962 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
967 *speed file_size=3 skip_raw
968 btape.c:1078 Test with zero data and bacula block structure.
969 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
970 ++++++++++++++++++++++++++++++++++++++++++
971 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
972 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
974 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
976 btape.c:1090 Test with random data, should give the minimum throughput.
977 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
978 +++++++++++++++++++++++++++++++++++++++++++
979 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
980 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
981 +++++++++++++++++++++++++++++++++++++++++++
983 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
987 When using compression, the random test will give your the minimum throughput
988 of your drive . The test using constant string will give you the maximum speed
989 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
991 You can change the block size in the Storage Daemon configuration file.
993 \section{New {\bf Block Checksum} Device Directive}
994 You may now turn off the Block Checksum (CRC32) code
995 that Bacula uses when writing blocks to a Volume. This is
1002 doing so can reduce the Storage daemon CPU usage slightly. It
1003 will also permit Bacula to read a Volume that has corrupted data.
1005 The default is {\bf yes} -- i.e. the checksum is computed on write
1006 and checked on read.
1008 We do not recommend to turn this off particularly on older tape
1009 drives or for disk Volumes where doing so may allow corrupted data
1012 \section{New Bat Features}
1014 Those new features were funded by Bacula Systems.
1016 \subsection{Media List View}
1018 By clicking on ``Media'', you can see the list of all your volumes. You will be
1019 able to filter by Pool, Media Type, Location,\dots And sort the result directly
1020 in the table. The old ``Media'' view is now known as ``Pool''.
1021 \begin{figure}[htbp]
1023 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
1024 \label{fig:mediaview}
1028 \subsection{Media Information View}
1030 By double-clicking on a volume (on the Media list, in the Autochanger content
1031 or in the Job information panel), you can access a detailed overview of your
1032 Volume. (cf \ref{fig:mediainfo}.)
1033 \begin{figure}[htbp]
1035 \includegraphics[width=13cm]{\idir bat11.eps}
1036 \caption{Media information}
1037 \label{fig:mediainfo}
1040 \subsection{Job Information View}
1042 By double-clicking on a Job record (on the Job run list or in the Media
1043 information panel), you can access a detailed overview of your Job. (cf
1045 \begin{figure}[htbp]
1047 \includegraphics[width=13cm]{\idir bat12.eps}
1048 \caption{Job information}
1052 \subsection{Autochanger Content View}
1054 By double-clicking on a Storage record (on the Storage list panel), you can
1055 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
1056 \begin{figure}[htbp]
1058 \includegraphics[width=13cm]{\idir bat13.eps}
1059 \caption{Autochanger content}
1060 \label{fig:achcontent}
1063 To use this feature, you need to use the latest mtx-changer script
1064 version. (With new \texttt{listall} and \texttt{transfer} commands)
1066 \section{Bat on Windows}
1067 We have ported {\bf bat} to Windows and it is now installed
1068 by default when the installer is run. It works quite well
1069 on Win32, but has not had a lot of testing there, so your
1070 feedback would be welcome. Unfortunately, eventhough it is
1071 installed by default, it does not yet work on 64 bit Windows
1074 \section{New Win32 Installer}
1075 The Win32 installer has been modified in several very important
1078 \item You must deinstall any current version of the
1079 Win32 File daemon before upgrading to the new one.
1080 If you forget to do so, the new installation will fail.
1081 To correct this failure, you must manually shutdown
1082 and deinstall the old File daemon.
1083 \item All files (other than menu links) are installed
1084 in {\bf c:/Program Files/Bacula}.
1085 \item The installer no longer sets this
1086 file to require administrator privileges by default. If you want
1087 to do so, please do it manually using the {\bf cacls} program.
1090 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1092 \item The server daemons (Director and Storage daemon) are
1093 no longer included in the Windows installer. If you want the
1094 Windows servers, you will either need to build them yourself (note
1095 they have not been ported to 64 bits), or you can contact
1096 Bacula Systems about this.
1099 \section{Win64 Installer}
1100 We have corrected a number of problems that required manual
1101 editing of the conf files. In most cases, it should now
1102 install and work. {\bf bat} is by default installed in
1103 {\bf c:/Program Files/Bacula/bin32} rather than
1104 {\bf c:/Program Files/Bacula} as is the case with the 32
1105 bit Windows installer.
1107 \section{Linux Bare Metal Recovery USB Key}
1108 We have made a number of significant improvements in the
1109 Bare Metal Recovery USB key. Please see the README files
1110 it the {\bf rescue} release for more details.
1112 We are working on an equivalent USB key for Windows bare
1113 metal recovery, but it will take some time to develop it (best
1114 estimate 3Q2010 or 4Q2010)
1117 \section{bconsole Timeout Option}
1118 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1119 for commands. This is useful with GUI programs that use {\bf bconsole}
1120 to interface to the Director.
1122 \section{Important Changes}
1123 \label{sec:importantchanges}
1126 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1127 to the same Pool. The Storage daemon ensures that you do not read and
1128 write to the same Volume.
1129 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1131 \item Virtually all the features of {\bf mtx-changer} have
1132 now been parameterized, which allows you to configure
1133 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
1134 that contains variables that you can set to configure mtx-changer.
1135 This configuration file will not be overwritten during upgrades.
1136 We encourage you to submit any changes
1137 that are made to mtx-changer and to parameterize it all in
1138 mtx-changer.conf so that all configuration will be done by
1139 changing only mtx-changer.conf.
1140 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1141 and \texttt{transfer}. Please configure them as appropriate
1142 in mtx-changer.conf.
1143 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1144 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1145 password. If you want to use the new script, you will need to
1146 manually change the \texttt{BackupCatalog} Job definition.
1147 \item The \texttt{bconsole} \texttt{help} command now accepts
1148 an argument, which if provided produces information on that
1149 command (ex: \texttt{help run}).
1153 \subsubsection*{Truncate volume after purge}
1155 Note that the Truncate Volume after purge feature doesn't work as expected
1156 in 5.0.0 version. Please, don't use it before version 5.0.1.
1158 \subsection{Custom Catalog queries}
1160 If you wish to add specialized commands that list the contents of the catalog,
1161 you can do so by adding them to the \texttt{query.sql} file. This
1162 \texttt{query.sql} file is now empty by default. The file
1163 \texttt{examples/sample-query.sql} has an a number of sample commands
1164 you might find useful.
1166 \subsection{Deprecated parts}
1168 The following items have been \textbf{deprecated} for a long time, and are now
1169 removed from the code.
1172 \item Support for SQLite 2
1175 \section{Misc Changes}
1176 \label{sec:miscchanges}
1179 \item Updated Nagios check\_bacula
1180 \item Updated man files
1181 \item Added OSX package generation script in platforms/darwin
1182 \item Added Spanish and Ukrainian Bacula translations
1183 \item Enable/disable command shows only Jobs that can change
1184 \item Added \texttt{show disabled} command to show disabled Jobs
1185 \item Many ACL improvements
1186 \item Added Level to FD status Job output
1187 \item Begin Ingres DB driver (not yet working)
1188 \item Split RedHat spec files into bacula, bat, mtx, and docs
1189 \item Reorganized the manuals (fewer separate manuals)
1190 \item Added lock/unlock order protection in lock manager
1191 \item Allow 64 bit sizes for a number of variables
1192 \item Fixed several deadlocks or potential race conditions in the SD
1195 \chapter{Released Version 3.0.3 and 3.0.3a}
1197 There are no new features in version 3.0.3. This version simply fixes a
1198 number of bugs found in version 3.0.2 during the onging development
1201 \chapter{New Features in Released Version 3.0.2}
1203 This chapter presents the new features added to the
1204 Released Bacula Version 3.0.2.
1206 \section{Full Restore from a Given JobId}
1207 \index[general]{Restore menu}
1209 This feature allows selecting a single JobId and having Bacula
1210 automatically select all the other jobs that comprise a full backup up to
1211 and including the selected date (through JobId).
1213 Assume we start with the following jobs:
1215 +-------+--------------+---------------------+-------+----------+------------+
1216 | jobid | client | starttime | level | jobfiles | jobbytes |
1217 +-------+--------------+---------------------+-------+----------+------------
1218 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
1219 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
1220 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
1221 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
1222 +-------+--------------+---------------------+-------+----------+------------+
1225 Below is an example of this new feature (which is number 12 in the
1230 To select the JobIds, you have the following choices:
1231 1: List last 20 Jobs run
1232 2: List Jobs where a given File is saved
1234 12: Select full restore to a specified Job date
1237 Select item: (1-13): 12
1238 Enter JobId to get the state to restore: 5
1239 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1240 You have selected the following JobIds: 1,3,5
1242 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1243 1,444 files inserted into the tree.
1246 This project was funded by Bacula Systems.
1248 \section{Source Address}
1249 \index[general]{Source Address}
1251 A feature has been added which allows the administrator to specify the address
1252 from which the Director and File daemons will establish connections. This
1253 may be used to simplify system configuration overhead when working in complex
1254 networks utilizing multi-homing and policy-routing.
1256 To accomplish this, two new configuration directives have been implemented:
1259 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
1263 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
1267 Simply adding specific host routes on the OS
1268 would have an undesirable side-effect: any
1269 application trying to contact the destination host would be forced to use the
1270 more specific route possibly diverting management traffic onto a backup VLAN.
1271 Instead of adding host routes for each client connected to a multi-homed backup
1272 server (for example where there are management and backup VLANs), one can
1273 use the new directives to specify a specific source address at the application
1276 Additionally, this allows the simplification and abstraction of firewall rules
1277 when dealing with a Hot-Standby director or storage daemon configuration. The
1278 Hot-standby pair may share a CARP address, which connections must be sourced
1279 from, while system services listen and act from the unique interface addresses.
1281 This project was funded by Collaborative Fusion, Inc.
1283 \section{Show volume availability when doing restore}
1285 When doing a restore the selection dialog ends by displaying this
1289 The job will require the following
1290 Volume(s) Storage(s) SD Device(s)
1291 ===========================================================================
1292 *000741L3 LTO-4 LTO3
1293 *000866L3 LTO-4 LTO3
1294 *000765L3 LTO-4 LTO3
1295 *000764L3 LTO-4 LTO3
1296 *000756L3 LTO-4 LTO3
1297 *001759L3 LTO-4 LTO3
1298 *001763L3 LTO-4 LTO3
1302 Volumes marked with ``*'' are online (in the autochanger).
1305 This should help speed up large restores by minimizing the time spent
1306 waiting for the operator to discover that he must change tapes in the library.
1308 This project was funded by Bacula Systems.
1310 \section{Accurate estimate command}
1312 The \texttt{estimate} command can now use the accurate code to detect changes
1313 and give a better estimation.
1315 You can set the accurate behavior on the command line by using
1316 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1319 * estimate listing accurate=yes level=incremental job=BackupJob
1322 This project was funded by Bacula Systems.
1324 \chapter{New Features in 3.0.0}
1325 \label{NewFeaturesChapter}
1326 \index[general]{New Features}
1328 This chapter presents the new features added to the development 2.5.x
1329 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1331 \section{Accurate Backup}
1332 \index[general]{Accurate Backup}
1334 As with most other backup programs, by default Bacula decides what files to
1335 backup for Incremental and Differental backup by comparing the change
1336 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1337 backup completed. If one of those two times is later than the last backup
1338 time, then the file will be backed up. This does not, however, permit tracking
1339 what files have been deleted and will miss any file with an old time that may
1340 have been restored to or moved onto the client filesystem.
1342 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
1343 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1344 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1345 backup, there is no difference, but for {\bf Differential} and {\bf
1346 Incremental} backups, the Director will send a list of all previous files
1347 backed up, and the File daemon will use that list to determine if any new files
1348 have been added or or moved and if any files have been deleted. This allows
1349 Bacula to make an accurate backup of your system to that point in time so that
1350 if you do a restore, it will restore your system exactly.
1353 about using Accurate backup is that it requires more resources (CPU and memory)
1354 on both the Director and the Client machines to create the list of previous
1355 files backed up, to send that list to the File daemon, for the File daemon to
1356 keep the list (possibly very big) in memory, and for the File daemon to do
1357 comparisons between every file in the FileSet and the list. In particular,
1358 if your client has lots of files (more than a few million), you will need
1359 lots of memory on the client machine.
1361 Accurate must not be enabled when backing up with a plugin that is not
1362 specially designed to work with Accurate. If you enable it, your restores
1363 will probably not work correctly.
1365 This project was funded by Bacula Systems.
1370 \index[general]{Copy Jobs}
1372 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1373 existing Migration feature with the exception that the Job that is copied is
1374 left unchanged. This essentially creates two identical copies of the same
1375 backup. However, the copy is treated as a copy rather than a backup job, and
1376 hence is not directly available for restore. The {\bf restore} command lists
1377 copy jobs and allows selection of copies by using \texttt{jobid=}
1378 option. If the keyword {\bf copies} is present on the command line, Bacula will
1379 display the list of all copies for selected jobs.
1384 These JobIds have copies as follows:
1385 +-------+------------------------------------+-----------+------------------+
1386 | JobId | Job | CopyJobId | MediaType |
1387 +-------+------------------------------------+-----------+------------------+
1388 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
1389 +-------+------------------------------------+-----------+------------------+
1390 +-------+-------+----------+----------+---------------------+------------------+
1391 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
1392 +-------+-------+----------+----------+---------------------+------------------+
1393 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1394 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
1395 +-------+-------+----------+----------+---------------------+------------------+
1396 You have selected the following JobIds: 19,2
1398 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1399 5,611 files inserted into the tree.
1404 The Copy Job runs without using the File daemon by copying the data from the
1405 old backup Volume to a different Volume in a different Pool. See the Migration
1406 documentation for additional details. For copy Jobs there is a new selection
1407 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1408 not already copied to another Pool.
1410 As with Migration, the Client, Volume, Job, or SQL query, are
1411 other possible ways of selecting the Jobs to be copied. Selection
1412 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1413 work, but are probably more suited for Migration Jobs.
1415 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1416 it will promote the Copy to a \textsl{real} backup job and will make it available for
1417 automatic restore. If more than one Copy is available, it will promote the copy
1418 with the smallest JobId.
1420 A nice solution which can be built with the new Copy feature is often
1421 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1422 look something like the one below:
1426 Name = FullBackupsVirtualPool
1428 Purge Oldest Volume = Yes
1430 NextPool = FullBackupsTapePool
1434 Name = FullBackupsTapePool
1438 Volume Retention = 365 days
1439 Storage = superloader
1443 # Fake fileset for copy jobs
1455 # Fake client for copy jobs
1465 # Default template for a CopyDiskToTape Job
1468 Name = CopyDiskToTape
1470 Messages = StandardCopy
1473 Selection Type = PoolUncopiedJobs
1474 Maximum Concurrent Jobs = 10
1476 Allow Duplicate Jobs = Yes
1477 Cancel Queued Duplicates = No
1478 Cancel Running Duplicates = No
1483 Name = DaySchedule7:00
1484 Run = Level=Full daily at 7:00
1488 Name = CopyDiskToTapeFullBackups
1490 Schedule = DaySchedule7:00
1491 Pool = FullBackupsVirtualPool
1492 JobDefs = CopyDiskToTape
1496 The example above had 2 pool which are copied using the PoolUncopiedJobs
1497 selection criteria. Normal Full backups go to the Virtual pool and are copied
1498 to the Tape pool the next morning.
1500 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1505 +-------+------------------------------------+-----------+------------------+
1506 | JobId | Job | CopyJobId | MediaType |
1507 +-------+------------------------------------+-----------+------------------+
1508 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1509 +-------+------------------------------------+-----------+------------------+
1512 \section{ACL Updates}
1513 \index[general]{ACL Updates}
1514 The whole ACL code had been overhauled and in this version each platforms has
1515 different streams for each type of acl available on such an platform. As ACLs
1516 between platforms tend to be not that portable (most implement POSIX acls but
1517 some use an other draft or a completely different format) we currently only
1518 allow certain platform specific ACL streams to be decoded and restored on the
1519 same platform that they were created on. The old code allowed to restore ACL
1520 cross platform but the comments already mention that not being to wise. For
1521 backward compatability the new code will accept the two old ACL streams and
1522 handle those with the platform specific handler. But for all new backups it
1523 will save the ACLs using the new streams.
1525 Currently the following platforms support ACLs:
1529 \item {\bf Darwin/OSX}
1538 Currently we support the following ACL types (these ACL streams use a reserved
1539 part of the stream numbers):
1542 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1544 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1545 string representation from acl\_to\_text (POSIX acl)
1546 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1547 string representation from acl\_to\_text (POSIX acl) for default acls.
1548 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1549 string representation from acl\_to\_text (POSIX acl) for access acls.
1550 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1551 string representation from acltostr (POSIX acl)
1552 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1553 representation from acl\_to\_text (POSIX acl) for default acls.
1554 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1555 representation from acl\_to\_text (POSIX acl) for access acls.
1556 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1557 string representation from acl\_to\_text (POSIX acl) for default acls.
1558 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1559 representation from acl\_to\_text (POSIX acl) for access acls.
1560 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1561 string representation from acl\_to\_text (POSIX acl) for default acls.
1562 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1563 string representation from acl\_to\_text (POSIX acl) for default acls.
1564 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1565 representation from acl\_to\_text (POSIX acl) for access acls.
1566 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1567 string representation from acltotext or acl\_totext (POSIX acl)
1568 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1569 representation from from acl\_totext (NFSv4 or ZFS acl)
1572 In future versions we might support conversion functions from one type of acl
1573 into an other for types that are either the same or easily convertable. For now
1574 the streams are seperate and restoring them on a platform that doesn't
1575 recognize them will give you a warning.
1577 \section{Extended Attributes}
1578 \index[general]{Extended Attributes}
1579 Something that was on the project list for some time is now implemented for
1580 platforms that support a similar kind of interface. Its the support for backup
1581 and restore of so called extended attributes. As extended attributes are so
1582 platform specific these attributes are saved in seperate streams for each
1583 platform. Restores of the extended attributes can only be performed on the
1584 same platform the backup was done. There is support for all types of extended
1585 attributes, but restoring from one type of filesystem onto an other type of
1586 filesystem on the same platform may lead to supprises. As extended attributes
1587 can contain any type of data they are stored as a series of so called
1588 value-pairs. This data must be seen as mostly binary and is stored as such.
1589 As security labels from selinux are also extended attributes this option also
1590 stores those labels and no specific code is enabled for handling selinux
1593 Currently the following platforms support extended attributes:
1595 \item {\bf Darwin/OSX}
1601 On linux acls are also extended attributes, as such when you enable ACLs on a
1602 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1603 and not the same exteneded attribute.
1605 To enable the backup of extended attributes please add the following to your
1620 \section{Shared objects}
1621 \index[general]{Shared objects}
1622 A default build of Bacula will now create the libraries as shared objects
1623 (.so) rather than static libraries as was previously the case.
1624 The shared libraries are built using {\bf libtool} so it should be quite
1627 An important advantage of using shared objects is that on a machine with the
1628 Directory, File daemon, the Storage daemon, and a console, you will have only
1629 one copy of the code in memory rather than four copies. Also the total size of
1630 the binary release is smaller since the library code appears only once rather
1631 than once for every program that uses it; this results in significant reduction
1632 in the size of the binaries particularly for the utility tools.
1634 In order for the system loader to find the shared objects when loading the
1635 Bacula binaries, the Bacula shared objects must either be in a shared object
1636 directory known to the loader (typically /usr/lib) or they must be in the
1637 directory that may be specified on the {\bf ./configure} line using the {\bf
1638 {-}{-}libdir} option as:
1641 ./configure --libdir=/full-path/dir
1644 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1645 no need to modify your loader configuration provided that
1646 the shared objects are installed in that directory (Bacula
1647 does this with the make install command). The shared objects
1648 that Bacula references are:
1657 These files are symbolically linked to the real shared object file,
1658 which has a version number to permit running multiple versions of
1659 the libraries if desired (not normally the case).
1661 If you have problems with libtool or you wish to use the old
1662 way of building static libraries, or you want to build a static
1663 version of Bacula you may disable
1664 libtool on the configure command line with:
1667 ./configure --disable-libtool
1671 \section{Building Static versions of Bacula}
1672 \index[general]{Static linking}
1673 In order to build static versions of Bacula, in addition
1674 to configuration options that were needed you now must
1675 also add --disable-libtool. Example
1678 ./configure --enable-static-client-only --disable-libtool
1682 \section{Virtual Backup (Vbackup)}
1683 \index[general]{Virtual Backup}
1684 \index[general]{Vbackup}
1686 Bacula's virtual backup feature is often called Synthetic Backup or
1687 Consolidation in other backup products. It permits you to consolidate the
1688 previous Full backup plus the most recent Differential backup and any
1689 subsequent Incremental backups into a new Full backup. This new Full
1690 backup will then be considered as the most recent Full for any future
1691 Incremental or Differential backups. The VirtualFull backup is
1692 accomplished without contacting the client by reading the previous backup
1693 data and writing it to a volume in a different pool.
1695 In some respects the Vbackup feature works similar to a Migration job, in
1696 that Bacula normally reads the data from the pool specified in the
1697 Job resource, and writes it to the {\bf Next Pool} specified in the
1698 Job resource. Note, this means that usually the output from the Virtual
1699 Backup is written into a different pool from where your prior backups
1700 are saved. Doing it this way guarantees that you will not get a deadlock
1701 situation attempting to read and write to the same volume in the Storage
1702 daemon. If you then want to do subsequent backups, you may need to
1703 move the Virtual Full Volume back to your normal backup pool.
1704 Alternatively, you can set your {\bf Next Pool} to point to the current
1705 pool. This will cause Bacula to read and write to Volumes in the
1706 current pool. In general, this will work, because Bacula will
1707 not allow reading and writing on the same Volume. In any case, once
1708 a VirtualFull has been created, and a restore is done involving the
1709 most current Full, it will read the Volume or Volumes by the VirtualFull
1710 regardless of in which Pool the Volume is found.
1712 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1713 a level of {\bf VirtualFull}.
1715 A typical Job resource definition might look like the following:
1722 FileSet = "Full Set"
1729 # Default pool definition
1733 Recycle = yes # Automatically recycle Volumes
1734 AutoPrune = yes # Prune expired volumes
1735 Volume Retention = 365d # one year
1743 Recycle = yes # Automatically recycle Volumes
1744 AutoPrune = yes # Prune expired volumes
1745 Volume Retention = 365d # one year
1746 Storage = DiskChanger
1749 # Definition of file storage device
1754 Device = FileStorage
1756 Maximum Concurrent Jobs = 5
1759 # Definition of DDS Virtual tape disk storage device
1762 Address = localhost # N.B. Use a fully qualified name here
1764 Device = DiskChanger
1765 Media Type = DiskChangerMedia
1766 Maximum Concurrent Jobs = 4
1771 Then in bconsole or via a Run schedule, you would run the job as:
1774 run job=MyBackup level=Full
1775 run job=MyBackup level=Incremental
1776 run job=MyBackup level=Differential
1777 run job=MyBackup level=Incremental
1778 run job=MyBackup level=Incremental
1781 So providing there were changes between each of those jobs, you would end up
1782 with a Full backup, a Differential, which includes the first Incremental
1783 backup, then two Incremental backups. All the above jobs would be written to
1784 the {\bf Default} pool.
1786 To consolidate those backups into a new Full backup, you would run the
1790 run job=MyBackup level=VirtualFull
1793 And it would produce a new Full backup without using the client, and the output
1794 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1796 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1799 Note, the Start and End time of the Virtual Full backup is set to the
1800 values for the last job included in the Virtual Full (in the above example,
1801 it is an Increment). This is so that if another incremental is done, which
1802 will be based on the Virtual Full, it will backup all files from the
1803 last Job included in the Virtual Full rather than from the time the Virtual
1804 Full was actually run.
1808 \section{Catalog Format}
1809 \index[general]{Catalog Format}
1810 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1811 operation will convert the FileId field of the File table from 32 bits (max 4
1812 billion table entries) to 64 bits (very large number of items). The
1813 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1814 your catalog during the conversion. Also you won't be able to run jobs during
1815 this conversion period. For example, a 3 million file catalog will take 2
1816 minutes to upgrade on a normal machine. Please don't forget to make a valid
1817 backup of your database before executing the upgrade script. See the
1818 ReleaseNotes for additional details.
1820 \section{64 bit Windows Client}
1821 \index[general]{Win64 Client}
1822 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1823 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1824 As a consequence, we are also releasing a 64 bit version of the Bacula
1825 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1826 These binaries should only be installed on 64 bit Windows operating systems.
1827 What is important is not your hardware but whether or not you have
1828 a 64 bit version of the Windows OS.
1830 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1832 \item Before installing the Win64 Bacula Client, you must totally
1833 deinstall any prior 2.4.x Client installation using the
1834 Bacula deinstallation (see the menu item). You may want
1835 to save your .conf files first.
1836 \item Only the Client (File daemon) is ported to Win64, the Director
1837 and the Storage daemon are not in the 64 bit Windows installer.
1838 \item bwx-console is not yet ported.
1839 \item bconsole is ported but it has not been tested.
1840 \item The documentation is not included in the installer.
1841 \item Due to Vista security restrictions imposed on a default installation
1842 of Vista, before upgrading the Client, you must manually stop
1843 any prior version of Bacula from running, otherwise the install
1845 \item Due to Vista security restrictions imposed on a default installation
1846 of Vista, attempting to edit the conf files via the menu items
1847 will fail. You must directly edit the files with appropriate
1848 permissions. Generally double clicking on the appropriate .conf
1849 file will work providing you have sufficient permissions.
1850 \item All Bacula files are now installed in
1851 {\bf C:/Program Files/Bacula} except the main menu items,
1852 which are installed as before. This vastly simplifies the installation.
1853 \item If you are running on a foreign language version of Windows, most
1854 likely {\bf C:/Program Files} does not exist, so you should use the
1855 Custom installation and enter an appropriate location to install
1857 \item The 3.0.0 Win32 Client continues to install files in the locations used
1858 by prior versions. For the next version we will convert it to use
1859 the same installation conventions as the Win64 version.
1862 This project was funded by Bacula Systems.
1865 \section{Duplicate Job Control}
1866 \index[general]{Duplicate Jobs}
1867 The new version of Bacula provides four new directives that
1868 give additional control over what Bacula does if duplicate jobs
1869 are started. A duplicate job in the sense we use it here means
1870 a second or subsequent job with the same name starts. This
1871 happens most frequently when the first job runs longer than expected because no
1872 tapes are available.
1874 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1875 are specified in the Job resource.
1879 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1880 \index[general]{Allow Duplicate Jobs}
1881 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1882 the directive is set to {\bf no} (default) then only one job of a given name
1883 may run at one time, and the action that Bacula takes to ensure only
1884 one job runs is determined by the other directives (see below).
1886 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1887 are present and none of the three directives given below permit
1888 cancelling a job, then the current job (the second one started)
1891 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1892 \index[general]{Allow Higher Duplicates}
1893 This directive was in version 5.0.0, but does not work as
1894 expected. If used, it should always be set to no. In later versions
1895 of Bacula the directive is disabled (disregarded).
1897 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1898 \index[general]{Cancel Running Duplicates}
1899 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1900 if this directive is set to {\bf yes} any job that is already running
1901 will be canceled. The default is {\bf no}.
1903 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1904 \index[general]{Cancel Queued Duplicates}
1905 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1906 if this directive is set to {\bf yes} any job that is
1907 already queued to run but not yet running will be canceled.
1908 The default is {\bf no}.
1911 \section{TLS Authentication}
1912 \index[general]{TLS Authentication}
1913 In Bacula version 2.5.x and later, in addition to the normal Bacula
1914 CRAM-MD5 authentication that is used to authenticate each Bacula
1915 connection, you can specify that you want TLS Authentication as well,
1916 which will provide more secure authentication.
1918 This new feature uses Bacula's existing TLS code (normally used for
1919 communications encryption) to do authentication. To use it, you must
1920 specify all the TLS directives normally used to enable communications
1921 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1924 \subsection{TLS Authenticate = yes}
1926 TLS Authenticate = yes
1929 in the main daemon configuration resource (Director for the Director,
1930 Client for the File daemon, and Storage for the Storage daemon).
1932 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1933 authentication, Bacula will also do TLS authentication, then TLS
1934 encryption will be turned off, and the rest of the communication between
1935 the two Bacula daemons will be done without encryption.
1937 If you want to encrypt communications data, use the normal TLS directives
1938 but do not turn on {\bf TLS Authenticate}.
1940 \section{bextract non-portable Win32 data}
1941 \index[general]{bextract handles Win32 non-portable data}
1942 {\bf bextract} has been enhanced to be able to restore
1943 non-portable Win32 data to any OS. Previous versions were
1944 unable to restore non-portable Win32 data to machines that
1945 did not have the Win32 BackupRead and BackupWrite API calls.
1947 \section{State File updated at Job Termination}
1948 \index[general]{State File}
1949 In previous versions of Bacula, the state file, which provides a
1950 summary of previous jobs run in the {\bf status} command output was
1951 updated only when Bacula terminated, thus if the daemon crashed, the
1952 state file might not contain all the run data. This version of
1953 the Bacula daemons updates the state file on each job termination.
1955 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1956 \index[general]{MaxFullInterval}
1957 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1958 can be used to specify the maximum time interval between {\bf Full} backup
1959 jobs. When a job starts, if the time since the last Full backup is
1960 greater than the specified interval, and the job would normally be an
1961 {\bf Incremental} or {\bf Differential}, it will be automatically
1962 upgraded to a {\bf Full} backup.
1964 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1965 \index[general]{MaxDiffInterval}
1966 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1967 can be used to specify the maximum time interval between {\bf Differential} backup
1968 jobs. When a job starts, if the time since the last Differential backup is
1969 greater than the specified interval, and the job would normally be an
1970 {\bf Incremental}, it will be automatically
1971 upgraded to a {\bf Differential} backup.
1973 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1974 \index[general]{MaxDiffInterval}
1975 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1976 by the user, and when it is set it is an indication to backup programs
1977 to not backup that particular file. This version of Bacula contains a
1978 new Options directive within a FileSet resource, which instructs Bacula to
1979 obey this flag. The new directive is:
1982 Honor No Dump Flag = yes\vb{}no
1985 The default value is {\bf no}.
1988 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1989 \index[general]{IgnoreDir}
1990 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1991 can be added to the Include section of the FileSet resource. If the specified
1992 filename ({\bf filename-string}) is found on the Client in any directory to be
1993 backed up, the whole directory will be ignored (not backed up). For example:
1996 # List of files to be backed up
2004 Exclude Dir Containing = .excludeme
2009 But in /home, there may be hundreds of directories of users and some
2010 people want to indicate that they don't want to have certain
2011 directories backed up. For example, with the above FileSet, if
2012 the user or sysadmin creates a file named {\bf .excludeme} in
2013 specific directories, such as
2016 /home/user/www/cache/.excludeme
2017 /home/user/temp/.excludeme
2020 then Bacula will not backup the two directories named:
2023 /home/user/www/cache
2027 NOTE: subdirectories will not be backed up. That is, the directive
2028 applies to the two directories in question and any children (be they
2029 files, directories, etc).
2032 \section{Bacula Plugins}
2033 \index[general]{Plugin}
2034 Support for shared object plugins has been implemented in the Linux, Unix
2035 and Win32 File daemons. The API will be documented separately in
2036 the Developer's Guide or in a new document. For the moment, there is
2037 a single plugin named {\bf bpipe} that allows an external program to
2038 get control to backup and restore a file.
2040 Plugins are also planned (partially implemented) in the Director and the
2043 \subsection{Plugin Directory}
2044 \index[general]{Plugin Directory}
2045 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
2046 be added to the daemon definition resource. The directory takes a quoted
2047 string argument, which is the name of the directory in which the daemon can
2048 find the Bacula plugins. If this directive is not specified, Bacula will not
2049 load any plugins. Since each plugin has a distinctive name, all the daemons
2050 can share the same plugin directory.
2052 \subsection{Plugin Options}
2053 \index[general]{Plugin Options}
2054 The {\bf Plugin Options} directive takes a quoted string
2055 arguement (after the equal sign) and may be specified in the
2056 Job resource. The options specified will be passed to all plugins
2057 when they are run. This each plugin must know what it is looking
2058 for. The value defined in the Job resource can be modified
2059 by the user when he runs a Job via the {\bf bconsole} command line
2062 Note: this directive may be specified, and there is code to modify
2063 the string in the run command, but the plugin options are not yet passed to
2064 the plugin (i.e. not fully implemented).
2066 \subsection{Plugin Options ACL}
2067 \index[general]{Plugin Options ACL}
2068 The {\bf Plugin Options ACL} directive may be specified in the
2069 Director's Console resource. It functions as all the other ACL commands
2070 do by permitting users running restricted consoles to specify a
2071 {\bf Plugin Options} that overrides the one specified in the Job
2072 definition. Without this directive restricted consoles may not modify
2075 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
2076 \index[general]{Plugin}
2077 The {\bf Plugin} directive is specified in the Include section of
2078 a FileSet resource where you put your {\bf File = xxx} directives.
2089 Plugin = "bpipe:..."
2094 In the above example, when the File daemon is processing the directives
2095 in the Include section, it will first backup all the files in {\bf /home}
2096 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2097 the Plugin Directory. The syntax and semantics of the Plugin directive
2098 require the first part of the string up to the colon (:) to be the name
2099 of the plugin. Everything after the first colon is ignored by the File daemon but
2100 is passed to the plugin. Thus the plugin writer may define the meaning of the
2101 rest of the string as he wishes.
2103 Please see the next section for information about the {\bf bpipe} Bacula
2106 \section{The bpipe Plugin}
2107 \index[general]{The bpipe Plugin}
2108 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2109 the Bacula source distribution. When the plugin is compiled and linking into
2110 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2111 Please note that this is a very simple plugin that was written for
2112 demonstration and test purposes. It is and can be used in production, but
2113 that was never really intended.
2115 The purpose of the plugin is to provide an interface to any system program for
2116 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2117 the Include section of your Job's FileSet resource. The full syntax of the
2118 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2119 to specify the sytax as it wishes) is:
2122 Plugin = "<field1>:<field2>:<field3>:<field4>"
2127 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2128 stripped off, so in this case, we would put {\bf bpipe} in this field.
2130 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2131 pseudo path and filename under which the backup will be saved. This pseudo
2132 path and filename will be seen by the user in the restore file tree.
2133 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2134 backed up by the plugin will be put under that "pseudo" path and filename.
2135 You must be careful to choose a naming convention that is unique to avoid
2136 a conflict with a path and filename that actually exists on your system.
2138 \item {\bf field3} for the {\bf bpipe} plugin
2139 specifies the "reader" program that is called by the plugin during
2140 backup to read the data. {\bf bpipe} will call this program by doing a
2143 \item {\bf field4} for the {\bf bpipe} plugin
2144 specifies the "writer" program that is called by the plugin during
2145 restore to write the data back to the filesystem.
2148 Please note that for two items above describing the "reader" and "writer"
2149 fields, these programs are "executed" by Bacula, which
2150 means there is no shell interpretation of any command line arguments
2151 you might use. If you want to use shell characters (redirection of input
2152 or output, ...), then we recommend that you put your command or commands
2153 in a shell script and execute the script. In addition if you backup a
2154 file with the reader program, when running the writer program during
2155 the restore, Bacula will not automatically create the path to the file.
2156 Either the path must exist, or you must explicitly do so with your command
2157 or in a shell script.
2159 Putting it all together, the full plugin directive line might look
2163 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
2164 --opt --databases bacula:mysql"
2167 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2168 would be written on a single line.
2170 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2171 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
2172 program {\bf mysqldump -f --opt --database bacula} to read the data during
2173 backup. The mysqldump command outputs all the data for the database named
2174 {\bf bacula}, which will be read by the plugin and stored in the backup.
2175 During restore, the data that was backed up will be sent to the program
2176 specified in the last field, which in this case is {\bf mysql}. When
2177 {\bf mysql} is called, it will read the data sent to it by the plugn
2178 then write it back to the same database from which it came ({\bf bacula}
2181 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2182 the data from a specified program to Bacula for backup, and then from Bacula to
2183 a specified program for restore.
2185 By using different command lines to {\bf bpipe},
2186 you can backup any kind of data (ASCII or binary) depending
2187 on the program called.
2189 \section{Microsoft Exchange Server 2003/2007 Plugin}
2190 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
2191 \subsection{Background}
2192 The Exchange plugin was made possible by a funded development project
2193 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2194 The code for the plugin was written by James Harper, and the Bacula core
2195 code by Kern Sibbald. All the code for this funded development has become
2196 part of the Bacula project. Thanks to everyone who made it happen.
2198 \subsection{Concepts}
2199 Although it is possible to backup Exchange using Bacula VSS the Exchange
2200 plugin adds a good deal of functionality, because while Bacula VSS
2201 completes a full backup (snapshot) of Exchange, it does
2202 not support Incremental or Differential backups, restoring is more
2203 complicated, and a single database restore is not possible.
2205 Microsoft Exchange organises its storage into Storage Groups with
2206 Databases inside them. A default installation of Exchange will have a
2207 single Storage Group called 'First Storage Group', with two Databases
2208 inside it, "Mailbox Store (SERVER NAME)" and
2209 "Public Folder Store (SERVER NAME)",
2210 which hold user email and public folders respectively.
2212 In the default configuration, Exchange logs everything that happens to
2213 log files, such that if you have a backup, and all the log files since,
2214 you can restore to the present time. Each Storage Group has its own set
2215 of log files and operates independently of any other Storage Groups. At
2216 the Storage Group level, the logging can be turned off by enabling a
2217 function called "Enable circular logging". At this time the Exchange
2218 plugin will not function if this option is enabled.
2220 The plugin allows backing up of entire storage groups, and the restoring
2221 of entire storage groups or individual databases. Backing up and
2222 restoring at the individual mailbox or email item is not supported but
2223 can be simulated by use of the "Recovery" Storage Group (see below).
2225 \subsection{Installing}
2226 The Exchange plugin requires a DLL that is shipped with Microsoft
2227 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2228 correctly the Exchange plugin should find this automatically and run
2229 without any additional installation.
2231 If the DLL can not be found automatically it will need to be copied into
2232 the Bacula installation
2233 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
2234 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
2235 default Exchange installation.
2237 \subsection{Backing Up}
2238 To back up an Exchange server the Fileset definition must contain at
2239 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2240 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2241 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2242 up files are prefixed with something that isn't going to share a name
2243 with something outside the plugin, and the 'Microsoft Information Store'
2244 bit is required also. It is also possible to add the name of a storage
2245 group to the "Plugin =" line, eg \\
2246 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2247 if you want only a single storage group backed up.
2249 Additionally, you can suffix the 'Plugin =' directive with
2250 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2251 database at the end of a full backup.
2253 An Incremental or Differential backup will backup only the database logs
2254 for each Storage Group by inspecting the "modified date" on each
2255 physical log file. Because of the way the Exchange API works, the last
2256 logfile backed up on each backup will always be backed up by the next
2257 Incremental or Differential backup too. This adds 5MB to each
2258 Incremental or Differential backup size but otherwise does not cause any
2261 By default, a normal VSS fileset containing all the drive letters will
2262 also back up the Exchange databases using VSS. This will interfere with
2263 the plugin and Exchange's shared ideas of when the last full backup was
2264 done, and may also truncate log files incorrectly. It is important,
2265 therefore, that the Exchange database files be excluded from the backup,
2266 although the folders the files are in should be included, or they will
2267 have to be recreated manually if a baremetal restore is done.
2272 File = C:/Program Files/Exchsrvr/mdbdata
2273 Plugin = "exchange:..."
2276 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2277 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2278 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2279 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2280 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2281 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2282 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2287 The advantage of excluding the above files is that you can significantly
2288 reduce the size of your backup since all the important Exchange files
2289 will be properly saved by the Plugin.
2292 \subsection{Restoring}
2293 The restore operation is much the same as a normal Bacula restore, with
2294 the following provisos:
2297 \item The {\bf Where} restore option must not be specified
2298 \item Each Database directory must be marked as a whole. You cannot just
2299 select (say) the .edb file and not the others.
2300 \item If a Storage Group is restored, the directory of the Storage Group
2302 \item It is possible to restore only a subset of the available log files,
2303 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2304 if a log file is missing from the sequence of log files
2305 \item Each database to be restored must be dismounted and marked as "Can be
2306 overwritten by restore"
2307 \item If an entire Storage Group is to be restored (eg all databases and
2308 logs in the Storage Group), then it is best to manually delete the
2309 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
2310 as Exchange can get confused by stray log files lying around.
2313 \subsection{Restoring to the Recovery Storage Group}
2314 The concept of the Recovery Storage Group is well documented by
2316 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2317 but to briefly summarize...
2319 Microsoft Exchange allows the creation of an additional Storage Group
2320 called the Recovery Storage Group, which is used to restore an older
2321 copy of a database (e.g. before a mailbox was deleted) into without
2322 messing with the current live data. This is required as the Standard and
2323 Small Business Server versions of Exchange can not ordinarily have more
2324 than one Storage Group.
2326 To create the Recovery Storage Group, drill down to the Server in Exchange
2327 System Manager, right click, and select
2328 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
2329 locations and click OK. On the Recovery Storage Group, right click and
2330 select {\bf "Add Database to Recover..."} and select the database you will
2333 Restore only the single database nominated as the database in the
2334 Recovery Storage Group. Exchange will redirect the restore to the
2335 Recovery Storage Group automatically.
2336 Then run the restore.
2338 \subsection{Restoring on Microsoft Server 2007}
2339 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2340 2007, and henc you use a new proceedure for recovering a single mail box.
2341 This procedure is ducomented by Microsoft at:
2342 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2343 and involves using the {\bf Restore-Mailbox} and {\bf
2344 Get-MailboxStatistics} shell commands.
2346 \subsection{Caveats}
2347 This plugin is still being developed, so you should consider it
2348 currently in BETA test, and thus use in a production environment
2349 should be done only after very careful testing.
2351 When doing a full backup, the Exchange database logs are truncated by
2352 Exchange as soon as the plugin has completed the backup. If the data
2353 never makes it to the backup medium (eg because of spooling) then the
2354 logs will still be truncated, but they will also not have been backed
2355 up. A solution to this is being worked on. You will have to schedule a
2356 new Full backup to ensure that your next backups will be usable.
2358 The "Enable Circular Logging" option cannot be enabled or the plugin
2361 Exchange insists that a successful Full backup must have taken place if
2362 an Incremental or Differential backup is desired, and the plugin will
2363 fail if this is not the case. If a restore is done, Exchange will
2364 require that a Full backup be done before an Incremental or Differential
2367 The plugin will most likely not work well if another backup application
2368 (eg NTBACKUP) is backing up the Exchange database, especially if the
2369 other backup application is truncating the log files.
2371 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2372 we recommend either carefully testing or that you avoid this option for
2375 The Exchange plugin is not called during processing the bconsole {\bf
2376 estimate} command, and so anything that would be backed up by the plugin
2377 will not be added to the estimate total that is displayed.
2380 \section{libdbi Framework}
2381 \index[general]{libdbi Framework}
2382 As a general guideline, Bacula has support for a few catalog database drivers
2383 (MySQL, PostgreSQL, SQLite)
2384 coded natively by the Bacula team. With the libdbi implementation, which is a
2385 Bacula driver that uses libdbi to access the catalog, we have an open field to
2386 use many different kinds database engines following the needs of users.
2388 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
2389 implements a database-independent abstraction layer in C, similar to the
2390 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2391 leverage the power of multiple databases and multiple simultaneous database
2392 connections by using this framework.
2394 Currently the libdbi driver in Bacula project only supports the same drivers
2395 natively coded in Bacula. However the libdbi project has support for many
2396 others database engines. You can view the list at
2397 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2398 supported by Bacula, however, they must be tested properly by the Bacula team.
2400 Some of benefits of using libdbi are:
2402 \item The possibility to use proprietary databases engines in which your
2403 proprietary licenses prevent the Bacula team from developing the driver.
2404 \item The possibility to use the drivers written for the libdbi project.
2405 \item The possibility to use other database engines without recompiling Bacula
2406 to use them. Just change one line in bacula-dir.conf
2407 \item Abstract Database access, this is, unique point to code and profiling
2408 catalog database access.
2411 The following drivers have been tested:
2413 \item PostgreSQL, with and without batch insert
2414 \item Mysql, with and without batch insert
2419 In the future, we will test and approve to use others databases engines
2420 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2422 To compile Bacula to support libdbi we need to configure the code with the
2423 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2424 [database] is the database engine to be used with Bacula (of course we can
2425 change the driver in file bacula-dir.conf, see below). We must configure the
2426 access port of the database engine with the option --with-db-port, because the
2427 libdbi framework doesn't know the default access port of each database.
2429 The next phase is checking (or configuring) the bacula-dir.conf, example:
2433 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2434 dbname = regress; user = regress; password = ""
2438 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2439 mysql database. Currently the drivers supported by Bacula are: postgresql,
2440 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2442 The following limitations apply when Bacula is set to use the libdbi framework:
2443 - Not tested on the Win32 platform
2444 - A little performance is lost if comparing with native database driver.
2445 The reason is bound with the database driver provided by libdbi and the
2446 simple fact that one more layer of code was added.
2448 It is important to remember, when compiling Bacula with libdbi, the
2449 following packages are needed:
2451 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2452 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2455 You can download them and compile them on your system or install the packages
2456 from your OS distribution.
2458 \section{Console Command Additions and Enhancements}
2459 \index[general]{Console Additions}
2461 \subsection{Display Autochanger Content}
2462 \index[general]{StatusSlots}
2464 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2465 autochanger content.
2469 Slot | Volume Name | Status | Media Type | Pool |
2470 ------+---------------+----------+-------------------+------------|
2471 1 | 00001 | Append | DiskChangerMedia | Default |
2472 2 | 00002 | Append | DiskChangerMedia | Default |
2473 3*| 00003 | Append | DiskChangerMedia | Scratch |
2478 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2479 {\bf update slots} command to synchronize autochanger content with your
2482 \subsection{list joblog job=xxx or jobid=nnn}
2483 \index[general]{list joblog}
2484 A new list command has been added that allows you to list the contents
2485 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2486 or for a particular JobId. The {\bf llist} command will include a line with
2487 the time and date of the entry.
2489 Note for the catalog to have Job Log entries, you must have a directive
2496 In your Director's {\bf Messages} resource.
2498 \subsection{Use separator for multiple commands}
2499 \index[general]{Command Separator}
2500 When using bconsole with readline, you can set the command separator with
2501 \textbf{@separator} command to one
2502 of those characters to write commands who require multiple input in one line.
2504 !$%&'()*+,-/:;<>?[]^`{|}~
2507 \subsection{Deleting Volumes}
2508 The delete volume bconsole command has been modified to
2509 require an asterisk (*) in front of a MediaId otherwise the
2510 value you enter is a taken to be a Volume name. This is so that
2511 users may delete numeric Volume names. The previous Bacula versions
2512 assumed that all input that started with a number was a MediaId.
2514 This new behavior is indicated in the prompt if you read it
2517 \section{Bare Metal Recovery}
2518 The old bare metal recovery project is essentially dead. One
2519 of the main features of it was that it would build a recovery
2520 CD based on the kernel on your system. The problem was that
2521 every distribution has a different boot procedure and different
2522 scripts, and worse yet, the boot procedures and scripts change
2523 from one distribution to another. This meant that maintaining
2524 (keeping up with the changes) the rescue CD was too much work.
2526 To replace it, a new bare metal recovery USB boot stick has been developed
2527 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2528 boot from a USB key.
2532 \item Recovery can be done from within graphical environment.
2533 \item Recovery can be done in a shell.
2534 \item Ubuntu boots on a large number of Linux systems.
2535 \item The process of updating the system and adding new
2536 packages is not too difficult.
2537 \item The USB key can easily be upgraded to newer Ubuntu versions.
2538 \item The USB key has writable partitions for modifications to
2539 the OS and for modification to your home directory.
2540 \item You can add new files/directories to the USB key very easily.
2541 \item You can save the environment from multiple machines on
2543 \item Bacula Systems is funding its ongoing development.
2546 The disadvantages are:
2548 \item The USB key is usable but currently under development.
2549 \item Not everyone may be familiar with Ubuntu (no worse
2551 \item Some older OSes cannot be booted from USB. This can
2552 be resolved by first booting a Ubuntu LiveCD then plugging
2554 \item Currently the documentation is sketchy and not yet added
2555 to the main manual. See below ...
2558 The documentation and the code can be found in the {\bf rescue} package
2559 in the directory {\bf linux/usb}.
2561 \section{Miscellaneous}
2562 \index[general]{Misc New Features}
2564 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2565 \index[general]{Allow Mixed Priority}
2566 This directive is only implemented in version 2.5 and later. When
2567 set to {\bf yes} (default {\bf no}), this job may run even if lower
2568 priority jobs are already running. This means a high priority job
2569 will not have to wait for other jobs to finish before starting.
2570 The scheduler will only mix priorities when all running jobs have
2573 Note that only higher priority jobs will start early. Suppose the
2574 director will allow two concurrent jobs, and that two jobs with
2575 priority 10 are running, with two more in the queue. If a job with
2576 priority 5 is added to the queue, it will be run as soon as one of
2577 the running jobs finishes. However, new priority 10 jobs will not
2578 be run until the priority 5 job has finished.
2580 \subsection{Bootstrap File Directive -- FileRegex}
2581 \index[general]{Bootstrap File Directive}
2582 {\bf FileRegex} is a new command that can be added to the bootstrap
2583 (.bsr) file. The value is a regular expression. When specified, only
2584 matching filenames will be restored.
2586 During a restore, if all File records are pruned from the catalog
2587 for a Job, normally Bacula can restore only all files saved. That
2588 is there is no way using the catalog to select individual files.
2589 With this new feature, Bacula will ask if you want to specify a Regex
2590 expression for extracting only a part of the full backup.
2593 Building directory tree for JobId(s) 1,3 ...
2594 There were no files inserted into the tree, so file selection
2595 is not possible.Most likely your retention policy pruned the files
2597 Do you want to restore all the files? (yes\vb{}no): no
2599 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2600 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2603 \subsection{Bootstrap File Optimization Changes}
2604 In order to permit proper seeking on disk files, we have extended the bootstrap
2605 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2606 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2607 address range and end address range respectively. These two directives replace
2608 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2609 VolEndBlock} directives. Bootstrap files containing the old directives will
2610 still work, but will not properly take advantage of proper disk seeking, and
2611 may read completely to the end of a disk volume during a restore. With the new
2612 format (automatically generated by the new Director), restores will seek
2613 properly and stop reading the volume when all the files have been restored.
2615 \subsection{Solaris ZFS/NFSv4 ACLs}
2616 This is an upgrade of the previous Solaris ACL backup code
2617 to the new library format, which will backup both the old
2618 POSIX(UFS) ACLs as well as the ZFS ACLs.
2620 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2621 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2622 be used to transfer from UFS to ZFS filesystems.
2625 \subsection{Virtual Tape Emulation}
2626 \index[general]{Virtual Tape Emulation}
2627 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2628 the tape code but actually reading and writing to a disk file. Used with the
2629 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2630 and 700 slots. This feature is most useful in testing. It is enabled
2631 by using {\bf Device Type = vtape} in the Storage daemon's Device
2632 directive. This feature is only implemented on Linux machines and should not be
2633 used for production.
2635 \subsection{Bat Enhancements}
2636 \index[general]{Bat Enhancements}
2637 Bat (the Bacula Administration Tool) GUI program has been significantly
2638 enhanced and stabilized. In particular, there are new table based status
2639 commands; it can now be easily localized using Qt4 Linguist.
2641 The Bat communications protocol has been significantly enhanced to improve
2642 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2643 the Director you are using otherwise the communications protocol will not
2646 \subsection{RunScript Enhancements}
2647 \index[general]{RunScript Enhancements}
2648 The {\bf RunScript} resource has been enhanced to permit multiple
2649 commands per RunScript. Simply specify multiple {\bf Command} directives
2656 Command = "/bin/echo test"
2657 Command = "/bin/echo an other test"
2658 Command = "/bin/echo 3 commands in the same runscript"
2665 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2666 implemented, which runs the command after the Volume Shadow Copy has been made.
2668 Console commands can be specified within a RunScript by using:
2669 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2670 carefully tested and debugged and is known to easily crash the Director.
2671 We would appreciate feedback. Due to the recursive nature of this command, we
2672 may remove it before the final release.
2674 \subsection{Status Enhancements}
2675 \index[general]{Status Enhancements}
2676 The bconsole {\bf status dir} output has been enhanced to indicate
2677 Storage daemon job spooling and despooling activity.
2679 \subsection{Connect Timeout}
2680 \index[general]{Connect Timeout}
2681 The default connect timeout to the File
2682 daemon has been set to 3 minutes. Previously it was 30 minutes.
2684 \subsection{ftruncate for NFS Volumes}
2685 \index[general]{ftruncate for NFS Volumes}
2686 If you write to a Volume mounted by NFS (say on a local file server),
2687 in previous Bacula versions, when the Volume was recycled, it was not
2688 properly truncated because NFS does not implement ftruncate (file
2689 truncate). This is now corrected in the new version because we have
2690 written code (actually a kind user) that deletes and recreates the Volume,
2691 thus accomplishing the same thing as a truncate.
2693 \subsection{Support for Ubuntu}
2694 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2695 version of Linux, and thus now provides correct autostart routines.
2696 Since Ubuntu officially supports Bacula, you can also obtain any
2697 recent release of Bacula from the Ubuntu repositories.
2699 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2700 \index[general]{Recycle Pool}
2701 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2702 be placed (moved) when it is recycled. Without this directive, a Volume will
2703 remain in the same pool when it is recycled. With this directive, it can be
2704 moved automatically to any existing pool during a recycle. This directive is
2705 probably most useful when defined in the Scratch pool, so that volumes will
2706 be recycled back into the Scratch pool.
2708 \subsection{FD Version}
2709 \index[general]{FD Version}
2710 The File daemon to Director protocol now includes a version
2711 number, which although there is no visible change for users,
2712 will help us in future versions automatically determine
2713 if a File daemon is not compatible.
2715 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2716 \index[general]{Max Run Sched Time}
2717 The time specifies the maximum allowed time that a job may run, counted from
2718 when the job was scheduled. This can be useful to prevent jobs from running
2719 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2722 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2723 \index[general]{Max Wait Time}
2724 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2725 of checking the maximum allowed time that a job may block for a resource,
2726 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2727 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2728 their job depending on the level. Now, they have to use
2729 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2730 directives are now deprecated.
2732 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2733 \index[general]{Incremental Max Wait Time}
2734 \index[general]{Differential Max Wait Time}
2736 These directives have been deprecated in favor of
2737 \texttt{Incremental|Differential Max Run Time}.
2739 \subsection{Max Run Time directives}
2740 \index[general]{Max Run Time directives}
2741 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2742 maximum allowed time that a job can run depending on the level.
2744 \addcontentsline{lof}{figure}{Job time control directives}
2745 \includegraphics{\idir different_time.eps}
2747 \subsection{Statistics Enhancements}
2748 \index[general]{Statistics Enhancements}
2749 If you (or probably your boss) want to have statistics on your backups to
2750 provide some \textit{Service Level Agreement} indicators, you could use a few
2751 SQL queries on the Job table to report how many:
2755 \item jobs have been successful
2756 \item files have been backed up
2760 However, these statistics are accurate only if your job retention is greater
2761 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2762 be able to use them.
2764 Now, you can use the \textbf{update stats [days=num]} console command to fill
2765 the JobHistory table with new Job records. If you want to be sure to take in
2766 account only \textbf{good jobs}, ie if one of your important job has failed but
2767 you have fixed the problem and restarted it on time, you probably want to
2768 delete the first \textit{bad} job record and keep only the successful one. For
2769 that simply let your staff do the job, and update JobHistory table after two or
2770 three days depending on your organization using the \textbf{[days=num]} option.
2772 These statistics records aren't used for restoring, but mainly for
2773 capacity planning, billings, etc.
2775 The Bweb interface provides a statistics module that can use this feature. You
2776 can also use tools like Talend or extract information by yourself.
2778 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2779 the length of time that Bacula will keep statistics job records in the Catalog
2780 database after the Job End time. (In \texttt{JobHistory} table) When this time
2781 period expires, and if user runs \texttt{prune stats} command, Bacula will
2782 prune (remove) Job records that are older than the specified period.
2784 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2785 job to maintain statistics.
2788 Name = BackupCatalog
2791 Console = "update stats days=3"
2792 Console = "prune stats yes"
2799 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2800 \index[general]{ScratchPool}
2801 This directive permits to specify a specific \textsl{Scratch} pool for the
2802 current pool. This is useful when using multiple storage sharing the same
2803 mediatype or when you want to dedicate volumes to a particular set of pool.
2805 \subsection{Enhanced Attribute Despooling}
2806 \index[general]{Attribute Despooling}
2807 If the storage daemon and the Director are on the same machine, the spool file
2808 that contains attributes is read directly by the Director instead of being
2809 transmitted across the network. That should reduce load and speedup insertion.
2811 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2812 \index[general]{SpoolSize}
2813 A new Job directive permits to specify the spool size per job. This is used
2814 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2816 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2817 \index[general]{MaximumConsoleConnections}
2818 A new director directive permits to specify the maximum number of Console
2819 Connections that could run concurrently. The default is set to 20, but you may
2820 set it to a larger number.
2822 \subsection{VerId = \lt{}string\gt{}}
2823 \index[general]{VerId}
2824 A new director directive permits to specify a personnal identifier that will be
2825 displayed in the \texttt{version} command.
2827 \subsection{dbcheck enhancements}
2828 \index[general]{dbcheck enhancements}
2829 If you are using Mysql, dbcheck will now ask you if you want to create
2830 temporary indexes to speed up orphaned Path and Filename elimination.
2832 A new \texttt{-B} option allows you to print catalog information in a simple
2833 text based format. This is useful to backup it in a secure way.
2848 You can now specify the database connection port in the command line.
2850 \subsection{{-}{-}docdir configure option}
2851 \index[general]{{-}{-}docdir configure option}
2852 You can use {-}{-}docdir= on the ./configure command to
2853 specify the directory where you want Bacula to install the
2854 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2855 {\bf /usr/share/doc/bacula}.
2857 \subsection{{-}{-}htmldir configure option}
2858 \index[general]{{-}{-}htmldir configure option}
2859 You can use {-}{-}htmldir= on the ./configure command to
2860 specify the directory where you want Bacula to install the bat html help
2861 files. The default is {\bf /usr/share/doc/bacula/html}
2863 \subsection{{-}{-}with-plugindir configure option}
2864 \index[general]{{-}{-}plugindir configure option}
2865 You can use {-}{-}plugindir= on the ./configure command to
2866 specify the directory where you want Bacula to install
2867 the plugins (currently only bpipe-fd). The default is