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{SQL Catalog Enhancements}
210 % TODO: Marco can explain more things
211 Bacula uses a new catalog backend structure, it allows to build all SQL drivers
212 with the same \texttt{./configure ; make} session.
214 We also added cursor support for PostgreSQL backend, this improves memory usage
215 for large installation.
217 \section{Changes in Bvfs (Bacula Virtual FileSystem)}
219 Bat has now a bRestore panel that uses Bvfs to display files and
220 directories. It's still experimental.
224 \includegraphics[width=12cm]{\idir bat-brestore}
225 \label{fig:batbrestore}
226 \caption{Bat Brestore Panel}
229 \texttt{Important}, the Bvfs module is not currently compatible with BaseJobs,
230 Copy and Migration jobs.
233 This project was funded by Bacula Systems.
235 \subsection*{General notes}
238 \item All fields are separated by a tab
239 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
240 records in very big directories
241 \item All operations (except cache creation) are designed to run instantly
242 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
243 can contribute new faster SQL queries we will be happy, else don't complain
245 \item The cache creation is dependent of the number of directories. As Bvfs
246 shares information accross jobs, the first creation can be slow
247 \item All fields are separated by a tab
248 \item Due to potential encoding problem, it's advised to allways use pathid in
252 \subsection*{Get dependent jobs from a given JobId}
254 Bvfs allows you to query the catalog against any combination of jobs. You
255 can combine all Jobs and all FileSet for a Client in a single session.
257 To get all JobId needed to restore a particular job, you can use the
258 \texttt{.bvfs\_get\_jobids} command.
261 .bvfs_get_jobids jobid=num [all]
265 .bvfs_get_jobids jobid=10
267 .bvfs_get_jobids jobid=10 all
271 In this example, a normal restore will need to use JobIds 1,2,5,10 to
272 compute a complete restore of the system.
274 With the \texttt{all} option, the Director will use all defined FileSet for
277 \subsection*{Generating Bvfs cache}
279 The \texttt{.bvfs\_update} command computes the directory cache for jobs
280 specified in argument, or for all jobs if unspecified.
283 .bvfs_update [jobid=numlist]
288 .bvfs_update jobid=1,2,3
291 You can run the cache update process in a RunScript after the catalog backup.
293 \subsection*{Get all versions of a specific file}
295 Bvfs allows you to find all versions of a specific file for a given Client with
296 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
297 function uses only PathId and FilenameId. The jobid argument is mandatory but
301 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
302 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
303 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
310 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
311 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
314 \subsection*{List directories}
316 Bvfs allows you to list directories in a specific path.
318 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
319 PathId FilenameId FileId JobId LStat Path
320 PathId FilenameId FileId JobId LStat Path
321 PathId FilenameId FileId JobId LStat Path
325 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
326 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
327 listed is a directory.
330 .bvfs_lsdirs pathid=4 jobid=1,11,12
331 4 0 0 0 A A A A A A A A A A A A A A .
332 5 0 0 0 A A A A A A A A A A A A A A ..
333 3 0 0 0 A A A A A A A A A A A A A A regress/
336 In this example, to list directories present in \texttt{regress/}, you can use
338 .bvfs_lsdirs pathid=3 jobid=1,11,12
339 3 0 0 0 A A A A A A A A A A A A A A .
340 4 0 0 0 A A A A A A A A A A A A A A ..
341 2 0 0 0 A A A A A A A A A A A A A A tmp/
344 \subsection*{List files}
346 Bvfs allows you to list files in a specific path.
348 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
349 PathId FilenameId FileId JobId LStat Path
350 PathId FilenameId FileId JobId LStat Path
351 PathId FilenameId FileId JobId LStat Path
355 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
356 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
360 .bvfs_lsfiles pathid=4 jobid=1,11,12
361 4 0 0 0 A A A A A A A A A A A A A A .
362 5 0 0 0 A A A A A A A A A A A A A A ..
363 1 0 0 0 A A A A A A A A A A A A A A regress/
366 In this example, to list files present in \texttt{regress/}, you can use
368 .bvfs_lsfiles pathid=1 jobid=1,11,12
369 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
370 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
371 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
372 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
373 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
376 \subsection*{Restore set of files}
378 Bvfs allows you to create a SQL table that contains files that you want to
379 restore. This table can be provided to a restore command with the file option.
382 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
384 restore file=?b2num ...
387 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
388 select all files. This query could be time consuming.
390 \texttt{hardlink} list is always composed of a serie of two numbers (jobid,
391 fileindex). This information can be found in the LinkFI field of the LStat
394 The \texttt{path} argument represents the name of the table that Bvfs will
395 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
396 b2 and followed by digits).
401 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
405 \subsection*{Cleanup after restore}
407 To drop the table used by the restore command, you can use the
408 \texttt{.bvfs\_cleanup} command.
411 .bvfs_cleanup path=b20001
414 \section{Changes in the pruning algorithm}
416 We rewrote the job pruning algorithm in this version. Previously, in some users
417 reported that the pruning process at the end of jobs was very long. It should
418 not be longer the case. Now, Bacula won't prune automatically a Job if this
419 particular Job is needed to restore data. Example:
423 JobId: 2 Level: Incremental
424 JobId: 3 Level: Incremental
425 JobId: 4 Level: Differential
426 .. Other incrementals up to now
429 In this example, if the Job Retention defined in the Pool or in the Client
430 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
431 detect that JobId 1 and 4 are essential to restore data at the current state
432 and will prune only JobId 2 and 3.
434 \texttt{Important}, this change affect only the automatic pruning step after a
435 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
436 \texttt{VolumeRetention} period, important jobs can be pruned.
438 \section{Ability to Verify any specified Job}
439 You now have the ability to tell Bacula which Job should verify instead of
440 automatically verify just the last one.
442 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
444 To verify a given job, just specify the Job jobid in argument when starting the
447 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
449 JobName: VerifyVolume
450 Level: VolumeToCatalog
453 Pool: Default (From Job resource)
454 Storage: File (From Job resource)
455 Verify Job: VerifyVol.2010-09-08_14.17.17_03
456 Verify List: /tmp/regress/working/VerifyVol.bsr
457 When: 2010-09-08 14:17:31
459 OK to run? (yes/mod/no):
463 This project was funded by Bacula Systems and is available with Bacula
464 Enterprise Edition and Community Edition.
466 \section{Additions to RunScript variables}
467 You can have access to JobBytes and JobFiles using \%b and \%f in your runscript
468 command. The Client address is now available through \%h.
471 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%f ClientAddress=%h"
474 %\section{Changes in drivetype.exe}
476 %Now the \texttt{drivetype.exe} program allows you to list all local hard
477 %drives. It can help to build dynamic FileSet on Windows.
480 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
484 \section{ACL/Extended Attributes}
486 We added support for NFSv4 ACLs on FreeBSD 8.1 and IRIX extended attributes.
488 This project was funded by Marco van Wieringen.
490 \section{Additions to the Plugin API}
491 The bfuncs structure has been extended to include a number of
495 The bFuncs structure defines the callback entry points within Bacula
496 that the plugin can use register events, get Bacula values, set
497 Bacula values, and send messages to the Job output or debug output.
499 The exact definition as of this writing is:
501 typedef struct s_baculaFuncs {
504 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
505 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
506 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
507 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
508 int type, utime_t mtime, const char *fmt, ...);
509 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
510 int level, const char *fmt, ...);
511 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
513 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
515 /* New functions follow */
516 bRC (*AddExclude)(bpContext *ctx, const char *file);
517 bRC (*AddInclude)(bpContext *ctx, const char *file);
518 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
519 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
520 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
521 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
527 \item [AddExclude] can be called to exclude a file. The file
528 string passed may include wildcards that will be interpreted by
529 the {\bf fnmatch} subroutine. This function can be called
530 multiple times, and each time the file specified will be added
531 to the list of files to be excluded. Note, this function only
532 permits adding excludes of specific file or directory names,
533 or files matched by the rather simple fnmatch mechanism.
534 See below for information on doing wild-card and regex excludes.
536 \item [NewInclude] can be called to create a new Include block. This
537 block will be added before any user defined Include blocks. This
538 function can be called multiple times, but each time, it will create
539 a new Include section (not normally needed). This function should
540 be called only if you want to add an entirely new Include block.
542 \item [AddInclude] can be called to add new files/directories to
543 be included. They are added to the current Include block. If
544 NewInclude has not been included, the current Include block is
545 the last one that the user created. This function
546 should be used only if you want to add totally new files/directories
547 to be included in the backup.
549 \item [NewOptions] adds a new Options block to the current Include
550 in front of any other Options blocks. This permits the plugin to
551 add exclude directives (wild-cards and regexes) in front of the
552 user Options, and thus prevent certain files from being backed up.
553 This can be useful if the plugin backs up files, and they should
554 not be also backed up by the main Bacula code. This function
555 may be called multiple times, and each time, it creates a new
556 prepended Options block. Note: normally you want to call this
557 entry point prior to calling AddOptions, AddRegex, or AddWild.
559 \item [AddOptions] allows the plugin it set options in
560 the current Options block, which is normally created with the
561 NewOptions call just prior to adding Include Options.
562 The permitted options are passed as a character string, where
563 each character has a specific meaning as defined below:
566 \item [a] always replace files (default).
567 \item [e] exclude rather than include.
568 \item [h] no recursion into subdirectories.
569 \item [H] do not handle hard links.
570 \item [i] ignore case in wildcard and regex matches.
571 \item [M] compute an MD5 sum.
572 \item [p] use a portable data format on Windows (not recommended).
573 \item [R] backup resource forks and Findr Info.
574 \item [r] read from a fifo
575 \item [S1] compute an SHA1 sum.
576 \item [S2] compute an SHA256 sum.
577 \item [S3] comput an SHA512 sum.
578 \item [s] handle sparse files.
579 \item [m] use st\_mtime only for file differences.
580 \item [k] restore the st\_atime after accessing a file.
581 \item [A] enable ACL backup.
582 \item [Vxxx:] specify verify options. Must terminate with :
583 \item [Cxxx:] specify accurate options. Must terminate with :
584 \item [Jxxx:] specify base job Options. Must terminate with :
585 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
587 \item [Zn] specify gzip compression level n.
588 \item [K] do not use st\_atime in backup decision.
589 \item [c] check if file changed during backup.
590 \item [N] honor no dump flag.
591 \item [X] enable backup of extended attributes.
594 \item [AddRegex] adds a regex expression to the current Options block.
595 The fillowing options are permitted:
597 \item [ ] (a blank) regex applies to whole path and filename.
598 \item [F] regex applies only to the filename (directory or path stripped).
599 \item [D] regex applies only to the directory (path) part of the name.
602 \item [AddWild] adds a wildcard expression to the current Options block.
603 The fillowing options are permitted:
605 \item [ ] (a blank) regex applies to whole path and filename.
606 \item [F] regex applies only to the filename (directory or path stripped).
607 \item [D] regex applies only to the directory (path) part of the name.
610 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
611 that can use Accurate code to compare the file information in argument with
612 the previous file information. The \texttt{delta\_seq} attribute of the
613 \texttt{save\_pkt} will be updated, and the call will return
614 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
619 \subsection{Bacula events}
620 The list of events has been extended to include:
626 bEventStartBackupJob = 3,
627 bEventEndBackupJob = 4,
628 bEventStartRestoreJob = 5,
629 bEventEndRestoreJob = 6,
630 bEventStartVerifyJob = 7,
631 bEventEndVerifyJob = 8,
632 bEventBackupCommand = 9,
633 bEventRestoreCommand = 10,
638 bEventCancelCommand = 13,
639 bEventVssBackupAddComponents = 14,
640 bEventVssRestoreLoadComponentMetadata = 15,
641 bEventVssRestoreSetComponentsSelected = 16,
642 bEventRestoreObject = 17,
643 bEventEndFileSet = 18,
644 bEventPluginCommand = 19,
645 bEventVssBeforeCloseRestore = 20,
646 bEventVssPrepareSnapshot = 21
652 \item [bEventCancelCommand] is called whenever the currently
653 running Job is cancelled */
655 \item [bEventVssBackupAddComponents]
657 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
658 provides a char[27] table where the plugin can add Windows drives that will
659 be used during the Job. You need to add them without duplicates, and you can
660 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
664 \chapter{Release Version 5.0.3}
666 There are no new features in version 5.0.2. This version simply fixes a
667 number of bugs found in version 5.0.1 during the onging development
670 \chapter{Release Version 5.0.2}
672 There are no new features in version 5.0.2. This version simply fixes a
673 number of bugs found in version 5.0.1 during the onging development
679 \chapter{New Features in 5.0.1}
681 This chapter presents the new features that are in the released Bacula version
682 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
683 the onging development process.
685 \section{Truncate Volume after Purge}
686 \label{sec:actiononpurge}
688 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
689 the volume when it is purged with the new command \texttt{purge volume
690 action}. It is useful to prevent disk based volumes from consuming too much
696 Action On Purge = Truncate
701 As usual you can also set this property with the \texttt{update volume} command
703 *update volume=xxx ActionOnPurge=Truncate
704 *update volume=xxx actiononpurge=None
707 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
708 following command in interactive mode or in a RunScript as shown after:
710 *purge volume action=truncate storage=File allpools
711 # or by default, action=all
712 *purge volume action storage=File pool=Default
715 This is possible to specify the volume name, the media type, the pool, the
716 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
717 idle when you decide to run this command.
726 Console = "purge volume action=all allpools storage=File"
731 \textbf{Important note}: This feature doesn't work as
732 expected in version 5.0.0. Please do not use it before version 5.0.1.
734 \section{Allow Higher Duplicates}
735 This directive did not work correctly and has been depreciated
736 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
737 file as it will be removed in a future rlease.
739 \section{Cancel Lower Level Duplicates}
740 This directive was added in Bacula version 5.0.1. It compares the
741 level of a new backup job to old jobs of the same name, if any,
742 and will kill the job which has a lower level than the other one.
743 If the levels are the same (i.e. both are Full backups), then
744 nothing is done and the other Cancel XXX Duplicate directives
747 \chapter{New Features in 5.0.0}
749 \section{Maximum Concurent Jobs for Devices}
750 \label{sec:maximumconcurentjobdevice}
752 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
753 Daemon configuration permits setting the maximum number of Jobs that can
754 run concurrently on a specified Device. Using this directive, it is
755 possible to have different Jobs using multiple drives, because when the
756 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
757 Jobs on any other available compatible drive. This facilitates writing to
758 multiple drives with multiple Jobs that all use the same Pool.
760 This project was funded by Bacula Systems.
762 \section{Restore from Multiple Storage Daemons}
763 \index[general]{Restore}
765 Previously, you were able to restore from multiple devices in a single Storage
766 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
767 example, if your full backup runs on a Storage Daemon with an autochanger, and
768 your incremental jobs use another Storage Daemon with lots of disks, Bacula
769 will switch automatically from one Storage Daemon to an other within the same
772 You must upgrade your File Daemon to version 3.1.3 or greater to use this
775 This project was funded by Bacula Systems with the help of Equiinet.
777 \section{File Deduplication using Base Jobs}
778 A base job is sort of like a Full save except that you will want the FileSet to
779 contain only files that are unlikely to change in the future (i.e. a snapshot
780 of most of your system after installing it). After the base job has been run,
781 when you are doing a Full save, you specify one or more Base jobs to be used.
782 All files that have been backed up in the Base job/jobs but not modified will
783 then be excluded from the backup. During a restore, the Base jobs will be
784 automatically pulled in where necessary.
786 This is something none of the competition does, as far as we know (except
787 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
788 win for the user, it makes Bacula stand out as offering a unique optimization
789 that immediately saves time and money. Basically, imagine that you have 100
790 nearly identical Windows or Linux machine containing the OS and user files.
791 Now for the OS part, a Base job will be backed up once, and rather than making
792 100 copies of the OS, there will be only one. If one or more of the systems
793 have some files updated, no problem, they will be automatically restored.
795 See the \ilink{Base Job Chapter}{basejobs} for more information.
797 This project was funded by Bacula Systems.
799 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
800 \index[dir]{AllowCompression}
802 This new directive may be added to Storage resource within the Director's
803 configuration to allow users to selectively disable the client compression for
804 any job which writes to this storage resource.
810 Address = ultrium-tape
811 Password = storage_password # Password for Storage Daemon
814 AllowCompression = No # Tape drive has hardware compression
817 The above example would cause any jobs running with the UltriumTape storage
818 resource to run without compression from the client file daemons. This
819 effectively overrides any compression settings defined at the FileSet level.
821 This feature is probably most useful if you have a tape drive which supports
822 hardware compression. By setting the \texttt{AllowCompression = No} directive
823 for your tape drive storage resource, you can avoid additional load on the file
824 daemon and possibly speed up tape backups.
826 This project was funded by Collaborative Fusion, Inc.
828 \section{Accurate Fileset Options}
829 \label{sec:accuratefileset}
831 In previous versions, the accurate code used the file creation and modification
832 times to determine if a file was modified or not. Now you can specify which
833 attributes to use (time, size, checksum, permission, owner, group, \dots),
834 similar to the Verify options.
850 \item {\bf i} compare the inodes
851 \item {\bf p} compare the permission bits
852 \item {\bf n} compare the number of links
853 \item {\bf u} compare the user id
854 \item {\bf g} compare the group id
855 \item {\bf s} compare the size
856 \item {\bf a} compare the access time
857 \item {\bf m} compare the modification time (st\_mtime)
858 \item {\bf c} compare the change time (st\_ctime)
859 \item {\bf d} report file size decreases
860 \item {\bf 5} compare the MD5 signature
861 \item {\bf 1} compare the SHA1 signature
864 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
865 the File Daemon will have to read all files even if they normally would not
866 be saved. This increases the I/O load, but also the accuracy of the
867 deduplication. By default, Bacula will check modification/creation time
870 This project was funded by Bacula Systems.
872 \section{Tab-completion for Bconsole}
873 \label{sec:tabcompletion}
875 If you build \texttt{bconsole} with readline support, you will be able to use
876 the new auto-completion mode. This mode supports all commands, gives help
877 inside command, and lists resources when required. It works also in the restore
880 To use this feature, you should have readline development package loaded on
881 your system, and use the following option in configure.
883 ./configure --with-readline=/usr/include/readline --disable-conio ...
886 The new bconsole won't be able to tab-complete with older directors.
888 This project was funded by Bacula Systems.
890 \section{Pool File and Job Retention}
891 \label{sec:poolfilejobretention}
893 We added two new Pool directives, \texttt{FileRetention} and
894 \texttt{JobRetention}, that take precedence over Client directives of the same
895 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
896 example, you can decide to increase Retention times for Archive or OffSite Pool.
898 It seems obvious to us, but apparently not to some users, that given the
899 definition above that the Pool File and Job Retention periods is a global
900 override for the normal Client based prunning, which means that when the
901 Job is prunned, the prunning will apply globally to that particular Job.
903 Currently, there is a bug in the implementation that causes any Pool
904 retention periods specified to apply to {\bf all} Pools for that
905 particular Client. Thus we suggest that you avoid using these two
906 directives until this implementation problem is corrected.
908 \section{Read-only File Daemon using capabilities}
909 \label{sec:fdreadonly}
910 This feature implements support of keeping \textbf{ReadAll} capabilities after
911 UID/GID switch, this allows FD to keep root read but drop write permission.
913 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
914 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
917 root@localhost:~# bacula-fd -k -u nobody -g nobody
920 The code for this feature was contributed by our friends at AltLinux.
925 To help developers of restore GUI interfaces, we have added new \textsl{dot
926 commands} that permit browsing the catalog in a very simple way.
929 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
930 the Bvfs cache in the catalog. You need to run it before any access to the
933 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
934 will list all directories in the specified \texttt{path} or
935 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
936 encoding of path/filenames.
938 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
939 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
940 \texttt{pathid} avoids problems with character encoding.
943 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
944 data that will be displayed.
947 * .bvfs_update jobid=1,2
949 * .bvfs_lsdir path=/ jobid=1,2
952 This project was funded by Bacula Systems.
954 \section{Testing your Tape Drive}
955 \label{sec:btapespeed}
957 To determine the best configuration of your tape drive, you can run the new
958 \texttt{speed} command available in the \texttt{btape} program.
960 This command can have the following arguments:
962 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
963 (between 1 and 5GB). This counter is in GB.
964 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
965 of data should be greater than your memory ($file\_size*nb\_file$).
966 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
968 \item[\texttt{skip\_random}] This flag permits to skip tests with random
970 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
971 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
976 *speed file_size=3 skip_raw
977 btape.c:1078 Test with zero data and bacula block structure.
978 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
979 ++++++++++++++++++++++++++++++++++++++++++
980 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
981 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
983 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
985 btape.c:1090 Test with random data, should give the minimum throughput.
986 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
987 +++++++++++++++++++++++++++++++++++++++++++
988 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
989 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
990 +++++++++++++++++++++++++++++++++++++++++++
992 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
996 When using compression, the random test will give your the minimum throughput
997 of your drive . The test using constant string will give you the maximum speed
998 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
1000 You can change the block size in the Storage Daemon configuration file.
1002 \section{New {\bf Block Checksum} Device Directive}
1003 You may now turn off the Block Checksum (CRC32) code
1004 that Bacula uses when writing blocks to a Volume. This is
1011 doing so can reduce the Storage daemon CPU usage slightly. It
1012 will also permit Bacula to read a Volume that has corrupted data.
1014 The default is {\bf yes} -- i.e. the checksum is computed on write
1015 and checked on read.
1017 We do not recommend to turn this off particularly on older tape
1018 drives or for disk Volumes where doing so may allow corrupted data
1021 \section{New Bat Features}
1023 Those new features were funded by Bacula Systems.
1025 \subsection{Media List View}
1027 By clicking on ``Media'', you can see the list of all your volumes. You will be
1028 able to filter by Pool, Media Type, Location,\dots And sort the result directly
1029 in the table. The old ``Media'' view is now known as ``Pool''.
1030 \begin{figure}[htbp]
1032 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
1033 \label{fig:mediaview}
1037 \subsection{Media Information View}
1039 By double-clicking on a volume (on the Media list, in the Autochanger content
1040 or in the Job information panel), you can access a detailed overview of your
1041 Volume. (cf \ref{fig:mediainfo}.)
1042 \begin{figure}[htbp]
1044 \includegraphics[width=13cm]{\idir bat11.eps}
1045 \caption{Media information}
1046 \label{fig:mediainfo}
1049 \subsection{Job Information View}
1051 By double-clicking on a Job record (on the Job run list or in the Media
1052 information panel), you can access a detailed overview of your Job. (cf
1054 \begin{figure}[htbp]
1056 \includegraphics[width=13cm]{\idir bat12.eps}
1057 \caption{Job information}
1061 \subsection{Autochanger Content View}
1063 By double-clicking on a Storage record (on the Storage list panel), you can
1064 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
1065 \begin{figure}[htbp]
1067 \includegraphics[width=13cm]{\idir bat13.eps}
1068 \caption{Autochanger content}
1069 \label{fig:achcontent}
1072 To use this feature, you need to use the latest mtx-changer script
1073 version. (With new \texttt{listall} and \texttt{transfer} commands)
1075 \section{Bat on Windows}
1076 We have ported {\bf bat} to Windows and it is now installed
1077 by default when the installer is run. It works quite well
1078 on Win32, but has not had a lot of testing there, so your
1079 feedback would be welcome. Unfortunately, eventhough it is
1080 installed by default, it does not yet work on 64 bit Windows
1083 \section{New Win32 Installer}
1084 The Win32 installer has been modified in several very important
1087 \item You must deinstall any current version of the
1088 Win32 File daemon before upgrading to the new one.
1089 If you forget to do so, the new installation will fail.
1090 To correct this failure, you must manually shutdown
1091 and deinstall the old File daemon.
1092 \item All files (other than menu links) are installed
1093 in {\bf c:/Program Files/Bacula}.
1094 \item The installer no longer sets this
1095 file to require administrator privileges by default. If you want
1096 to do so, please do it manually using the {\bf cacls} program.
1099 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1101 \item The server daemons (Director and Storage daemon) are
1102 no longer included in the Windows installer. If you want the
1103 Windows servers, you will either need to build them yourself (note
1104 they have not been ported to 64 bits), or you can contact
1105 Bacula Systems about this.
1108 \section{Win64 Installer}
1109 We have corrected a number of problems that required manual
1110 editing of the conf files. In most cases, it should now
1111 install and work. {\bf bat} is by default installed in
1112 {\bf c:/Program Files/Bacula/bin32} rather than
1113 {\bf c:/Program Files/Bacula} as is the case with the 32
1114 bit Windows installer.
1116 \section{Linux Bare Metal Recovery USB Key}
1117 We have made a number of significant improvements in the
1118 Bare Metal Recovery USB key. Please see the README files
1119 it the {\bf rescue} release for more details.
1121 We are working on an equivalent USB key for Windows bare
1122 metal recovery, but it will take some time to develop it (best
1123 estimate 3Q2010 or 4Q2010)
1126 \section{bconsole Timeout Option}
1127 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1128 for commands. This is useful with GUI programs that use {\bf bconsole}
1129 to interface to the Director.
1131 \section{Important Changes}
1132 \label{sec:importantchanges}
1135 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1136 to the same Pool. The Storage daemon ensures that you do not read and
1137 write to the same Volume.
1138 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1140 \item Virtually all the features of {\bf mtx-changer} have
1141 now been parameterized, which allows you to configure
1142 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
1143 that contains variables that you can set to configure mtx-changer.
1144 This configuration file will not be overwritten during upgrades.
1145 We encourage you to submit any changes
1146 that are made to mtx-changer and to parameterize it all in
1147 mtx-changer.conf so that all configuration will be done by
1148 changing only mtx-changer.conf.
1149 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1150 and \texttt{transfer}. Please configure them as appropriate
1151 in mtx-changer.conf.
1152 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1153 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1154 password. If you want to use the new script, you will need to
1155 manually change the \texttt{BackupCatalog} Job definition.
1156 \item The \texttt{bconsole} \texttt{help} command now accepts
1157 an argument, which if provided produces information on that
1158 command (ex: \texttt{help run}).
1162 \subsubsection*{Truncate volume after purge}
1164 Note that the Truncate Volume after purge feature doesn't work as expected
1165 in 5.0.0 version. Please, don't use it before version 5.0.1.
1167 \subsection{Custom Catalog queries}
1169 If you wish to add specialized commands that list the contents of the catalog,
1170 you can do so by adding them to the \texttt{query.sql} file. This
1171 \texttt{query.sql} file is now empty by default. The file
1172 \texttt{examples/sample-query.sql} has an a number of sample commands
1173 you might find useful.
1175 \subsection{Deprecated parts}
1177 The following items have been \textbf{deprecated} for a long time, and are now
1178 removed from the code.
1181 \item Support for SQLite 2
1184 \section{Misc Changes}
1185 \label{sec:miscchanges}
1188 \item Updated Nagios check\_bacula
1189 \item Updated man files
1190 \item Added OSX package generation script in platforms/darwin
1191 \item Added Spanish and Ukrainian Bacula translations
1192 \item Enable/disable command shows only Jobs that can change
1193 \item Added \texttt{show disabled} command to show disabled Jobs
1194 \item Many ACL improvements
1195 \item Added Level to FD status Job output
1196 \item Begin Ingres DB driver (not yet working)
1197 \item Split RedHat spec files into bacula, bat, mtx, and docs
1198 \item Reorganized the manuals (fewer separate manuals)
1199 \item Added lock/unlock order protection in lock manager
1200 \item Allow 64 bit sizes for a number of variables
1201 \item Fixed several deadlocks or potential race conditions in the SD
1204 \chapter{Released Version 3.0.3 and 3.0.3a}
1206 There are no new features in version 3.0.3. This version simply fixes a
1207 number of bugs found in version 3.0.2 during the onging development
1210 \chapter{New Features in Released Version 3.0.2}
1212 This chapter presents the new features added to the
1213 Released Bacula Version 3.0.2.
1215 \section{Full Restore from a Given JobId}
1216 \index[general]{Restore menu}
1218 This feature allows selecting a single JobId and having Bacula
1219 automatically select all the other jobs that comprise a full backup up to
1220 and including the selected date (through JobId).
1222 Assume we start with the following jobs:
1224 +-------+--------------+---------------------+-------+----------+------------+
1225 | jobid | client | starttime | level | jobfiles | jobbytes |
1226 +-------+--------------+---------------------+-------+----------+------------
1227 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
1228 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
1229 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
1230 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
1231 +-------+--------------+---------------------+-------+----------+------------+
1234 Below is an example of this new feature (which is number 12 in the
1239 To select the JobIds, you have the following choices:
1240 1: List last 20 Jobs run
1241 2: List Jobs where a given File is saved
1243 12: Select full restore to a specified Job date
1246 Select item: (1-13): 12
1247 Enter JobId to get the state to restore: 5
1248 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1249 You have selected the following JobIds: 1,3,5
1251 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1252 1,444 files inserted into the tree.
1255 This project was funded by Bacula Systems.
1257 \section{Source Address}
1258 \index[general]{Source Address}
1260 A feature has been added which allows the administrator to specify the address
1261 from which the Director and File daemons will establish connections. This
1262 may be used to simplify system configuration overhead when working in complex
1263 networks utilizing multi-homing and policy-routing.
1265 To accomplish this, two new configuration directives have been implemented:
1268 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
1272 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
1276 Simply adding specific host routes on the OS
1277 would have an undesirable side-effect: any
1278 application trying to contact the destination host would be forced to use the
1279 more specific route possibly diverting management traffic onto a backup VLAN.
1280 Instead of adding host routes for each client connected to a multi-homed backup
1281 server (for example where there are management and backup VLANs), one can
1282 use the new directives to specify a specific source address at the application
1285 Additionally, this allows the simplification and abstraction of firewall rules
1286 when dealing with a Hot-Standby director or storage daemon configuration. The
1287 Hot-standby pair may share a CARP address, which connections must be sourced
1288 from, while system services listen and act from the unique interface addresses.
1290 This project was funded by Collaborative Fusion, Inc.
1292 \section{Show volume availability when doing restore}
1294 When doing a restore the selection dialog ends by displaying this
1298 The job will require the following
1299 Volume(s) Storage(s) SD Device(s)
1300 ===========================================================================
1301 *000741L3 LTO-4 LTO3
1302 *000866L3 LTO-4 LTO3
1303 *000765L3 LTO-4 LTO3
1304 *000764L3 LTO-4 LTO3
1305 *000756L3 LTO-4 LTO3
1306 *001759L3 LTO-4 LTO3
1307 *001763L3 LTO-4 LTO3
1311 Volumes marked with ``*'' are online (in the autochanger).
1314 This should help speed up large restores by minimizing the time spent
1315 waiting for the operator to discover that he must change tapes in the library.
1317 This project was funded by Bacula Systems.
1319 \section{Accurate estimate command}
1321 The \texttt{estimate} command can now use the accurate code to detect changes
1322 and give a better estimation.
1324 You can set the accurate behavior on the command line by using
1325 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1328 * estimate listing accurate=yes level=incremental job=BackupJob
1331 This project was funded by Bacula Systems.
1333 \chapter{New Features in 3.0.0}
1334 \label{NewFeaturesChapter}
1335 \index[general]{New Features}
1337 This chapter presents the new features added to the development 2.5.x
1338 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1340 \section{Accurate Backup}
1341 \index[general]{Accurate Backup}
1343 As with most other backup programs, by default Bacula decides what files to
1344 backup for Incremental and Differental backup by comparing the change
1345 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1346 backup completed. If one of those two times is later than the last backup
1347 time, then the file will be backed up. This does not, however, permit tracking
1348 what files have been deleted and will miss any file with an old time that may
1349 have been restored to or moved onto the client filesystem.
1351 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
1352 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1353 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1354 backup, there is no difference, but for {\bf Differential} and {\bf
1355 Incremental} backups, the Director will send a list of all previous files
1356 backed up, and the File daemon will use that list to determine if any new files
1357 have been added or or moved and if any files have been deleted. This allows
1358 Bacula to make an accurate backup of your system to that point in time so that
1359 if you do a restore, it will restore your system exactly.
1362 about using Accurate backup is that it requires more resources (CPU and memory)
1363 on both the Director and the Client machines to create the list of previous
1364 files backed up, to send that list to the File daemon, for the File daemon to
1365 keep the list (possibly very big) in memory, and for the File daemon to do
1366 comparisons between every file in the FileSet and the list. In particular,
1367 if your client has lots of files (more than a few million), you will need
1368 lots of memory on the client machine.
1370 Accurate must not be enabled when backing up with a plugin that is not
1371 specially designed to work with Accurate. If you enable it, your restores
1372 will probably not work correctly.
1374 This project was funded by Bacula Systems.
1379 \index[general]{Copy Jobs}
1381 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1382 existing Migration feature with the exception that the Job that is copied is
1383 left unchanged. This essentially creates two identical copies of the same
1384 backup. However, the copy is treated as a copy rather than a backup job, and
1385 hence is not directly available for restore. The {\bf restore} command lists
1386 copy jobs and allows selection of copies by using \texttt{jobid=}
1387 option. If the keyword {\bf copies} is present on the command line, Bacula will
1388 display the list of all copies for selected jobs.
1393 These JobIds have copies as follows:
1394 +-------+------------------------------------+-----------+------------------+
1395 | JobId | Job | CopyJobId | MediaType |
1396 +-------+------------------------------------+-----------+------------------+
1397 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
1398 +-------+------------------------------------+-----------+------------------+
1399 +-------+-------+----------+----------+---------------------+------------------+
1400 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
1401 +-------+-------+----------+----------+---------------------+------------------+
1402 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1403 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
1404 +-------+-------+----------+----------+---------------------+------------------+
1405 You have selected the following JobIds: 19,2
1407 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1408 5,611 files inserted into the tree.
1413 The Copy Job runs without using the File daemon by copying the data from the
1414 old backup Volume to a different Volume in a different Pool. See the Migration
1415 documentation for additional details. For copy Jobs there is a new selection
1416 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1417 not already copied to another Pool.
1419 As with Migration, the Client, Volume, Job, or SQL query, are
1420 other possible ways of selecting the Jobs to be copied. Selection
1421 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1422 work, but are probably more suited for Migration Jobs.
1424 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1425 it will promote the Copy to a \textsl{real} backup job and will make it available for
1426 automatic restore. If more than one Copy is available, it will promote the copy
1427 with the smallest JobId.
1429 A nice solution which can be built with the new Copy feature is often
1430 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1431 look something like the one below:
1435 Name = FullBackupsVirtualPool
1437 Purge Oldest Volume = Yes
1439 NextPool = FullBackupsTapePool
1443 Name = FullBackupsTapePool
1447 Volume Retention = 365 days
1448 Storage = superloader
1452 # Fake fileset for copy jobs
1464 # Fake client for copy jobs
1474 # Default template for a CopyDiskToTape Job
1477 Name = CopyDiskToTape
1479 Messages = StandardCopy
1482 Selection Type = PoolUncopiedJobs
1483 Maximum Concurrent Jobs = 10
1485 Allow Duplicate Jobs = Yes
1486 Cancel Queued Duplicates = No
1487 Cancel Running Duplicates = No
1492 Name = DaySchedule7:00
1493 Run = Level=Full daily at 7:00
1497 Name = CopyDiskToTapeFullBackups
1499 Schedule = DaySchedule7:00
1500 Pool = FullBackupsVirtualPool
1501 JobDefs = CopyDiskToTape
1505 The example above had 2 pool which are copied using the PoolUncopiedJobs
1506 selection criteria. Normal Full backups go to the Virtual pool and are copied
1507 to the Tape pool the next morning.
1509 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1514 +-------+------------------------------------+-----------+------------------+
1515 | JobId | Job | CopyJobId | MediaType |
1516 +-------+------------------------------------+-----------+------------------+
1517 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1518 +-------+------------------------------------+-----------+------------------+
1521 \section{ACL Updates}
1522 \index[general]{ACL Updates}
1523 The whole ACL code had been overhauled and in this version each platforms has
1524 different streams for each type of acl available on such an platform. As ACLs
1525 between platforms tend to be not that portable (most implement POSIX acls but
1526 some use an other draft or a completely different format) we currently only
1527 allow certain platform specific ACL streams to be decoded and restored on the
1528 same platform that they were created on. The old code allowed to restore ACL
1529 cross platform but the comments already mention that not being to wise. For
1530 backward compatability the new code will accept the two old ACL streams and
1531 handle those with the platform specific handler. But for all new backups it
1532 will save the ACLs using the new streams.
1534 Currently the following platforms support ACLs:
1538 \item {\bf Darwin/OSX}
1547 Currently we support the following ACL types (these ACL streams use a reserved
1548 part of the stream numbers):
1551 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1553 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1554 string representation from acl\_to\_text (POSIX acl)
1555 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1556 string representation from acl\_to\_text (POSIX acl) for default acls.
1557 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1558 string representation from acl\_to\_text (POSIX acl) for access acls.
1559 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1560 string representation from acltostr (POSIX acl)
1561 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1562 representation from acl\_to\_text (POSIX acl) for default acls.
1563 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1564 representation from acl\_to\_text (POSIX acl) for access acls.
1565 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1566 string representation from acl\_to\_text (POSIX acl) for default acls.
1567 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1568 representation from acl\_to\_text (POSIX acl) for access acls.
1569 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1570 string representation from acl\_to\_text (POSIX acl) for default acls.
1571 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1572 string representation from acl\_to\_text (POSIX acl) for default acls.
1573 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1574 representation from acl\_to\_text (POSIX acl) for access acls.
1575 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1576 string representation from acltotext or acl\_totext (POSIX acl)
1577 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1578 representation from from acl\_totext (NFSv4 or ZFS acl)
1581 In future versions we might support conversion functions from one type of acl
1582 into an other for types that are either the same or easily convertable. For now
1583 the streams are seperate and restoring them on a platform that doesn't
1584 recognize them will give you a warning.
1586 \section{Extended Attributes}
1587 \index[general]{Extended Attributes}
1588 Something that was on the project list for some time is now implemented for
1589 platforms that support a similar kind of interface. Its the support for backup
1590 and restore of so called extended attributes. As extended attributes are so
1591 platform specific these attributes are saved in seperate streams for each
1592 platform. Restores of the extended attributes can only be performed on the
1593 same platform the backup was done. There is support for all types of extended
1594 attributes, but restoring from one type of filesystem onto an other type of
1595 filesystem on the same platform may lead to supprises. As extended attributes
1596 can contain any type of data they are stored as a series of so called
1597 value-pairs. This data must be seen as mostly binary and is stored as such.
1598 As security labels from selinux are also extended attributes this option also
1599 stores those labels and no specific code is enabled for handling selinux
1602 Currently the following platforms support extended attributes:
1604 \item {\bf Darwin/OSX}
1610 On linux acls are also extended attributes, as such when you enable ACLs on a
1611 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1612 and not the same exteneded attribute.
1614 To enable the backup of extended attributes please add the following to your
1629 \section{Shared objects}
1630 \index[general]{Shared objects}
1631 A default build of Bacula will now create the libraries as shared objects
1632 (.so) rather than static libraries as was previously the case.
1633 The shared libraries are built using {\bf libtool} so it should be quite
1636 An important advantage of using shared objects is that on a machine with the
1637 Directory, File daemon, the Storage daemon, and a console, you will have only
1638 one copy of the code in memory rather than four copies. Also the total size of
1639 the binary release is smaller since the library code appears only once rather
1640 than once for every program that uses it; this results in significant reduction
1641 in the size of the binaries particularly for the utility tools.
1643 In order for the system loader to find the shared objects when loading the
1644 Bacula binaries, the Bacula shared objects must either be in a shared object
1645 directory known to the loader (typically /usr/lib) or they must be in the
1646 directory that may be specified on the {\bf ./configure} line using the {\bf
1647 {-}{-}libdir} option as:
1650 ./configure --libdir=/full-path/dir
1653 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1654 no need to modify your loader configuration provided that
1655 the shared objects are installed in that directory (Bacula
1656 does this with the make install command). The shared objects
1657 that Bacula references are:
1666 These files are symbolically linked to the real shared object file,
1667 which has a version number to permit running multiple versions of
1668 the libraries if desired (not normally the case).
1670 If you have problems with libtool or you wish to use the old
1671 way of building static libraries, or you want to build a static
1672 version of Bacula you may disable
1673 libtool on the configure command line with:
1676 ./configure --disable-libtool
1680 \section{Building Static versions of Bacula}
1681 \index[general]{Static linking}
1682 In order to build static versions of Bacula, in addition
1683 to configuration options that were needed you now must
1684 also add --disable-libtool. Example
1687 ./configure --enable-static-client-only --disable-libtool
1691 \section{Virtual Backup (Vbackup)}
1692 \index[general]{Virtual Backup}
1693 \index[general]{Vbackup}
1695 Bacula's virtual backup feature is often called Synthetic Backup or
1696 Consolidation in other backup products. It permits you to consolidate the
1697 previous Full backup plus the most recent Differential backup and any
1698 subsequent Incremental backups into a new Full backup. This new Full
1699 backup will then be considered as the most recent Full for any future
1700 Incremental or Differential backups. The VirtualFull backup is
1701 accomplished without contacting the client by reading the previous backup
1702 data and writing it to a volume in a different pool.
1704 In some respects the Vbackup feature works similar to a Migration job, in
1705 that Bacula normally reads the data from the pool specified in the
1706 Job resource, and writes it to the {\bf Next Pool} specified in the
1707 Job resource. Note, this means that usually the output from the Virtual
1708 Backup is written into a different pool from where your prior backups
1709 are saved. Doing it this way guarantees that you will not get a deadlock
1710 situation attempting to read and write to the same volume in the Storage
1711 daemon. If you then want to do subsequent backups, you may need to
1712 move the Virtual Full Volume back to your normal backup pool.
1713 Alternatively, you can set your {\bf Next Pool} to point to the current
1714 pool. This will cause Bacula to read and write to Volumes in the
1715 current pool. In general, this will work, because Bacula will
1716 not allow reading and writing on the same Volume. In any case, once
1717 a VirtualFull has been created, and a restore is done involving the
1718 most current Full, it will read the Volume or Volumes by the VirtualFull
1719 regardless of in which Pool the Volume is found.
1721 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1722 a level of {\bf VirtualFull}.
1724 A typical Job resource definition might look like the following:
1731 FileSet = "Full Set"
1738 # Default pool definition
1742 Recycle = yes # Automatically recycle Volumes
1743 AutoPrune = yes # Prune expired volumes
1744 Volume Retention = 365d # one year
1752 Recycle = yes # Automatically recycle Volumes
1753 AutoPrune = yes # Prune expired volumes
1754 Volume Retention = 365d # one year
1755 Storage = DiskChanger
1758 # Definition of file storage device
1763 Device = FileStorage
1765 Maximum Concurrent Jobs = 5
1768 # Definition of DDS Virtual tape disk storage device
1771 Address = localhost # N.B. Use a fully qualified name here
1773 Device = DiskChanger
1774 Media Type = DiskChangerMedia
1775 Maximum Concurrent Jobs = 4
1780 Then in bconsole or via a Run schedule, you would run the job as:
1783 run job=MyBackup level=Full
1784 run job=MyBackup level=Incremental
1785 run job=MyBackup level=Differential
1786 run job=MyBackup level=Incremental
1787 run job=MyBackup level=Incremental
1790 So providing there were changes between each of those jobs, you would end up
1791 with a Full backup, a Differential, which includes the first Incremental
1792 backup, then two Incremental backups. All the above jobs would be written to
1793 the {\bf Default} pool.
1795 To consolidate those backups into a new Full backup, you would run the
1799 run job=MyBackup level=VirtualFull
1802 And it would produce a new Full backup without using the client, and the output
1803 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1805 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1808 Note, the Start and End time of the Virtual Full backup is set to the
1809 values for the last job included in the Virtual Full (in the above example,
1810 it is an Increment). This is so that if another incremental is done, which
1811 will be based on the Virtual Full, it will backup all files from the
1812 last Job included in the Virtual Full rather than from the time the Virtual
1813 Full was actually run.
1817 \section{Catalog Format}
1818 \index[general]{Catalog Format}
1819 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1820 operation will convert the FileId field of the File table from 32 bits (max 4
1821 billion table entries) to 64 bits (very large number of items). The
1822 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1823 your catalog during the conversion. Also you won't be able to run jobs during
1824 this conversion period. For example, a 3 million file catalog will take 2
1825 minutes to upgrade on a normal machine. Please don't forget to make a valid
1826 backup of your database before executing the upgrade script. See the
1827 ReleaseNotes for additional details.
1829 \section{64 bit Windows Client}
1830 \index[general]{Win64 Client}
1831 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1832 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1833 As a consequence, we are also releasing a 64 bit version of the Bacula
1834 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1835 These binaries should only be installed on 64 bit Windows operating systems.
1836 What is important is not your hardware but whether or not you have
1837 a 64 bit version of the Windows OS.
1839 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1841 \item Before installing the Win64 Bacula Client, you must totally
1842 deinstall any prior 2.4.x Client installation using the
1843 Bacula deinstallation (see the menu item). You may want
1844 to save your .conf files first.
1845 \item Only the Client (File daemon) is ported to Win64, the Director
1846 and the Storage daemon are not in the 64 bit Windows installer.
1847 \item bwx-console is not yet ported.
1848 \item bconsole is ported but it has not been tested.
1849 \item The documentation is not included in the installer.
1850 \item Due to Vista security restrictions imposed on a default installation
1851 of Vista, before upgrading the Client, you must manually stop
1852 any prior version of Bacula from running, otherwise the install
1854 \item Due to Vista security restrictions imposed on a default installation
1855 of Vista, attempting to edit the conf files via the menu items
1856 will fail. You must directly edit the files with appropriate
1857 permissions. Generally double clicking on the appropriate .conf
1858 file will work providing you have sufficient permissions.
1859 \item All Bacula files are now installed in
1860 {\bf C:/Program Files/Bacula} except the main menu items,
1861 which are installed as before. This vastly simplifies the installation.
1862 \item If you are running on a foreign language version of Windows, most
1863 likely {\bf C:/Program Files} does not exist, so you should use the
1864 Custom installation and enter an appropriate location to install
1866 \item The 3.0.0 Win32 Client continues to install files in the locations used
1867 by prior versions. For the next version we will convert it to use
1868 the same installation conventions as the Win64 version.
1871 This project was funded by Bacula Systems.
1874 \section{Duplicate Job Control}
1875 \index[general]{Duplicate Jobs}
1876 The new version of Bacula provides four new directives that
1877 give additional control over what Bacula does if duplicate jobs
1878 are started. A duplicate job in the sense we use it here means
1879 a second or subsequent job with the same name starts. This
1880 happens most frequently when the first job runs longer than expected because no
1881 tapes are available.
1883 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1884 are specified in the Job resource.
1888 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1889 \index[general]{Allow Duplicate Jobs}
1890 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1891 the directive is set to {\bf no} (default) then only one job of a given name
1892 may run at one time, and the action that Bacula takes to ensure only
1893 one job runs is determined by the other directives (see below).
1895 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1896 are present and none of the three directives given below permit
1897 cancelling a job, then the current job (the second one started)
1900 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1901 \index[general]{Allow Higher Duplicates}
1902 This directive was in version 5.0.0, but does not work as
1903 expected. If used, it should always be set to no. In later versions
1904 of Bacula the directive is disabled (disregarded).
1906 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1907 \index[general]{Cancel Running Duplicates}
1908 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1909 if this directive is set to {\bf yes} any job that is already running
1910 will be canceled. The default is {\bf no}.
1912 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1913 \index[general]{Cancel Queued Duplicates}
1914 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1915 if this directive is set to {\bf yes} any job that is
1916 already queued to run but not yet running will be canceled.
1917 The default is {\bf no}.
1920 \section{TLS Authentication}
1921 \index[general]{TLS Authentication}
1922 In Bacula version 2.5.x and later, in addition to the normal Bacula
1923 CRAM-MD5 authentication that is used to authenticate each Bacula
1924 connection, you can specify that you want TLS Authentication as well,
1925 which will provide more secure authentication.
1927 This new feature uses Bacula's existing TLS code (normally used for
1928 communications encryption) to do authentication. To use it, you must
1929 specify all the TLS directives normally used to enable communications
1930 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1933 \subsection{TLS Authenticate = yes}
1935 TLS Authenticate = yes
1938 in the main daemon configuration resource (Director for the Director,
1939 Client for the File daemon, and Storage for the Storage daemon).
1941 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1942 authentication, Bacula will also do TLS authentication, then TLS
1943 encryption will be turned off, and the rest of the communication between
1944 the two Bacula daemons will be done without encryption.
1946 If you want to encrypt communications data, use the normal TLS directives
1947 but do not turn on {\bf TLS Authenticate}.
1949 \section{bextract non-portable Win32 data}
1950 \index[general]{bextract handles Win32 non-portable data}
1951 {\bf bextract} has been enhanced to be able to restore
1952 non-portable Win32 data to any OS. Previous versions were
1953 unable to restore non-portable Win32 data to machines that
1954 did not have the Win32 BackupRead and BackupWrite API calls.
1956 \section{State File updated at Job Termination}
1957 \index[general]{State File}
1958 In previous versions of Bacula, the state file, which provides a
1959 summary of previous jobs run in the {\bf status} command output was
1960 updated only when Bacula terminated, thus if the daemon crashed, the
1961 state file might not contain all the run data. This version of
1962 the Bacula daemons updates the state file on each job termination.
1964 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1965 \index[general]{MaxFullInterval}
1966 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1967 can be used to specify the maximum time interval between {\bf Full} backup
1968 jobs. When a job starts, if the time since the last Full backup is
1969 greater than the specified interval, and the job would normally be an
1970 {\bf Incremental} or {\bf Differential}, it will be automatically
1971 upgraded to a {\bf Full} backup.
1973 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1974 \index[general]{MaxDiffInterval}
1975 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1976 can be used to specify the maximum time interval between {\bf Differential} backup
1977 jobs. When a job starts, if the time since the last Differential backup is
1978 greater than the specified interval, and the job would normally be an
1979 {\bf Incremental}, it will be automatically
1980 upgraded to a {\bf Differential} backup.
1982 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1983 \index[general]{MaxDiffInterval}
1984 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1985 by the user, and when it is set it is an indication to backup programs
1986 to not backup that particular file. This version of Bacula contains a
1987 new Options directive within a FileSet resource, which instructs Bacula to
1988 obey this flag. The new directive is:
1991 Honor No Dump Flag = yes\vb{}no
1994 The default value is {\bf no}.
1997 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1998 \index[general]{IgnoreDir}
1999 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
2000 can be added to the Include section of the FileSet resource. If the specified
2001 filename ({\bf filename-string}) is found on the Client in any directory to be
2002 backed up, the whole directory will be ignored (not backed up). For example:
2005 # List of files to be backed up
2013 Exclude Dir Containing = .excludeme
2018 But in /home, there may be hundreds of directories of users and some
2019 people want to indicate that they don't want to have certain
2020 directories backed up. For example, with the above FileSet, if
2021 the user or sysadmin creates a file named {\bf .excludeme} in
2022 specific directories, such as
2025 /home/user/www/cache/.excludeme
2026 /home/user/temp/.excludeme
2029 then Bacula will not backup the two directories named:
2032 /home/user/www/cache
2036 NOTE: subdirectories will not be backed up. That is, the directive
2037 applies to the two directories in question and any children (be they
2038 files, directories, etc).
2041 \section{Bacula Plugins}
2042 \index[general]{Plugin}
2043 Support for shared object plugins has been implemented in the Linux, Unix
2044 and Win32 File daemons. The API will be documented separately in
2045 the Developer's Guide or in a new document. For the moment, there is
2046 a single plugin named {\bf bpipe} that allows an external program to
2047 get control to backup and restore a file.
2049 Plugins are also planned (partially implemented) in the Director and the
2052 \subsection{Plugin Directory}
2053 \index[general]{Plugin Directory}
2054 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
2055 be added to the daemon definition resource. The directory takes a quoted
2056 string argument, which is the name of the directory in which the daemon can
2057 find the Bacula plugins. If this directive is not specified, Bacula will not
2058 load any plugins. Since each plugin has a distinctive name, all the daemons
2059 can share the same plugin directory.
2061 \subsection{Plugin Options}
2062 \index[general]{Plugin Options}
2063 The {\bf Plugin Options} directive takes a quoted string
2064 arguement (after the equal sign) and may be specified in the
2065 Job resource. The options specified will be passed to all plugins
2066 when they are run. This each plugin must know what it is looking
2067 for. The value defined in the Job resource can be modified
2068 by the user when he runs a Job via the {\bf bconsole} command line
2071 Note: this directive may be specified, and there is code to modify
2072 the string in the run command, but the plugin options are not yet passed to
2073 the plugin (i.e. not fully implemented).
2075 \subsection{Plugin Options ACL}
2076 \index[general]{Plugin Options ACL}
2077 The {\bf Plugin Options ACL} directive may be specified in the
2078 Director's Console resource. It functions as all the other ACL commands
2079 do by permitting users running restricted consoles to specify a
2080 {\bf Plugin Options} that overrides the one specified in the Job
2081 definition. Without this directive restricted consoles may not modify
2084 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
2085 \index[general]{Plugin}
2086 The {\bf Plugin} directive is specified in the Include section of
2087 a FileSet resource where you put your {\bf File = xxx} directives.
2098 Plugin = "bpipe:..."
2103 In the above example, when the File daemon is processing the directives
2104 in the Include section, it will first backup all the files in {\bf /home}
2105 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2106 the Plugin Directory. The syntax and semantics of the Plugin directive
2107 require the first part of the string up to the colon (:) to be the name
2108 of the plugin. Everything after the first colon is ignored by the File daemon but
2109 is passed to the plugin. Thus the plugin writer may define the meaning of the
2110 rest of the string as he wishes.
2112 Please see the next section for information about the {\bf bpipe} Bacula
2115 \section{The bpipe Plugin}
2116 \index[general]{The bpipe Plugin}
2117 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2118 the Bacula source distribution. When the plugin is compiled and linking into
2119 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2120 Please note that this is a very simple plugin that was written for
2121 demonstration and test purposes. It is and can be used in production, but
2122 that was never really intended.
2124 The purpose of the plugin is to provide an interface to any system program for
2125 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2126 the Include section of your Job's FileSet resource. The full syntax of the
2127 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2128 to specify the sytax as it wishes) is:
2131 Plugin = "<field1>:<field2>:<field3>:<field4>"
2136 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2137 stripped off, so in this case, we would put {\bf bpipe} in this field.
2139 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2140 pseudo path and filename under which the backup will be saved. This pseudo
2141 path and filename will be seen by the user in the restore file tree.
2142 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2143 backed up by the plugin will be put under that "pseudo" path and filename.
2144 You must be careful to choose a naming convention that is unique to avoid
2145 a conflict with a path and filename that actually exists on your system.
2147 \item {\bf field3} for the {\bf bpipe} plugin
2148 specifies the "reader" program that is called by the plugin during
2149 backup to read the data. {\bf bpipe} will call this program by doing a
2152 \item {\bf field4} for the {\bf bpipe} plugin
2153 specifies the "writer" program that is called by the plugin during
2154 restore to write the data back to the filesystem.
2157 Please note that for two items above describing the "reader" and "writer"
2158 fields, these programs are "executed" by Bacula, which
2159 means there is no shell interpretation of any command line arguments
2160 you might use. If you want to use shell characters (redirection of input
2161 or output, ...), then we recommend that you put your command or commands
2162 in a shell script and execute the script. In addition if you backup a
2163 file with the reader program, when running the writer program during
2164 the restore, Bacula will not automatically create the path to the file.
2165 Either the path must exist, or you must explicitly do so with your command
2166 or in a shell script.
2168 Putting it all together, the full plugin directive line might look
2172 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
2173 --opt --databases bacula:mysql"
2176 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2177 would be written on a single line.
2179 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2180 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
2181 program {\bf mysqldump -f --opt --database bacula} to read the data during
2182 backup. The mysqldump command outputs all the data for the database named
2183 {\bf bacula}, which will be read by the plugin and stored in the backup.
2184 During restore, the data that was backed up will be sent to the program
2185 specified in the last field, which in this case is {\bf mysql}. When
2186 {\bf mysql} is called, it will read the data sent to it by the plugn
2187 then write it back to the same database from which it came ({\bf bacula}
2190 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2191 the data from a specified program to Bacula for backup, and then from Bacula to
2192 a specified program for restore.
2194 By using different command lines to {\bf bpipe},
2195 you can backup any kind of data (ASCII or binary) depending
2196 on the program called.
2198 \section{Microsoft Exchange Server 2003/2007 Plugin}
2199 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
2200 \subsection{Background}
2201 The Exchange plugin was made possible by a funded development project
2202 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2203 The code for the plugin was written by James Harper, and the Bacula core
2204 code by Kern Sibbald. All the code for this funded development has become
2205 part of the Bacula project. Thanks to everyone who made it happen.
2207 \subsection{Concepts}
2208 Although it is possible to backup Exchange using Bacula VSS the Exchange
2209 plugin adds a good deal of functionality, because while Bacula VSS
2210 completes a full backup (snapshot) of Exchange, it does
2211 not support Incremental or Differential backups, restoring is more
2212 complicated, and a single database restore is not possible.
2214 Microsoft Exchange organises its storage into Storage Groups with
2215 Databases inside them. A default installation of Exchange will have a
2216 single Storage Group called 'First Storage Group', with two Databases
2217 inside it, "Mailbox Store (SERVER NAME)" and
2218 "Public Folder Store (SERVER NAME)",
2219 which hold user email and public folders respectively.
2221 In the default configuration, Exchange logs everything that happens to
2222 log files, such that if you have a backup, and all the log files since,
2223 you can restore to the present time. Each Storage Group has its own set
2224 of log files and operates independently of any other Storage Groups. At
2225 the Storage Group level, the logging can be turned off by enabling a
2226 function called "Enable circular logging". At this time the Exchange
2227 plugin will not function if this option is enabled.
2229 The plugin allows backing up of entire storage groups, and the restoring
2230 of entire storage groups or individual databases. Backing up and
2231 restoring at the individual mailbox or email item is not supported but
2232 can be simulated by use of the "Recovery" Storage Group (see below).
2234 \subsection{Installing}
2235 The Exchange plugin requires a DLL that is shipped with Microsoft
2236 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2237 correctly the Exchange plugin should find this automatically and run
2238 without any additional installation.
2240 If the DLL can not be found automatically it will need to be copied into
2241 the Bacula installation
2242 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
2243 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
2244 default Exchange installation.
2246 \subsection{Backing Up}
2247 To back up an Exchange server the Fileset definition must contain at
2248 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2249 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2250 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2251 up files are prefixed with something that isn't going to share a name
2252 with something outside the plugin, and the 'Microsoft Information Store'
2253 bit is required also. It is also possible to add the name of a storage
2254 group to the "Plugin =" line, eg \\
2255 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2256 if you want only a single storage group backed up.
2258 Additionally, you can suffix the 'Plugin =' directive with
2259 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2260 database at the end of a full backup.
2262 An Incremental or Differential backup will backup only the database logs
2263 for each Storage Group by inspecting the "modified date" on each
2264 physical log file. Because of the way the Exchange API works, the last
2265 logfile backed up on each backup will always be backed up by the next
2266 Incremental or Differential backup too. This adds 5MB to each
2267 Incremental or Differential backup size but otherwise does not cause any
2270 By default, a normal VSS fileset containing all the drive letters will
2271 also back up the Exchange databases using VSS. This will interfere with
2272 the plugin and Exchange's shared ideas of when the last full backup was
2273 done, and may also truncate log files incorrectly. It is important,
2274 therefore, that the Exchange database files be excluded from the backup,
2275 although the folders the files are in should be included, or they will
2276 have to be recreated manually if a baremetal restore is done.
2281 File = C:/Program Files/Exchsrvr/mdbdata
2282 Plugin = "exchange:..."
2285 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2286 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2287 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2288 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2289 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2290 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2291 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2296 The advantage of excluding the above files is that you can significantly
2297 reduce the size of your backup since all the important Exchange files
2298 will be properly saved by the Plugin.
2301 \subsection{Restoring}
2302 The restore operation is much the same as a normal Bacula restore, with
2303 the following provisos:
2306 \item The {\bf Where} restore option must not be specified
2307 \item Each Database directory must be marked as a whole. You cannot just
2308 select (say) the .edb file and not the others.
2309 \item If a Storage Group is restored, the directory of the Storage Group
2311 \item It is possible to restore only a subset of the available log files,
2312 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2313 if a log file is missing from the sequence of log files
2314 \item Each database to be restored must be dismounted and marked as "Can be
2315 overwritten by restore"
2316 \item If an entire Storage Group is to be restored (eg all databases and
2317 logs in the Storage Group), then it is best to manually delete the
2318 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
2319 as Exchange can get confused by stray log files lying around.
2322 \subsection{Restoring to the Recovery Storage Group}
2323 The concept of the Recovery Storage Group is well documented by
2325 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2326 but to briefly summarize...
2328 Microsoft Exchange allows the creation of an additional Storage Group
2329 called the Recovery Storage Group, which is used to restore an older
2330 copy of a database (e.g. before a mailbox was deleted) into without
2331 messing with the current live data. This is required as the Standard and
2332 Small Business Server versions of Exchange can not ordinarily have more
2333 than one Storage Group.
2335 To create the Recovery Storage Group, drill down to the Server in Exchange
2336 System Manager, right click, and select
2337 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
2338 locations and click OK. On the Recovery Storage Group, right click and
2339 select {\bf "Add Database to Recover..."} and select the database you will
2342 Restore only the single database nominated as the database in the
2343 Recovery Storage Group. Exchange will redirect the restore to the
2344 Recovery Storage Group automatically.
2345 Then run the restore.
2347 \subsection{Restoring on Microsoft Server 2007}
2348 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2349 2007, and henc you use a new proceedure for recovering a single mail box.
2350 This procedure is ducomented by Microsoft at:
2351 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2352 and involves using the {\bf Restore-Mailbox} and {\bf
2353 Get-MailboxStatistics} shell commands.
2355 \subsection{Caveats}
2356 This plugin is still being developed, so you should consider it
2357 currently in BETA test, and thus use in a production environment
2358 should be done only after very careful testing.
2360 When doing a full backup, the Exchange database logs are truncated by
2361 Exchange as soon as the plugin has completed the backup. If the data
2362 never makes it to the backup medium (eg because of spooling) then the
2363 logs will still be truncated, but they will also not have been backed
2364 up. A solution to this is being worked on. You will have to schedule a
2365 new Full backup to ensure that your next backups will be usable.
2367 The "Enable Circular Logging" option cannot be enabled or the plugin
2370 Exchange insists that a successful Full backup must have taken place if
2371 an Incremental or Differential backup is desired, and the plugin will
2372 fail if this is not the case. If a restore is done, Exchange will
2373 require that a Full backup be done before an Incremental or Differential
2376 The plugin will most likely not work well if another backup application
2377 (eg NTBACKUP) is backing up the Exchange database, especially if the
2378 other backup application is truncating the log files.
2380 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2381 we recommend either carefully testing or that you avoid this option for
2384 The Exchange plugin is not called during processing the bconsole {\bf
2385 estimate} command, and so anything that would be backed up by the plugin
2386 will not be added to the estimate total that is displayed.
2389 \section{libdbi Framework}
2390 \index[general]{libdbi Framework}
2391 As a general guideline, Bacula has support for a few catalog database drivers
2392 (MySQL, PostgreSQL, SQLite)
2393 coded natively by the Bacula team. With the libdbi implementation, which is a
2394 Bacula driver that uses libdbi to access the catalog, we have an open field to
2395 use many different kinds database engines following the needs of users.
2397 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
2398 implements a database-independent abstraction layer in C, similar to the
2399 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2400 leverage the power of multiple databases and multiple simultaneous database
2401 connections by using this framework.
2403 Currently the libdbi driver in Bacula project only supports the same drivers
2404 natively coded in Bacula. However the libdbi project has support for many
2405 others database engines. You can view the list at
2406 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2407 supported by Bacula, however, they must be tested properly by the Bacula team.
2409 Some of benefits of using libdbi are:
2411 \item The possibility to use proprietary databases engines in which your
2412 proprietary licenses prevent the Bacula team from developing the driver.
2413 \item The possibility to use the drivers written for the libdbi project.
2414 \item The possibility to use other database engines without recompiling Bacula
2415 to use them. Just change one line in bacula-dir.conf
2416 \item Abstract Database access, this is, unique point to code and profiling
2417 catalog database access.
2420 The following drivers have been tested:
2422 \item PostgreSQL, with and without batch insert
2423 \item Mysql, with and without batch insert
2428 In the future, we will test and approve to use others databases engines
2429 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2431 To compile Bacula to support libdbi we need to configure the code with the
2432 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2433 [database] is the database engine to be used with Bacula (of course we can
2434 change the driver in file bacula-dir.conf, see below). We must configure the
2435 access port of the database engine with the option --with-db-port, because the
2436 libdbi framework doesn't know the default access port of each database.
2438 The next phase is checking (or configuring) the bacula-dir.conf, example:
2442 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2443 dbname = regress; user = regress; password = ""
2447 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2448 mysql database. Currently the drivers supported by Bacula are: postgresql,
2449 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2451 The following limitations apply when Bacula is set to use the libdbi framework:
2452 - Not tested on the Win32 platform
2453 - A little performance is lost if comparing with native database driver.
2454 The reason is bound with the database driver provided by libdbi and the
2455 simple fact that one more layer of code was added.
2457 It is important to remember, when compiling Bacula with libdbi, the
2458 following packages are needed:
2460 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2461 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2464 You can download them and compile them on your system or install the packages
2465 from your OS distribution.
2467 \section{Console Command Additions and Enhancements}
2468 \index[general]{Console Additions}
2470 \subsection{Display Autochanger Content}
2471 \index[general]{StatusSlots}
2473 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2474 autochanger content.
2478 Slot | Volume Name | Status | Media Type | Pool |
2479 ------+---------------+----------+-------------------+------------|
2480 1 | 00001 | Append | DiskChangerMedia | Default |
2481 2 | 00002 | Append | DiskChangerMedia | Default |
2482 3*| 00003 | Append | DiskChangerMedia | Scratch |
2487 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2488 {\bf update slots} command to synchronize autochanger content with your
2491 \subsection{list joblog job=xxx or jobid=nnn}
2492 \index[general]{list joblog}
2493 A new list command has been added that allows you to list the contents
2494 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2495 or for a particular JobId. The {\bf llist} command will include a line with
2496 the time and date of the entry.
2498 Note for the catalog to have Job Log entries, you must have a directive
2505 In your Director's {\bf Messages} resource.
2507 \subsection{Use separator for multiple commands}
2508 \index[general]{Command Separator}
2509 When using bconsole with readline, you can set the command separator with
2510 \textbf{@separator} command to one
2511 of those characters to write commands who require multiple input in one line.
2513 !$%&'()*+,-/:;<>?[]^`{|}~
2516 \subsection{Deleting Volumes}
2517 The delete volume bconsole command has been modified to
2518 require an asterisk (*) in front of a MediaId otherwise the
2519 value you enter is a taken to be a Volume name. This is so that
2520 users may delete numeric Volume names. The previous Bacula versions
2521 assumed that all input that started with a number was a MediaId.
2523 This new behavior is indicated in the prompt if you read it
2526 \section{Bare Metal Recovery}
2527 The old bare metal recovery project is essentially dead. One
2528 of the main features of it was that it would build a recovery
2529 CD based on the kernel on your system. The problem was that
2530 every distribution has a different boot procedure and different
2531 scripts, and worse yet, the boot procedures and scripts change
2532 from one distribution to another. This meant that maintaining
2533 (keeping up with the changes) the rescue CD was too much work.
2535 To replace it, a new bare metal recovery USB boot stick has been developed
2536 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2537 boot from a USB key.
2541 \item Recovery can be done from within graphical environment.
2542 \item Recovery can be done in a shell.
2543 \item Ubuntu boots on a large number of Linux systems.
2544 \item The process of updating the system and adding new
2545 packages is not too difficult.
2546 \item The USB key can easily be upgraded to newer Ubuntu versions.
2547 \item The USB key has writable partitions for modifications to
2548 the OS and for modification to your home directory.
2549 \item You can add new files/directories to the USB key very easily.
2550 \item You can save the environment from multiple machines on
2552 \item Bacula Systems is funding its ongoing development.
2555 The disadvantages are:
2557 \item The USB key is usable but currently under development.
2558 \item Not everyone may be familiar with Ubuntu (no worse
2560 \item Some older OSes cannot be booted from USB. This can
2561 be resolved by first booting a Ubuntu LiveCD then plugging
2563 \item Currently the documentation is sketchy and not yet added
2564 to the main manual. See below ...
2567 The documentation and the code can be found in the {\bf rescue} package
2568 in the directory {\bf linux/usb}.
2570 \section{Miscellaneous}
2571 \index[general]{Misc New Features}
2573 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2574 \index[general]{Allow Mixed Priority}
2575 This directive is only implemented in version 2.5 and later. When
2576 set to {\bf yes} (default {\bf no}), this job may run even if lower
2577 priority jobs are already running. This means a high priority job
2578 will not have to wait for other jobs to finish before starting.
2579 The scheduler will only mix priorities when all running jobs have
2582 Note that only higher priority jobs will start early. Suppose the
2583 director will allow two concurrent jobs, and that two jobs with
2584 priority 10 are running, with two more in the queue. If a job with
2585 priority 5 is added to the queue, it will be run as soon as one of
2586 the running jobs finishes. However, new priority 10 jobs will not
2587 be run until the priority 5 job has finished.
2589 \subsection{Bootstrap File Directive -- FileRegex}
2590 \index[general]{Bootstrap File Directive}
2591 {\bf FileRegex} is a new command that can be added to the bootstrap
2592 (.bsr) file. The value is a regular expression. When specified, only
2593 matching filenames will be restored.
2595 During a restore, if all File records are pruned from the catalog
2596 for a Job, normally Bacula can restore only all files saved. That
2597 is there is no way using the catalog to select individual files.
2598 With this new feature, Bacula will ask if you want to specify a Regex
2599 expression for extracting only a part of the full backup.
2602 Building directory tree for JobId(s) 1,3 ...
2603 There were no files inserted into the tree, so file selection
2604 is not possible.Most likely your retention policy pruned the files
2606 Do you want to restore all the files? (yes\vb{}no): no
2608 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2609 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2612 \subsection{Bootstrap File Optimization Changes}
2613 In order to permit proper seeking on disk files, we have extended the bootstrap
2614 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2615 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2616 address range and end address range respectively. These two directives replace
2617 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2618 VolEndBlock} directives. Bootstrap files containing the old directives will
2619 still work, but will not properly take advantage of proper disk seeking, and
2620 may read completely to the end of a disk volume during a restore. With the new
2621 format (automatically generated by the new Director), restores will seek
2622 properly and stop reading the volume when all the files have been restored.
2624 \subsection{Solaris ZFS/NFSv4 ACLs}
2625 This is an upgrade of the previous Solaris ACL backup code
2626 to the new library format, which will backup both the old
2627 POSIX(UFS) ACLs as well as the ZFS ACLs.
2629 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2630 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2631 be used to transfer from UFS to ZFS filesystems.
2634 \subsection{Virtual Tape Emulation}
2635 \index[general]{Virtual Tape Emulation}
2636 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2637 the tape code but actually reading and writing to a disk file. Used with the
2638 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2639 and 700 slots. This feature is most useful in testing. It is enabled
2640 by using {\bf Device Type = vtape} in the Storage daemon's Device
2641 directive. This feature is only implemented on Linux machines and should not be
2642 used for production.
2644 \subsection{Bat Enhancements}
2645 \index[general]{Bat Enhancements}
2646 Bat (the Bacula Administration Tool) GUI program has been significantly
2647 enhanced and stabilized. In particular, there are new table based status
2648 commands; it can now be easily localized using Qt4 Linguist.
2650 The Bat communications protocol has been significantly enhanced to improve
2651 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2652 the Director you are using otherwise the communications protocol will not
2655 \subsection{RunScript Enhancements}
2656 \index[general]{RunScript Enhancements}
2657 The {\bf RunScript} resource has been enhanced to permit multiple
2658 commands per RunScript. Simply specify multiple {\bf Command} directives
2665 Command = "/bin/echo test"
2666 Command = "/bin/echo an other test"
2667 Command = "/bin/echo 3 commands in the same runscript"
2674 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2675 implemented, which runs the command after the Volume Shadow Copy has been made.
2677 Console commands can be specified within a RunScript by using:
2678 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2679 carefully tested and debugged and is known to easily crash the Director.
2680 We would appreciate feedback. Due to the recursive nature of this command, we
2681 may remove it before the final release.
2683 \subsection{Status Enhancements}
2684 \index[general]{Status Enhancements}
2685 The bconsole {\bf status dir} output has been enhanced to indicate
2686 Storage daemon job spooling and despooling activity.
2688 \subsection{Connect Timeout}
2689 \index[general]{Connect Timeout}
2690 The default connect timeout to the File
2691 daemon has been set to 3 minutes. Previously it was 30 minutes.
2693 \subsection{ftruncate for NFS Volumes}
2694 \index[general]{ftruncate for NFS Volumes}
2695 If you write to a Volume mounted by NFS (say on a local file server),
2696 in previous Bacula versions, when the Volume was recycled, it was not
2697 properly truncated because NFS does not implement ftruncate (file
2698 truncate). This is now corrected in the new version because we have
2699 written code (actually a kind user) that deletes and recreates the Volume,
2700 thus accomplishing the same thing as a truncate.
2702 \subsection{Support for Ubuntu}
2703 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2704 version of Linux, and thus now provides correct autostart routines.
2705 Since Ubuntu officially supports Bacula, you can also obtain any
2706 recent release of Bacula from the Ubuntu repositories.
2708 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2709 \index[general]{Recycle Pool}
2710 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2711 be placed (moved) when it is recycled. Without this directive, a Volume will
2712 remain in the same pool when it is recycled. With this directive, it can be
2713 moved automatically to any existing pool during a recycle. This directive is
2714 probably most useful when defined in the Scratch pool, so that volumes will
2715 be recycled back into the Scratch pool.
2717 \subsection{FD Version}
2718 \index[general]{FD Version}
2719 The File daemon to Director protocol now includes a version
2720 number, which although there is no visible change for users,
2721 will help us in future versions automatically determine
2722 if a File daemon is not compatible.
2724 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2725 \index[general]{Max Run Sched Time}
2726 The time specifies the maximum allowed time that a job may run, counted from
2727 when the job was scheduled. This can be useful to prevent jobs from running
2728 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2731 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2732 \index[general]{Max Wait Time}
2733 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2734 of checking the maximum allowed time that a job may block for a resource,
2735 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2736 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2737 their job depending on the level. Now, they have to use
2738 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2739 directives are now deprecated.
2741 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2742 \index[general]{Incremental Max Wait Time}
2743 \index[general]{Differential Max Wait Time}
2745 These directives have been deprecated in favor of
2746 \texttt{Incremental|Differential Max Run Time}.
2748 \subsection{Max Run Time directives}
2749 \index[general]{Max Run Time directives}
2750 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2751 maximum allowed time that a job can run depending on the level.
2753 \addcontentsline{lof}{figure}{Job time control directives}
2754 \includegraphics{\idir different_time.eps}
2756 \subsection{Statistics Enhancements}
2757 \index[general]{Statistics Enhancements}
2758 If you (or probably your boss) want to have statistics on your backups to
2759 provide some \textit{Service Level Agreement} indicators, you could use a few
2760 SQL queries on the Job table to report how many:
2764 \item jobs have been successful
2765 \item files have been backed up
2769 However, these statistics are accurate only if your job retention is greater
2770 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2771 be able to use them.
2773 Now, you can use the \textbf{update stats [days=num]} console command to fill
2774 the JobHistory table with new Job records. If you want to be sure to take in
2775 account only \textbf{good jobs}, ie if one of your important job has failed but
2776 you have fixed the problem and restarted it on time, you probably want to
2777 delete the first \textit{bad} job record and keep only the successful one. For
2778 that simply let your staff do the job, and update JobHistory table after two or
2779 three days depending on your organization using the \textbf{[days=num]} option.
2781 These statistics records aren't used for restoring, but mainly for
2782 capacity planning, billings, etc.
2784 The Bweb interface provides a statistics module that can use this feature. You
2785 can also use tools like Talend or extract information by yourself.
2787 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2788 the length of time that Bacula will keep statistics job records in the Catalog
2789 database after the Job End time. (In \texttt{JobHistory} table) When this time
2790 period expires, and if user runs \texttt{prune stats} command, Bacula will
2791 prune (remove) Job records that are older than the specified period.
2793 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2794 job to maintain statistics.
2797 Name = BackupCatalog
2800 Console = "update stats days=3"
2801 Console = "prune stats yes"
2808 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2809 \index[general]{ScratchPool}
2810 This directive permits to specify a specific \textsl{Scratch} pool for the
2811 current pool. This is useful when using multiple storage sharing the same
2812 mediatype or when you want to dedicate volumes to a particular set of pool.
2814 \subsection{Enhanced Attribute Despooling}
2815 \index[general]{Attribute Despooling}
2816 If the storage daemon and the Director are on the same machine, the spool file
2817 that contains attributes is read directly by the Director instead of being
2818 transmitted across the network. That should reduce load and speedup insertion.
2820 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2821 \index[general]{SpoolSize}
2822 A new Job directive permits to specify the spool size per job. This is used
2823 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2825 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2826 \index[general]{MaximumConsoleConnections}
2827 A new director directive permits to specify the maximum number of Console
2828 Connections that could run concurrently. The default is set to 20, but you may
2829 set it to a larger number.
2831 \subsection{VerId = \lt{}string\gt{}}
2832 \index[general]{VerId}
2833 A new director directive permits to specify a personnal identifier that will be
2834 displayed in the \texttt{version} command.
2836 \subsection{dbcheck enhancements}
2837 \index[general]{dbcheck enhancements}
2838 If you are using Mysql, dbcheck will now ask you if you want to create
2839 temporary indexes to speed up orphaned Path and Filename elimination.
2841 A new \texttt{-B} option allows you to print catalog information in a simple
2842 text based format. This is useful to backup it in a secure way.
2857 You can now specify the database connection port in the command line.
2859 \subsection{{-}{-}docdir configure option}
2860 \index[general]{{-}{-}docdir configure option}
2861 You can use {-}{-}docdir= on the ./configure command to
2862 specify the directory where you want Bacula to install the
2863 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2864 {\bf /usr/share/doc/bacula}.
2866 \subsection{{-}{-}htmldir configure option}
2867 \index[general]{{-}{-}htmldir configure option}
2868 You can use {-}{-}htmldir= on the ./configure command to
2869 specify the directory where you want Bacula to install the bat html help
2870 files. The default is {\bf /usr/share/doc/bacula/html}
2872 \subsection{{-}{-}with-plugindir configure option}
2873 \index[general]{{-}{-}plugindir configure option}
2874 You can use {-}{-}plugindir= on the ./configure command to
2875 specify the directory where you want Bacula to install
2876 the plugins (currently only bpipe-fd). The default is