1 \chapter{New Features in 5.2.2}
2 This chapter presents the new features that have been added to the next
3 Community version of Bacula that is not yet released.
5 \section{Additions to RunScript variables}
6 You can have access to Director name using \%D in your runscript
10 RunAfterJob = "/bin/echo Director=%D
13 \chapter{New Features in 5.2.1}
14 This chapter presents the new features that have been added to the current
15 Community version of Bacula that is now released.
17 There are additional features (plugins) available in the Enterprise version
18 that are described in another chapter. A subscription to Bacula Systems
19 is required for the Enterprise version.
21 \section{LZO Compression}
23 LZO compression was added in the Unix File Daemon. From the user point of view,
24 it works like the GZIP compression (just replace {\bf compression=GZIP} with
25 {\bf compression=LZO}).
30 Options { compression=LZO }
36 LZO provides much faster compression and decompression speed but lower
37 compression ratio than GZIP. It is a good option when you backup to disk. For
38 tape, the built-in compression may be a better option.
40 LZO is a good altenative for GZIP1 when you don't want to slow down your
41 backup. On a modern CPU it should be able to run almost as fast as:
44 \item your client can read data from disk. Unless you have very fast disks like
45 SSD or large/fast RAID array.
46 \item the data transfers between the file daemon and the storage daemon even on
50 Note that bacula only use one compression level LZO1X-1.
53 The code for this feature was contributed by Laurent Papier.
55 \section{New Tray Monitor}
57 Since the old integrated Windows tray monitor doesn't work with
58 recent Windows versions, we have written a new Qt Tray Monitor that is available
59 for both Linux and Windows. In addition to all the previous features,
60 this new version allows you to run Backups from
61 the tray monitor menu.
65 \includegraphics[width=10cm]{\idir tray-monitor}
66 \label{fig:traymonitor}
67 \caption{New tray monitor}
72 \includegraphics[width=10cm]{\idir tray-monitor1}
73 \label{fig:traymonitor1}
74 \caption{Run a Job through the new tray monitor}
78 To be able to run a job from the tray monitor, you need to
79 allow specific commands in the Director monitor console:
84 CommandACL = status, .clients, .jobs, .pools, .storage, .filesets, .messages, run
85 ClientACL = *all* # you can restrict to a specific host
97 This project was funded by Bacula Systems and is available with Bacula
98 the Enterprise Edition and the Community Edition.
100 \section{Purge Migration Job}
102 The new {\bf Purge Migration Job} directive may be added to the Migration
103 Job definition in the Director's configuration file. When it is enabled
104 the Job that was migrated during a migration will be purged at
105 the end of the migration job.
113 Client = localhost-fd
116 Storage = DiskChanger
119 Selection Pattern = ".*Save"
121 Purge Migration Job = yes
127 This project was submited by Dunlap Blake; testing and documentation was funded
130 \section{Changes in Bvfs (Bacula Virtual FileSystem)}
132 Bat has now a bRestore panel that uses Bvfs to display files and
137 \includegraphics[width=12cm]{\idir bat-brestore}
138 \label{fig:batbrestore}
139 \caption{Bat Brestore Panel}
142 \texttt{Important}, the Bvfs module does not yet work correctly with BaseJobs,
143 Copy and Migration jobs.
146 This project was funded by Bacula Systems.
148 \subsection*{General notes}
151 \item All fields are separated by a tab
152 \item You can specify \texttt{limit=} and \texttt{offset=} to list smoothly
153 records in very big directories
154 \item All operations (except cache creation) are designed to run instantly
155 \item At this time, Bvfs works faster on PostgreSQL than MySQL catalog. If you
156 can contribute new faster SQL queries we will be happy, else don't complain
158 \item The cache creation is dependent of the number of directories. As Bvfs
159 shares information accross jobs, the first creation can be slow
160 \item All fields are separated by a tab
161 \item Due to potential encoding problem, it's advised to allways use pathid in
165 \subsection*{Get dependent jobs from a given JobId}
167 Bvfs allows you to query the catalog against any combination of jobs. You
168 can combine all Jobs and all FileSet for a Client in a single session.
170 To get all JobId needed to restore a particular job, you can use the
171 \texttt{.bvfs\_get\_jobids} command.
174 .bvfs_get_jobids jobid=num [all]
178 .bvfs_get_jobids jobid=10
180 .bvfs_get_jobids jobid=10 all
184 In this example, a normal restore will need to use JobIds 1,2,5,10 to
185 compute a complete restore of the system.
187 With the \texttt{all} option, the Director will use all defined FileSet for
190 \subsection*{Generating Bvfs cache}
192 The \texttt{.bvfs\_update} command computes the directory cache for jobs
193 specified in argument, or for all jobs if unspecified.
196 .bvfs_update [jobid=numlist]
201 .bvfs_update jobid=1,2,3
204 You can run the cache update process in a RunScript after the catalog backup.
206 \subsection*{Get all versions of a specific file}
208 Bvfs allows you to find all versions of a specific file for a given Client with
209 the \texttt{.bvfs\_version} command. To avoid problems with encoding, this
210 function uses only PathId and FilenameId. The jobid argument is mandatory but
214 .bvfs_versions client=filedaemon pathid=num filenameid=num jobid=1
215 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
216 PathId FilenameId FileId JobId LStat Md5 VolName Inchanger
223 .bvfs_versions client=localhost-fd pathid=1 fnid=47 jobid=1
224 1 47 52 12 gD HRid IGk D Po Po A P BAA I A /uPgWaxMgKZlnMti7LChyA Vol1 1
227 \subsection*{List directories}
229 Bvfs allows you to list directories in a specific path.
231 .bvfs_lsdirs pathid=num path=/apath jobid=numlist limit=num offset=num
232 PathId FilenameId FileId JobId LStat Path
233 PathId FilenameId FileId JobId LStat Path
234 PathId FilenameId FileId JobId LStat Path
238 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
239 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record
240 listed is a directory.
243 .bvfs_lsdirs pathid=4 jobid=1,11,12
244 4 0 0 0 A A A A A A A A A A A A A A .
245 5 0 0 0 A A A A A A A A A A A A A A ..
246 3 0 0 0 A A A A A A A A A A A A A A regress/
249 In this example, to list directories present in \texttt{regress/}, you can use
251 .bvfs_lsdirs pathid=3 jobid=1,11,12
252 3 0 0 0 A A A A A A A A A A A A A A .
253 4 0 0 0 A A A A A A A A A A A A A A ..
254 2 0 0 0 A A A A A A A A A A A A A A tmp/
257 \subsection*{List files}
259 Bvfs allows you to list files in a specific path.
261 .bvfs_lsfiles pathid=num path=/apath jobid=numlist limit=num offset=num
262 PathId FilenameId FileId JobId LStat Path
263 PathId FilenameId FileId JobId LStat Path
264 PathId FilenameId FileId JobId LStat Path
268 You need to \texttt{pathid} or \texttt{path}. Using \texttt{path=""} will list
269 ``/'' on Unix and all drives on Windows. If FilenameId is 0, the record listed
273 .bvfs_lsfiles pathid=4 jobid=1,11,12
274 4 0 0 0 A A A A A A A A A A A A A A .
275 5 0 0 0 A A A A A A A A A A A A A A ..
276 1 0 0 0 A A A A A A A A A A A A A A regress/
279 In this example, to list files present in \texttt{regress/}, you can use
281 .bvfs_lsfiles pathid=1 jobid=1,11,12
282 1 47 52 12 gD HRid IGk BAA I BMqcPH BMqcPE BMqe+t A titi
283 1 49 53 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B toto
284 1 48 54 12 gD HRie IGk BAA I BMqcPH BMqcPE BMqe+3 A tutu
285 1 45 55 12 gD HRid IGk BAA I BMqe/K BMqcPE BMqe+t B ficheriro1.txt
286 1 46 56 12 gD HRie IGk BAA I BMqe/K BMqcPE BMqe+3 D ficheriro2.txt
289 \subsection*{Restore set of files}
291 Bvfs allows you to create a SQL table that contains files that you want to
292 restore. This table can be provided to a restore command with the file option.
295 .bvfs_restore fileid=numlist dirid=numlist hardlink=numlist path=b2num
297 restore file=?b2num ...
300 To include a directory (with \texttt{dirid}), Bvfs needs to run a query to
301 select all files. This query could be time consuming.
303 \texttt{hardlink} list is always composed of a serie of two numbers (jobid,
304 fileindex). This information can be found in the LinkFI field of the LStat
307 The \texttt{path} argument represents the name of the table that Bvfs will
308 store results. The format of this table is \texttt{b2[0-9]+}. (Should start by
309 b2 and followed by digits).
314 .bvfs_restore fileid=1,2,3,4 hardlink=10,15,10,20 jobid=10 path=b20001
318 \subsection*{Cleanup after Restore}
320 To drop the table used by the restore command, you can use the
321 \texttt{.bvfs\_cleanup} command.
324 .bvfs_cleanup path=b20001
327 \section{Changes in the Pruning Algorithm}
329 We rewrote the job pruning algorithm in this version. Previously, in some users
330 reported that the pruning process at the end of jobs was very long. It should
331 not be longer the case. Now, Bacula won't prune automatically a Job if this
332 particular Job is needed to restore data. Example:
336 JobId: 2 Level: Incremental
337 JobId: 3 Level: Incremental
338 JobId: 4 Level: Differential
339 .. Other incrementals up to now
342 In this example, if the Job Retention defined in the Pool or in the Client
343 resource causes that Jobs with Jobid in 1,2,3,4 can be pruned, Bacula will
344 detect that JobId 1 and 4 are essential to restore data at the current state
345 and will prune only JobId 2 and 3.
347 \texttt{Important}, this change affect only the automatic pruning step after a
348 Job and the \texttt{prune jobs} Bconsole command. If a volume expires after the
349 \texttt{VolumeRetention} period, important jobs can be pruned.
351 \section{Ability to Verify any specified Job}
352 You now have the ability to tell Bacula which Job should verify instead of
353 automatically verify just the last one.
355 This feature can be used with VolumeToCatalog, DiskToCatalog and Catalog level.
357 To verify a given job, just specify the Job jobid in argument when starting the
360 *run job=VerifyVolume jobid=1 level=VolumeToCatalog
362 JobName: VerifyVolume
363 Level: VolumeToCatalog
366 Pool: Default (From Job resource)
367 Storage: File (From Job resource)
368 Verify Job: VerifyVol.2010-09-08_14.17.17_03
369 Verify List: /tmp/regress/working/VerifyVol.bsr
370 When: 2010-09-08 14:17:31
372 OK to run? (yes/mod/no):
376 This project was funded by Bacula Systems and is available with Bacula
377 Enterprise Edition and Community Edition.
379 \section{Additions to RunScript variables}
380 You can have access to JobBytes and JobFiles using \%b and \%F in your runscript
381 command. The Client address is now available through \%h.
384 RunAfterJob = "/bin/echo Job=%j JobBytes=%b JobFiles=%F ClientAddress=%h"
387 %\section{Changes in drivetype.exe}
389 %Now the \texttt{drivetype.exe} program allows you to list all local hard
390 %drives. It can help to build dynamic FileSet on Windows.
393 %File = "\\|\"c:/program files/bacula/bin32/drivetype\" -l -a"
397 \section{Additions to the Plugin API}
398 The bfuncs structure has been extended to include a number of
402 The bFuncs structure defines the callback entry points within Bacula
403 that the plugin can use register events, get Bacula values, set
404 Bacula values, and send messages to the Job output or debug output.
406 The exact definition as of this writing is:
408 typedef struct s_baculaFuncs {
411 bRC (*registerBaculaEvents)(bpContext *ctx, ...);
412 bRC (*getBaculaValue)(bpContext *ctx, bVariable var, void *value);
413 bRC (*setBaculaValue)(bpContext *ctx, bVariable var, void *value);
414 bRC (*JobMessage)(bpContext *ctx, const char *file, int line,
415 int type, utime_t mtime, const char *fmt, ...);
416 bRC (*DebugMessage)(bpContext *ctx, const char *file, int line,
417 int level, const char *fmt, ...);
418 void *(*baculaMalloc)(bpContext *ctx, const char *file, int line,
420 void (*baculaFree)(bpContext *ctx, const char *file, int line, void *mem);
422 /* New functions follow */
423 bRC (*AddExclude)(bpContext *ctx, const char *file);
424 bRC (*AddInclude)(bpContext *ctx, const char *file);
425 bRC (*AddIncludeOptions)(bpContext *ctx, const char *opts);
426 bRC (*AddRegex)(bpContext *ctx, const char *item, int type);
427 bRC (*AddWild)(bpContext *ctx, const char *item, int type);
428 bRC (*checkChanges)(bpContext *ctx, struct save_pkt *sp);
434 \item [AddExclude] can be called to exclude a file. The file
435 string passed may include wildcards that will be interpreted by
436 the {\bf fnmatch} subroutine. This function can be called
437 multiple times, and each time the file specified will be added
438 to the list of files to be excluded. Note, this function only
439 permits adding excludes of specific file or directory names,
440 or files matched by the rather simple fnmatch mechanism.
441 See below for information on doing wild-card and regex excludes.
443 \item [NewInclude] can be called to create a new Include block. This
444 block will be added before any user defined Include blocks. This
445 function can be called multiple times, but each time, it will create
446 a new Include section (not normally needed). This function should
447 be called only if you want to add an entirely new Include block.
449 \item [AddInclude] can be called to add new files/directories to
450 be included. They are added to the current Include block. If
451 NewInclude has not been included, the current Include block is
452 the last one that the user created. This function
453 should be used only if you want to add totally new files/directories
454 to be included in the backup.
456 \item [NewOptions] adds a new Options block to the current Include
457 in front of any other Options blocks. This permits the plugin to
458 add exclude directives (wild-cards and regexes) in front of the
459 user Options, and thus prevent certain files from being backed up.
460 This can be useful if the plugin backs up files, and they should
461 not be also backed up by the main Bacula code. This function
462 may be called multiple times, and each time, it creates a new
463 prepended Options block. Note: normally you want to call this
464 entry point prior to calling AddOptions, AddRegex, or AddWild.
466 \item [AddOptions] allows the plugin it set options in
467 the current Options block, which is normally created with the
468 NewOptions call just prior to adding Include Options.
469 The permitted options are passed as a character string, where
470 each character has a specific meaning as defined below:
473 \item [a] always replace files (default).
474 \item [e] exclude rather than include.
475 \item [h] no recursion into subdirectories.
476 \item [H] do not handle hard links.
477 \item [i] ignore case in wildcard and regex matches.
478 \item [M] compute an MD5 sum.
479 \item [p] use a portable data format on Windows (not recommended).
480 \item [R] backup resource forks and Findr Info.
481 \item [r] read from a fifo
482 \item [S1] compute an SHA1 sum.
483 \item [S2] compute an SHA256 sum.
484 \item [S3] comput an SHA512 sum.
485 \item [s] handle sparse files.
486 \item [m] use st\_mtime only for file differences.
487 \item [k] restore the st\_atime after accessing a file.
488 \item [A] enable ACL backup.
489 \item [Vxxx:] specify verify options. Must terminate with :
490 \item [Cxxx:] specify accurate options. Must terminate with :
491 \item [Jxxx:] specify base job Options. Must terminate with :
492 \item [Pnnn:] specify integer nnn paths to strip. Must terminate with :
494 \item [Zn] specify gzip compression level n.
495 \item [K] do not use st\_atime in backup decision.
496 \item [c] check if file changed during backup.
497 \item [N] honor no dump flag.
498 \item [X] enable backup of extended attributes.
501 \item [AddRegex] adds a regex expression to the current Options block.
502 The fillowing options are permitted:
504 \item [ ] (a blank) regex applies to whole path and filename.
505 \item [F] regex applies only to the filename (directory or path stripped).
506 \item [D] regex applies only to the directory (path) part of the name.
509 \item [AddWild] adds a wildcard expression to the current Options block.
510 The fillowing options are permitted:
512 \item [ ] (a blank) regex applies to whole path and filename.
513 \item [F] regex applies only to the filename (directory or path stripped).
514 \item [D] regex applies only to the directory (path) part of the name.
517 \item [checkChanges] call the \texttt{check\_changes()} function in Bacula code
518 that can use Accurate code to compare the file information in argument with
519 the previous file information. The \texttt{delta\_seq} attribute of the
520 \texttt{save\_pkt} will be updated, and the call will return
521 \texttt{bRC\_Seen} if the core code wouldn't decide to backup it.
526 \subsection{Bacula events}
527 The list of events has been extended to include:
533 bEventStartBackupJob = 3,
534 bEventEndBackupJob = 4,
535 bEventStartRestoreJob = 5,
536 bEventEndRestoreJob = 6,
537 bEventStartVerifyJob = 7,
538 bEventEndVerifyJob = 8,
539 bEventBackupCommand = 9,
540 bEventRestoreCommand = 10,
545 bEventCancelCommand = 13,
546 bEventVssBackupAddComponents = 14,
547 bEventVssRestoreLoadComponentMetadata = 15,
548 bEventVssRestoreSetComponentsSelected = 16,
549 bEventRestoreObject = 17,
550 bEventEndFileSet = 18,
551 bEventPluginCommand = 19,
552 bEventVssBeforeCloseRestore = 20,
553 bEventVssPrepareSnapshot = 21
559 \item [bEventCancelCommand] is called whenever the currently
560 running Job is cancelled */
562 \item [bEventVssBackupAddComponents]
564 \item [bEventVssPrepareSnapshot] is called before creating VSS snapshots, it
565 provides a char[27] table where the plugin can add Windows drives that will
566 be used during the Job. You need to add them without duplicates, and you can
567 use in \texttt{fd\_common.h} \texttt{add\_drive()} and \texttt{copy\_drives()}
571 \section{ACL enhancements}
573 The following enhancements are made to the Bacula Filed with regards to
574 Access Control Lists (ACLs)
577 \item Added support for AIX 5.3 and later new aclx\_get interface which supports
578 POSIX and NFSv4 ACLs.
579 \item Added support for new acl types on FreeBSD 8.1 and later which supports
580 POSIX and NFSv4 ACLs.
581 \item Some generic cleanups for internal ACL handling.
582 \item Fix for acl storage on OSX
583 \item Cleanup of configure checks for ACL detection, now configure only
584 tests for a certain interface type based on the operating system
585 this should give less false possitives on detection. Also when acls
586 are detected no other acl checks are performed anymore.
590 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
591 and is available with Bacula Enterprise Edition and Community Edition.
593 \section{XATTR enhancements}
595 The following enhancements are made to the Bacula Filed with regards to
596 Extended Attributes (XATTRs)
599 \item Added support for IRIX extended attributes using the attr\_get interface.
600 \item Added support for Tru64 (OSF1) extended attributes using the
601 getproplist interface.
602 \item Added support for AIX extended attributes available in AIX 6.x
603 and higher using the listea/getea/setea interface.
604 \item Added some debugging to generic xattr code so it easier to
606 \item Cleanup of configure checks for XATTR detection, now configure only
607 tests for a certain interface type based on the operating system
608 this should give less false possitives on detection. Also when xattrs
609 are detected no other xattr checks are performed anymore.
613 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
614 and is available with Bacula Enterprise Edition and Community Edition.
616 \section{Class Based Database Backend Drivers}
618 All current database backend drivers for catalog information are rewritten
619 to use a set of multi inherited C++ classes which abstract the specific
620 database specific internals and make sure we have a more stable generic
621 interface with the rest of sql code. From now on there is a strict boundery
622 between the SQL code and the low-level database functions. This new interface
623 should also make it easier to add a new backend for a currently unsupported
624 database. As part of the rewrite the SQLite 2 code was removed (e.g. only
625 SQLite 3 is now supported). An extra bonus of the new code is that you can
626 configure multiple backends in the configure and build all backends in one
627 compile session and select the correct database backend at install time.
628 This should make it a lot easier for packages maintainers.
631 We also added cursor support for PostgreSQL backend, this improves memory usage
632 for large installation.
635 This project was implemented by Planets Communications B.V. and ELM Consultancy B.V.
636 and Bacula Systems and is available with both the Bacula Enterprise Edition and
637 the Community Edition.
639 \section{Hash List Enhancements}
641 The htable hash table class has been extended with extra hash functions for
642 handling next to char pointer hashes also 32 bits and 64 bits hash keys.
643 Also the hash table initialization routines have been enhanced with
644 support for passing a hint as to the number of initial pages to use
645 for the size of the hash table. Until now the hash table always used
646 a fixed value of 10 Mb. The private hash functions of the mountpoint entry
647 cache have been rewritten to use the new htable class with a small memory
651 This project was funded by Planets Communications B.V. and ELM Consultancy B.V.
652 and Bacula Systems and is available with Bacula Enterprise Edition and
657 %%% =====================================================================
662 \chapter{Release Version 5.0.3}
664 There are no new features in version 5.0.2. This version simply fixes a
665 number of bugs found in version 5.0.1 during the onging development
668 \chapter{Release Version 5.0.2}
670 There are no new features in version 5.0.2. This version simply fixes a
671 number of bugs found in version 5.0.1 during the onging development
677 \chapter{New Features in 5.0.1}
679 This chapter presents the new features that are in the released Bacula version
680 5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during
681 the onging development process.
683 \section{Truncate Volume after Purge}
684 \label{sec:actiononpurge}
686 The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate
687 the volume when it is purged with the new command \texttt{purge volume
688 action}. It is useful to prevent disk based volumes from consuming too much
694 Action On Purge = Truncate
699 As usual you can also set this property with the \texttt{update volume} command
701 *update volume=xxx ActionOnPurge=Truncate
702 *update volume=xxx actiononpurge=None
705 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
706 following command in interactive mode or in a RunScript as shown after:
708 *purge volume action=truncate storage=File allpools
709 # or by default, action=all
710 *purge volume action storage=File pool=Default
713 This is possible to specify the volume name, the media type, the pool, the
714 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
715 idle when you decide to run this command.
724 Console = "purge volume action=all allpools storage=File"
729 \textbf{Important note}: This feature doesn't work as
730 expected in version 5.0.0. Please do not use it before version 5.0.1.
732 \section{Allow Higher Duplicates}
733 This directive did not work correctly and has been depreciated
734 (disabled) in version 5.0.1. Please remove it from your bacula-dir.conf
735 file as it will be removed in a future rlease.
737 \section{Cancel Lower Level Duplicates}
738 This directive was added in Bacula version 5.0.1. It compares the
739 level of a new backup job to old jobs of the same name, if any,
740 and will kill the job which has a lower level than the other one.
741 If the levels are the same (i.e. both are Full backups), then
742 nothing is done and the other Cancel XXX Duplicate directives
745 \chapter{New Features in 5.0.0}
747 \section{Maximum Concurrent Jobs for Devices}
748 \label{sec:maximumconcurrentjobdevice}
750 {\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
751 Daemon configuration permits setting the maximum number of Jobs that can
752 run concurrently on a specified Device. Using this directive, it is
753 possible to have different Jobs using multiple drives, because when the
754 Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
755 Jobs on any other available compatible drive. This facilitates writing to
756 multiple drives with multiple Jobs that all use the same Pool.
758 This project was funded by Bacula Systems.
760 \section{Restore from Multiple Storage Daemons}
761 \index[general]{Restore}
763 Previously, you were able to restore from multiple devices in a single Storage
764 Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
765 example, if your full backup runs on a Storage Daemon with an autochanger, and
766 your incremental jobs use another Storage Daemon with lots of disks, Bacula
767 will switch automatically from one Storage Daemon to an other within the same
770 You must upgrade your File Daemon to version 3.1.3 or greater to use this
773 This project was funded by Bacula Systems with the help of Equiinet.
775 \section{File Deduplication using Base Jobs}
776 A base job is sort of like a Full save except that you will want the FileSet to
777 contain only files that are unlikely to change in the future (i.e. a snapshot
778 of most of your system after installing it). After the base job has been run,
779 when you are doing a Full save, you specify one or more Base jobs to be used.
780 All files that have been backed up in the Base job/jobs but not modified will
781 then be excluded from the backup. During a restore, the Base jobs will be
782 automatically pulled in where necessary.
784 This is something none of the competition does, as far as we know (except
785 perhaps BackupPC, which is a Perl program that saves to disk only). It is big
786 win for the user, it makes Bacula stand out as offering a unique optimization
787 that immediately saves time and money. Basically, imagine that you have 100
788 nearly identical Windows or Linux machine containing the OS and user files.
789 Now for the OS part, a Base job will be backed up once, and rather than making
790 100 copies of the OS, there will be only one. If one or more of the systems
791 have some files updated, no problem, they will be automatically restored.
793 See the \ilink{Base Job Chapter}{basejobs} for more information.
795 This project was funded by Bacula Systems.
797 \section{AllowCompression = \lt{}yes\vb{}no\gt{}}
798 \index[dir]{AllowCompression}
800 This new directive may be added to Storage resource within the Director's
801 configuration to allow users to selectively disable the client compression for
802 any job which writes to this storage resource.
808 Address = ultrium-tape
809 Password = storage_password # Password for Storage Daemon
812 AllowCompression = No # Tape drive has hardware compression
815 The above example would cause any jobs running with the UltriumTape storage
816 resource to run without compression from the client file daemons. This
817 effectively overrides any compression settings defined at the FileSet level.
819 This feature is probably most useful if you have a tape drive which supports
820 hardware compression. By setting the \texttt{AllowCompression = No} directive
821 for your tape drive storage resource, you can avoid additional load on the file
822 daemon and possibly speed up tape backups.
824 This project was funded by Collaborative Fusion, Inc.
826 \section{Accurate Fileset Options}
827 \label{sec:accuratefileset}
829 In previous versions, the accurate code used the file creation and modification
830 times to determine if a file was modified or not. Now you can specify which
831 attributes to use (time, size, checksum, permission, owner, group, \dots),
832 similar to the Verify options.
848 \item {\bf i} compare the inodes
849 \item {\bf p} compare the permission bits
850 \item {\bf n} compare the number of links
851 \item {\bf u} compare the user id
852 \item {\bf g} compare the group id
853 \item {\bf s} compare the size
854 \item {\bf a} compare the access time
855 \item {\bf m} compare the modification time (st\_mtime)
856 \item {\bf c} compare the change time (st\_ctime)
857 \item {\bf d} report file size decreases
858 \item {\bf 5} compare the MD5 signature
859 \item {\bf 1} compare the SHA1 signature
862 \textbf{Important note:} If you decide to use checksum in Accurate jobs,
863 the File Daemon will have to read all files even if they normally would not
864 be saved. This increases the I/O load, but also the accuracy of the
865 deduplication. By default, Bacula will check modification/creation time
868 This project was funded by Bacula Systems.
870 \section{Tab-completion for Bconsole}
871 \label{sec:tabcompletion}
873 If you build \texttt{bconsole} with readline support, you will be able to use
874 the new auto-completion mode. This mode supports all commands, gives help
875 inside command, and lists resources when required. It works also in the restore
878 To use this feature, you should have readline development package loaded on
879 your system, and use the following option in configure.
881 ./configure --with-readline=/usr/include/readline --disable-conio ...
884 The new bconsole won't be able to tab-complete with older directors.
886 This project was funded by Bacula Systems.
888 \section{Pool File and Job Retention}
889 \label{sec:poolfilejobretention}
891 We added two new Pool directives, \texttt{FileRetention} and
892 \texttt{JobRetention}, that take precedence over Client directives of the same
893 name. It allows you to control the Catalog pruning algorithm Pool by Pool. For
894 example, you can decide to increase Retention times for Archive or OffSite Pool.
896 It seems obvious to us, but apparently not to some users, that given the
897 definition above that the Pool File and Job Retention periods is a global
898 override for the normal Client based prunning, which means that when the
899 Job is prunned, the prunning will apply globally to that particular Job.
901 Currently, there is a bug in the implementation that causes any Pool
902 retention periods specified to apply to {\bf all} Pools for that
903 particular Client. Thus we suggest that you avoid using these two
904 directives until this implementation problem is corrected.
906 \section{Read-only File Daemon using capabilities}
907 \label{sec:fdreadonly}
908 This feature implements support of keeping \textbf{ReadAll} capabilities after
909 UID/GID switch, this allows FD to keep root read but drop write permission.
911 It introduces new \texttt{bacula-fd} option (\texttt{-k}) specifying that
912 \textbf{ReadAll} capabilities should be kept after UID/GID switch.
915 root@localhost:~# bacula-fd -k -u nobody -g nobody
918 The code for this feature was contributed by our friends at AltLinux.
923 To help developers of restore GUI interfaces, we have added new \textsl{dot
924 commands} that permit browsing the catalog in a very simple way.
927 \item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
928 the Bvfs cache in the catalog. You need to run it before any access to the
931 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
932 will list all directories in the specified \texttt{path} or
933 \texttt{pathid}. Using \texttt{pathid} avoids problems with character
934 encoding of path/filenames.
936 \item \texttt{.bvfs\_lsfiles jobid=x,y,z path=/path | pathid=101} This command
937 will list all files in the specified \texttt{path} or \texttt{pathid}. Using
938 \texttt{pathid} avoids problems with character encoding.
941 You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
942 data that will be displayed.
945 * .bvfs_update jobid=1,2
947 * .bvfs_lsdir path=/ jobid=1,2
950 This project was funded by Bacula Systems.
952 \section{Testing your Tape Drive}
953 \label{sec:btapespeed}
955 To determine the best configuration of your tape drive, you can run the new
956 \texttt{speed} command available in the \texttt{btape} program.
958 This command can have the following arguments:
960 \item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
961 (between 1 and 5GB). This counter is in GB.
962 \item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
963 of data should be greater than your memory ($file\_size*nb\_file$).
964 \item[\texttt{skip\_zero}] This flag permits to skip tests with constant
966 \item[\texttt{skip\_random}] This flag permits to skip tests with random
968 \item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
969 \item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
974 *speed file_size=3 skip_raw
975 btape.c:1078 Test with zero data and bacula block structure.
976 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
977 ++++++++++++++++++++++++++++++++++++++++++
978 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
979 btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
981 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
983 btape.c:1090 Test with random data, should give the minimum throughput.
984 btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
985 +++++++++++++++++++++++++++++++++++++++++++
986 btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
987 btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
988 +++++++++++++++++++++++++++++++++++++++++++
990 btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
994 When using compression, the random test will give your the minimum throughput
995 of your drive . The test using constant string will give you the maximum speed
996 of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
998 You can change the block size in the Storage Daemon configuration file.
1000 \section{New {\bf Block Checksum} Device Directive}
1001 You may now turn off the Block Checksum (CRC32) code
1002 that Bacula uses when writing blocks to a Volume. This is
1009 doing so can reduce the Storage daemon CPU usage slightly. It
1010 will also permit Bacula to read a Volume that has corrupted data.
1012 The default is {\bf yes} -- i.e. the checksum is computed on write
1013 and checked on read.
1015 We do not recommend to turn this off particularly on older tape
1016 drives or for disk Volumes where doing so may allow corrupted data
1019 \section{New Bat Features}
1021 Those new features were funded by Bacula Systems.
1023 \subsection{Media List View}
1025 By clicking on ``Media'', you can see the list of all your volumes. You will be
1026 able to filter by Pool, Media Type, Location,\dots And sort the result directly
1027 in the table. The old ``Media'' view is now known as ``Pool''.
1028 \begin{figure}[htbp]
1030 \includegraphics[width=13cm]{\idir bat-mediaview.eps}
1031 \label{fig:mediaview}
1035 \subsection{Media Information View}
1037 By double-clicking on a volume (on the Media list, in the Autochanger content
1038 or in the Job information panel), you can access a detailed overview of your
1039 Volume. (cf \ref{fig:mediainfo}.)
1040 \begin{figure}[htbp]
1042 \includegraphics[width=13cm]{\idir bat11.eps}
1043 \caption{Media information}
1044 \label{fig:mediainfo}
1047 \subsection{Job Information View}
1049 By double-clicking on a Job record (on the Job run list or in the Media
1050 information panel), you can access a detailed overview of your Job. (cf
1052 \begin{figure}[htbp]
1054 \includegraphics[width=13cm]{\idir bat12.eps}
1055 \caption{Job information}
1059 \subsection{Autochanger Content View}
1061 By double-clicking on a Storage record (on the Storage list panel), you can
1062 access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
1063 \begin{figure}[htbp]
1065 \includegraphics[width=13cm]{\idir bat13.eps}
1066 \caption{Autochanger content}
1067 \label{fig:achcontent}
1070 To use this feature, you need to use the latest mtx-changer script
1071 version. (With new \texttt{listall} and \texttt{transfer} commands)
1073 \section{Bat on Windows}
1074 We have ported {\bf bat} to Windows and it is now installed
1075 by default when the installer is run. It works quite well
1076 on Win32, but has not had a lot of testing there, so your
1077 feedback would be welcome. Unfortunately, eventhough it is
1078 installed by default, it does not yet work on 64 bit Windows
1081 \section{New Win32 Installer}
1082 The Win32 installer has been modified in several very important
1085 \item You must deinstall any current version of the
1086 Win32 File daemon before upgrading to the new one.
1087 If you forget to do so, the new installation will fail.
1088 To correct this failure, you must manually shutdown
1089 and deinstall the old File daemon.
1090 \item All files (other than menu links) are installed
1091 in {\bf c:/Program Files/Bacula}.
1092 \item The installer no longer sets this
1093 file to require administrator privileges by default. If you want
1094 to do so, please do it manually using the {\bf cacls} program.
1097 cacls "C:\Program Files\Bacula" /T /G SYSTEM:F Administrators:F
1099 \item The server daemons (Director and Storage daemon) are
1100 no longer included in the Windows installer. If you want the
1101 Windows servers, you will either need to build them yourself (note
1102 they have not been ported to 64 bits), or you can contact
1103 Bacula Systems about this.
1106 \section{Win64 Installer}
1107 We have corrected a number of problems that required manual
1108 editing of the conf files. In most cases, it should now
1109 install and work. {\bf bat} is by default installed in
1110 {\bf c:/Program Files/Bacula/bin32} rather than
1111 {\bf c:/Program Files/Bacula} as is the case with the 32
1112 bit Windows installer.
1114 \section{Linux Bare Metal Recovery USB Key}
1115 We have made a number of significant improvements in the
1116 Bare Metal Recovery USB key. Please see the README files
1117 it the {\bf rescue} release for more details.
1119 We are working on an equivalent USB key for Windows bare
1120 metal recovery, but it will take some time to develop it (best
1121 estimate 3Q2010 or 4Q2010)
1124 \section{bconsole Timeout Option}
1125 You can now use the -u option of {\bf bconsole} to set a timeout in seconds
1126 for commands. This is useful with GUI programs that use {\bf bconsole}
1127 to interface to the Director.
1129 \section{Important Changes}
1130 \label{sec:importantchanges}
1133 \item You are now allowed to Migrate, Copy, and Virtual Full to read and write
1134 to the same Pool. The Storage daemon ensures that you do not read and
1135 write to the same Volume.
1136 \item The \texttt{Device Poll Interval} is now 5 minutes. (previously did not
1138 \item Virtually all the features of {\bf mtx-changer} have
1139 now been parameterized, which allows you to configure
1140 mtx-changer without changing it. There is a new configuration file {\bf mtx-changer.conf}
1141 that contains variables that you can set to configure mtx-changer.
1142 This configuration file will not be overwritten during upgrades.
1143 We encourage you to submit any changes
1144 that are made to mtx-changer and to parameterize it all in
1145 mtx-changer.conf so that all configuration will be done by
1146 changing only mtx-changer.conf.
1147 \item The new \texttt{mtx-changer} script has two new options, \texttt{listall}
1148 and \texttt{transfer}. Please configure them as appropriate
1149 in mtx-changer.conf.
1150 \item To enhance security of the \texttt{BackupCatalog} job, we provide a new
1151 script (\texttt{make\_catalog\_backup.pl}) that does not expose your catalog
1152 password. If you want to use the new script, you will need to
1153 manually change the \texttt{BackupCatalog} Job definition.
1154 \item The \texttt{bconsole} \texttt{help} command now accepts
1155 an argument, which if provided produces information on that
1156 command (ex: \texttt{help run}).
1160 \subsubsection*{Truncate volume after purge}
1162 Note that the Truncate Volume after purge feature doesn't work as expected
1163 in 5.0.0 version. Please, don't use it before version 5.0.1.
1165 \subsection{Custom Catalog queries}
1167 If you wish to add specialized commands that list the contents of the catalog,
1168 you can do so by adding them to the \texttt{query.sql} file. This
1169 \texttt{query.sql} file is now empty by default. The file
1170 \texttt{examples/sample-query.sql} has an a number of sample commands
1171 you might find useful.
1173 \subsection{Deprecated parts}
1175 The following items have been \textbf{deprecated} for a long time, and are now
1176 removed from the code.
1179 \item Support for SQLite 2
1182 \section{Misc Changes}
1183 \label{sec:miscchanges}
1186 \item Updated Nagios check\_bacula
1187 \item Updated man files
1188 \item Added OSX package generation script in platforms/darwin
1189 \item Added Spanish and Ukrainian Bacula translations
1190 \item Enable/disable command shows only Jobs that can change
1191 \item Added \texttt{show disabled} command to show disabled Jobs
1192 \item Many ACL improvements
1193 \item Added Level to FD status Job output
1194 \item Begin Ingres DB driver (not yet working)
1195 \item Split RedHat spec files into bacula, bat, mtx, and docs
1196 \item Reorganized the manuals (fewer separate manuals)
1197 \item Added lock/unlock order protection in lock manager
1198 \item Allow 64 bit sizes for a number of variables
1199 \item Fixed several deadlocks or potential race conditions in the SD
1202 \chapter{Released Version 3.0.3 and 3.0.3a}
1204 There are no new features in version 3.0.3. This version simply fixes a
1205 number of bugs found in version 3.0.2 during the onging development
1208 \chapter{New Features in Released Version 3.0.2}
1210 This chapter presents the new features added to the
1211 Released Bacula Version 3.0.2.
1213 \section{Full Restore from a Given JobId}
1214 \index[general]{Restore menu}
1216 This feature allows selecting a single JobId and having Bacula
1217 automatically select all the other jobs that comprise a full backup up to
1218 and including the selected date (through JobId).
1220 Assume we start with the following jobs:
1222 +-------+--------------+---------------------+-------+----------+------------+
1223 | jobid | client | starttime | level | jobfiles | jobbytes |
1224 +-------+--------------+---------------------+-------+----------+------------
1225 | 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
1226 | 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
1227 | 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
1228 | 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
1229 +-------+--------------+---------------------+-------+----------+------------+
1232 Below is an example of this new feature (which is number 12 in the
1237 To select the JobIds, you have the following choices:
1238 1: List last 20 Jobs run
1239 2: List Jobs where a given File is saved
1241 12: Select full restore to a specified Job date
1244 Select item: (1-13): 12
1245 Enter JobId to get the state to restore: 5
1246 Selecting jobs to build the Full state at 2009-07-15 11:45:45
1247 You have selected the following JobIds: 1,3,5
1249 Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
1250 1,444 files inserted into the tree.
1253 This project was funded by Bacula Systems.
1255 \section{Source Address}
1256 \index[general]{Source Address}
1258 A feature has been added which allows the administrator to specify the address
1259 from which the Director and File daemons will establish connections. This
1260 may be used to simplify system configuration overhead when working in complex
1261 networks utilizing multi-homing and policy-routing.
1263 To accomplish this, two new configuration directives have been implemented:
1266 FDSourceAddress=10.0.1.20 # Always initiate connections from this address
1270 DirSourceAddress=10.0.1.10 # Always initiate connections from this address
1274 Simply adding specific host routes on the OS
1275 would have an undesirable side-effect: any
1276 application trying to contact the destination host would be forced to use the
1277 more specific route possibly diverting management traffic onto a backup VLAN.
1278 Instead of adding host routes for each client connected to a multi-homed backup
1279 server (for example where there are management and backup VLANs), one can
1280 use the new directives to specify a specific source address at the application
1283 Additionally, this allows the simplification and abstraction of firewall rules
1284 when dealing with a Hot-Standby director or storage daemon configuration. The
1285 Hot-standby pair may share a CARP address, which connections must be sourced
1286 from, while system services listen and act from the unique interface addresses.
1288 This project was funded by Collaborative Fusion, Inc.
1290 \section{Show volume availability when doing restore}
1292 When doing a restore the selection dialog ends by displaying this
1296 The job will require the following
1297 Volume(s) Storage(s) SD Device(s)
1298 ===========================================================================
1299 *000741L3 LTO-4 LTO3
1300 *000866L3 LTO-4 LTO3
1301 *000765L3 LTO-4 LTO3
1302 *000764L3 LTO-4 LTO3
1303 *000756L3 LTO-4 LTO3
1304 *001759L3 LTO-4 LTO3
1305 *001763L3 LTO-4 LTO3
1309 Volumes marked with ``*'' are online (in the autochanger).
1312 This should help speed up large restores by minimizing the time spent
1313 waiting for the operator to discover that he must change tapes in the library.
1315 This project was funded by Bacula Systems.
1317 \section{Accurate estimate command}
1319 The \texttt{estimate} command can now use the accurate code to detect changes
1320 and give a better estimation.
1322 You can set the accurate behavior on the command line by using
1323 \texttt{accurate=yes\vb{}no} or use the Job setting as default value.
1326 * estimate listing accurate=yes level=incremental job=BackupJob
1329 This project was funded by Bacula Systems.
1331 \chapter{New Features in 3.0.0}
1332 \label{NewFeaturesChapter}
1333 \index[general]{New Features}
1335 This chapter presents the new features added to the development 2.5.x
1336 versions to be released as Bacula version 3.0.0 sometime in April 2009.
1338 \section{Accurate Backup}
1339 \index[general]{Accurate Backup}
1341 As with most other backup programs, by default Bacula decides what files to
1342 backup for Incremental and Differental backup by comparing the change
1343 (st\_ctime) and modification (st\_mtime) times of the file to the time the last
1344 backup completed. If one of those two times is later than the last backup
1345 time, then the file will be backed up. This does not, however, permit tracking
1346 what files have been deleted and will miss any file with an old time that may
1347 have been restored to or moved onto the client filesystem.
1349 \subsection{Accurate = \lt{}yes\vb{}no\gt{}}
1350 If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
1351 the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
1352 backup, there is no difference, but for {\bf Differential} and {\bf
1353 Incremental} backups, the Director will send a list of all previous files
1354 backed up, and the File daemon will use that list to determine if any new files
1355 have been added or or moved and if any files have been deleted. This allows
1356 Bacula to make an accurate backup of your system to that point in time so that
1357 if you do a restore, it will restore your system exactly.
1360 about using Accurate backup is that it requires more resources (CPU and memory)
1361 on both the Director and the Client machines to create the list of previous
1362 files backed up, to send that list to the File daemon, for the File daemon to
1363 keep the list (possibly very big) in memory, and for the File daemon to do
1364 comparisons between every file in the FileSet and the list. In particular,
1365 if your client has lots of files (more than a few million), you will need
1366 lots of memory on the client machine.
1368 Accurate must not be enabled when backing up with a plugin that is not
1369 specially designed to work with Accurate. If you enable it, your restores
1370 will probably not work correctly.
1372 This project was funded by Bacula Systems.
1377 \index[general]{Copy Jobs}
1379 A new {\bf Copy} job type 'C' has been implemented. It is similar to the
1380 existing Migration feature with the exception that the Job that is copied is
1381 left unchanged. This essentially creates two identical copies of the same
1382 backup. However, the copy is treated as a copy rather than a backup job, and
1383 hence is not directly available for restore. The {\bf restore} command lists
1384 copy jobs and allows selection of copies by using \texttt{jobid=}
1385 option. If the keyword {\bf copies} is present on the command line, Bacula will
1386 display the list of all copies for selected jobs.
1391 These JobIds have copies as follows:
1392 +-------+------------------------------------+-----------+------------------+
1393 | JobId | Job | CopyJobId | MediaType |
1394 +-------+------------------------------------+-----------+------------------+
1395 | 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
1396 +-------+------------------------------------+-----------+------------------+
1397 +-------+-------+----------+----------+---------------------+------------------+
1398 | JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
1399 +-------+-------+----------+----------+---------------------+------------------+
1400 | 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
1401 | 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
1402 +-------+-------+----------+----------+---------------------+------------------+
1403 You have selected the following JobIds: 19,2
1405 Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
1406 5,611 files inserted into the tree.
1411 The Copy Job runs without using the File daemon by copying the data from the
1412 old backup Volume to a different Volume in a different Pool. See the Migration
1413 documentation for additional details. For copy Jobs there is a new selection
1414 directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
1415 not already copied to another Pool.
1417 As with Migration, the Client, Volume, Job, or SQL query, are
1418 other possible ways of selecting the Jobs to be copied. Selection
1419 types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
1420 work, but are probably more suited for Migration Jobs.
1422 If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
1423 it will promote the Copy to a \textsl{real} backup job and will make it available for
1424 automatic restore. If more than one Copy is available, it will promote the copy
1425 with the smallest JobId.
1427 A nice solution which can be built with the new Copy feature is often
1428 called disk-to-disk-to-tape backup (DTDTT). A sample config could
1429 look something like the one below:
1433 Name = FullBackupsVirtualPool
1435 Purge Oldest Volume = Yes
1437 NextPool = FullBackupsTapePool
1441 Name = FullBackupsTapePool
1445 Volume Retention = 365 days
1446 Storage = superloader
1450 # Fake fileset for copy jobs
1462 # Fake client for copy jobs
1472 # Default template for a CopyDiskToTape Job
1475 Name = CopyDiskToTape
1477 Messages = StandardCopy
1480 Selection Type = PoolUncopiedJobs
1481 Maximum Concurrent Jobs = 10
1483 Allow Duplicate Jobs = Yes
1484 Cancel Queued Duplicates = No
1485 Cancel Running Duplicates = No
1490 Name = DaySchedule7:00
1491 Run = Level=Full daily at 7:00
1495 Name = CopyDiskToTapeFullBackups
1497 Schedule = DaySchedule7:00
1498 Pool = FullBackupsVirtualPool
1499 JobDefs = CopyDiskToTape
1503 The example above had 2 pool which are copied using the PoolUncopiedJobs
1504 selection criteria. Normal Full backups go to the Virtual pool and are copied
1505 to the Tape pool the next morning.
1507 The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
1512 +-------+------------------------------------+-----------+------------------+
1513 | JobId | Job | CopyJobId | MediaType |
1514 +-------+------------------------------------+-----------+------------------+
1515 | 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
1516 +-------+------------------------------------+-----------+------------------+
1519 \section{ACL Updates}
1520 \index[general]{ACL Updates}
1521 The whole ACL code had been overhauled and in this version each platforms has
1522 different streams for each type of acl available on such an platform. As ACLs
1523 between platforms tend to be not that portable (most implement POSIX acls but
1524 some use an other draft or a completely different format) we currently only
1525 allow certain platform specific ACL streams to be decoded and restored on the
1526 same platform that they were created on. The old code allowed to restore ACL
1527 cross platform but the comments already mention that not being to wise. For
1528 backward compatability the new code will accept the two old ACL streams and
1529 handle those with the platform specific handler. But for all new backups it
1530 will save the ACLs using the new streams.
1532 Currently the following platforms support ACLs:
1536 \item {\bf Darwin/OSX}
1545 Currently we support the following ACL types (these ACL streams use a reserved
1546 part of the stream numbers):
1549 \item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
1551 \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
1552 string representation from acl\_to\_text (POSIX acl)
1553 \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
1554 string representation from acl\_to\_text (POSIX acl) for default acls.
1555 \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
1556 string representation from acl\_to\_text (POSIX acl) for access acls.
1557 \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
1558 string representation from acltostr (POSIX acl)
1559 \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
1560 representation from acl\_to\_text (POSIX acl) for default acls.
1561 \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
1562 representation from acl\_to\_text (POSIX acl) for access acls.
1563 \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
1564 string representation from acl\_to\_text (POSIX acl) for default acls.
1565 \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
1566 representation from acl\_to\_text (POSIX acl) for access acls.
1567 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
1568 string representation from acl\_to\_text (POSIX acl) for default acls.
1569 \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
1570 string representation from acl\_to\_text (POSIX acl) for default acls.
1571 \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
1572 representation from acl\_to\_text (POSIX acl) for access acls.
1573 \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
1574 string representation from acltotext or acl\_totext (POSIX acl)
1575 \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
1576 representation from from acl\_totext (NFSv4 or ZFS acl)
1579 In future versions we might support conversion functions from one type of acl
1580 into an other for types that are either the same or easily convertable. For now
1581 the streams are seperate and restoring them on a platform that doesn't
1582 recognize them will give you a warning.
1584 \section{Extended Attributes}
1585 \index[general]{Extended Attributes}
1586 Something that was on the project list for some time is now implemented for
1587 platforms that support a similar kind of interface. Its the support for backup
1588 and restore of so called extended attributes. As extended attributes are so
1589 platform specific these attributes are saved in seperate streams for each
1590 platform. Restores of the extended attributes can only be performed on the
1591 same platform the backup was done. There is support for all types of extended
1592 attributes, but restoring from one type of filesystem onto an other type of
1593 filesystem on the same platform may lead to supprises. As extended attributes
1594 can contain any type of data they are stored as a series of so called
1595 value-pairs. This data must be seen as mostly binary and is stored as such.
1596 As security labels from selinux are also extended attributes this option also
1597 stores those labels and no specific code is enabled for handling selinux
1600 Currently the following platforms support extended attributes:
1602 \item {\bf Darwin/OSX}
1608 On linux acls are also extended attributes, as such when you enable ACLs on a
1609 Linux platform it will NOT save the same data twice e.g. it will save the ACLs
1610 and not the same exteneded attribute.
1612 To enable the backup of extended attributes please add the following to your
1627 \section{Shared objects}
1628 \index[general]{Shared objects}
1629 A default build of Bacula will now create the libraries as shared objects
1630 (.so) rather than static libraries as was previously the case.
1631 The shared libraries are built using {\bf libtool} so it should be quite
1634 An important advantage of using shared objects is that on a machine with the
1635 Directory, File daemon, the Storage daemon, and a console, you will have only
1636 one copy of the code in memory rather than four copies. Also the total size of
1637 the binary release is smaller since the library code appears only once rather
1638 than once for every program that uses it; this results in significant reduction
1639 in the size of the binaries particularly for the utility tools.
1641 In order for the system loader to find the shared objects when loading the
1642 Bacula binaries, the Bacula shared objects must either be in a shared object
1643 directory known to the loader (typically /usr/lib) or they must be in the
1644 directory that may be specified on the {\bf ./configure} line using the {\bf
1645 {-}{-}libdir} option as:
1648 ./configure --libdir=/full-path/dir
1651 the default is /usr/lib. If {-}{-}libdir is specified, there should be
1652 no need to modify your loader configuration provided that
1653 the shared objects are installed in that directory (Bacula
1654 does this with the make install command). The shared objects
1655 that Bacula references are:
1664 These files are symbolically linked to the real shared object file,
1665 which has a version number to permit running multiple versions of
1666 the libraries if desired (not normally the case).
1668 If you have problems with libtool or you wish to use the old
1669 way of building static libraries, or you want to build a static
1670 version of Bacula you may disable
1671 libtool on the configure command line with:
1674 ./configure --disable-libtool
1678 \section{Building Static versions of Bacula}
1679 \index[general]{Static linking}
1680 In order to build static versions of Bacula, in addition
1681 to configuration options that were needed you now must
1682 also add --disable-libtool. Example
1685 ./configure --enable-static-client-only --disable-libtool
1689 \section{Virtual Backup (Vbackup)}
1690 \index[general]{Virtual Backup}
1691 \index[general]{Vbackup}
1693 Bacula's virtual backup feature is often called Synthetic Backup or
1694 Consolidation in other backup products. It permits you to consolidate the
1695 previous Full backup plus the most recent Differential backup and any
1696 subsequent Incremental backups into a new Full backup. This new Full
1697 backup will then be considered as the most recent Full for any future
1698 Incremental or Differential backups. The VirtualFull backup is
1699 accomplished without contacting the client by reading the previous backup
1700 data and writing it to a volume in a different pool.
1702 In some respects the Vbackup feature works similar to a Migration job, in
1703 that Bacula normally reads the data from the pool specified in the
1704 Job resource, and writes it to the {\bf Next Pool} specified in the
1705 Job resource. Note, this means that usually the output from the Virtual
1706 Backup is written into a different pool from where your prior backups
1707 are saved. Doing it this way guarantees that you will not get a deadlock
1708 situation attempting to read and write to the same volume in the Storage
1709 daemon. If you then want to do subsequent backups, you may need to
1710 move the Virtual Full Volume back to your normal backup pool.
1711 Alternatively, you can set your {\bf Next Pool} to point to the current
1712 pool. This will cause Bacula to read and write to Volumes in the
1713 current pool. In general, this will work, because Bacula will
1714 not allow reading and writing on the same Volume. In any case, once
1715 a VirtualFull has been created, and a restore is done involving the
1716 most current Full, it will read the Volume or Volumes by the VirtualFull
1717 regardless of in which Pool the Volume is found.
1719 The Vbackup is enabled on a Job by Job in the Job resource by specifying
1720 a level of {\bf VirtualFull}.
1722 A typical Job resource definition might look like the following:
1729 FileSet = "Full Set"
1736 # Default pool definition
1740 Recycle = yes # Automatically recycle Volumes
1741 AutoPrune = yes # Prune expired volumes
1742 Volume Retention = 365d # one year
1750 Recycle = yes # Automatically recycle Volumes
1751 AutoPrune = yes # Prune expired volumes
1752 Volume Retention = 365d # one year
1753 Storage = DiskChanger
1756 # Definition of file storage device
1761 Device = FileStorage
1763 Maximum Concurrent Jobs = 5
1766 # Definition of DDS Virtual tape disk storage device
1769 Address = localhost # N.B. Use a fully qualified name here
1771 Device = DiskChanger
1772 Media Type = DiskChangerMedia
1773 Maximum Concurrent Jobs = 4
1778 Then in bconsole or via a Run schedule, you would run the job as:
1781 run job=MyBackup level=Full
1782 run job=MyBackup level=Incremental
1783 run job=MyBackup level=Differential
1784 run job=MyBackup level=Incremental
1785 run job=MyBackup level=Incremental
1788 So providing there were changes between each of those jobs, you would end up
1789 with a Full backup, a Differential, which includes the first Incremental
1790 backup, then two Incremental backups. All the above jobs would be written to
1791 the {\bf Default} pool.
1793 To consolidate those backups into a new Full backup, you would run the
1797 run job=MyBackup level=VirtualFull
1800 And it would produce a new Full backup without using the client, and the output
1801 would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
1803 If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
1806 Note, the Start and End time of the Virtual Full backup is set to the
1807 values for the last job included in the Virtual Full (in the above example,
1808 it is an Increment). This is so that if another incremental is done, which
1809 will be based on the Virtual Full, it will backup all files from the
1810 last Job included in the Virtual Full rather than from the time the Virtual
1811 Full was actually run.
1815 \section{Catalog Format}
1816 \index[general]{Catalog Format}
1817 Bacula 3.0 comes with some changes to the catalog format. The upgrade
1818 operation will convert the FileId field of the File table from 32 bits (max 4
1819 billion table entries) to 64 bits (very large number of items). The
1820 conversion process can take a bit of time and will likely DOUBLE THE SIZE of
1821 your catalog during the conversion. Also you won't be able to run jobs during
1822 this conversion period. For example, a 3 million file catalog will take 2
1823 minutes to upgrade on a normal machine. Please don't forget to make a valid
1824 backup of your database before executing the upgrade script. See the
1825 ReleaseNotes for additional details.
1827 \section{64 bit Windows Client}
1828 \index[general]{Win64 Client}
1829 Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
1830 their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
1831 As a consequence, we are also releasing a 64 bit version of the Bacula
1832 Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
1833 These binaries should only be installed on 64 bit Windows operating systems.
1834 What is important is not your hardware but whether or not you have
1835 a 64 bit version of the Windows OS.
1837 Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
1839 \item Before installing the Win64 Bacula Client, you must totally
1840 deinstall any prior 2.4.x Client installation using the
1841 Bacula deinstallation (see the menu item). You may want
1842 to save your .conf files first.
1843 \item Only the Client (File daemon) is ported to Win64, the Director
1844 and the Storage daemon are not in the 64 bit Windows installer.
1845 \item bwx-console is not yet ported.
1846 \item bconsole is ported but it has not been tested.
1847 \item The documentation is not included in the installer.
1848 \item Due to Vista security restrictions imposed on a default installation
1849 of Vista, before upgrading the Client, you must manually stop
1850 any prior version of Bacula from running, otherwise the install
1852 \item Due to Vista security restrictions imposed on a default installation
1853 of Vista, attempting to edit the conf files via the menu items
1854 will fail. You must directly edit the files with appropriate
1855 permissions. Generally double clicking on the appropriate .conf
1856 file will work providing you have sufficient permissions.
1857 \item All Bacula files are now installed in
1858 {\bf C:/Program Files/Bacula} except the main menu items,
1859 which are installed as before. This vastly simplifies the installation.
1860 \item If you are running on a foreign language version of Windows, most
1861 likely {\bf C:/Program Files} does not exist, so you should use the
1862 Custom installation and enter an appropriate location to install
1864 \item The 3.0.0 Win32 Client continues to install files in the locations used
1865 by prior versions. For the next version we will convert it to use
1866 the same installation conventions as the Win64 version.
1869 This project was funded by Bacula Systems.
1872 \section{Duplicate Job Control}
1873 \index[general]{Duplicate Jobs}
1874 The new version of Bacula provides four new directives that
1875 give additional control over what Bacula does if duplicate jobs
1876 are started. A duplicate job in the sense we use it here means
1877 a second or subsequent job with the same name starts. This
1878 happens most frequently when the first job runs longer than expected because no
1879 tapes are available.
1881 The four directives each take as an argument a {\bf yes} or {\bf no} value and
1882 are specified in the Job resource.
1886 \subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
1887 \index[general]{Allow Duplicate Jobs}
1888 If this directive is set to {\bf yes}, duplicate jobs will be run. If
1889 the directive is set to {\bf no} (default) then only one job of a given name
1890 may run at one time, and the action that Bacula takes to ensure only
1891 one job runs is determined by the other directives (see below).
1893 If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
1894 are present and none of the three directives given below permit
1895 cancelling a job, then the current job (the second one started)
1898 \subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
1899 \index[general]{Allow Higher Duplicates}
1900 This directive was in version 5.0.0, but does not work as
1901 expected. If used, it should always be set to no. In later versions
1902 of Bacula the directive is disabled (disregarded).
1904 \subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
1905 \index[general]{Cancel Running Duplicates}
1906 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1907 if this directive is set to {\bf yes} any job that is already running
1908 will be canceled. The default is {\bf no}.
1910 \subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
1911 \index[general]{Cancel Queued Duplicates}
1912 If {\bf Allow Duplicate Jobs} is set to {\bf no} and
1913 if this directive is set to {\bf yes} any job that is
1914 already queued to run but not yet running will be canceled.
1915 The default is {\bf no}.
1918 \section{TLS Authentication}
1919 \index[general]{TLS Authentication}
1920 In Bacula version 2.5.x and later, in addition to the normal Bacula
1921 CRAM-MD5 authentication that is used to authenticate each Bacula
1922 connection, you can specify that you want TLS Authentication as well,
1923 which will provide more secure authentication.
1925 This new feature uses Bacula's existing TLS code (normally used for
1926 communications encryption) to do authentication. To use it, you must
1927 specify all the TLS directives normally used to enable communications
1928 encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
1931 \subsection{TLS Authenticate = yes}
1933 TLS Authenticate = yes
1936 in the main daemon configuration resource (Director for the Director,
1937 Client for the File daemon, and Storage for the Storage daemon).
1939 When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
1940 authentication, Bacula will also do TLS authentication, then TLS
1941 encryption will be turned off, and the rest of the communication between
1942 the two Bacula daemons will be done without encryption.
1944 If you want to encrypt communications data, use the normal TLS directives
1945 but do not turn on {\bf TLS Authenticate}.
1947 \section{bextract non-portable Win32 data}
1948 \index[general]{bextract handles Win32 non-portable data}
1949 {\bf bextract} has been enhanced to be able to restore
1950 non-portable Win32 data to any OS. Previous versions were
1951 unable to restore non-portable Win32 data to machines that
1952 did not have the Win32 BackupRead and BackupWrite API calls.
1954 \section{State File updated at Job Termination}
1955 \index[general]{State File}
1956 In previous versions of Bacula, the state file, which provides a
1957 summary of previous jobs run in the {\bf status} command output was
1958 updated only when Bacula terminated, thus if the daemon crashed, the
1959 state file might not contain all the run data. This version of
1960 the Bacula daemons updates the state file on each job termination.
1962 \section{MaxFullInterval = \lt{}time-interval\gt{}}
1963 \index[general]{MaxFullInterval}
1964 The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
1965 can be used to specify the maximum time interval between {\bf Full} backup
1966 jobs. When a job starts, if the time since the last Full backup is
1967 greater than the specified interval, and the job would normally be an
1968 {\bf Incremental} or {\bf Differential}, it will be automatically
1969 upgraded to a {\bf Full} backup.
1971 \section{MaxDiffInterval = \lt{}time-interval\gt{}}
1972 \index[general]{MaxDiffInterval}
1973 The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
1974 can be used to specify the maximum time interval between {\bf Differential} backup
1975 jobs. When a job starts, if the time since the last Differential backup is
1976 greater than the specified interval, and the job would normally be an
1977 {\bf Incremental}, it will be automatically
1978 upgraded to a {\bf Differential} backup.
1980 \section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
1981 \index[general]{MaxDiffInterval}
1982 On FreeBSD systems, each file has a {\bf no dump flag} that can be set
1983 by the user, and when it is set it is an indication to backup programs
1984 to not backup that particular file. This version of Bacula contains a
1985 new Options directive within a FileSet resource, which instructs Bacula to
1986 obey this flag. The new directive is:
1989 Honor No Dump Flag = yes\vb{}no
1992 The default value is {\bf no}.
1995 \section{Exclude Dir Containing = \lt{}filename-string\gt{}}
1996 \index[general]{IgnoreDir}
1997 The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
1998 can be added to the Include section of the FileSet resource. If the specified
1999 filename ({\bf filename-string}) is found on the Client in any directory to be
2000 backed up, the whole directory will be ignored (not backed up). For example:
2003 # List of files to be backed up
2011 Exclude Dir Containing = .excludeme
2016 But in /home, there may be hundreds of directories of users and some
2017 people want to indicate that they don't want to have certain
2018 directories backed up. For example, with the above FileSet, if
2019 the user or sysadmin creates a file named {\bf .excludeme} in
2020 specific directories, such as
2023 /home/user/www/cache/.excludeme
2024 /home/user/temp/.excludeme
2027 then Bacula will not backup the two directories named:
2030 /home/user/www/cache
2034 NOTE: subdirectories will not be backed up. That is, the directive
2035 applies to the two directories in question and any children (be they
2036 files, directories, etc).
2039 \section{Bacula Plugins}
2040 \index[general]{Plugin}
2041 Support for shared object plugins has been implemented in the Linux, Unix
2042 and Win32 File daemons. The API will be documented separately in
2043 the Developer's Guide or in a new document. For the moment, there is
2044 a single plugin named {\bf bpipe} that allows an external program to
2045 get control to backup and restore a file.
2047 Plugins are also planned (partially implemented) in the Director and the
2050 \subsection{Plugin Directory}
2051 \index[general]{Plugin Directory}
2052 Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
2053 be added to the daemon definition resource. The directory takes a quoted
2054 string argument, which is the name of the directory in which the daemon can
2055 find the Bacula plugins. If this directive is not specified, Bacula will not
2056 load any plugins. Since each plugin has a distinctive name, all the daemons
2057 can share the same plugin directory.
2059 \subsection{Plugin Options}
2060 \index[general]{Plugin Options}
2061 The {\bf Plugin Options} directive takes a quoted string
2062 arguement (after the equal sign) and may be specified in the
2063 Job resource. The options specified will be passed to all plugins
2064 when they are run. This each plugin must know what it is looking
2065 for. The value defined in the Job resource can be modified
2066 by the user when he runs a Job via the {\bf bconsole} command line
2069 Note: this directive may be specified, and there is code to modify
2070 the string in the run command, but the plugin options are not yet passed to
2071 the plugin (i.e. not fully implemented).
2073 \subsection{Plugin Options ACL}
2074 \index[general]{Plugin Options ACL}
2075 The {\bf Plugin Options ACL} directive may be specified in the
2076 Director's Console resource. It functions as all the other ACL commands
2077 do by permitting users running restricted consoles to specify a
2078 {\bf Plugin Options} that overrides the one specified in the Job
2079 definition. Without this directive restricted consoles may not modify
2082 \subsection{Plugin = \lt{}plugin-command-string\gt{}}
2083 \index[general]{Plugin}
2084 The {\bf Plugin} directive is specified in the Include section of
2085 a FileSet resource where you put your {\bf File = xxx} directives.
2096 Plugin = "bpipe:..."
2101 In the above example, when the File daemon is processing the directives
2102 in the Include section, it will first backup all the files in {\bf /home}
2103 then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
2104 the Plugin Directory. The syntax and semantics of the Plugin directive
2105 require the first part of the string up to the colon (:) to be the name
2106 of the plugin. Everything after the first colon is ignored by the File daemon but
2107 is passed to the plugin. Thus the plugin writer may define the meaning of the
2108 rest of the string as he wishes.
2110 Please see the next section for information about the {\bf bpipe} Bacula
2113 \section{The bpipe Plugin}
2114 \index[general]{The bpipe Plugin}
2115 The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
2116 the Bacula source distribution. When the plugin is compiled and linking into
2117 the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
2118 Please note that this is a very simple plugin that was written for
2119 demonstration and test purposes. It is and can be used in production, but
2120 that was never really intended.
2122 The purpose of the plugin is to provide an interface to any system program for
2123 backup and restore. As specified above the {\bf bpipe} plugin is specified in
2124 the Include section of your Job's FileSet resource. The full syntax of the
2125 plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
2126 to specify the sytax as it wishes) is:
2129 Plugin = "<field1>:<field2>:<field3>:<field4>"
2134 \item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
2135 stripped off, so in this case, we would put {\bf bpipe} in this field.
2137 \item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
2138 pseudo path and filename under which the backup will be saved. This pseudo
2139 path and filename will be seen by the user in the restore file tree.
2140 For example, if the value is {\bf /MYSQL/regress.sql}, the data
2141 backed up by the plugin will be put under that "pseudo" path and filename.
2142 You must be careful to choose a naming convention that is unique to avoid
2143 a conflict with a path and filename that actually exists on your system.
2145 \item {\bf field3} for the {\bf bpipe} plugin
2146 specifies the "reader" program that is called by the plugin during
2147 backup to read the data. {\bf bpipe} will call this program by doing a
2150 \item {\bf field4} for the {\bf bpipe} plugin
2151 specifies the "writer" program that is called by the plugin during
2152 restore to write the data back to the filesystem.
2155 Please note that for two items above describing the "reader" and "writer"
2156 fields, these programs are "executed" by Bacula, which
2157 means there is no shell interpretation of any command line arguments
2158 you might use. If you want to use shell characters (redirection of input
2159 or output, ...), then we recommend that you put your command or commands
2160 in a shell script and execute the script. In addition if you backup a
2161 file with the reader program, when running the writer program during
2162 the restore, Bacula will not automatically create the path to the file.
2163 Either the path must exist, or you must explicitly do so with your command
2164 or in a shell script.
2166 Putting it all together, the full plugin directive line might look
2170 Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
2171 --opt --databases bacula:mysql"
2174 The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
2175 would be written on a single line.
2177 This causes the File daemon to call the {\bf bpipe} plugin, which will write
2178 its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
2179 program {\bf mysqldump -f --opt --database bacula} to read the data during
2180 backup. The mysqldump command outputs all the data for the database named
2181 {\bf bacula}, which will be read by the plugin and stored in the backup.
2182 During restore, the data that was backed up will be sent to the program
2183 specified in the last field, which in this case is {\bf mysql}. When
2184 {\bf mysql} is called, it will read the data sent to it by the plugn
2185 then write it back to the same database from which it came ({\bf bacula}
2188 The {\bf bpipe} plugin is a generic pipe program, that simply transmits
2189 the data from a specified program to Bacula for backup, and then from Bacula to
2190 a specified program for restore.
2192 By using different command lines to {\bf bpipe},
2193 you can backup any kind of data (ASCII or binary) depending
2194 on the program called.
2196 \section{Microsoft Exchange Server 2003/2007 Plugin}
2197 \index[general]{Microsoft Exchange Server 2003/2007 Plugin}
2198 \subsection{Background}
2199 The Exchange plugin was made possible by a funded development project
2200 between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
2201 The code for the plugin was written by James Harper, and the Bacula core
2202 code by Kern Sibbald. All the code for this funded development has become
2203 part of the Bacula project. Thanks to everyone who made it happen.
2205 \subsection{Concepts}
2206 Although it is possible to backup Exchange using Bacula VSS the Exchange
2207 plugin adds a good deal of functionality, because while Bacula VSS
2208 completes a full backup (snapshot) of Exchange, it does
2209 not support Incremental or Differential backups, restoring is more
2210 complicated, and a single database restore is not possible.
2212 Microsoft Exchange organises its storage into Storage Groups with
2213 Databases inside them. A default installation of Exchange will have a
2214 single Storage Group called 'First Storage Group', with two Databases
2215 inside it, "Mailbox Store (SERVER NAME)" and
2216 "Public Folder Store (SERVER NAME)",
2217 which hold user email and public folders respectively.
2219 In the default configuration, Exchange logs everything that happens to
2220 log files, such that if you have a backup, and all the log files since,
2221 you can restore to the present time. Each Storage Group has its own set
2222 of log files and operates independently of any other Storage Groups. At
2223 the Storage Group level, the logging can be turned off by enabling a
2224 function called "Enable circular logging". At this time the Exchange
2225 plugin will not function if this option is enabled.
2227 The plugin allows backing up of entire storage groups, and the restoring
2228 of entire storage groups or individual databases. Backing up and
2229 restoring at the individual mailbox or email item is not supported but
2230 can be simulated by use of the "Recovery" Storage Group (see below).
2232 \subsection{Installing}
2233 The Exchange plugin requires a DLL that is shipped with Microsoft
2234 Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
2235 correctly the Exchange plugin should find this automatically and run
2236 without any additional installation.
2238 If the DLL can not be found automatically it will need to be copied into
2239 the Bacula installation
2240 directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
2241 named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
2242 default Exchange installation.
2244 \subsection{Backing Up}
2245 To back up an Exchange server the Fileset definition must contain at
2246 least {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store"} for
2247 the backup to work correctly. The 'exchange:' bit tells Bacula to look
2248 for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
2249 up files are prefixed with something that isn't going to share a name
2250 with something outside the plugin, and the 'Microsoft Information Store'
2251 bit is required also. It is also possible to add the name of a storage
2252 group to the "Plugin =" line, eg \\
2253 {\bf Plugin = "exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group"} \\
2254 if you want only a single storage group backed up.
2256 Additionally, you can suffix the 'Plugin =' directive with
2257 ":notrunconfull" which will tell the plugin not to truncate the Exchange
2258 database at the end of a full backup.
2260 An Incremental or Differential backup will backup only the database logs
2261 for each Storage Group by inspecting the "modified date" on each
2262 physical log file. Because of the way the Exchange API works, the last
2263 logfile backed up on each backup will always be backed up by the next
2264 Incremental or Differential backup too. This adds 5MB to each
2265 Incremental or Differential backup size but otherwise does not cause any
2268 By default, a normal VSS fileset containing all the drive letters will
2269 also back up the Exchange databases using VSS. This will interfere with
2270 the plugin and Exchange's shared ideas of when the last full backup was
2271 done, and may also truncate log files incorrectly. It is important,
2272 therefore, that the Exchange database files be excluded from the backup,
2273 although the folders the files are in should be included, or they will
2274 have to be recreated manually if a baremetal restore is done.
2279 File = C:/Program Files/Exchsrvr/mdbdata
2280 Plugin = "exchange:..."
2283 File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
2284 File = C:/Program Files/Exchsrvr/mdbdata/E00.log
2285 File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
2286 File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
2287 File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
2288 File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
2289 File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
2294 The advantage of excluding the above files is that you can significantly
2295 reduce the size of your backup since all the important Exchange files
2296 will be properly saved by the Plugin.
2299 \subsection{Restoring}
2300 The restore operation is much the same as a normal Bacula restore, with
2301 the following provisos:
2304 \item The {\bf Where} restore option must not be specified
2305 \item Each Database directory must be marked as a whole. You cannot just
2306 select (say) the .edb file and not the others.
2307 \item If a Storage Group is restored, the directory of the Storage Group
2309 \item It is possible to restore only a subset of the available log files,
2310 but they {\bf must} be contiguous. Exchange will fail to restore correctly
2311 if a log file is missing from the sequence of log files
2312 \item Each database to be restored must be dismounted and marked as "Can be
2313 overwritten by restore"
2314 \item If an entire Storage Group is to be restored (eg all databases and
2315 logs in the Storage Group), then it is best to manually delete the
2316 database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
2317 as Exchange can get confused by stray log files lying around.
2320 \subsection{Restoring to the Recovery Storage Group}
2321 The concept of the Recovery Storage Group is well documented by
2323 \elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
2324 but to briefly summarize...
2326 Microsoft Exchange allows the creation of an additional Storage Group
2327 called the Recovery Storage Group, which is used to restore an older
2328 copy of a database (e.g. before a mailbox was deleted) into without
2329 messing with the current live data. This is required as the Standard and
2330 Small Business Server versions of Exchange can not ordinarily have more
2331 than one Storage Group.
2333 To create the Recovery Storage Group, drill down to the Server in Exchange
2334 System Manager, right click, and select
2335 {\bf "New -> Recovery Storage Group..."}. Accept or change the file
2336 locations and click OK. On the Recovery Storage Group, right click and
2337 select {\bf "Add Database to Recover..."} and select the database you will
2340 Restore only the single database nominated as the database in the
2341 Recovery Storage Group. Exchange will redirect the restore to the
2342 Recovery Storage Group automatically.
2343 Then run the restore.
2345 \subsection{Restoring on Microsoft Server 2007}
2346 Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
2347 2007, and henc you use a new proceedure for recovering a single mail box.
2348 This procedure is ducomented by Microsoft at:
2349 \elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
2350 and involves using the {\bf Restore-Mailbox} and {\bf
2351 Get-MailboxStatistics} shell commands.
2353 \subsection{Caveats}
2354 This plugin is still being developed, so you should consider it
2355 currently in BETA test, and thus use in a production environment
2356 should be done only after very careful testing.
2358 When doing a full backup, the Exchange database logs are truncated by
2359 Exchange as soon as the plugin has completed the backup. If the data
2360 never makes it to the backup medium (eg because of spooling) then the
2361 logs will still be truncated, but they will also not have been backed
2362 up. A solution to this is being worked on. You will have to schedule a
2363 new Full backup to ensure that your next backups will be usable.
2365 The "Enable Circular Logging" option cannot be enabled or the plugin
2368 Exchange insists that a successful Full backup must have taken place if
2369 an Incremental or Differential backup is desired, and the plugin will
2370 fail if this is not the case. If a restore is done, Exchange will
2371 require that a Full backup be done before an Incremental or Differential
2374 The plugin will most likely not work well if another backup application
2375 (eg NTBACKUP) is backing up the Exchange database, especially if the
2376 other backup application is truncating the log files.
2378 The Exchange plugin has not been tested with the {\bf Accurate} option, so
2379 we recommend either carefully testing or that you avoid this option for
2382 The Exchange plugin is not called during processing the bconsole {\bf
2383 estimate} command, and so anything that would be backed up by the plugin
2384 will not be added to the estimate total that is displayed.
2387 \section{libdbi Framework}
2388 \index[general]{libdbi Framework}
2389 As a general guideline, Bacula has support for a few catalog database drivers
2390 (MySQL, PostgreSQL, SQLite)
2391 coded natively by the Bacula team. With the libdbi implementation, which is a
2392 Bacula driver that uses libdbi to access the catalog, we have an open field to
2393 use many different kinds database engines following the needs of users.
2395 The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
2396 implements a database-independent abstraction layer in C, similar to the
2397 DBI/DBD layer in Perl. Writing one generic set of code, programmers can
2398 leverage the power of multiple databases and multiple simultaneous database
2399 connections by using this framework.
2401 Currently the libdbi driver in Bacula project only supports the same drivers
2402 natively coded in Bacula. However the libdbi project has support for many
2403 others database engines. You can view the list at
2404 http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
2405 supported by Bacula, however, they must be tested properly by the Bacula team.
2407 Some of benefits of using libdbi are:
2409 \item The possibility to use proprietary databases engines in which your
2410 proprietary licenses prevent the Bacula team from developing the driver.
2411 \item The possibility to use the drivers written for the libdbi project.
2412 \item The possibility to use other database engines without recompiling Bacula
2413 to use them. Just change one line in bacula-dir.conf
2414 \item Abstract Database access, this is, unique point to code and profiling
2415 catalog database access.
2418 The following drivers have been tested:
2420 \item PostgreSQL, with and without batch insert
2421 \item Mysql, with and without batch insert
2426 In the future, we will test and approve to use others databases engines
2427 (proprietary or not) like DB2, Oracle, Microsoft SQL.
2429 To compile Bacula to support libdbi we need to configure the code with the
2430 --with-dbi and --with-dbi-driver=[database] ./configure options, where
2431 [database] is the database engine to be used with Bacula (of course we can
2432 change the driver in file bacula-dir.conf, see below). We must configure the
2433 access port of the database engine with the option --with-db-port, because the
2434 libdbi framework doesn't know the default access port of each database.
2436 The next phase is checking (or configuring) the bacula-dir.conf, example:
2440 dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
2441 dbname = regress; user = regress; password = ""
2445 The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
2446 mysql database. Currently the drivers supported by Bacula are: postgresql,
2447 mysql, sqlite, sqlite3; these are the names that may be added to string "dbi:".
2449 The following limitations apply when Bacula is set to use the libdbi framework:
2450 - Not tested on the Win32 platform
2451 - A little performance is lost if comparing with native database driver.
2452 The reason is bound with the database driver provided by libdbi and the
2453 simple fact that one more layer of code was added.
2455 It is important to remember, when compiling Bacula with libdbi, the
2456 following packages are needed:
2458 \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
2459 \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
2462 You can download them and compile them on your system or install the packages
2463 from your OS distribution.
2465 \section{Console Command Additions and Enhancements}
2466 \index[general]{Console Additions}
2468 \subsection{Display Autochanger Content}
2469 \index[general]{StatusSlots}
2471 The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
2472 autochanger content.
2476 Slot | Volume Name | Status | Media Type | Pool |
2477 ------+---------------+----------+-------------------+------------|
2478 1 | 00001 | Append | DiskChangerMedia | Default |
2479 2 | 00002 | Append | DiskChangerMedia | Default |
2480 3*| 00003 | Append | DiskChangerMedia | Scratch |
2485 If you an asterisk ({\bf *}) appears after the slot number, you must run an
2486 {\bf update slots} command to synchronize autochanger content with your
2489 \subsection{list joblog job=xxx or jobid=nnn}
2490 \index[general]{list joblog}
2491 A new list command has been added that allows you to list the contents
2492 of the Job Log stored in the catalog for either a Job Name (fully qualified)
2493 or for a particular JobId. The {\bf llist} command will include a line with
2494 the time and date of the entry.
2496 Note for the catalog to have Job Log entries, you must have a directive
2503 In your Director's {\bf Messages} resource.
2505 \subsection{Use separator for multiple commands}
2506 \index[general]{Command Separator}
2507 When using bconsole with readline, you can set the command separator with
2508 \textbf{@separator} command to one
2509 of those characters to write commands who require multiple input in one line.
2511 !$%&'()*+,-/:;<>?[]^`{|}~
2514 \subsection{Deleting Volumes}
2515 The delete volume bconsole command has been modified to
2516 require an asterisk (*) in front of a MediaId otherwise the
2517 value you enter is a taken to be a Volume name. This is so that
2518 users may delete numeric Volume names. The previous Bacula versions
2519 assumed that all input that started with a number was a MediaId.
2521 This new behavior is indicated in the prompt if you read it
2524 \section{Bare Metal Recovery}
2525 The old bare metal recovery project is essentially dead. One
2526 of the main features of it was that it would build a recovery
2527 CD based on the kernel on your system. The problem was that
2528 every distribution has a different boot procedure and different
2529 scripts, and worse yet, the boot procedures and scripts change
2530 from one distribution to another. This meant that maintaining
2531 (keeping up with the changes) the rescue CD was too much work.
2533 To replace it, a new bare metal recovery USB boot stick has been developed
2534 by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
2535 boot from a USB key.
2539 \item Recovery can be done from within graphical environment.
2540 \item Recovery can be done in a shell.
2541 \item Ubuntu boots on a large number of Linux systems.
2542 \item The process of updating the system and adding new
2543 packages is not too difficult.
2544 \item The USB key can easily be upgraded to newer Ubuntu versions.
2545 \item The USB key has writable partitions for modifications to
2546 the OS and for modification to your home directory.
2547 \item You can add new files/directories to the USB key very easily.
2548 \item You can save the environment from multiple machines on
2550 \item Bacula Systems is funding its ongoing development.
2553 The disadvantages are:
2555 \item The USB key is usable but currently under development.
2556 \item Not everyone may be familiar with Ubuntu (no worse
2558 \item Some older OSes cannot be booted from USB. This can
2559 be resolved by first booting a Ubuntu LiveCD then plugging
2561 \item Currently the documentation is sketchy and not yet added
2562 to the main manual. See below ...
2565 The documentation and the code can be found in the {\bf rescue} package
2566 in the directory {\bf linux/usb}.
2568 \section{Miscellaneous}
2569 \index[general]{Misc New Features}
2571 \subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
2572 \index[general]{Allow Mixed Priority}
2573 This directive is only implemented in version 2.5 and later. When
2574 set to {\bf yes} (default {\bf no}), this job may run even if lower
2575 priority jobs are already running. This means a high priority job
2576 will not have to wait for other jobs to finish before starting.
2577 The scheduler will only mix priorities when all running jobs have
2580 Note that only higher priority jobs will start early. Suppose the
2581 director will allow two concurrent jobs, and that two jobs with
2582 priority 10 are running, with two more in the queue. If a job with
2583 priority 5 is added to the queue, it will be run as soon as one of
2584 the running jobs finishes. However, new priority 10 jobs will not
2585 be run until the priority 5 job has finished.
2587 \subsection{Bootstrap File Directive -- FileRegex}
2588 \index[general]{Bootstrap File Directive}
2589 {\bf FileRegex} is a new command that can be added to the bootstrap
2590 (.bsr) file. The value is a regular expression. When specified, only
2591 matching filenames will be restored.
2593 During a restore, if all File records are pruned from the catalog
2594 for a Job, normally Bacula can restore only all files saved. That
2595 is there is no way using the catalog to select individual files.
2596 With this new feature, Bacula will ask if you want to specify a Regex
2597 expression for extracting only a part of the full backup.
2600 Building directory tree for JobId(s) 1,3 ...
2601 There were no files inserted into the tree, so file selection
2602 is not possible.Most likely your retention policy pruned the files
2604 Do you want to restore all the files? (yes\vb{}no): no
2606 Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
2607 Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
2610 \subsection{Bootstrap File Optimization Changes}
2611 In order to permit proper seeking on disk files, we have extended the bootstrap
2612 file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
2613 takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
2614 address range and end address range respectively. These two directives replace
2615 the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
2616 VolEndBlock} directives. Bootstrap files containing the old directives will
2617 still work, but will not properly take advantage of proper disk seeking, and
2618 may read completely to the end of a disk volume during a restore. With the new
2619 format (automatically generated by the new Director), restores will seek
2620 properly and stop reading the volume when all the files have been restored.
2622 \subsection{Solaris ZFS/NFSv4 ACLs}
2623 This is an upgrade of the previous Solaris ACL backup code
2624 to the new library format, which will backup both the old
2625 POSIX(UFS) ACLs as well as the ZFS ACLs.
2627 The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
2628 (it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
2629 be used to transfer from UFS to ZFS filesystems.
2632 \subsection{Virtual Tape Emulation}
2633 \index[general]{Virtual Tape Emulation}
2634 We now have a Virtual Tape emulator that allows us to run though 99.9\% of
2635 the tape code but actually reading and writing to a disk file. Used with the
2636 \textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
2637 and 700 slots. This feature is most useful in testing. It is enabled
2638 by using {\bf Device Type = vtape} in the Storage daemon's Device
2639 directive. This feature is only implemented on Linux machines and should not be
2640 used for production.
2642 \subsection{Bat Enhancements}
2643 \index[general]{Bat Enhancements}
2644 Bat (the Bacula Administration Tool) GUI program has been significantly
2645 enhanced and stabilized. In particular, there are new table based status
2646 commands; it can now be easily localized using Qt4 Linguist.
2648 The Bat communications protocol has been significantly enhanced to improve
2649 GUI handling. Note, you {\bf must} use a the bat that is distributed with
2650 the Director you are using otherwise the communications protocol will not
2653 \subsection{RunScript Enhancements}
2654 \index[general]{RunScript Enhancements}
2655 The {\bf RunScript} resource has been enhanced to permit multiple
2656 commands per RunScript. Simply specify multiple {\bf Command} directives
2663 Command = "/bin/echo test"
2664 Command = "/bin/echo an other test"
2665 Command = "/bin/echo 3 commands in the same runscript"
2672 A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
2673 implemented, which runs the command after the Volume Shadow Copy has been made.
2675 Console commands can be specified within a RunScript by using:
2676 {\bf Console = \lt{}command\gt{}}, however, this command has not been
2677 carefully tested and debugged and is known to easily crash the Director.
2678 We would appreciate feedback. Due to the recursive nature of this command, we
2679 may remove it before the final release.
2681 \subsection{Status Enhancements}
2682 \index[general]{Status Enhancements}
2683 The bconsole {\bf status dir} output has been enhanced to indicate
2684 Storage daemon job spooling and despooling activity.
2686 \subsection{Connect Timeout}
2687 \index[general]{Connect Timeout}
2688 The default connect timeout to the File
2689 daemon has been set to 3 minutes. Previously it was 30 minutes.
2691 \subsection{ftruncate for NFS Volumes}
2692 \index[general]{ftruncate for NFS Volumes}
2693 If you write to a Volume mounted by NFS (say on a local file server),
2694 in previous Bacula versions, when the Volume was recycled, it was not
2695 properly truncated because NFS does not implement ftruncate (file
2696 truncate). This is now corrected in the new version because we have
2697 written code (actually a kind user) that deletes and recreates the Volume,
2698 thus accomplishing the same thing as a truncate.
2700 \subsection{Support for Ubuntu}
2701 The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
2702 version of Linux, and thus now provides correct autostart routines.
2703 Since Ubuntu officially supports Bacula, you can also obtain any
2704 recent release of Bacula from the Ubuntu repositories.
2706 \subsection{Recycle Pool = \lt{}pool-name\gt{}}
2707 \index[general]{Recycle Pool}
2708 The new \textbf{RecyclePool} directive defines to which pool the Volume will
2709 be placed (moved) when it is recycled. Without this directive, a Volume will
2710 remain in the same pool when it is recycled. With this directive, it can be
2711 moved automatically to any existing pool during a recycle. This directive is
2712 probably most useful when defined in the Scratch pool, so that volumes will
2713 be recycled back into the Scratch pool.
2715 \subsection{FD Version}
2716 \index[general]{FD Version}
2717 The File daemon to Director protocol now includes a version
2718 number, which although there is no visible change for users,
2719 will help us in future versions automatically determine
2720 if a File daemon is not compatible.
2722 \subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
2723 \index[general]{Max Run Sched Time}
2724 The time specifies the maximum allowed time that a job may run, counted from
2725 when the job was scheduled. This can be useful to prevent jobs from running
2726 during working hours. We can see it like \texttt{Max Start Delay + Max Run
2729 \subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2730 \index[general]{Max Wait Time}
2731 Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
2732 of checking the maximum allowed time that a job may block for a resource,
2733 those directives worked like \textbf{MaxRunTime}. Some users are reporting to
2734 use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
2735 their job depending on the level. Now, they have to use
2736 \textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
2737 directives are now deprecated.
2739 \subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
2740 \index[general]{Incremental Max Wait Time}
2741 \index[general]{Differential Max Wait Time}
2743 These directives have been deprecated in favor of
2744 \texttt{Incremental|Differential Max Run Time}.
2746 \subsection{Max Run Time directives}
2747 \index[general]{Max Run Time directives}
2748 Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
2749 maximum allowed time that a job can run depending on the level.
2751 \addcontentsline{lof}{figure}{Job time control directives}
2752 \includegraphics{\idir different_time.eps}
2754 \subsection{Statistics Enhancements}
2755 \index[general]{Statistics Enhancements}
2756 If you (or probably your boss) want to have statistics on your backups to
2757 provide some \textit{Service Level Agreement} indicators, you could use a few
2758 SQL queries on the Job table to report how many:
2762 \item jobs have been successful
2763 \item files have been backed up
2767 However, these statistics are accurate only if your job retention is greater
2768 than your statistics period. Ie, if jobs are purged from the catalog, you won't
2769 be able to use them.
2771 Now, you can use the \textbf{update stats [days=num]} console command to fill
2772 the JobHistory table with new Job records. If you want to be sure to take in
2773 account only \textbf{good jobs}, ie if one of your important job has failed but
2774 you have fixed the problem and restarted it on time, you probably want to
2775 delete the first \textit{bad} job record and keep only the successful one. For
2776 that simply let your staff do the job, and update JobHistory table after two or
2777 three days depending on your organization using the \textbf{[days=num]} option.
2779 These statistics records aren't used for restoring, but mainly for
2780 capacity planning, billings, etc.
2782 The Bweb interface provides a statistics module that can use this feature. You
2783 can also use tools like Talend or extract information by yourself.
2785 The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
2786 the length of time that Bacula will keep statistics job records in the Catalog
2787 database after the Job End time. (In \texttt{JobHistory} table) When this time
2788 period expires, and if user runs \texttt{prune stats} command, Bacula will
2789 prune (remove) Job records that are older than the specified period.
2791 You can use the following Job resource in your nightly \textbf{BackupCatalog}
2792 job to maintain statistics.
2795 Name = BackupCatalog
2798 Console = "update stats days=3"
2799 Console = "prune stats yes"
2806 \subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
2807 \index[general]{ScratchPool}
2808 This directive permits to specify a specific \textsl{Scratch} pool for the
2809 current pool. This is useful when using multiple storage sharing the same
2810 mediatype or when you want to dedicate volumes to a particular set of pool.
2812 \subsection{Enhanced Attribute Despooling}
2813 \index[general]{Attribute Despooling}
2814 If the storage daemon and the Director are on the same machine, the spool file
2815 that contains attributes is read directly by the Director instead of being
2816 transmitted across the network. That should reduce load and speedup insertion.
2818 \subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
2819 \index[general]{SpoolSize}
2820 A new Job directive permits to specify the spool size per job. This is used
2821 in advanced job tunning. {\bf SpoolSize={\it bytes}}
2823 \subsection{MaximumConsoleConnections = \lt{}number\gt{}}
2824 \index[general]{MaximumConsoleConnections}
2825 A new director directive permits to specify the maximum number of Console
2826 Connections that could run concurrently. The default is set to 20, but you may
2827 set it to a larger number.
2829 \subsection{VerId = \lt{}string\gt{}}
2830 \index[general]{VerId}
2831 A new director directive permits to specify a personnal identifier that will be
2832 displayed in the \texttt{version} command.
2834 \subsection{dbcheck enhancements}
2835 \index[general]{dbcheck enhancements}
2836 If you are using Mysql, dbcheck will now ask you if you want to create
2837 temporary indexes to speed up orphaned Path and Filename elimination.
2839 A new \texttt{-B} option allows you to print catalog information in a simple
2840 text based format. This is useful to backup it in a secure way.
2855 You can now specify the database connection port in the command line.
2857 \subsection{{-}{-}docdir configure option}
2858 \index[general]{{-}{-}docdir configure option}
2859 You can use {-}{-}docdir= on the ./configure command to
2860 specify the directory where you want Bacula to install the
2861 LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
2862 {\bf /usr/share/doc/bacula}.
2864 \subsection{{-}{-}htmldir configure option}
2865 \index[general]{{-}{-}htmldir configure option}
2866 You can use {-}{-}htmldir= on the ./configure command to
2867 specify the directory where you want Bacula to install the bat html help
2868 files. The default is {\bf /usr/share/doc/bacula/html}
2870 \subsection{{-}{-}with-plugindir configure option}
2871 \index[general]{{-}{-}plugindir configure option}
2872 You can use {-}{-}plugindir= on the ./configure command to
2873 specify the directory where you want Bacula to install
2874 the plugins (currently only bpipe-fd). The default is