1 \chapter{Community Bacula New Features in 5.2.0}
2 This chapter presents the new features that have been added to the current
3 Community version of Bacula that is now released.
5 There are additional features (plugins) available in the Enterprise version
6 that are described in another chapter. A subscription to Bacula Systems
7 is required for the Enterprise version.
10 \section{LZO Compression}
12 LZO compression was added in the Unix File Daemon. From the user point of view, it
13 works like the GZIP compression (just replace {\bf compression=GZIP} with {\bf
19 Options { compression=LZO }
25 LZO provides much faster compression and decompression speed but lower
26 compression ratio than GZIP. It is a good option when you backup to disk. For
27 tape, the built-in compression may be a better option.
29 LZO is a good altenative for GZIP1 when you don't want to slow down your
30 backup. On a modern CPU it should be able to run almost as fast as:
33 \item your client can read data from disk. Unless you have very fast disks like
34 SSD or large/fast RAID array.
35 \item the data transfers between the file daemon and the storage daemon even on
39 Note that bacula only use one compression level LZO1X-1.
42 The code for this feature was contributed by Laurent Papier.
44 \section{New Tray Monitor}
46 Since the old integrated Windows tray monitor doesn't work with
47 recent Windows versions, we have written a new Qt Tray Monitor that is available
48 for both Linux and Windows. In addition to all the previous features,
49 this new version allows you to run Backups from
50 the tray monitor menu.
54 \includegraphics[width=10cm]{\idir tray-monitor}
55 \label{fig:traymonitor}
56 \caption{New tray monitor}
61 \includegraphics[width=10cm]{\idir tray-monitor1}
62 \label{fig:traymonitor1}
63 \caption{Run a Job through the new tray monitor}
67 To be able to run a job from the tray monitor, you need to
68 allow specific commands in the Director monitor console:
73 CommandACL = status, .clients, .jobs, .pools, .storage, .filesets, .messages, run
74 ClientACL = *all* # you can restrict to a specific host
86 This project was funded by Bacula Systems and is available with Bacula
87 the Enterprise Edition and the Community Edition.
89 \section{Purge Migration Job}
91 The new {\bf Purge Migration Job} directive may be added to the Migration
92 Job definition in the Director's configuration file. When it is enabled
93 the Job that was migrated during a migration will be purged at
94 the end of the migration job.
102 Client = localhost-fd
105 Storage = DiskChanger
108 Selection Pattern = ".*Save"
110 Purge Migrated Job = yes
116 This project was submited by Dunlap Blake; testing and documentation was funded
119 \section{Changes in Bvfs (Bacula Virtual FileSystem)}
121 Bat has now a bRestore panel that uses Bvfs to display files and
126 \includegraphics[width=12cm]{\idir bat-brestore}
127 \label{fig:batbrestore}
128 \caption{Bat Brestore Panel}
131 \texttt{Important}, the Bvfs module does not yet work correctly with BaseJobs,
132 Copy and Migration jobs.
135 This project was funded by Bacula Systems.
137 \subsection*{General notes}
140 \item All fields are separated by a tab
141 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
142 records in very big directories
143 \item All operations (except cache creation) are designed to run instantly
144 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
145 can contribute new faster SQL queries we will be happy, else don't complain
147 \item The cache creation is dependent of the number of directories. As Bvfs
148 shares information accross jobs, the first creation can be slow
149 \item All fields are separated by a tab
150 \item Due to potential encoding problem, it's advised to allways use pathid in
154 \subsection*{Get dependent jobs from a given JobId}
156 Bvfs allows you to query the catalog against any combination of jobs. You
157 can combine all Jobs and all FileSet for a Client in a single session.
159 To get all JobId needed to restore a particular job, you can use the
160 \texttt{.bvfs\_get\_jobids} command.
163 .bvfs_get_jobids jobid=num [all]
167 .bvfs_get_jobids jobid=10
169 .bvfs_get_jobids jobid=10 all
173 In this example, a normal restore will need to use JobIds 1,2,5,10 to
174 compute a complete restore of the system.
176 With the \texttt{all} option, the Director will use all defined FileSet for
179 \subsection*{Generating Bvfs cache}
181 The \texttt{.bvfs\_update} command computes the directory cache for jobs
182 specified in argument, or for all jobs if unspecified.
185 .bvfs_update [jobid=numlist]
190 .bvfs_update jobid=1,2,3
193 You can run the cache update process in a RunScript after the catalog backup.
195 \subsection*{Get all versions of a specific file}
197 Bvfs allows you to find all versions of a specific file for a given Client with
198 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
199 function uses only PathId and FilenameId. The jobid argument is mandatory but
203 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
204 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
205 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
212 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
213 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
216 \subsection*{List directories}
218 Bvfs allows you to list directories in a specific path.
220 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
221 PathId FilenameId FileId JobId LStat Path
222 PathId FilenameId FileId JobId LStat Path
223 PathId FilenameId FileId JobId LStat Path
227 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
228 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
229 listed is a directory.
232 .bvfs_lsdirs pathid=4 jobid=1,11,12
233 4 0 0 0 A A A A A A A A A A A A A A .
234 5 0 0 0 A A A A A A A A A A A A A A ..
235 3 0 0 0 A A A A A A A A A A A A A A regress/
238 In this example, to list directories present in \texttt{regress/}, you can use
240 .bvfs_lsdirs pathid=3 jobid=1,11,12
241 3 0 0 0 A A A A A A A A A A A A A A .
242 4 0 0 0 A A A A A A A A A A A A A A ..
243 2 0 0 0 A A A A A A A A A A A A A A tmp/
246 \subsection*{List files}
248 Bvfs allows you to list files in a specific path.
250 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
251 PathId FilenameId FileId JobId LStat Path
252 PathId FilenameId FileId JobId LStat Path
253 PathId FilenameId FileId JobId LStat Path
257 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
258 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
262 .bvfs_lsfiles pathid=4 jobid=1,11,12
263 4 0 0 0 A A A A A A A A A A A A A A .
264 5 0 0 0 A A A A A A A A A A A A A A ..
265 1 0 0 0 A A A A A A A A A A A A A A regress/
268 In this example, to list files present in \texttt{regress/}, you can use
270 .bvfs_lsfiles pathid=1 jobid=1,11,12
271 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
272 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
273 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
274 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
275 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
278 \subsection*{Restore set of files}
280 Bvfs allows you to create a SQL table that contains files that you want to
281 restore. This table can be provided to a restore command with the file option.
284 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
286 restore file=?b2num ...
289 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
290 select all files. This query could be time consuming.
292 \texttt{hardlink} list is always composed of a serie of two numbers (jobid,
293 fileindex). This information can be found in the LinkFI field of the LStat
296 The \texttt{path} argument represents the name of the table that Bvfs will
297 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
298 b2 and followed by digits).
303 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
307 \subsection*{Cleanup after Restore}
309 To drop the table used by the restore command, you can use the
310 \texttt{.bvfs\_cleanup} command.
313 .bvfs_cleanup path=b20001
316 \section{Changes in the Pruning Algorithm}
318 We rewrote the job pruning algorithm in this version. Previously, in some users
319 reported that the pruning process at the end of jobs was very long. It should
320 not be longer the case. Now, Bacula won't prune automatically a Job if this
321 particular Job is needed to restore data. Example:
325 JobId: 2 Level: Incremental
326 JobId: 3 Level: Incremental
327 JobId: 4 Level: Differential
328 .. Other incrementals up to now
331 In this example, if the Job Retention defined in the Pool or in the Client
332 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
333 detect that JobId 1 and 4 are essential to restore data at the current state
334 and will prune only JobId 2 and 3.
336 \texttt{Important}, this change affect only the automatic pruning step after a
337 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
338 \texttt{VolumeRetention} period, important jobs can be pruned.
340 \section{Ability to Verify any specified Job}
341 You now have the ability to tell Bacula which Job should verify instead of
342 automatically verify just the last one.
344 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
346 To verify a given job, just specify the Job jobid in argument when starting the
349 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
351 JobName: VerifyVolume
352 Level: VolumeToCatalog
355 Pool: Default (From Job resource)
356 Storage: File (From Job resource)
357 Verify Job: VerifyVol.2010-09-08_14.17.17_03
358 Verify List: /tmp/regress/working/VerifyVol.bsr
359 When: 2010-09-08 14:17:31
361 OK to run? (yes/mod/no):
365 This project was funded by Bacula Systems and is available with Bacula
366 Enterprise Edition and Community Edition.
368 \section{Additions to RunScript variables}
369 You can have access to JobBytes and JobFiles using \%b and \%F in your runscript
370 command. The Client address is now available through \%h.
373 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h"
376 %\section{Changes in drivetype.exe}
378 %Now the \texttt{drivetype.exe} program allows you to list all local hard
379 %drives. It can help to build dynamic FileSet on Windows.
382 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
386 \section{Additions to the Plugin API}
387 The bfuncs structure has been extended to include a number of
391 The bFuncs structure defines the callback entry points within Bacula
392 that the plugin can use register events, get Bacula values, set
393 Bacula values, and send messages to the Job output or debug output.
395 The exact definition as of this writing is:
397 typedef struct s_baculaFuncs {
400 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
401 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
402 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
403 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
404 int type, utime_t mtime, const char *fmt, ...);
405 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
406 int level, const char *fmt, ...);
407 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
409 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
411 /* New functions follow */
412 bRC (*AddExclude)(bpContext *ctx, const char *file);
413 bRC (*AddInclude)(bpContext *ctx, const char *file);
414 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
415 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
416 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
417 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
423 \item [AddExclude] can be called to exclude a file. The file
424 string passed may include wildcards that will be interpreted by
425 the {\bf fnmatch} subroutine. This function can be called
426 multiple times, and each time the file specified will be added
427 to the list of files to be excluded. Note, this function only
428 permits adding excludes of specific file or directory names,
429 or files matched by the rather simple fnmatch mechanism.
430 See below for information on doing wild-card and regex excludes.
432 \item [NewInclude] can be called to create a new Include block. This
433 block will be added before any user defined Include blocks. This
434 function can be called multiple times, but each time, it will create
435 a new Include section (not normally needed). This function should
436 be called only if you want to add an entirely new Include block.
438 \item [AddInclude] can be called to add new files/directories to
439 be included. They are added to the current Include block. If
440 NewInclude has not been included, the current Include block is
441 the last one that the user created. This function
442 should be used only if you want to add totally new files/directories
443 to be included in the backup.
445 \item [NewOptions] adds a new Options block to the current Include
446 in front of any other Options blocks. This permits the plugin to
447 add exclude directives (wild-cards and regexes) in front of the
448 user Options, and thus prevent certain files from being backed up.
449 This can be useful if the plugin backs up files, and they should
450 not be also backed up by the main Bacula code. This function
451 may be called multiple times, and each time, it creates a new
452 prepended Options block. Note: normally you want to call this
453 entry point prior to calling AddOptions, AddRegex, or AddWild.
455 \item [AddOptions] allows the plugin it set options in
456 the current Options block, which is normally created with the
457 NewOptions call just prior to adding Include Options.
458 The permitted options are passed as a character string, where
459 each character has a specific meaning as defined below:
462 \item [a] always replace files (default).
463 \item [e] exclude rather than include.
464 \item [h] no recursion into subdirectories.
465 \item [H] do not handle hard links.
466 \item [i] ignore case in wildcard and regex matches.
467 \item [M] compute an MD5 sum.
468 \item [p] use a portable data format on Windows (not recommended).
469 \item [R] backup resource forks and Findr Info.
470 \item [r] read from a fifo
471 \item [S1] compute an SHA1 sum.
472 \item [S2] compute an SHA256 sum.
473 \item [S3] comput an SHA512 sum.
474 \item [s] handle sparse files.
475 \item [m] use st\_mtime only for file differences.
476 \item [k] restore the st\_atime after accessing a file.
477 \item [A] enable ACL backup.
478 \item [Vxxx:] specify verify options. Must terminate with :
479 \item [Cxxx:] specify accurate options. Must terminate with :
480 \item [Jxxx:] specify base job Options. Must terminate with :
481 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
483 \item [Zn] specify gzip compression level n.
484 \item [K] do not use st\_atime in backup decision.
485 \item [c] check if file changed during backup.
486 \item [N] honor no dump flag.
487 \item [X] enable backup of extended attributes.
490 \item [AddRegex] adds a regex expression to the current Options block.
491 The fillowing options are permitted:
493 \item [ ] (a blank) regex applies to whole path and filename.
494 \item [F] regex applies only to the filename (directory or path stripped).
495 \item [D] regex applies only to the directory (path) part of the name.
498 \item [AddWild] adds a wildcard expression to the current Options block.
499 The fillowing options are permitted:
501 \item [ ] (a blank) regex applies to whole path and filename.
502 \item [F] regex applies only to the filename (directory or path stripped).
503 \item [D] regex applies only to the directory (path) part of the name.
506 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
507 that can use Accurate code to compare the file information in argument with
508 the previous file information. The \texttt{delta\_seq} attribute of the
509 \texttt{save\_pkt} will be updated, and the call will return
510 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
515 \subsection{Bacula events}
516 The list of events has been extended to include:
522 bEventStartBackupJob = 3,
523 bEventEndBackupJob = 4,
524 bEventStartRestoreJob = 5,
525 bEventEndRestoreJob = 6,
526 bEventStartVerifyJob = 7,
527 bEventEndVerifyJob = 8,
528 bEventBackupCommand = 9,
529 bEventRestoreCommand = 10,
534 bEventCancelCommand = 13,
535 bEventVssBackupAddComponents = 14,
536 bEventVssRestoreLoadComponentMetadata = 15,
537 bEventVssRestoreSetComponentsSelected = 16,
538 bEventRestoreObject = 17,
539 bEventEndFileSet = 18,
540 bEventPluginCommand = 19,
541 bEventVssBeforeCloseRestore = 20,
542 bEventVssPrepareSnapshot = 21
548 \item [bEventCancelCommand] is called whenever the currently
549 running Job is cancelled */
551 \item [bEventVssBackupAddComponents]
553 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
554 provides a char[27] table where the plugin can add Windows drives that will
555 be used during the Job. You need to add them without duplicates, and you can
556 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
560 \section{ACL enhancements}
562 The following enhancements are made to the Bacula Filed with regards to
563 Access Control Lists (ACLs)
566 \item Added support for AIX 5.3 and later new aclx\_get interface which supports
567 POSIX and NFSv4 ACLs.
568 \item Added support for new acl types on FreeBSD 8.1 and later which supports
569 POSIX and NFSv4 ACLs.
570 \item Some generic cleanups for internal ACL handling.
571 \item Fix for acl storage on OSX
572 \item Cleanup of configure checks for ACL detection, now configure only
573 tests for a certain interface type based on the operating system
574 this should give less false possitives on detection. Also when acls
575 are detected no other acl checks are performed anymore.
579 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
580 and is available with Bacula Enterprise Edition and Community Edition.
582 \section{XATTR enhancements}
584 The following enhancements are made to the Bacula Filed with regards to
585 Extended Attributes (XATTRs)
588 \item Added support for IRIX extended attributes using the attr\_get interface.
589 \item Added support for Tru64 (OSF1) extended attributes using the
590 getproplist interface.
591 \item Added support for AIX extended attributes available in AIX 6.x
592 and higher using the listea/getea/setea interface.
593 \item Added some debugging to generic xattr code so it easier to
595 \item Cleanup of configure checks for XATTR detection, now configure only
596 tests for a certain interface type based on the operating system
597 this should give less false possitives on detection. Also when xattrs
598 are detected no other xattr checks are performed anymore.
602 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
603 and is available with Bacula Enterprise Edition and Community Edition.
605 \section{Class Based Dtabase Backend Drivers}
607 All current database backend drivers for catalog information are rewritten
608 to use a set of multi inherited C++ classes which abstract the specific
609 database specific internals and make sure we have a more stable generic
610 interface with the rest of sql code. From now on there is a strict boundery
611 between the SQL code and the low-level database functions. This new interface
612 should also make it easier to add a new backend for a currently unsupported
613 database. As part of the rewrite the SQLite 2 code was removed (e.g. only
614 SQLite 3 is now supported). An extra bonus of the new code is that you can
615 configure multiple backends in the configure and build all backends in one
616 compile session and select the correct database backend at install time.
617 This should make it a lot easier for packages maintainers.
620 We also added cursor support for PostgreSQL backend, this improves memory usage
621 for large installation.
624 This project was implemented by Planets Communications B.V. and ELM Consultancy B.V.
625 and Bacula Systems and is available with both the Bacula Enterprise Edition and
626 the Community Edition.
628 \section{Hash List Enhancements}
630 The htable hash table class has been extended with extra hash functions for
631 handling next to char pointer hashes also 32 bits and 64 bits hash keys.
632 Also the hash table initialization routines have been enhanced with
633 support for passing a hint as to the number of initial pages to use
634 for the size of the hash table. Until now the hash table always used
635 a fixed value of 10 Mb. The private hash functions of the mountpoint entry
636 cache have been rewritten to use the new htable class with a small memory
640 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
641 and Bacula Systems and is available with Bacula Enterprise Edition and
646 %%% =====================================================================
651 \chapter{Release Version 5.0.3}
653 There are no new features in version 5.0.2. This version simply fixes a
654 number of bugs found in version 5.0.1 during the onging development
657 \chapter{Release Version 5.0.2}
659 There are no new features in version 5.0.2. This version simply fixes a
660 number of bugs found in version 5.0.1 during the onging development
666 \chapter{New Features in 5.0.1}
668 This chapter presents the new features that are in the released Bacula version
669 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
670 the onging development process.
672 \section{Truncate Volume after Purge}
673 \label{sec:actiononpurge}
675 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
676 the volume when it is purged with the new command \texttt{purge volume
677 action}. It is useful to prevent disk based volumes from consuming too much
683 Action On Purge = Truncate
688 As usual you can also set this property with the \texttt{update volume} command
690 *update volume=xxx ActionOnPurge=Truncate
691 *update volume=xxx actiononpurge=None
694 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
695 following command in interactive mode or in a RunScript as shown after:
697 *purge volume action=truncate storage=File allpools
698 # or by default, action=all
699 *purge volume action storage=File pool=Default
702 This is possible to specify the volume name, the media type, the pool, the
703 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
704 idle when you decide to run this command.
713 Console = "purge volume action=all allpools storage=File"
718 \textbf{Important note}: This feature doesn't work as
719 expected in version 5.0.0. Please do not use it before version 5.0.1.
721 \section{Allow Higher Duplicates}
722 This directive did not work correctly and has been depreciated
723 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
724 file as it will be removed in a future rlease.
726 \section{Cancel Lower Level Duplicates}
727 This directive was added in Bacula version 5.0.1. It compares the
728 level of a new backup job to old jobs of the same name, if any,
729 and will kill the job which has a lower level than the other one.
730 If the levels are the same (i.e. both are Full backups), then
731 nothing is done and the other Cancel XXX Duplicate directives
734 \chapter{New Features in 5.0.0}
736 \section{Maximum Concurrent Jobs for Devices}
737 \label{sec:maximumconcurrentjobdevice}
739 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
740 Daemon configuration permits setting the maximum number of Jobs that can
741 run concurrently on a specified Device. Using this directive, it is
742 possible to have different Jobs using multiple drives, because when the
743 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
744 Jobs on any other available compatible drive. This facilitates writing to
745 multiple drives with multiple Jobs that all use the same Pool.
747 This project was funded by Bacula Systems.
749 \section{Restore from Multiple Storage Daemons}
750 \index[general]{Restore}
752 Previously, you were able to restore from multiple devices in a single Storage
753 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
754 example, if your full backup runs on a Storage Daemon with an autochanger, and
755 your incremental jobs use another Storage Daemon with lots of disks, Bacula
756 will switch automatically from one Storage Daemon to an other within the same
759 You must upgrade your File Daemon to version 3.1.3 or greater to use this
762 This project was funded by Bacula Systems with the help of Equiinet.
764 \section{File Deduplication using Base Jobs}
765 A base job is sort of like a Full save except that you will want the FileSet to
766 contain only files that are unlikely to change in the future (i.e. a snapshot
767 of most of your system after installing it). After the base job has been run,
768 when you are doing a Full save, you specify one or more Base jobs to be used.
769 All files that have been backed up in the Base job/jobs but not modified will
770 then be excluded from the backup. During a restore, the Base jobs will be
771 automatically pulled in where necessary.
773 This is something none of the competition does, as far as we know (except
774 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
775 win for the user, it makes Bacula stand out as offering a unique optimization
776 that immediately saves time and money. Basically, imagine that you have 100
777 nearly identical Windows or Linux machine containing the OS and user files.
778 Now for the OS part, a Base job will be backed up once, and rather than making
779 100 copies of the OS, there will be only one. If one or more of the systems
780 have some files updated, no problem, they will be automatically restored.
782 See the \ilink{Base Job Chapter}{basejobs} for more information.
784 This project was funded by Bacula Systems.
786 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
787 \index[dir]{AllowCompression}
789 This new directive may be added to Storage resource within the Director's
790 configuration to allow users to selectively disable the client compression for
791 any job which writes to this storage resource.
797 Address = ultrium-tape
798 Password = storage_password # Password for Storage Daemon
801 AllowCompression = No # Tape drive has hardware compression
804 The above example would cause any jobs running with the UltriumTape storage
805 resource to run without compression from the client file daemons. This
806 effectively overrides any compression settings defined at the FileSet level.
808 This feature is probably most useful if you have a tape drive which supports
809 hardware compression. By setting the \texttt{AllowCompression = No} directive
810 for your tape drive storage resource, you can avoid additional load on the file
811 daemon and possibly speed up tape backups.
813 This project was funded by Collaborative Fusion, Inc.
815 \section{Accurate Fileset Options}
816 \label{sec:accuratefileset}
818 In previous versions, the accurate code used the file creation and modification
819 times to determine if a file was modified or not. Now you can specify which
820 attributes to use (time, size, checksum, permission, owner, group, \dots),
821 similar to the Verify options.
837 \item {\bf i} compare the inodes
838 \item {\bf p} compare the permission bits
839 \item {\bf n} compare the number of links
840 \item {\bf u} compare the user id
841 \item {\bf g} compare the group id
842 \item {\bf s} compare the size
843 \item {\bf a} compare the access time
844 \item {\bf m} compare the modification time (st\_mtime)
845 \item {\bf c} compare the change time (st\_ctime)
846 \item {\bf d} report file size decreases
847 \item {\bf 5} compare the MD5 signature
848 \item {\bf 1} compare the SHA1 signature
851 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
852 the File Daemon will have to read all files even if they normally would not
853 be saved. This increases the I/O load, but also the accuracy of the
854 deduplication. By default, Bacula will check modification/creation time
857 This project was funded by Bacula Systems.
859 \section{Tab-completion for Bconsole}
860 \label{sec:tabcompletion}
862 If you build \texttt{bconsole} with readline support, you will be able to use
863 the new auto-completion mode. This mode supports all commands, gives help
864 inside command, and lists resources when required. It works also in the restore
867 To use this feature, you should have readline development package loaded on
868 your system, and use the following option in configure.
870 ./configure --with-readline=/usr/include/readline --disable-conio ...
873 The new bconsole won't be able to tab-complete with older directors.
875 This project was funded by Bacula Systems.
877 \section{Pool File and Job Retention}
878 \label{sec:poolfilejobretention}
880 We added two new Pool directives, \texttt{FileRetention} and
881 \texttt{JobRetention}, that take precedence over Client directives of the same
882 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
883 example, you can decide to increase Retention times for Archive or OffSite Pool.
885 It seems obvious to us, but apparently not to some users, that given the
886 definition above that the Pool File and Job Retention periods is a global
887 override for the normal Client based prunning, which means that when the
888 Job is prunned, the prunning will apply globally to that particular Job.
890 Currently, there is a bug in the implementation that causes any Pool
891 retention periods specified to apply to {\bf all} Pools for that
892 particular Client. Thus we suggest that you avoid using these two
893 directives until this implementation problem is corrected.
895 \section{Read-only File Daemon using capabilities}
896 \label{sec:fdreadonly}
897 This feature implements support of keeping \textbf{ReadAll} capabilities after
898 UID/GID switch, this allows FD to keep root read but drop write permission.
900 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
901 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
904 root@localhost:~# bacula-fd -k -u nobody -g nobody
907 The code for this feature was contributed by our friends at AltLinux.
912 To help developers of restore GUI interfaces, we have added new \textsl{dot
913 commands} that permit browsing the catalog in a very simple way.
916 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
917 the Bvfs cache in the catalog. You need to run it before any access to the
920 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
921 will list all directories in the specified \texttt{path} or
922 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
923 encoding of path/filenames.
925 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
926 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
927 \texttt{pathid} avoids problems with character encoding.
930 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
931 data that will be displayed.
934 * .bvfs_update jobid=1,2
936 * .bvfs_lsdir path=/ jobid=1,2
939 This project was funded by Bacula Systems.
941 \section{Testing your Tape Drive}
942 \label{sec:btapespeed}
944 To determine the best configuration of your tape drive, you can run the new
945 \texttt{speed} command available in the \texttt{btape} program.
947 This command can have the following arguments:
949 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
950 (between 1 and 5GB). This counter is in GB.
951 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
952 of data should be greater than your memory ($file\_size*nb\_file$).
953 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
955 \item[\texttt{skip\_random}] This flag permits to skip tests with random
957 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
958 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
963 *speed file_size=3 skip_raw
964 btape.c:1078 Test with zero data and bacula block structure.
965 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
966 ++++++++++++++++++++++++++++++++++++++++++
967 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
968 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
970 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
972 btape.c:1090 Test with random data, should give the minimum throughput.
973 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
974 +++++++++++++++++++++++++++++++++++++++++++
975 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
976 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
977 +++++++++++++++++++++++++++++++++++++++++++
979 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
983 When using compression, the random test will give your the minimum throughput
984 of your drive . The test using constant string will give you the maximum speed
985 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
987 You can change the block size in the Storage Daemon configuration file.
989 \section{New {\bf Block Checksum} Device Directive}
990 You may now turn off the Block Checksum (CRC32) code
991 that Bacula uses when writing blocks to a Volume. This is
998 doing so can reduce the Storage daemon CPU usage slightly. It
999 will also permit Bacula to read a Volume that has corrupted data.
1001 The default is {\bf yes} -- i.e. the checksum is computed on write
1002 and checked on read.
1004 We do not recommend to turn this off particularly on older tape
1005 drives or for disk Volumes where doing so may allow corrupted data
1008 \section{New Bat Features}
1010 Those new features were funded by Bacula Systems.
1012 \subsection{Media List View}
1014 By clicking on ``Media'', you can see the list of all your volumes. You will be
1015 able to filter by Pool, Media Type, Location,\dots And sort the result directly
1016 in the table. The old ``Media'' view is now known as ``Pool''.
1017 \begin{figure}[htbp]
1019 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
1020 \label{fig:mediaview}
1024 \subsection{Media Information View}
1026 By double-clicking on a volume (on the Media list, in the Autochanger content
1027 or in the Job information panel), you can access a detailed overview of your
1028 Volume. (cf \ref{fig:mediainfo}.)
1029 \begin{figure}[htbp]
1031 \includegraphics[width=13cm]{\idir bat11.eps}
1032 \caption{Media information}
1033 \label{fig:mediainfo}
1036 \subsection{Job Information View}
1038 By double-clicking on a Job record (on the Job run list or in the Media
1039 information panel), you can access a detailed overview of your Job. (cf
1041 \begin{figure}[htbp]
1043 \includegraphics[width=13cm]{\idir bat12.eps}
1044 \caption{Job information}
1048 \subsection{Autochanger Content View}
1050 By double-clicking on a Storage record (on the Storage list panel), you can
1051 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
1052 \begin{figure}[htbp]
1054 \includegraphics[width=13cm]{\idir bat13.eps}
1055 \caption{Autochanger content}
1056 \label{fig:achcontent}
1059 To use this feature, you need to use the latest mtx-changer script
1060 version. (With new \texttt{listall} and \texttt{transfer} commands)
1062 \section{Bat on Windows}
1063 We have ported {\bf bat} to Windows and it is now installed
1064 by default when the installer is run. It works quite well
1065 on Win32, but has not had a lot of testing there, so your
1066 feedback would be welcome. Unfortunately, eventhough it is
1067 installed by default, it does not yet work on 64 bit Windows
1070 \section{New Win32 Installer}
1071 The Win32 installer has been modified in several very important
1074 \item You must deinstall any current version of the
1075 Win32 File daemon before upgrading to the new one.
1076 If you forget to do so, the new installation will fail.
1077 To correct this failure, you must manually shutdown
1078 and deinstall the old File daemon.
1079 \item All files (other than menu links) are installed
1080 in {\bf c:/Program Files/Bacula}.
1081 \item The installer no longer sets this
1082 file to require administrator privileges by default. If you want
1083 to do so, please do it manually using the {\bf cacls} program.
1086 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1088 \item The server daemons (Director and Storage daemon) are
1089 no longer included in the Windows installer. If you want the
1090 Windows servers, you will either need to build them yourself (note
1091 they have not been ported to 64 bits), or you can contact
1092 Bacula Systems about this.
1095 \section{Win64 Installer}
1096 We have corrected a number of problems that required manual
1097 editing of the conf files. In most cases, it should now
1098 install and work. {\bf bat} is by default installed in
1099 {\bf c:/Program Files/Bacula/bin32} rather than
1100 {\bf c:/Program Files/Bacula} as is the case with the 32
1101 bit Windows installer.
1103 \section{Linux Bare Metal Recovery USB Key}
1104 We have made a number of significant improvements in the
1105 Bare Metal Recovery USB key. Please see the README files
1106 it the {\bf rescue} release for more details.
1108 We are working on an equivalent USB key for Windows bare
1109 metal recovery, but it will take some time to develop it (best
1110 estimate 3Q2010 or 4Q2010)
1113 \section{bconsole Timeout Option}
1114 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1115 for commands. This is useful with GUI programs that use {\bf bconsole}
1116 to interface to the Director.
1118 \section{Important Changes}
1119 \label{sec:importantchanges}
1122 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1123 to the same Pool. The Storage daemon ensures that you do not read and
1124 write to the same Volume.
1125 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1127 \item Virtually all the features of {\bf mtx-changer} have
1128 now been parameterized, which allows you to configure
1129 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
1130 that contains variables that you can set to configure mtx-changer.
1131 This configuration file will not be overwritten during upgrades.
1132 We encourage you to submit any changes
1133 that are made to mtx-changer and to parameterize it all in
1134 mtx-changer.conf so that all configuration will be done by
1135 changing only mtx-changer.conf.
1136 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1137 and \texttt{transfer}. Please configure them as appropriate
1138 in mtx-changer.conf.
1139 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1140 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1141 password. If you want to use the new script, you will need to
1142 manually change the \texttt{BackupCatalog} Job definition.
1143 \item The \texttt{bconsole} \texttt{help} command now accepts
1144 an argument, which if provided produces information on that
1145 command (ex: \texttt{help run}).
1149 \subsubsection*{Truncate volume after purge}
1151 Note that the Truncate Volume after purge feature doesn't work as expected
1152 in 5.0.0 version. Please, don't use it before version 5.0.1.
1154 \subsection{Custom Catalog queries}
1156 If you wish to add specialized commands that list the contents of the catalog,
1157 you can do so by adding them to the \texttt{query.sql} file. This
1158 \texttt{query.sql} file is now empty by default. The file
1159 \texttt{examples/sample-query.sql} has an a number of sample commands
1160 you might find useful.
1162 \subsection{Deprecated parts}
1164 The following items have been \textbf{deprecated} for a long time, and are now
1165 removed from the code.
1168 \item Support for SQLite 2
1171 \section{Misc Changes}
1172 \label{sec:miscchanges}
1175 \item Updated Nagios check\_bacula
1176 \item Updated man files
1177 \item Added OSX package generation script in platforms/darwin
1178 \item Added Spanish and Ukrainian Bacula translations
1179 \item Enable/disable command shows only Jobs that can change
1180 \item Added \texttt{show disabled} command to show disabled Jobs
1181 \item Many ACL improvements
1182 \item Added Level to FD status Job output
1183 \item Begin Ingres DB driver (not yet working)
1184 \item Split RedHat spec files into bacula, bat, mtx, and docs
1185 \item Reorganized the manuals (fewer separate manuals)
1186 \item Added lock/unlock order protection in lock manager
1187 \item Allow 64 bit sizes for a number of variables
1188 \item Fixed several deadlocks or potential race conditions in the SD
1191 \chapter{Released Version 3.0.3 and 3.0.3a}
1193 There are no new features in version 3.0.3. This version simply fixes a
1194 number of bugs found in version 3.0.2 during the onging development
1197 \chapter{New Features in Released Version 3.0.2}
1199 This chapter presents the new features added to the
1200 Released Bacula Version 3.0.2.
1202 \section{Full Restore from a Given JobId}
1203 \index[general]{Restore menu}
1205 This feature allows selecting a single JobId and having Bacula
1206 automatically select all the other jobs that comprise a full backup up to
1207 and including the selected date (through JobId).
1209 Assume we start with the following jobs:
1211 +-------+--------------+---------------------+-------+----------+------------+
1212 | jobid | client | starttime | level | jobfiles | jobbytes |
1213 +-------+--------------+---------------------+-------+----------+------------
1214 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
1215 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
1216 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
1217 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
1218 +-------+--------------+---------------------+-------+----------+------------+
1221 Below is an example of this new feature (which is number 12 in the
1226 To select the JobIds, you have the following choices:
1227 1: List last 20 Jobs run
1228 2: List Jobs where a given File is saved
1230 12: Select full restore to a specified Job date
1233 Select item: (1-13): 12
1234 Enter JobId to get the state to restore: 5
1235 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1236 You have selected the following JobIds: 1,3,5
1238 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1239 1,444 files inserted into the tree.
1242 This project was funded by Bacula Systems.
1244 \section{Source Address}
1245 \index[general]{Source Address}
1247 A feature has been added which allows the administrator to specify the address
1248 from which the Director and File daemons will establish connections. This
1249 may be used to simplify system configuration overhead when working in complex
1250 networks utilizing multi-homing and policy-routing.
1252 To accomplish this, two new configuration directives have been implemented:
1255 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
1259 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
1263 Simply adding specific host routes on the OS
1264 would have an undesirable side-effect: any
1265 application trying to contact the destination host would be forced to use the
1266 more specific route possibly diverting management traffic onto a backup VLAN.
1267 Instead of adding host routes for each client connected to a multi-homed backup
1268 server (for example where there are management and backup VLANs), one can
1269 use the new directives to specify a specific source address at the application
1272 Additionally, this allows the simplification and abstraction of firewall rules
1273 when dealing with a Hot-Standby director or storage daemon configuration. The
1274 Hot-standby pair may share a CARP address, which connections must be sourced
1275 from, while system services listen and act from the unique interface addresses.
1277 This project was funded by Collaborative Fusion, Inc.
1279 \section{Show volume availability when doing restore}
1281 When doing a restore the selection dialog ends by displaying this
1285 The job will require the following
1286 Volume(s) Storage(s) SD Device(s)
1287 ===========================================================================
1288 *000741L3 LTO-4 LTO3
1289 *000866L3 LTO-4 LTO3
1290 *000765L3 LTO-4 LTO3
1291 *000764L3 LTO-4 LTO3
1292 *000756L3 LTO-4 LTO3
1293 *001759L3 LTO-4 LTO3
1294 *001763L3 LTO-4 LTO3
1298 Volumes marked with ``*'' are online (in the autochanger).
1301 This should help speed up large restores by minimizing the time spent
1302 waiting for the operator to discover that he must change tapes in the library.
1304 This project was funded by Bacula Systems.
1306 \section{Accurate estimate command}
1308 The \texttt{estimate} command can now use the accurate code to detect changes
1309 and give a better estimation.
1311 You can set the accurate behavior on the command line by using
1312 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1315 * estimate listing accurate=yes level=incremental job=BackupJob
1318 This project was funded by Bacula Systems.
1320 \chapter{New Features in 3.0.0}
1321 \label{NewFeaturesChapter}
1322 \index[general]{New Features}
1324 This chapter presents the new features added to the development 2.5.x
1325 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1327 \section{Accurate Backup}
1328 \index[general]{Accurate Backup}
1330 As with most other backup programs, by default Bacula decides what files to
1331 backup for Incremental and Differental backup by comparing the change
1332 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1333 backup completed. If one of those two times is later than the last backup
1334 time, then the file will be backed up. This does not, however, permit tracking
1335 what files have been deleted and will miss any file with an old time that may
1336 have been restored to or moved onto the client filesystem.
1338 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
1339 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1340 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1341 backup, there is no difference, but for {\bf Differential} and {\bf
1342 Incremental} backups, the Director will send a list of all previous files
1343 backed up, and the File daemon will use that list to determine if any new files
1344 have been added or or moved and if any files have been deleted. This allows
1345 Bacula to make an accurate backup of your system to that point in time so that
1346 if you do a restore, it will restore your system exactly.
1349 about using Accurate backup is that it requires more resources (CPU and memory)
1350 on both the Director and the Client machines to create the list of previous
1351 files backed up, to send that list to the File daemon, for the File daemon to
1352 keep the list (possibly very big) in memory, and for the File daemon to do
1353 comparisons between every file in the FileSet and the list. In particular,
1354 if your client has lots of files (more than a few million), you will need
1355 lots of memory on the client machine.
1357 Accurate must not be enabled when backing up with a plugin that is not
1358 specially designed to work with Accurate. If you enable it, your restores
1359 will probably not work correctly.
1361 This project was funded by Bacula Systems.
1366 \index[general]{Copy Jobs}
1368 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1369 existing Migration feature with the exception that the Job that is copied is
1370 left unchanged. This essentially creates two identical copies of the same
1371 backup. However, the copy is treated as a copy rather than a backup job, and
1372 hence is not directly available for restore. The {\bf restore} command lists
1373 copy jobs and allows selection of copies by using \texttt{jobid=}
1374 option. If the keyword {\bf copies} is present on the command line, Bacula will
1375 display the list of all copies for selected jobs.
1380 These JobIds have copies as follows:
1381 +-------+------------------------------------+-----------+------------------+
1382 | JobId | Job | CopyJobId | MediaType |
1383 +-------+------------------------------------+-----------+------------------+
1384 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
1385 +-------+------------------------------------+-----------+------------------+
1386 +-------+-------+----------+----------+---------------------+------------------+
1387 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
1388 +-------+-------+----------+----------+---------------------+------------------+
1389 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1390 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
1391 +-------+-------+----------+----------+---------------------+------------------+
1392 You have selected the following JobIds: 19,2
1394 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1395 5,611 files inserted into the tree.
1400 The Copy Job runs without using the File daemon by copying the data from the
1401 old backup Volume to a different Volume in a different Pool. See the Migration
1402 documentation for additional details. For copy Jobs there is a new selection
1403 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1404 not already copied to another Pool.
1406 As with Migration, the Client, Volume, Job, or SQL query, are
1407 other possible ways of selecting the Jobs to be copied. Selection
1408 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1409 work, but are probably more suited for Migration Jobs.
1411 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1412 it will promote the Copy to a \textsl{real} backup job and will make it available for
1413 automatic restore. If more than one Copy is available, it will promote the copy
1414 with the smallest JobId.
1416 A nice solution which can be built with the new Copy feature is often
1417 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1418 look something like the one below:
1422 Name = FullBackupsVirtualPool
1424 Purge Oldest Volume = Yes
1426 NextPool = FullBackupsTapePool
1430 Name = FullBackupsTapePool
1434 Volume Retention = 365 days
1435 Storage = superloader
1439 # Fake fileset for copy jobs
1451 # Fake client for copy jobs
1461 # Default template for a CopyDiskToTape Job
1464 Name = CopyDiskToTape
1466 Messages = StandardCopy
1469 Selection Type = PoolUncopiedJobs
1470 Maximum Concurrent Jobs = 10
1472 Allow Duplicate Jobs = Yes
1473 Cancel Queued Duplicates = No
1474 Cancel Running Duplicates = No
1479 Name = DaySchedule7:00
1480 Run = Level=Full daily at 7:00
1484 Name = CopyDiskToTapeFullBackups
1486 Schedule = DaySchedule7:00
1487 Pool = FullBackupsVirtualPool
1488 JobDefs = CopyDiskToTape
1492 The example above had 2 pool which are copied using the PoolUncopiedJobs
1493 selection criteria. Normal Full backups go to the Virtual pool and are copied
1494 to the Tape pool the next morning.
1496 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1501 +-------+------------------------------------+-----------+------------------+
1502 | JobId | Job | CopyJobId | MediaType |
1503 +-------+------------------------------------+-----------+------------------+
1504 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1505 +-------+------------------------------------+-----------+------------------+
1508 \section{ACL Updates}
1509 \index[general]{ACL Updates}
1510 The whole ACL code had been overhauled and in this version each platforms has
1511 different streams for each type of acl available on such an platform. As ACLs
1512 between platforms tend to be not that portable (most implement POSIX acls but
1513 some use an other draft or a completely different format) we currently only
1514 allow certain platform specific ACL streams to be decoded and restored on the
1515 same platform that they were created on. The old code allowed to restore ACL
1516 cross platform but the comments already mention that not being to wise. For
1517 backward compatability the new code will accept the two old ACL streams and
1518 handle those with the platform specific handler. But for all new backups it
1519 will save the ACLs using the new streams.
1521 Currently the following platforms support ACLs:
1525 \item {\bf Darwin/OSX}
1534 Currently we support the following ACL types (these ACL streams use a reserved
1535 part of the stream numbers):
1538 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1540 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1541 string representation from acl\_to\_text (POSIX acl)
1542 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1543 string representation from acl\_to\_text (POSIX acl) for default acls.
1544 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1545 string representation from acl\_to\_text (POSIX acl) for access acls.
1546 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1547 string representation from acltostr (POSIX acl)
1548 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1549 representation from acl\_to\_text (POSIX acl) for default acls.
1550 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1551 representation from acl\_to\_text (POSIX acl) for access acls.
1552 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1553 string representation from acl\_to\_text (POSIX acl) for default acls.
1554 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1555 representation from acl\_to\_text (POSIX acl) for access acls.
1556 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1557 string representation from acl\_to\_text (POSIX acl) for default acls.
1558 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1559 string representation from acl\_to\_text (POSIX acl) for default acls.
1560 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1561 representation from acl\_to\_text (POSIX acl) for access acls.
1562 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1563 string representation from acltotext or acl\_totext (POSIX acl)
1564 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1565 representation from from acl\_totext (NFSv4 or ZFS acl)
1568 In future versions we might support conversion functions from one type of acl
1569 into an other for types that are either the same or easily convertable. For now
1570 the streams are seperate and restoring them on a platform that doesn't
1571 recognize them will give you a warning.
1573 \section{Extended Attributes}
1574 \index[general]{Extended Attributes}
1575 Something that was on the project list for some time is now implemented for
1576 platforms that support a similar kind of interface. Its the support for backup
1577 and restore of so called extended attributes. As extended attributes are so
1578 platform specific these attributes are saved in seperate streams for each
1579 platform. Restores of the extended attributes can only be performed on the
1580 same platform the backup was done. There is support for all types of extended
1581 attributes, but restoring from one type of filesystem onto an other type of
1582 filesystem on the same platform may lead to supprises. As extended attributes
1583 can contain any type of data they are stored as a series of so called
1584 value-pairs. This data must be seen as mostly binary and is stored as such.
1585 As security labels from selinux are also extended attributes this option also
1586 stores those labels and no specific code is enabled for handling selinux
1589 Currently the following platforms support extended attributes:
1591 \item {\bf Darwin/OSX}
1597 On linux acls are also extended attributes, as such when you enable ACLs on a
1598 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1599 and not the same exteneded attribute.
1601 To enable the backup of extended attributes please add the following to your
1616 \section{Shared objects}
1617 \index[general]{Shared objects}
1618 A default build of Bacula will now create the libraries as shared objects
1619 (.so) rather than static libraries as was previously the case.
1620 The shared libraries are built using {\bf libtool} so it should be quite
1623 An important advantage of using shared objects is that on a machine with the
1624 Directory, File daemon, the Storage daemon, and a console, you will have only
1625 one copy of the code in memory rather than four copies. Also the total size of
1626 the binary release is smaller since the library code appears only once rather
1627 than once for every program that uses it; this results in significant reduction
1628 in the size of the binaries particularly for the utility tools.
1630 In order for the system loader to find the shared objects when loading the
1631 Bacula binaries, the Bacula shared objects must either be in a shared object
1632 directory known to the loader (typically /usr/lib) or they must be in the
1633 directory that may be specified on the {\bf ./configure} line using the {\bf
1634 {-}{-}libdir} option as:
1637 ./configure --libdir=/full-path/dir
1640 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1641 no need to modify your loader configuration provided that
1642 the shared objects are installed in that directory (Bacula
1643 does this with the make install command). The shared objects
1644 that Bacula references are:
1653 These files are symbolically linked to the real shared object file,
1654 which has a version number to permit running multiple versions of
1655 the libraries if desired (not normally the case).
1657 If you have problems with libtool or you wish to use the old
1658 way of building static libraries, or you want to build a static
1659 version of Bacula you may disable
1660 libtool on the configure command line with:
1663 ./configure --disable-libtool
1667 \section{Building Static versions of Bacula}
1668 \index[general]{Static linking}
1669 In order to build static versions of Bacula, in addition
1670 to configuration options that were needed you now must
1671 also add --disable-libtool. Example
1674 ./configure --enable-static-client-only --disable-libtool
1678 \section{Virtual Backup (Vbackup)}
1679 \index[general]{Virtual Backup}
1680 \index[general]{Vbackup}
1682 Bacula's virtual backup feature is often called Synthetic Backup or
1683 Consolidation in other backup products. It permits you to consolidate the
1684 previous Full backup plus the most recent Differential backup and any
1685 subsequent Incremental backups into a new Full backup. This new Full
1686 backup will then be considered as the most recent Full for any future
1687 Incremental or Differential backups. The VirtualFull backup is
1688 accomplished without contacting the client by reading the previous backup
1689 data and writing it to a volume in a different pool.
1691 In some respects the Vbackup feature works similar to a Migration job, in
1692 that Bacula normally reads the data from the pool specified in the
1693 Job resource, and writes it to the {\bf Next Pool} specified in the
1694 Job resource. Note, this means that usually the output from the Virtual
1695 Backup is written into a different pool from where your prior backups
1696 are saved. Doing it this way guarantees that you will not get a deadlock
1697 situation attempting to read and write to the same volume in the Storage
1698 daemon. If you then want to do subsequent backups, you may need to
1699 move the Virtual Full Volume back to your normal backup pool.
1700 Alternatively, you can set your {\bf Next Pool} to point to the current
1701 pool. This will cause Bacula to read and write to Volumes in the
1702 current pool. In general, this will work, because Bacula will
1703 not allow reading and writing on the same Volume. In any case, once
1704 a VirtualFull has been created, and a restore is done involving the
1705 most current Full, it will read the Volume or Volumes by the VirtualFull
1706 regardless of in which Pool the Volume is found.
1708 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1709 a level of {\bf VirtualFull}.
1711 A typical Job resource definition might look like the following:
1718 FileSet = "Full Set"
1725 # Default pool definition
1729 Recycle = yes # Automatically recycle Volumes
1730 AutoPrune = yes # Prune expired volumes
1731 Volume Retention = 365d # one year
1739 Recycle = yes # Automatically recycle Volumes
1740 AutoPrune = yes # Prune expired volumes
1741 Volume Retention = 365d # one year
1742 Storage = DiskChanger
1745 # Definition of file storage device
1750 Device = FileStorage
1752 Maximum Concurrent Jobs = 5
1755 # Definition of DDS Virtual tape disk storage device
1758 Address = localhost # N.B. Use a fully qualified name here
1760 Device = DiskChanger
1761 Media Type = DiskChangerMedia
1762 Maximum Concurrent Jobs = 4
1767 Then in bconsole or via a Run schedule, you would run the job as:
1770 run job=MyBackup level=Full
1771 run job=MyBackup level=Incremental
1772 run job=MyBackup level=Differential
1773 run job=MyBackup level=Incremental
1774 run job=MyBackup level=Incremental
1777 So providing there were changes between each of those jobs, you would end up
1778 with a Full backup, a Differential, which includes the first Incremental
1779 backup, then two Incremental backups. All the above jobs would be written to
1780 the {\bf Default} pool.
1782 To consolidate those backups into a new Full backup, you would run the
1786 run job=MyBackup level=VirtualFull
1789 And it would produce a new Full backup without using the client, and the output
1790 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1792 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1795 Note, the Start and End time of the Virtual Full backup is set to the
1796 values for the last job included in the Virtual Full (in the above example,
1797 it is an Increment). This is so that if another incremental is done, which
1798 will be based on the Virtual Full, it will backup all files from the
1799 last Job included in the Virtual Full rather than from the time the Virtual
1800 Full was actually run.
1804 \section{Catalog Format}
1805 \index[general]{Catalog Format}
1806 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1807 operation will convert the FileId field of the File table from 32 bits (max 4
1808 billion table entries) to 64 bits (very large number of items). The
1809 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1810 your catalog during the conversion. Also you won't be able to run jobs during
1811 this conversion period. For example, a 3 million file catalog will take 2
1812 minutes to upgrade on a normal machine. Please don't forget to make a valid
1813 backup of your database before executing the upgrade script. See the
1814 ReleaseNotes for additional details.
1816 \section{64 bit Windows Client}
1817 \index[general]{Win64 Client}
1818 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1819 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1820 As a consequence, we are also releasing a 64 bit version of the Bacula
1821 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1822 These binaries should only be installed on 64 bit Windows operating systems.
1823 What is important is not your hardware but whether or not you have
1824 a 64 bit version of the Windows OS.
1826 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1828 \item Before installing the Win64 Bacula Client, you must totally
1829 deinstall any prior 2.4.x Client installation using the
1830 Bacula deinstallation (see the menu item). You may want
1831 to save your .conf files first.
1832 \item Only the Client (File daemon) is ported to Win64, the Director
1833 and the Storage daemon are not in the 64 bit Windows installer.
1834 \item bwx-console is not yet ported.
1835 \item bconsole is ported but it has not been tested.
1836 \item The documentation is not included in the installer.
1837 \item Due to Vista security restrictions imposed on a default installation
1838 of Vista, before upgrading the Client, you must manually stop
1839 any prior version of Bacula from running, otherwise the install
1841 \item Due to Vista security restrictions imposed on a default installation
1842 of Vista, attempting to edit the conf files via the menu items
1843 will fail. You must directly edit the files with appropriate
1844 permissions. Generally double clicking on the appropriate .conf
1845 file will work providing you have sufficient permissions.
1846 \item All Bacula files are now installed in
1847 {\bf C:/Program Files/Bacula} except the main menu items,
1848 which are installed as before. This vastly simplifies the installation.
1849 \item If you are running on a foreign language version of Windows, most
1850 likely {\bf C:/Program Files} does not exist, so you should use the
1851 Custom installation and enter an appropriate location to install
1853 \item The 3.0.0 Win32 Client continues to install files in the locations used
1854 by prior versions. For the next version we will convert it to use
1855 the same installation conventions as the Win64 version.
1858 This project was funded by Bacula Systems.
1861 \section{Duplicate Job Control}
1862 \index[general]{Duplicate Jobs}
1863 The new version of Bacula provides four new directives that
1864 give additional control over what Bacula does if duplicate jobs
1865 are started. A duplicate job in the sense we use it here means
1866 a second or subsequent job with the same name starts. This
1867 happens most frequently when the first job runs longer than expected because no
1868 tapes are available.
1870 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1871 are specified in the Job resource.
1875 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1876 \index[general]{Allow Duplicate Jobs}
1877 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1878 the directive is set to {\bf no} (default) then only one job of a given name
1879 may run at one time, and the action that Bacula takes to ensure only
1880 one job runs is determined by the other directives (see below).
1882 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1883 are present and none of the three directives given below permit
1884 cancelling a job, then the current job (the second one started)
1887 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1888 \index[general]{Allow Higher Duplicates}
1889 This directive was in version 5.0.0, but does not work as
1890 expected. If used, it should always be set to no. In later versions
1891 of Bacula the directive is disabled (disregarded).
1893 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1894 \index[general]{Cancel Running Duplicates}
1895 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1896 if this directive is set to {\bf yes} any job that is already running
1897 will be canceled. The default is {\bf no}.
1899 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1900 \index[general]{Cancel Queued Duplicates}
1901 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1902 if this directive is set to {\bf yes} any job that is
1903 already queued to run but not yet running will be canceled.
1904 The default is {\bf no}.
1907 \section{TLS Authentication}
1908 \index[general]{TLS Authentication}
1909 In Bacula version 2.5.x and later, in addition to the normal Bacula
1910 CRAM-MD5 authentication that is used to authenticate each Bacula
1911 connection, you can specify that you want TLS Authentication as well,
1912 which will provide more secure authentication.
1914 This new feature uses Bacula's existing TLS code (normally used for
1915 communications encryption) to do authentication. To use it, you must
1916 specify all the TLS directives normally used to enable communications
1917 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1920 \subsection{TLS Authenticate = yes}
1922 TLS Authenticate = yes
1925 in the main daemon configuration resource (Director for the Director,
1926 Client for the File daemon, and Storage for the Storage daemon).
1928 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1929 authentication, Bacula will also do TLS authentication, then TLS
1930 encryption will be turned off, and the rest of the communication between
1931 the two Bacula daemons will be done without encryption.
1933 If you want to encrypt communications data, use the normal TLS directives
1934 but do not turn on {\bf TLS Authenticate}.
1936 \section{bextract non-portable Win32 data}
1937 \index[general]{bextract handles Win32 non-portable data}
1938 {\bf bextract} has been enhanced to be able to restore
1939 non-portable Win32 data to any OS. Previous versions were
1940 unable to restore non-portable Win32 data to machines that
1941 did not have the Win32 BackupRead and BackupWrite API calls.
1943 \section{State File updated at Job Termination}
1944 \index[general]{State File}
1945 In previous versions of Bacula, the state file, which provides a
1946 summary of previous jobs run in the {\bf status} command output was
1947 updated only when Bacula terminated, thus if the daemon crashed, the
1948 state file might not contain all the run data. This version of
1949 the Bacula daemons updates the state file on each job termination.
1951 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1952 \index[general]{MaxFullInterval}
1953 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1954 can be used to specify the maximum time interval between {\bf Full} backup
1955 jobs. When a job starts, if the time since the last Full backup is
1956 greater than the specified interval, and the job would normally be an
1957 {\bf Incremental} or {\bf Differential}, it will be automatically
1958 upgraded to a {\bf Full} backup.
1960 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1961 \index[general]{MaxDiffInterval}
1962 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1963 can be used to specify the maximum time interval between {\bf Differential} backup
1964 jobs. When a job starts, if the time since the last Differential backup is
1965 greater than the specified interval, and the job would normally be an
1966 {\bf Incremental}, it will be automatically
1967 upgraded to a {\bf Differential} backup.
1969 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1970 \index[general]{MaxDiffInterval}
1971 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1972 by the user, and when it is set it is an indication to backup programs
1973 to not backup that particular file. This version of Bacula contains a
1974 new Options directive within a FileSet resource, which instructs Bacula to
1975 obey this flag. The new directive is:
1978 Honor No Dump Flag = yes\vb{}no
1981 The default value is {\bf no}.
1984 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1985 \index[general]{IgnoreDir}
1986 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1987 can be added to the Include section of the FileSet resource. If the specified
1988 filename ({\bf filename-string}) is found on the Client in any directory to be
1989 backed up, the whole directory will be ignored (not backed up). For example:
1992 # List of files to be backed up
2000 Exclude Dir Containing = .excludeme
2005 But in /home, there may be hundreds of directories of users and some
2006 people want to indicate that they don't want to have certain
2007 directories backed up. For example, with the above FileSet, if
2008 the user or sysadmin creates a file named {\bf .excludeme} in
2009 specific directories, such as
2012 /home/user/www/cache/.excludeme
2013 /home/user/temp/.excludeme
2016 then Bacula will not backup the two directories named:
2019 /home/user/www/cache
2023 NOTE: subdirectories will not be backed up. That is, the directive
2024 applies to the two directories in question and any children (be they
2025 files, directories, etc).
2028 \section{Bacula Plugins}
2029 \index[general]{Plugin}
2030 Support for shared object plugins has been implemented in the Linux, Unix
2031 and Win32 File daemons. The API will be documented separately in
2032 the Developer's Guide or in a new document. For the moment, there is
2033 a single plugin named {\bf bpipe} that allows an external program to
2034 get control to backup and restore a file.
2036 Plugins are also planned (partially implemented) in the Director and the
2039 \subsection{Plugin Directory}
2040 \index[general]{Plugin Directory}
2041 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
2042 be added to the daemon definition resource. The directory takes a quoted
2043 string argument, which is the name of the directory in which the daemon can
2044 find the Bacula plugins. If this directive is not specified, Bacula will not
2045 load any plugins. Since each plugin has a distinctive name, all the daemons
2046 can share the same plugin directory.
2048 \subsection{Plugin Options}
2049 \index[general]{Plugin Options}
2050 The {\bf Plugin Options} directive takes a quoted string
2051 arguement (after the equal sign) and may be specified in the
2052 Job resource. The options specified will be passed to all plugins
2053 when they are run. This each plugin must know what it is looking
2054 for. The value defined in the Job resource can be modified
2055 by the user when he runs a Job via the {\bf bconsole} command line
2058 Note: this directive may be specified, and there is code to modify
2059 the string in the run command, but the plugin options are not yet passed to
2060 the plugin (i.e. not fully implemented).
2062 \subsection{Plugin Options ACL}
2063 \index[general]{Plugin Options ACL}
2064 The {\bf Plugin Options ACL} directive may be specified in the
2065 Director's Console resource. It functions as all the other ACL commands
2066 do by permitting users running restricted consoles to specify a
2067 {\bf Plugin Options} that overrides the one specified in the Job
2068 definition. Without this directive restricted consoles may not modify
2071 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
2072 \index[general]{Plugin}
2073 The {\bf Plugin} directive is specified in the Include section of
2074 a FileSet resource where you put your {\bf File = xxx} directives.
2085 Plugin = "bpipe:..."
2090 In the above example, when the File daemon is processing the directives
2091 in the Include section, it will first backup all the files in {\bf /home}
2092 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2093 the Plugin Directory. The syntax and semantics of the Plugin directive
2094 require the first part of the string up to the colon (:) to be the name
2095 of the plugin. Everything after the first colon is ignored by the File daemon but
2096 is passed to the plugin. Thus the plugin writer may define the meaning of the
2097 rest of the string as he wishes.
2099 Please see the next section for information about the {\bf bpipe} Bacula
2102 \section{The bpipe Plugin}
2103 \index[general]{The bpipe Plugin}
2104 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2105 the Bacula source distribution. When the plugin is compiled and linking into
2106 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2107 Please note that this is a very simple plugin that was written for
2108 demonstration and test purposes. It is and can be used in production, but
2109 that was never really intended.
2111 The purpose of the plugin is to provide an interface to any system program for
2112 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2113 the Include section of your Job's FileSet resource. The full syntax of the
2114 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2115 to specify the sytax as it wishes) is:
2118 Plugin = "<field1>:<field2>:<field3>:<field4>"
2123 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2124 stripped off, so in this case, we would put {\bf bpipe} in this field.
2126 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2127 pseudo path and filename under which the backup will be saved. This pseudo
2128 path and filename will be seen by the user in the restore file tree.
2129 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2130 backed up by the plugin will be put under that "pseudo" path and filename.
2131 You must be careful to choose a naming convention that is unique to avoid
2132 a conflict with a path and filename that actually exists on your system.
2134 \item {\bf field3} for the {\bf bpipe} plugin
2135 specifies the "reader" program that is called by the plugin during
2136 backup to read the data. {\bf bpipe} will call this program by doing a
2139 \item {\bf field4} for the {\bf bpipe} plugin
2140 specifies the "writer" program that is called by the plugin during
2141 restore to write the data back to the filesystem.
2144 Please note that for two items above describing the "reader" and "writer"
2145 fields, these programs are "executed" by Bacula, which
2146 means there is no shell interpretation of any command line arguments
2147 you might use. If you want to use shell characters (redirection of input
2148 or output, ...), then we recommend that you put your command or commands
2149 in a shell script and execute the script. In addition if you backup a
2150 file with the reader program, when running the writer program during
2151 the restore, Bacula will not automatically create the path to the file.
2152 Either the path must exist, or you must explicitly do so with your command
2153 or in a shell script.
2155 Putting it all together, the full plugin directive line might look
2159 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
2160 --opt --databases bacula:mysql"
2163 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2164 would be written on a single line.
2166 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2167 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
2168 program {\bf mysqldump -f --opt --database bacula} to read the data during
2169 backup. The mysqldump command outputs all the data for the database named
2170 {\bf bacula}, which will be read by the plugin and stored in the backup.
2171 During restore, the data that was backed up will be sent to the program
2172 specified in the last field, which in this case is {\bf mysql}. When
2173 {\bf mysql} is called, it will read the data sent to it by the plugn
2174 then write it back to the same database from which it came ({\bf bacula}
2177 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2178 the data from a specified program to Bacula for backup, and then from Bacula to
2179 a specified program for restore.
2181 By using different command lines to {\bf bpipe},
2182 you can backup any kind of data (ASCII or binary) depending
2183 on the program called.
2185 \section{Microsoft Exchange Server 2003/2007 Plugin}
2186 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
2187 \subsection{Background}
2188 The Exchange plugin was made possible by a funded development project
2189 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2190 The code for the plugin was written by James Harper, and the Bacula core
2191 code by Kern Sibbald. All the code for this funded development has become
2192 part of the Bacula project. Thanks to everyone who made it happen.
2194 \subsection{Concepts}
2195 Although it is possible to backup Exchange using Bacula VSS the Exchange
2196 plugin adds a good deal of functionality, because while Bacula VSS
2197 completes a full backup (snapshot) of Exchange, it does
2198 not support Incremental or Differential backups, restoring is more
2199 complicated, and a single database restore is not possible.
2201 Microsoft Exchange organises its storage into Storage Groups with
2202 Databases inside them. A default installation of Exchange will have a
2203 single Storage Group called 'First Storage Group', with two Databases
2204 inside it, "Mailbox Store (SERVER NAME)" and
2205 "Public Folder Store (SERVER NAME)",
2206 which hold user email and public folders respectively.
2208 In the default configuration, Exchange logs everything that happens to
2209 log files, such that if you have a backup, and all the log files since,
2210 you can restore to the present time. Each Storage Group has its own set
2211 of log files and operates independently of any other Storage Groups. At
2212 the Storage Group level, the logging can be turned off by enabling a
2213 function called "Enable circular logging". At this time the Exchange
2214 plugin will not function if this option is enabled.
2216 The plugin allows backing up of entire storage groups, and the restoring
2217 of entire storage groups or individual databases. Backing up and
2218 restoring at the individual mailbox or email item is not supported but
2219 can be simulated by use of the "Recovery" Storage Group (see below).
2221 \subsection{Installing}
2222 The Exchange plugin requires a DLL that is shipped with Microsoft
2223 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2224 correctly the Exchange plugin should find this automatically and run
2225 without any additional installation.
2227 If the DLL can not be found automatically it will need to be copied into
2228 the Bacula installation
2229 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
2230 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
2231 default Exchange installation.
2233 \subsection{Backing Up}
2234 To back up an Exchange server the Fileset definition must contain at
2235 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2236 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2237 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2238 up files are prefixed with something that isn't going to share a name
2239 with something outside the plugin, and the 'Microsoft Information Store'
2240 bit is required also. It is also possible to add the name of a storage
2241 group to the "Plugin =" line, eg \\
2242 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2243 if you want only a single storage group backed up.
2245 Additionally, you can suffix the 'Plugin =' directive with
2246 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2247 database at the end of a full backup.
2249 An Incremental or Differential backup will backup only the database logs
2250 for each Storage Group by inspecting the "modified date" on each
2251 physical log file. Because of the way the Exchange API works, the last
2252 logfile backed up on each backup will always be backed up by the next
2253 Incremental or Differential backup too. This adds 5MB to each
2254 Incremental or Differential backup size but otherwise does not cause any
2257 By default, a normal VSS fileset containing all the drive letters will
2258 also back up the Exchange databases using VSS. This will interfere with
2259 the plugin and Exchange's shared ideas of when the last full backup was
2260 done, and may also truncate log files incorrectly. It is important,
2261 therefore, that the Exchange database files be excluded from the backup,
2262 although the folders the files are in should be included, or they will
2263 have to be recreated manually if a baremetal restore is done.
2268 File = C:/Program Files/Exchsrvr/mdbdata
2269 Plugin = "exchange:..."
2272 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2273 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2274 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2275 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2276 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2277 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2278 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2283 The advantage of excluding the above files is that you can significantly
2284 reduce the size of your backup since all the important Exchange files
2285 will be properly saved by the Plugin.
2288 \subsection{Restoring}
2289 The restore operation is much the same as a normal Bacula restore, with
2290 the following provisos:
2293 \item The {\bf Where} restore option must not be specified
2294 \item Each Database directory must be marked as a whole. You cannot just
2295 select (say) the .edb file and not the others.
2296 \item If a Storage Group is restored, the directory of the Storage Group
2298 \item It is possible to restore only a subset of the available log files,
2299 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2300 if a log file is missing from the sequence of log files
2301 \item Each database to be restored must be dismounted and marked as "Can be
2302 overwritten by restore"
2303 \item If an entire Storage Group is to be restored (eg all databases and
2304 logs in the Storage Group), then it is best to manually delete the
2305 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
2306 as Exchange can get confused by stray log files lying around.
2309 \subsection{Restoring to the Recovery Storage Group}
2310 The concept of the Recovery Storage Group is well documented by
2312 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2313 but to briefly summarize...
2315 Microsoft Exchange allows the creation of an additional Storage Group
2316 called the Recovery Storage Group, which is used to restore an older
2317 copy of a database (e.g. before a mailbox was deleted) into without
2318 messing with the current live data. This is required as the Standard and
2319 Small Business Server versions of Exchange can not ordinarily have more
2320 than one Storage Group.
2322 To create the Recovery Storage Group, drill down to the Server in Exchange
2323 System Manager, right click, and select
2324 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
2325 locations and click OK. On the Recovery Storage Group, right click and
2326 select {\bf "Add Database to Recover..."} and select the database you will
2329 Restore only the single database nominated as the database in the
2330 Recovery Storage Group. Exchange will redirect the restore to the
2331 Recovery Storage Group automatically.
2332 Then run the restore.
2334 \subsection{Restoring on Microsoft Server 2007}
2335 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2336 2007, and henc you use a new proceedure for recovering a single mail box.
2337 This procedure is ducomented by Microsoft at:
2338 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2339 and involves using the {\bf Restore-Mailbox} and {\bf
2340 Get-MailboxStatistics} shell commands.
2342 \subsection{Caveats}
2343 This plugin is still being developed, so you should consider it
2344 currently in BETA test, and thus use in a production environment
2345 should be done only after very careful testing.
2347 When doing a full backup, the Exchange database logs are truncated by
2348 Exchange as soon as the plugin has completed the backup. If the data
2349 never makes it to the backup medium (eg because of spooling) then the
2350 logs will still be truncated, but they will also not have been backed
2351 up. A solution to this is being worked on. You will have to schedule a
2352 new Full backup to ensure that your next backups will be usable.
2354 The "Enable Circular Logging" option cannot be enabled or the plugin
2357 Exchange insists that a successful Full backup must have taken place if
2358 an Incremental or Differential backup is desired, and the plugin will
2359 fail if this is not the case. If a restore is done, Exchange will
2360 require that a Full backup be done before an Incremental or Differential
2363 The plugin will most likely not work well if another backup application
2364 (eg NTBACKUP) is backing up the Exchange database, especially if the
2365 other backup application is truncating the log files.
2367 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2368 we recommend either carefully testing or that you avoid this option for
2371 The Exchange plugin is not called during processing the bconsole {\bf
2372 estimate} command, and so anything that would be backed up by the plugin
2373 will not be added to the estimate total that is displayed.
2376 \section{libdbi Framework}
2377 \index[general]{libdbi Framework}
2378 As a general guideline, Bacula has support for a few catalog database drivers
2379 (MySQL, PostgreSQL, SQLite)
2380 coded natively by the Bacula team. With the libdbi implementation, which is a
2381 Bacula driver that uses libdbi to access the catalog, we have an open field to
2382 use many different kinds database engines following the needs of users.
2384 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
2385 implements a database-independent abstraction layer in C, similar to the
2386 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2387 leverage the power of multiple databases and multiple simultaneous database
2388 connections by using this framework.
2390 Currently the libdbi driver in Bacula project only supports the same drivers
2391 natively coded in Bacula. However the libdbi project has support for many
2392 others database engines. You can view the list at
2393 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2394 supported by Bacula, however, they must be tested properly by the Bacula team.
2396 Some of benefits of using libdbi are:
2398 \item The possibility to use proprietary databases engines in which your
2399 proprietary licenses prevent the Bacula team from developing the driver.
2400 \item The possibility to use the drivers written for the libdbi project.
2401 \item The possibility to use other database engines without recompiling Bacula
2402 to use them. Just change one line in bacula-dir.conf
2403 \item Abstract Database access, this is, unique point to code and profiling
2404 catalog database access.
2407 The following drivers have been tested:
2409 \item PostgreSQL, with and without batch insert
2410 \item Mysql, with and without batch insert
2415 In the future, we will test and approve to use others databases engines
2416 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2418 To compile Bacula to support libdbi we need to configure the code with the
2419 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2420 [database] is the database engine to be used with Bacula (of course we can
2421 change the driver in file bacula-dir.conf, see below). We must configure the
2422 access port of the database engine with the option --with-db-port, because the
2423 libdbi framework doesn't know the default access port of each database.
2425 The next phase is checking (or configuring) the bacula-dir.conf, example:
2429 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2430 dbname = regress; user = regress; password = ""
2434 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2435 mysql database. Currently the drivers supported by Bacula are: postgresql,
2436 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2438 The following limitations apply when Bacula is set to use the libdbi framework:
2439 - Not tested on the Win32 platform
2440 - A little performance is lost if comparing with native database driver.
2441 The reason is bound with the database driver provided by libdbi and the
2442 simple fact that one more layer of code was added.
2444 It is important to remember, when compiling Bacula with libdbi, the
2445 following packages are needed:
2447 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2448 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2451 You can download them and compile them on your system or install the packages
2452 from your OS distribution.
2454 \section{Console Command Additions and Enhancements}
2455 \index[general]{Console Additions}
2457 \subsection{Display Autochanger Content}
2458 \index[general]{StatusSlots}
2460 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2461 autochanger content.
2465 Slot | Volume Name | Status | Media Type | Pool |
2466 ------+---------------+----------+-------------------+------------|
2467 1 | 00001 | Append | DiskChangerMedia | Default |
2468 2 | 00002 | Append | DiskChangerMedia | Default |
2469 3*| 00003 | Append | DiskChangerMedia | Scratch |
2474 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2475 {\bf update slots} command to synchronize autochanger content with your
2478 \subsection{list joblog job=xxx or jobid=nnn}
2479 \index[general]{list joblog}
2480 A new list command has been added that allows you to list the contents
2481 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2482 or for a particular JobId. The {\bf llist} command will include a line with
2483 the time and date of the entry.
2485 Note for the catalog to have Job Log entries, you must have a directive
2492 In your Director's {\bf Messages} resource.
2494 \subsection{Use separator for multiple commands}
2495 \index[general]{Command Separator}
2496 When using bconsole with readline, you can set the command separator with
2497 \textbf{@separator} command to one
2498 of those characters to write commands who require multiple input in one line.
2500 !$%&'()*+,-/:;<>?[]^`{|}~
2503 \subsection{Deleting Volumes}
2504 The delete volume bconsole command has been modified to
2505 require an asterisk (*) in front of a MediaId otherwise the
2506 value you enter is a taken to be a Volume name. This is so that
2507 users may delete numeric Volume names. The previous Bacula versions
2508 assumed that all input that started with a number was a MediaId.
2510 This new behavior is indicated in the prompt if you read it
2513 \section{Bare Metal Recovery}
2514 The old bare metal recovery project is essentially dead. One
2515 of the main features of it was that it would build a recovery
2516 CD based on the kernel on your system. The problem was that
2517 every distribution has a different boot procedure and different
2518 scripts, and worse yet, the boot procedures and scripts change
2519 from one distribution to another. This meant that maintaining
2520 (keeping up with the changes) the rescue CD was too much work.
2522 To replace it, a new bare metal recovery USB boot stick has been developed
2523 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2524 boot from a USB key.
2528 \item Recovery can be done from within graphical environment.
2529 \item Recovery can be done in a shell.
2530 \item Ubuntu boots on a large number of Linux systems.
2531 \item The process of updating the system and adding new
2532 packages is not too difficult.
2533 \item The USB key can easily be upgraded to newer Ubuntu versions.
2534 \item The USB key has writable partitions for modifications to
2535 the OS and for modification to your home directory.
2536 \item You can add new files/directories to the USB key very easily.
2537 \item You can save the environment from multiple machines on
2539 \item Bacula Systems is funding its ongoing development.
2542 The disadvantages are:
2544 \item The USB key is usable but currently under development.
2545 \item Not everyone may be familiar with Ubuntu (no worse
2547 \item Some older OSes cannot be booted from USB. This can
2548 be resolved by first booting a Ubuntu LiveCD then plugging
2550 \item Currently the documentation is sketchy and not yet added
2551 to the main manual. See below ...
2554 The documentation and the code can be found in the {\bf rescue} package
2555 in the directory {\bf linux/usb}.
2557 \section{Miscellaneous}
2558 \index[general]{Misc New Features}
2560 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2561 \index[general]{Allow Mixed Priority}
2562 This directive is only implemented in version 2.5 and later. When
2563 set to {\bf yes} (default {\bf no}), this job may run even if lower
2564 priority jobs are already running. This means a high priority job
2565 will not have to wait for other jobs to finish before starting.
2566 The scheduler will only mix priorities when all running jobs have
2569 Note that only higher priority jobs will start early. Suppose the
2570 director will allow two concurrent jobs, and that two jobs with
2571 priority 10 are running, with two more in the queue. If a job with
2572 priority 5 is added to the queue, it will be run as soon as one of
2573 the running jobs finishes. However, new priority 10 jobs will not
2574 be run until the priority 5 job has finished.
2576 \subsection{Bootstrap File Directive -- FileRegex}
2577 \index[general]{Bootstrap File Directive}
2578 {\bf FileRegex} is a new command that can be added to the bootstrap
2579 (.bsr) file. The value is a regular expression. When specified, only
2580 matching filenames will be restored.
2582 During a restore, if all File records are pruned from the catalog
2583 for a Job, normally Bacula can restore only all files saved. That
2584 is there is no way using the catalog to select individual files.
2585 With this new feature, Bacula will ask if you want to specify a Regex
2586 expression for extracting only a part of the full backup.
2589 Building directory tree for JobId(s) 1,3 ...
2590 There were no files inserted into the tree, so file selection
2591 is not possible.Most likely your retention policy pruned the files
2593 Do you want to restore all the files? (yes\vb{}no): no
2595 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2596 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2599 \subsection{Bootstrap File Optimization Changes}
2600 In order to permit proper seeking on disk files, we have extended the bootstrap
2601 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2602 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2603 address range and end address range respectively. These two directives replace
2604 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2605 VolEndBlock} directives. Bootstrap files containing the old directives will
2606 still work, but will not properly take advantage of proper disk seeking, and
2607 may read completely to the end of a disk volume during a restore. With the new
2608 format (automatically generated by the new Director), restores will seek
2609 properly and stop reading the volume when all the files have been restored.
2611 \subsection{Solaris ZFS/NFSv4 ACLs}
2612 This is an upgrade of the previous Solaris ACL backup code
2613 to the new library format, which will backup both the old
2614 POSIX(UFS) ACLs as well as the ZFS ACLs.
2616 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2617 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2618 be used to transfer from UFS to ZFS filesystems.
2621 \subsection{Virtual Tape Emulation}
2622 \index[general]{Virtual Tape Emulation}
2623 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2624 the tape code but actually reading and writing to a disk file. Used with the
2625 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2626 and 700 slots. This feature is most useful in testing. It is enabled
2627 by using {\bf Device Type = vtape} in the Storage daemon's Device
2628 directive. This feature is only implemented on Linux machines and should not be
2629 used for production.
2631 \subsection{Bat Enhancements}
2632 \index[general]{Bat Enhancements}
2633 Bat (the Bacula Administration Tool) GUI program has been significantly
2634 enhanced and stabilized. In particular, there are new table based status
2635 commands; it can now be easily localized using Qt4 Linguist.
2637 The Bat communications protocol has been significantly enhanced to improve
2638 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2639 the Director you are using otherwise the communications protocol will not
2642 \subsection{RunScript Enhancements}
2643 \index[general]{RunScript Enhancements}
2644 The {\bf RunScript} resource has been enhanced to permit multiple
2645 commands per RunScript. Simply specify multiple {\bf Command} directives
2652 Command = "/bin/echo test"
2653 Command = "/bin/echo an other test"
2654 Command = "/bin/echo 3 commands in the same runscript"
2661 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2662 implemented, which runs the command after the Volume Shadow Copy has been made.
2664 Console commands can be specified within a RunScript by using:
2665 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2666 carefully tested and debugged and is known to easily crash the Director.
2667 We would appreciate feedback. Due to the recursive nature of this command, we
2668 may remove it before the final release.
2670 \subsection{Status Enhancements}
2671 \index[general]{Status Enhancements}
2672 The bconsole {\bf status dir} output has been enhanced to indicate
2673 Storage daemon job spooling and despooling activity.
2675 \subsection{Connect Timeout}
2676 \index[general]{Connect Timeout}
2677 The default connect timeout to the File
2678 daemon has been set to 3 minutes. Previously it was 30 minutes.
2680 \subsection{ftruncate for NFS Volumes}
2681 \index[general]{ftruncate for NFS Volumes}
2682 If you write to a Volume mounted by NFS (say on a local file server),
2683 in previous Bacula versions, when the Volume was recycled, it was not
2684 properly truncated because NFS does not implement ftruncate (file
2685 truncate). This is now corrected in the new version because we have
2686 written code (actually a kind user) that deletes and recreates the Volume,
2687 thus accomplishing the same thing as a truncate.
2689 \subsection{Support for Ubuntu}
2690 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2691 version of Linux, and thus now provides correct autostart routines.
2692 Since Ubuntu officially supports Bacula, you can also obtain any
2693 recent release of Bacula from the Ubuntu repositories.
2695 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2696 \index[general]{Recycle Pool}
2697 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2698 be placed (moved) when it is recycled. Without this directive, a Volume will
2699 remain in the same pool when it is recycled. With this directive, it can be
2700 moved automatically to any existing pool during a recycle. This directive is
2701 probably most useful when defined in the Scratch pool, so that volumes will
2702 be recycled back into the Scratch pool.
2704 \subsection{FD Version}
2705 \index[general]{FD Version}
2706 The File daemon to Director protocol now includes a version
2707 number, which although there is no visible change for users,
2708 will help us in future versions automatically determine
2709 if a File daemon is not compatible.
2711 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2712 \index[general]{Max Run Sched Time}
2713 The time specifies the maximum allowed time that a job may run, counted from
2714 when the job was scheduled. This can be useful to prevent jobs from running
2715 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2718 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2719 \index[general]{Max Wait Time}
2720 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2721 of checking the maximum allowed time that a job may block for a resource,
2722 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2723 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2724 their job depending on the level. Now, they have to use
2725 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2726 directives are now deprecated.
2728 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2729 \index[general]{Incremental Max Wait Time}
2730 \index[general]{Differential Max Wait Time}
2732 These directives have been deprecated in favor of
2733 \texttt{Incremental|Differential Max Run Time}.
2735 \subsection{Max Run Time directives}
2736 \index[general]{Max Run Time directives}
2737 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2738 maximum allowed time that a job can run depending on the level.
2740 \addcontentsline{lof}{figure}{Job time control directives}
2741 \includegraphics{\idir different_time.eps}
2743 \subsection{Statistics Enhancements}
2744 \index[general]{Statistics Enhancements}
2745 If you (or probably your boss) want to have statistics on your backups to
2746 provide some \textit{Service Level Agreement} indicators, you could use a few
2747 SQL queries on the Job table to report how many:
2751 \item jobs have been successful
2752 \item files have been backed up
2756 However, these statistics are accurate only if your job retention is greater
2757 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2758 be able to use them.
2760 Now, you can use the \textbf{update stats [days=num]} console command to fill
2761 the JobHistory table with new Job records. If you want to be sure to take in
2762 account only \textbf{good jobs}, ie if one of your important job has failed but
2763 you have fixed the problem and restarted it on time, you probably want to
2764 delete the first \textit{bad} job record and keep only the successful one. For
2765 that simply let your staff do the job, and update JobHistory table after two or
2766 three days depending on your organization using the \textbf{[days=num]} option.
2768 These statistics records aren't used for restoring, but mainly for
2769 capacity planning, billings, etc.
2771 The Bweb interface provides a statistics module that can use this feature. You
2772 can also use tools like Talend or extract information by yourself.
2774 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2775 the length of time that Bacula will keep statistics job records in the Catalog
2776 database after the Job End time. (In \texttt{JobHistory} table) When this time
2777 period expires, and if user runs \texttt{prune stats} command, Bacula will
2778 prune (remove) Job records that are older than the specified period.
2780 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2781 job to maintain statistics.
2784 Name = BackupCatalog
2787 Console = "update stats days=3"
2788 Console = "prune stats yes"
2795 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2796 \index[general]{ScratchPool}
2797 This directive permits to specify a specific \textsl{Scratch} pool for the
2798 current pool. This is useful when using multiple storage sharing the same
2799 mediatype or when you want to dedicate volumes to a particular set of pool.
2801 \subsection{Enhanced Attribute Despooling}
2802 \index[general]{Attribute Despooling}
2803 If the storage daemon and the Director are on the same machine, the spool file
2804 that contains attributes is read directly by the Director instead of being
2805 transmitted across the network. That should reduce load and speedup insertion.
2807 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2808 \index[general]{SpoolSize}
2809 A new Job directive permits to specify the spool size per job. This is used
2810 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2812 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2813 \index[general]{MaximumConsoleConnections}
2814 A new director directive permits to specify the maximum number of Console
2815 Connections that could run concurrently. The default is set to 20, but you may
2816 set it to a larger number.
2818 \subsection{VerId = \lt{}string\gt{}}
2819 \index[general]{VerId}
2820 A new director directive permits to specify a personnal identifier that will be
2821 displayed in the \texttt{version} command.
2823 \subsection{dbcheck enhancements}
2824 \index[general]{dbcheck enhancements}
2825 If you are using Mysql, dbcheck will now ask you if you want to create
2826 temporary indexes to speed up orphaned Path and Filename elimination.
2828 A new \texttt{-B} option allows you to print catalog information in a simple
2829 text based format. This is useful to backup it in a secure way.
2844 You can now specify the database connection port in the command line.
2846 \subsection{{-}{-}docdir configure option}
2847 \index[general]{{-}{-}docdir configure option}
2848 You can use {-}{-}docdir= on the ./configure command to
2849 specify the directory where you want Bacula to install the
2850 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2851 {\bf /usr/share/doc/bacula}.
2853 \subsection{{-}{-}htmldir configure option}
2854 \index[general]{{-}{-}htmldir configure option}
2855 You can use {-}{-}htmldir= on the ./configure command to
2856 specify the directory where you want Bacula to install the bat html help
2857 files. The default is {\bf /usr/share/doc/bacula/html}
2859 \subsection{{-}{-}with-plugindir configure option}
2860 \index[general]{{-}{-}plugindir configure option}
2861 You can use {-}{-}plugindir= on the ./configure command to
2862 specify the directory where you want Bacula to install
2863 the plugins (currently only bpipe-fd). The default is